Skip to main content

Amazon Web Services

Connect to AWS services (S3, Lambda, DynamoDB, EC2, and 400+ more).

Amazon Web Services Logo

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})

Available Actions

This connector provides 17863 actions:

ActionPurposeParameters
accessanalyzer/apply_archive_ruleRetroactively applies the archive rule to existing findings that meet the archive rule criteria.analyzerArn (string) required
ruleName (string) required
clientToken (string)
accessanalyzer/cancel_policy_generationCancels the requested policy generation.jobId (string) required
accessanalyzer/check_access_not_grantedChecks whether the specified access isn't allowed by a policy.policyDocument (string) required
access (array) required
policyType (string) required
accessanalyzer/check_no_new_accessChecks whether new access is allowed for an updated policy when compared to the existing policy. You can find examples for reference policies and learn how to set up and run a custom policy check for new access in the IAM Access Analyzer custom policy checks samples repository on GitHub. The reference policies in this repository are meant to be passed to the existingPolicyDocument request parameter.newPolicyDocument (string) required
existingPolicyDocument (string) required
policyType (string) required
accessanalyzer/check_no_public_accessChecks whether a resource policy can grant public access to the specified resource type.policyDocument (string) required
resourceType (string) required
accessanalyzer/create_access_previewCreates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.analyzerArn (string) required
configurations (object) required
clientToken (string)
accessanalyzer/generate_finding_recommendationCreates a recommendation for an unused permissions finding.analyzerArn (string) required
id (string) required
accessanalyzer/get_access_previewRetrieves information about an access preview for the specified analyzer.accessPreviewId (string) required
analyzerArn (string) required
accessanalyzer/get_analyzed_resourceRetrieves information about a resource that was analyzed. This action is supported only for external access analyzers.analyzerArn (string) required
resourceArn (string) required
accessanalyzer/get_findingRetrieves information about the specified finding. GetFinding and GetFindingV2 both use access-analyzer:GetFinding in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:GetFinding action. GetFinding is supported only for external access analyzers. You must use GetFindingV2 for internal and unused access analyzers.analyzerArn (string) required
id (string) required
accessanalyzer/get_finding_recommendationRetrieves information about a finding recommendation for the specified analyzer.analyzerArn (string) required
id (string) required
maxResults (integer)
nextToken (string)
accessanalyzer/get_findings_statisticsRetrieves a list of aggregated finding statistics for an external access or unused access analyzer.analyzerArn (string) required
accessanalyzer/get_finding_v2Retrieves information about the specified finding. GetFinding and GetFindingV2 both use access-analyzer:GetFinding in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:GetFinding action.analyzerArn (string) required
id (string) required
maxResults (integer)
nextToken (string)
accessanalyzer/get_generated_policyRetrieves the policy that was generated using StartPolicyGeneration.jobId (string) required
includeResourcePlaceholders (boolean)
includeServiceLevelTemplate (boolean)
accessanalyzer/list_access_preview_findingsRetrieves a list of access preview findings generated by the specified access preview.accessPreviewId (string) required
analyzerArn (string) required
filter (object)
nextToken (string)
maxResults (integer)
accessanalyzer/list_access_previewsRetrieves a list of access previews for the specified analyzer.analyzerArn (string) required
nextToken (string)
maxResults (integer)
accessanalyzer/list_analyzed_resourcesRetrieves a list of resources of the specified type that have been analyzed by the specified analyzer.analyzerArn (string) required
resourceType (string)
nextToken (string)
maxResults (integer)
accessanalyzer/list_findingsRetrieves a list of findings generated by the specified analyzer. ListFindings and ListFindingsV2 both use access-analyzer:ListFindings in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:ListFindings action. 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 is supported only for external access analyzers. You must use ListFindingsV2 for internalanalyzerArn (string) required
filter (object)
sort: {
. attributeName (string)
. orderBy (string)
} (object)
nextToken (string)
maxResults (integer)
accessanalyzer/list_findings_v2Retrieves a list of findings generated by the specified analyzer. ListFindings and ListFindingsV2 both use access-analyzer:ListFindings in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:ListFindings action. 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.analyzerArn (string) required
filter (object)
maxResults (integer)
nextToken (string)
sort: {
. attributeName (string)
. orderBy (string)
} (object)
accessanalyzer/list_policy_generationsLists all of the policy generations requested in the last seven days.principalArn (string)
maxResults (integer)
nextToken (string)
accessanalyzer/list_tags_for_resourceRetrieves a list of tags applied to the specified resource.resourceArn (string) required
accessanalyzer/start_policy_generationStarts the policy generation request.policyGenerationDetails: {
. principalArn (string)
} (object) required
cloudTrailDetails: {
. trails (array)
. accessRole (string)
. startTime (string)
. endTime (string)
} (object)
clientToken (string)
accessanalyzer/start_resource_scanImmediately starts a scan of the policies applied to the specified resource. This action is supported only for external access analyzers.analyzerArn (string) required
resourceArn (string) required
resourceOwnerAccount (string)
accessanalyzer/tag_resourceAdds a tag to the specified resource.resourceArn (string) required
tags (object) required
accessanalyzer/untag_resourceRemoves a tag from the specified resource.resourceArn (string) required
tagKeys (array) required
accessanalyzer/update_findingsUpdates the status for the specified findings.analyzerArn (string) required
status (string) required
ids (array)
resourceArn (string)
clientToken (string)
accessanalyzer/validate_policyRequests 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.locale (string)
maxResults (integer)
nextToken (string)
policyDocument (string) required
policyType (string) required
validatePolicyResourceType (string)
accessanalyzer/get_analyzerRetrieves information about the specified analyzer.analyzerName (string) required
accessanalyzer/update_analyzerModifies the configuration of an existing analyzer. This action is not supported for external access analyzers.analyzerName (string) required
configuration (undefined)
accessanalyzer/delete_analyzerDeletes 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.analyzerName (string) required
clientToken (string)
accessanalyzer/list_analyzersRetrieves a list of analyzers.nextToken (string)
maxResults (integer)
type (string)
accessanalyzer/create_analyzerCreates an analyzer for your account.analyzerName (string) required
type (string) required
archiveRules (array)
tags (object)
clientToken (string)
configuration (undefined)
accessanalyzer/get_archive_ruleRetrieves 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.analyzerName (string) required
ruleName (string) required
accessanalyzer/update_archive_ruleUpdates the criteria and values for the specified archive rule.analyzerName (string) required
ruleName (string) required
filter (object) required
clientToken (string)
accessanalyzer/delete_archive_ruleDeletes the specified archive rule.analyzerName (string) required
ruleName (string) required
clientToken (string)
accessanalyzer/list_archive_rulesRetrieves a list of archive rules created for the specified analyzer.analyzerName (string) required
nextToken (string)
maxResults (integer)
accessanalyzer/create_archive_ruleCreates 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.analyzerName (string) required
ruleName (string) required
filter (object) required
clientToken (string)
account/get_account_informationRetrieves information about the specified account including its account name, account ID, and account creation date and time. To use this API, an IAM user or role must have the account:GetAccountInformation IAM permission.AccountId (string)
account/put_account_nameUpdates the account name of the specified account. To use this API, IAM principals must have the account:PutAccountName IAM permission.AccountName (string) required
AccountId (string)
account/get_alternate_contactRetrieves the specified alternate contact attached to an Amazon Web Services account. For complete details about how to use the alternate contact operations, see Update the alternate contacts for your Amazon Web Services account. 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 Enable trusted acceAlternateContactType (string) required
AccountId (string)
account/delete_alternate_contactDeletes the specified alternate contact from an Amazon Web Services account. For complete details about how to use the alternate contact operations, see Update the alternate contacts for your Amazon Web Services account. 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 Enable trusted access for AmAlternateContactType (string) required
AccountId (string)
account/put_alternate_contactModifies the specified alternate contact attached to an Amazon Web Services account. For complete details about how to use the alternate contact operations, see Update the alternate contacts for your Amazon Web Services account. 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 Enable trusted accesName (string) required
Title (string) required
EmailAddress (string) required
PhoneNumber (string) required
AlternateContactType (string) required
AccountId (string)
account/get_gov_cloud_account_informationRetrieves information about the GovCloud account linked to the specified standard account if it exists including the GovCloud account ID and state. To use this API, an IAM user or role must have the account:GetGovCloudAccountInformation IAM permission.StandardAccountId (string)
account/get_contact_informationRetrieves 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 contact for your Amazon Web Services account.AccountId (string)
account/put_contact_informationUpdates 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 contact for your Amazon Web Services account.ContactInformation: {
. FullName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. AddressLine3 (string)
. City (string)
. StateOrRegion (string)
. DistrictOrCounty (string)
. PostalCode (string)
. CountryCode (string)
. PhoneNumber (string)
. CompanyName (string)
. WebsiteUrl (string)
} (object) required
AccountId (string)
account/accept_primary_email_updateAccepts the request that originated from StartPrimaryEmailUpdate to update the primary email address also known as the root user email address for the specified account.AccountId (string) required
PrimaryEmail (string) required
Otp (string) required
account/get_primary_emailRetrieves the primary email address for the specified account.AccountId (string) required
account/start_primary_email_updateStarts the process to update the primary email address for the specified account.AccountId (string) required
PrimaryEmail (string) required
account/disable_regionDisables opts-out a particular Region for an account. The act of disabling a Region will remove all IAM access to any resources that reside in that Region.AccountId (string)
RegionName (string) required
account/enable_regionEnables opts-in a particular Region for an account.AccountId (string)
RegionName (string) required
account/get_region_opt_statusRetrieves the opt-in status of a particular Region.AccountId (string)
RegionName (string) required
account/list_regionsLists all the Regions for a given account and their respective opt-in statuses. Optionally, this list can be filtered by the region-opt-status-contains parameter.AccountId (string)
MaxResults (integer)
NextToken (string)
RegionOptStatusContains (array)
acm_pca/create_certificate_authorityCreates 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. ThCertificateAuthorityConfiguration: {
. KeyAlgorithm (string)
. SigningAlgorithm (string)
. Subject (object)
. CsrExtensions (object)
} (object) required
RevocationConfiguration: {
. CrlConfiguration (object)
. OcspConfiguration (object)
} (object)
CertificateAuthorityType (string) required
IdempotencyToken (string)
KeyStorageSecurityStandard (string)
Tags (array)
UsageMode (string)
acm_pca/create_certificate_authority_audit_reportCreates an audit report that lists every time that your CA private key is used to issue a certificate. The IssueCertificate and RevokeCertificate actions use the private key. To save the audit report to your designated Amazon S3 bucket, you must create a bucket policy that grants Amazon Web Services Private CA permission to access and write to it. For an example policy, see Prepare an Amazon S3 bucket for audit reports. Amazon Web Services Private CA assets that are stored in Amazon S3 can be prCertificateAuthorityArn (string) required
S3BucketName (string) required
AuditReportResponseFormat (string) required
acm_pca/create_permissionGrants 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 permissionCertificateAuthorityArn (string) required
Principal (string) required
SourceAccount (string)
Actions (array) required
acm_pca/delete_certificate_authorityDeletes 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. AdditiCertificateAuthorityArn (string) required
PermanentDeletionTimeInDays (integer)
acm_pca/delete_permissionRevokes 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 iCertificateAuthorityArn (string) required
Principal (string) required
SourceAccount (string)
acm_pca/delete_policyDeletes 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 policyResourceArn (string) required
acm_pca/describe_certificate_authorityLists 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 - Amazon Web Services Private CA is creating your private certificate authority. PENDING_CERTIFICATE - The certificate is pending. You must use your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your privateCertificateAuthorityArn (string) required
acm_pca/describe_certificate_authority_audit_reportLists 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.CertificateAuthorityArn (string) required
AuditReportId (string) required
acm_pca/get_certificateRetrieves 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, EXPIRED, or REVOKED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of theCertificateAuthorityArn (string) required
CertificateArn (string) required
acm_pca/get_certificate_authority_certificateRetrieves 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.CertificateAuthorityArn (string) required
acm_pca/get_certificate_authority_csrRetrieves 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 Amazon Web Services Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into Amazon Web Services Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.CertificateAuthorityArn (string) required
acm_pca/get_policyRetrieves 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. FResourceArn (string) required
acm_pca/import_certificate_authority_certificateImports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this action, the following preparations must in place: In Amazon Web Services 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 signiCertificateAuthorityArn (string) required
Certificate (string) required
CertificateChain (string)
acm_pca/issue_certificateUses 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 Amazon Web Services Private CA.ApiPassthrough: {
. Extensions (object)
. Subject (object)
} (object)
CertificateAuthorityArn (string) required
Csr (string) required
SigningAlgorithm (string) required
TemplateArn (string)
Validity: {
. Value (integer)
. Type (string)
} (object) required
ValidityNotBefore: {
. Value (integer)
. Type (string)
} (object)
IdempotencyToken (string)
acm_pca/list_certificate_authoritiesLists the private certificate authorities that you created by using the CreateCertificateAuthority action.MaxResults (integer)
NextToken (string)
ResourceOwner (string)
acm_pca/list_permissionsList 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 permissionsMaxResults (integer)
NextToken (string)
CertificateAuthorityArn (string) required
acm_pca/list_tagsLists 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.MaxResults (integer)
NextToken (string)
CertificateAuthorityArn (string) required
acm_pca/put_policyAttaches 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 areResourceArn (string) required
Policy (string) required
acm_pca/restore_certificate_authorityRestores 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 DescribeCertiCertificateAuthorityArn (string) required
acm_pca/revoke_certificateRevokes a certificate that was issued inside Amazon Web Services 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. Amazon Web Services 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, Amazon Web Services Private CA attempts makes further atCertificateAuthorityArn (string) required
CertificateSerial (string) required
RevocationReason (string) required
acm_pca/tag_certificate_authorityAdds 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 relaCertificateAuthorityArn (string) required
Tags (array) required
acm_pca/untag_certificate_authorityRemove 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.CertificateAuthorityArn (string) required
Tags (array) required
acm_pca/update_certificate_authorityUpdates 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 Amazon Web Services Private CA 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 isCertificateAuthorityArn (string) required
RevocationConfiguration: {
. CrlConfiguration (object)
. OcspConfiguration (object)
} (object)
Status (string)
acm/add_tags_to_certificateAdds 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 foCertificateArn (string) required
Tags (array) required
acm/delete_certificateDeletes 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 associatiCertificateArn (string) required
acm/describe_certificateReturns 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.CertificateArn (string) required
acm/export_certificateExports a private certificate issued by a private certificate authority CA or public certificate for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 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 and Export a pCertificateArn (string) required
Passphrase (string) required
acm/get_account_configurationReturns the account configuration options associated with an Amazon Web Services account.No parameters
acm/get_certificateRetrieves a certificate and its certificate chain. The certificate may be either a public or private certificate issued using the ACM RequestCertificate action, or a certificate imported into ACM using the ImportCertificate action. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.CertificateArn (string) required
acm/import_certificateImports 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 ManagerCertificateArn (string)
Certificate (string) required
PrivateKey (string) required
CertificateChain (string)
Tags (array)
acm/list_certificatesRetrieves 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.CertificateStatuses (array)
Includes: {
. extendedKeyUsage (array)
. keyUsage (array)
. keyTypes (array)
. exportOption (string)
. managedBy (string)
} (object)
NextToken (string)
MaxItems (integer)
SortBy (string)
SortOrder (string)
acm/list_tags_for_certificateLists 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.CertificateArn (string) required
acm/put_account_configurationAdds 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.ExpiryEvents: {
. DaysBeforeExpiry (integer)
} (object)
IdempotencyToken (string) required
acm/remove_tags_from_certificateRemove 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.CertificateArn (string) required
Tags (array) required
acm/renew_certificateRenews an eligible ACM certificate. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.CertificateArn (string) required
acm/request_certificateRequests 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 uDomainName (string) required
ValidationMethod (string)
SubjectAlternativeNames (array)
IdempotencyToken (string)
DomainValidationOptions (array)
Options: {
. CertificateTransparencyLoggingPreference (string)
. Export (string)
} (object)
CertificateAuthorityArn (string)
Tags (array)
KeyAlgorithm (string)
ManagedBy (string)
acm/resend_validation_emailResends 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 tCertificateArn (string) required
Domain (string) required
ValidationDomain (string) required
acm/revoke_certificateRevokes a public ACM certificate. You can only revoke certificates that have been previously exported.CertificateArn (string) required
RevocationReason (string) required
acm/update_certificate_optionsUpdates a certificate. You can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log and exporting. For more information, see Opting Out of Certificate Transparency Logging and Certificate Manager Exportable Managed Certificates.CertificateArn (string) required
Options: {
. CertificateTransparencyLoggingPreference (string)
. Export (string)
} (object) required
aiops/list_tags_for_resourceDisplays the tags associated with a CloudWatch investigations resource. Currently, investigation groups support tagging.resourceArn (string) required
aiops/tag_resourceAssigns one or more tags key-value pairs to the specified 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. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can associate as many as 50 tags with a resource.resourceArn (string) required
tags (object) required
aiops/untag_resourceRemoves one or more tags from the specified resource.resourceArn (string) required
tagKeys (array) required
aiops/create_investigation_groupCreates an investigation group in your account. Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary task to be able to perform investigations. Settings in the investigation group help you centrally manage the common properties of your investigations, such as the following: Who can access the investigations Whether investigation data is encrypted with a customer managed Key Management Service key. How long investigations and their data are rname (string) required
roleArn (string) required
encryptionConfiguration: {
. type (string)
. kmsKeyId (string)
} (object)
retentionInDays (integer)
tags (object)
tagKeyBoundaries (array)
chatbotNotificationChannel (object)
isCloudTrailEventHistoryEnabled (boolean)
crossAccountConfigurations (array)
aiops/get_investigation_groupReturns the configuration information for the specified investigation group.identifier (string) required
aiops/update_investigation_groupUpdates the configuration of the specified investigation group.identifier (string) required
roleArn (string)
encryptionConfiguration: {
. type (string)
. kmsKeyId (string)
} (object)
tagKeyBoundaries (array)
chatbotNotificationChannel (object)
isCloudTrailEventHistoryEnabled (boolean)
crossAccountConfigurations (array)
aiops/delete_investigation_groupDeletes the specified investigation group from your account. You can currently have one investigation group per Region in your account. After you delete an investigation group, you can later create a new investigation group in the same Region.identifier (string) required
aiops/list_investigation_groupsReturns the ARN and name of each investigation group in the account.nextToken (string)
maxResults (integer)
aiops/get_investigation_group_policyReturns the JSON of the IAM resource policy associated with the specified investigation group in a string. For example, 'Version':'2012-10-17','Statement':'Effect':'Allow','Principal':'Service':'aiops.alarms.cloudwatch.amazonaws.com','Action':'aiops:CreateInvestigation','aiops:CreateInvestigationEvent','Resource':'','Condition':'StringEquals':'aws:SourceAccount':'111122223333','ArnLike':'aws:SourceArn':'arn:aws:cloudwatch:us-east-1:111122223333:alarm:'.identifier (string) required
aiops/delete_investigation_group_policyRemoves the IAM resource policy from being associated with the investigation group that you specify.identifier (string) required
aiops/put_investigation_group_policyCreates an IAM resource policy and assigns it to the specified investigation group. If you create your investigation group with CreateInvestigationGroup and you want to enable CloudWatch alarms to create investigations and add events to investigations, you must use this operation to create a policy similar to this example. 'Version': '2008-10-17', 'Statement': 'Effect': 'Allow', 'Principal': 'Service': 'aiops.alarms.cloudwatch.amazonaws.com' , 'Action': 'aiops:CreateInvestigation', 'aiops:Cidentifier (string) required
policy (string) required
amp/get_default_scraper_configurationThe GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.No parameters
amp/list_tags_for_resourceThe ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are scrapers, workspaces, and rule groups namespaces.resourceArn (string) required
amp/tag_resourceThe TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and 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. To remove a tag, use UntagResource.resourceArn (string) required
tags (object) required
amp/untag_resourceRemoves the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are rule groups namespaces, scrapers, and workspaces.resourceArn (string) required
tagKeys (array) required
amp/create_scraperThe CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources and sends them to your Amazon Managed Service for Prometheus workspace. You can configure scrapers to collect metrics from Amazon EKS clusters, Amazon MSK clusters, or from VPC-based sources that support DNS-based service discovery. Scrapers are flexible, and can be configured to control what metrics are collected, the frequency of collection, what transformations are applalias (string)
scrapeConfiguration (undefined) required
source (undefined) required
destination (undefined) required
roleConfiguration: {
. sourceRoleArn (string)
. targetRoleArn (string)
} (object)
clientToken (string)
tags (object)
amp/describe_scraperThe DescribeScraper operation displays information about an existing scraper.scraperId (string) required
amp/update_scraperUpdates an existing scraper. You can't use this function to update the source from which the scraper is collecting metrics. To change the source, delete the scraper and create a new one.scraperId (string) required
alias (string)
scrapeConfiguration (undefined)
destination (undefined)
roleConfiguration: {
. sourceRoleArn (string)
. targetRoleArn (string)
} (object)
clientToken (string)
amp/delete_scraperThe DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.scraperId (string) required
clientToken (string)
amp/list_scrapersThe ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.filters (object)
nextToken (string)
maxResults (integer)
amp/describe_scraper_logging_configurationDescribes the logging configuration for a Amazon Managed Service for Prometheus scraper.scraperId (string) required
amp/update_scraper_logging_configurationUpdates the logging configuration for a Amazon Managed Service for Prometheus scraper.scraperId (string) required
loggingDestination (undefined) required
scraperComponents (array)
amp/delete_scraper_logging_configurationDeletes the logging configuration for a Amazon Managed Service for Prometheus scraper.scraperId (string) required
clientToken (string)
amp/create_workspaceCreates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.alias (string)
clientToken (string)
tags (object)
kmsKeyArn (string)
amp/describe_workspaceReturns information about an existing workspace.workspaceId (string) required
amp/update_workspace_aliasUpdates the alias of an existing workspace.workspaceId (string) required
alias (string)
clientToken (string)
amp/delete_workspaceDeletes an existing workspace. When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.workspaceId (string) required
clientToken (string)
amp/list_workspacesLists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.nextToken (string)
alias (string)
maxResults (integer)
amp/describe_alert_manager_definitionRetrieves the full information about the alert manager definition for a workspace.workspaceId (string) required
amp/put_alert_manager_definitionUpdates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition.workspaceId (string) required
data (string) required
clientToken (string)
amp/delete_alert_manager_definitionDeletes the alert manager definition from a workspace.workspaceId (string) required
clientToken (string)
amp/create_alert_manager_definitionThe CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition.workspaceId (string) required
data (string) required
clientToken (string)
amp/create_anomaly_detectorCreates an anomaly detector within a workspace using the Random Cut Forest algorithm for time-series analysis. The anomaly detector analyzes Amazon Managed Service for Prometheus metrics to identify unusual patterns and behaviors.workspaceId (string) required
alias (string) required
evaluationIntervalInSeconds (integer)
missingDataAction (undefined)
configuration (undefined) required
labels (object)
clientToken (string)
tags (object)
amp/describe_anomaly_detectorRetrieves detailed information about a specific anomaly detector, including its status and configuration.workspaceId (string) required
anomalyDetectorId (string) required
amp/delete_anomaly_detectorRemoves an anomaly detector from a workspace. This operation is idempotent.workspaceId (string) required
anomalyDetectorId (string) required
clientToken (string)
amp/list_anomaly_detectorsReturns a paginated list of anomaly detectors for a workspace with optional filtering by alias.workspaceId (string) required
alias (string)
maxResults (integer)
nextToken (string)
amp/put_anomaly_detectorWhen you call PutAnomalyDetector, the operation creates a new anomaly detector if one doesn't exist, or updates an existing one. Each call to this operation triggers a complete retraining of the detector, which includes querying the minimum required samples and backfilling the detector with historical data. This process occurs regardless of whether you're making a minor change like updating the evaluation interval or making more substantial modifications. The operation serves as the single methoworkspaceId (string) required
anomalyDetectorId (string) required
evaluationIntervalInSeconds (integer)
missingDataAction (undefined)
configuration (undefined) required
labels (object)
clientToken (string)
amp/describe_logging_configurationReturns complete information about the current rules and alerting logging configuration of the workspace. These logging configurations are only for rules and alerting logs.workspaceId (string) required
amp/update_logging_configurationUpdates the log group ARN or the workspace ID of the current rules and alerting logging configuration. These logging configurations are only for rules and alerting logs.workspaceId (string) required
logGroupArn (string) required
clientToken (string)
amp/delete_logging_configurationDeletes the rules and alerting logging configuration for a workspace. These logging configurations are only for rules and alerting logs.workspaceId (string) required
clientToken (string)
amp/create_logging_configurationThe CreateLoggingConfiguration operation creates rules and alerting logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to. These logging configurations are only for rules and alerting logs.workspaceId (string) required
logGroupArn (string) required
clientToken (string)
amp/describe_query_logging_configurationRetrieves the details of the query logging configuration for the specified workspace.workspaceId (string) required
amp/update_query_logging_configurationUpdates the query logging configuration for the specified workspace.workspaceId (string) required
destinations (array) required
clientToken (string)
amp/delete_query_logging_configurationDeletes the query logging configuration for the specified workspace.workspaceId (string) required
clientToken (string)
amp/create_query_logging_configurationCreates a query logging configuration for the specified workspace. This operation enables logging of queries that exceed the specified QSP threshold.workspaceId (string) required
destinations (array) required
clientToken (string)
amp/describe_rule_groups_namespaceReturns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.workspaceId (string) required
name (string) required
amp/put_rule_groups_namespaceUpdates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces. The combined length of a rule group namespace and a rule group name cannot exceed 721 UTF-8 bytes. Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace. You can't use this operation to add tags to an existing rule groups namespace. InworkspaceId (string) required
name (string) required
data (string) required
clientToken (string)
amp/delete_rule_groups_namespaceDeletes one rule groups namespace and its associated rule groups definition.workspaceId (string) required
name (string) required
clientToken (string)
amp/list_rule_groups_namespacesReturns a list of rule groups namespaces in a workspace.workspaceId (string) required
name (string)
nextToken (string)
maxResults (integer)
amp/create_rule_groups_namespaceThe CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces. The combined length of a rule group namespace and a rule group name cannot exceed 721 UTF-8 bytes. Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.workspaceId (string) required
name (string) required
data (string) required
clientToken (string)
tags (object)
amp/describe_workspace_configurationUse this operation to return information about the configuration of a workspace. The configuration details returned include workspace configuration status, label set limits, and retention period.workspaceId (string) required
amp/update_workspace_configurationUse this operation to create or update the label sets, label set limits, and retention period of a workspace. You must specify at least one of limitsPerLabelSet or retentionPeriodInDays for the request to be valid.workspaceId (string) required
clientToken (string)
limitsPerLabelSet (array)
retentionPeriodInDays (integer)
amp/describe_resource_policyReturns information about the resource-based policy attached to an Amazon Managed Service for Prometheus workspace.workspaceId (string) required
amp/delete_resource_policyDeletes the resource-based policy attached to an Amazon Managed Service for Prometheus workspace.workspaceId (string) required
clientToken (string)
revisionId (string)
amp/put_resource_policyCreates or updates a resource-based policy for an Amazon Managed Service for Prometheus workspace. Use resource-based policies to grant permissions to other AWS accounts or services to access your workspace. Only Prometheus-compatible APIs can be used for workspace sharing. You can add non-Prometheus-compatible APIs to the policy, but they will be ignored. For more information, see Prometheus-compatible APIs in the Amazon Managed Service for Prometheus User Guide. If your workspace uses customerworkspaceId (string) required
policyDocument (string) required
clientToken (string)
revisionId (string)
amplify/create_appCreates a new Amplify app.name (string) required
description (string)
repository (string)
platform (string)
computeRoleArn (string)
iamServiceRoleArn (string)
oauthToken (string)
accessToken (string)
environmentVariables (object)
enableBranchAutoBuild (boolean)
enableBranchAutoDeletion (boolean)
enableBasicAuth (boolean)
basicAuthCredentials (string)
customRules (array)
tags (object)
buildSpec (string)
customHeaders (string)
enableAutoBranchCreation (boolean)
autoBranchCreationPatterns (array)
autoBranchCreationConfig: {
. stage (string)
. framework (string)
. enableAutoBuild (boolean)
. environmentVariables (object)
. basicAuthCredentials (string)
. enableBasicAuth (boolean)
. enablePerformanceMode (boolean)
. buildSpec (string)
. enablePullRequestPreview (boolean)
. pullRequestEnvironmentName (string)
} (object)
jobConfig: {
. buildComputeType (string)
} (object)
cacheConfig: {
. type (string)
} (object)
amplify/create_backend_environmentCreates a new backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface CLI. This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.appId (string) required
environmentName (string) required
stackName (string)
deploymentArtifacts (string)
amplify/create_branchCreates a new branch for an Amplify app.appId (string) required
branchName (string) required
description (string)
stage (string)
framework (string)
enableNotification (boolean)
enableAutoBuild (boolean)
enableSkewProtection (boolean)
environmentVariables (object)
basicAuthCredentials (string)
enableBasicAuth (boolean)
enablePerformanceMode (boolean)
tags (object)
buildSpec (string)
ttl (string)
displayName (string)
enablePullRequestPreview (boolean)
pullRequestEnvironmentName (string)
backendEnvironmentArn (string)
backend: {
. stackArn (string)
} (object)
computeRoleArn (string)
amplify/create_deploymentCreates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a Git repository. The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.appId (string) required
branchName (string) required
fileMap (object)
amplify/create_domain_associationCreates a new domain association for an Amplify app. This action associates a custom domain with the Amplify appappId (string) required
domainName (string) required
enableAutoSubDomain (boolean)
subDomainSettings (array) required
autoSubDomainCreationPatterns (array)
autoSubDomainIAMRole (string)
certificateSettings: {
. type (string)
. customCertificateArn (string)
} (object)
amplify/create_webhookCreates a new webhook on an Amplify app.appId (string) required
branchName (string) required
description (string)
amplify/delete_appDeletes an existing Amplify app specified by an app ID.appId (string) required
amplify/delete_backend_environmentDeletes a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface CLI. This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.appId (string) required
environmentName (string) required
amplify/delete_branchDeletes a branch for an Amplify app.appId (string) required
branchName (string) required
amplify/delete_domain_associationDeletes a domain association for an Amplify app.appId (string) required
domainName (string) required
amplify/delete_jobDeletes a job for a branch of an Amplify app.appId (string) required
branchName (string) required
jobId (string) required
amplify/delete_webhookDeletes a webhook.webhookId (string) required
amplify/generate_access_logsReturns the website access logs for a specific time range using a presigned URL.startTime (string)
endTime (string)
domainName (string) required
appId (string) required
amplify/get_appReturns an existing Amplify app specified by an app ID.appId (string) required
amplify/get_artifact_urlReturns the artifact info that corresponds to an artifact id.artifactId (string) required
amplify/get_backend_environmentReturns a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface CLI. This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.appId (string) required
environmentName (string) required
amplify/get_branchReturns a branch for an Amplify app.appId (string) required
branchName (string) required
amplify/get_domain_associationReturns the domain information for an Amplify app.appId (string) required
domainName (string) required
amplify/get_jobReturns a job for a branch of an Amplify app.appId (string) required
branchName (string) required
jobId (string) required
amplify/get_webhookReturns the webhook information that corresponds to a specified webhook ID.webhookId (string) required
amplify/list_appsReturns a list of the existing Amplify apps.nextToken (string)
maxResults (integer)
amplify/list_artifactsReturns a list of end-to-end testing artifacts for a specified app, branch, and job. To return the build artifacts, use the GetJob API. For more information about Amplify testing support, see Setting up end-to-end Cypress tests for your Amplify application in the Amplify Hosting User Guide.appId (string) required
branchName (string) required
jobId (string) required
nextToken (string)
maxResults (integer)
amplify/list_backend_environmentsLists the backend environments for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface CLI. This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.appId (string) required
environmentName (string)
nextToken (string)
maxResults (integer)
amplify/list_branchesLists the branches of an Amplify app.appId (string) required
nextToken (string)
maxResults (integer)
amplify/list_domain_associationsReturns the domain associations for an Amplify app.appId (string) required
nextToken (string)
maxResults (integer)
amplify/list_jobsLists the jobs for a branch of an Amplify app.appId (string) required
branchName (string) required
nextToken (string)
maxResults (integer)
amplify/list_tags_for_resourceReturns a list of tags for a specified Amazon Resource Name ARN.resourceArn (string) required
amplify/list_webhooksReturns a list of webhooks for an Amplify app.appId (string) required
nextToken (string)
maxResults (integer)
amplify/start_deploymentStarts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository. The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.appId (string) required
branchName (string) required
jobId (string)
sourceUrl (string)
sourceUrlType (string)
amplify/start_jobStarts a new job for a branch of an Amplify app.appId (string) required
branchName (string) required
jobId (string)
jobType (string) required
jobReason (string)
commitId (string)
commitMessage (string)
commitTime (string)
amplify/stop_jobStops a job that is in progress for a branch of an Amplify app.appId (string) required
branchName (string) required
jobId (string) required
amplify/tag_resourceTags the resource with a tag key and value.resourceArn (string) required
tags (object) required
amplify/untag_resourceUntags a resource with a specified Amazon Resource Name ARN.resourceArn (string) required
tagKeys (array) required
amplify/update_appUpdates an existing Amplify app.appId (string) required
name (string)
description (string)
platform (string)
computeRoleArn (string)
iamServiceRoleArn (string)
environmentVariables (object)
enableBranchAutoBuild (boolean)
enableBranchAutoDeletion (boolean)
enableBasicAuth (boolean)
basicAuthCredentials (string)
customRules (array)
buildSpec (string)
customHeaders (string)
enableAutoBranchCreation (boolean)
autoBranchCreationPatterns (array)
autoBranchCreationConfig: {
. stage (string)
. framework (string)
. enableAutoBuild (boolean)
. environmentVariables (object)
. basicAuthCredentials (string)
. enableBasicAuth (boolean)
. enablePerformanceMode (boolean)
. buildSpec (string)
. enablePullRequestPreview (boolean)
. pullRequestEnvironmentName (string)
} (object)
repository (string)
oauthToken (string)
accessToken (string)
jobConfig: {
. buildComputeType (string)
} (object)
cacheConfig: {
. type (string)
} (object)
amplify/update_branchUpdates a branch for an Amplify app.appId (string) required
branchName (string) required
description (string)
framework (string)
stage (string)
enableNotification (boolean)
enableAutoBuild (boolean)
enableSkewProtection (boolean)
environmentVariables (object)
basicAuthCredentials (string)
enableBasicAuth (boolean)
enablePerformanceMode (boolean)
buildSpec (string)
ttl (string)
displayName (string)
enablePullRequestPreview (boolean)
pullRequestEnvironmentName (string)
backendEnvironmentArn (string)
backend: {
. stackArn (string)
} (object)
computeRoleArn (string)
amplify/update_domain_associationCreates a new domain association for an Amplify app.appId (string) required
domainName (string) required
enableAutoSubDomain (boolean)
subDomainSettings (array)
autoSubDomainCreationPatterns (array)
autoSubDomainIAMRole (string)
certificateSettings: {
. type (string)
. customCertificateArn (string)
} (object)
amplify/update_webhookUpdates a webhook.webhookId (string) required
branchName (string)
description (string)
amplifybackend/clone_backendThis operation clones an existing backend.AppId (string) required
BackendEnvironmentName (string) required
TargetEnvironmentName (string) required
amplifybackend/create_backendThis operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.AppId (string) required
AppName (string) required
BackendEnvironmentName (string) required
ResourceConfig: {

} (object)
ResourceName (string)
amplifybackend/create_backend_apiCreates a new backend API resource.AppId (string) required
BackendEnvironmentName (string) required
ResourceConfig: {
. AdditionalAuthTypes (array)
. ApiName (string)
. ConflictResolution (object)
. DefaultAuthType (object)
. Service (string)
. TransformSchema (string)
} (object) required
ResourceName (string) required
amplifybackend/create_backend_authCreates a new backend authentication resource.AppId (string) required
BackendEnvironmentName (string) required
ResourceConfig: {
. AuthResources (string)
. IdentityPoolConfigs (object)
. Service (string)
. UserPoolConfigs (object)
} (object) required
ResourceName (string) required
amplifybackend/create_backend_configCreates a config object for a backend.AppId (string) required
BackendManagerAppId (string)
amplifybackend/create_backend_storageCreates a backend storage resource.AppId (string) required
BackendEnvironmentName (string) required
ResourceConfig: {
. BucketName (string)
. Permissions (object)
. ServiceName (string)
} (object) required
ResourceName (string) required
amplifybackend/create_tokenGenerates a one-time challenge code to authenticate a user into your Amplify Admin UI.AppId (string) required
amplifybackend/delete_backendRemoves an existing environment from your Amplify project.AppId (string) required
BackendEnvironmentName (string) required
amplifybackend/delete_backend_apiDeletes an existing backend API resource.AppId (string) required
BackendEnvironmentName (string) required
ResourceConfig: {
. AdditionalAuthTypes (array)
. ApiName (string)
. ConflictResolution (object)
. DefaultAuthType (object)
. Service (string)
. TransformSchema (string)
} (object)
ResourceName (string) required
amplifybackend/delete_backend_authDeletes an existing backend authentication resource.AppId (string) required
BackendEnvironmentName (string) required
ResourceName (string) required
amplifybackend/delete_backend_storageRemoves the specified backend storage resource.AppId (string) required
BackendEnvironmentName (string) required
ResourceName (string) required
ServiceName (string) required
amplifybackend/delete_tokenDeletes the challenge token based on the given appId and sessionId.AppId (string) required
SessionId (string) required
amplifybackend/generate_backend_apimodelsGenerates a model schema for an existing backend API resource.AppId (string) required
BackendEnvironmentName (string) required
ResourceName (string) required
amplifybackend/get_backendProvides project-level details for your Amplify UI project.AppId (string) required
BackendEnvironmentName (string)
amplifybackend/get_backend_apiGets the details for a backend API.AppId (string) required
BackendEnvironmentName (string) required
ResourceConfig: {
. AdditionalAuthTypes (array)
. ApiName (string)
. ConflictResolution (object)
. DefaultAuthType (object)
. Service (string)
. TransformSchema (string)
} (object)
ResourceName (string) required
amplifybackend/get_backend_apimodelsGets a model introspection schema for an existing backend API resource.AppId (string) required
BackendEnvironmentName (string) required
ResourceName (string) required
amplifybackend/get_backend_authGets a backend auth details.AppId (string) required
BackendEnvironmentName (string) required
ResourceName (string) required
amplifybackend/get_backend_jobReturns information about a specific job.AppId (string) required
BackendEnvironmentName (string) required
JobId (string) required
amplifybackend/get_backend_storageGets details for a backend storage resource.AppId (string) required
BackendEnvironmentName (string) required
ResourceName (string) required
amplifybackend/get_tokenGets the challenge token based on the given appId and sessionId.AppId (string) required
SessionId (string) required
amplifybackend/import_backend_authImports an existing backend authentication resource.AppId (string) required
BackendEnvironmentName (string) required
IdentityPoolId (string)
NativeClientId (string) required
UserPoolId (string) required
WebClientId (string) required
amplifybackend/import_backend_storageImports an existing backend storage resource.AppId (string) required
BackendEnvironmentName (string) required
BucketName (string)
ServiceName (string) required
amplifybackend/list_backend_jobsLists the jobs for the backend of an Amplify app.AppId (string) required
BackendEnvironmentName (string) required
JobId (string)
MaxResults (integer)
NextToken (string)
Operation (string)
Status (string)
amplifybackend/list_s3bucketsThe list of S3 buckets in your account.NextToken (string)
amplifybackend/remove_all_backendsRemoves all backend environments from your Amplify project.AppId (string) required
CleanAmplifyApp (boolean)
amplifybackend/remove_backend_configRemoves the AWS resources required to access the Amplify Admin UI.AppId (string) required
amplifybackend/update_backend_apiUpdates an existing backend API resource.AppId (string) required
BackendEnvironmentName (string) required
ResourceConfig: {
. AdditionalAuthTypes (array)
. ApiName (string)
. ConflictResolution (object)
. DefaultAuthType (object)
. Service (string)
. TransformSchema (string)
} (object)
ResourceName (string) required
amplifybackend/update_backend_authUpdates an existing backend authentication resource.AppId (string) required
BackendEnvironmentName (string) required
ResourceConfig: {
. AuthResources (string)
. IdentityPoolConfigs (object)
. Service (string)
. UserPoolConfigs (object)
} (object) required
ResourceName (string) required
amplifybackend/update_backend_configUpdates the AWS resources required to access the Amplify Admin UI.AppId (string) required
LoginAuthConfig: {
. AwsCognitoIdentityPoolId (string)
. AwsCognitoRegion (string)
. AwsUserPoolsId (string)
. AwsUserPoolsWebClientId (string)
} (object)
amplifybackend/update_backend_jobUpdates a specific job.AppId (string) required
BackendEnvironmentName (string) required
JobId (string) required
Operation (string)
Status (string)
amplifybackend/update_backend_storageUpdates an existing backend storage resource.AppId (string) required
BackendEnvironmentName (string) required
ResourceConfig: {
. Permissions (object)
. ServiceName (string)
} (object) required
ResourceName (string) required
amplifyuibuilder/exchange_code_for_tokenThis is for internal use. Amplify uses this action to exchange an access code for a token.provider (string) required
request: {
. code (string)
. redirectUri (string)
. clientId (string)
} (object) required
amplifyuibuilder/get_metadataReturns existing metadata for an Amplify app.appId (string) required
environmentName (string) required
amplifyuibuilder/list_tags_for_resourceReturns a list of tags for a specified Amazon Resource Name ARN.resourceArn (string) required
amplifyuibuilder/put_metadata_flagStores the metadata information about a feature on a form.appId (string) required
environmentName (string) required
featureName (string) required
body: {
. newValue (string)
} (object) required
amplifyuibuilder/refresh_tokenThis is for internal use. Amplify uses this action to refresh a previously issued access token that might have expired.provider (string) required
refreshTokenBody: {
. token (string)
. clientId (string)
} (object) required
amplifyuibuilder/tag_resourceTags the resource with a tag key and value.resourceArn (string) required
tags (object) required
amplifyuibuilder/untag_resourceUntags a resource with a specified Amazon Resource Name ARN.resourceArn (string) required
tagKeys (array) required
amplifyuibuilder/start_codegen_jobStarts a code generation job for a specified Amplify app and backend environment.appId (string) required
environmentName (string) required
clientToken (string)
codegenJobToCreate: {
. renderConfig
. genericDataSchema (object)
. autoGenerateForms (boolean)
. features (object)
. tags (object)
} (object) required
amplifyuibuilder/get_codegen_jobReturns an existing code generation job.appId (string) required
environmentName (string) required
id (string) required
amplifyuibuilder/list_codegen_jobsRetrieves a list of code generation jobs for a specified Amplify app and backend environment.appId (string) required
environmentName (string) required
nextToken (string)
maxResults (integer)
amplifyuibuilder/export_componentsExports component configurations to code that is ready to integrate into an Amplify app.appId (string) required
environmentName (string) required
nextToken (string)
amplifyuibuilder/create_componentCreates a new component for an Amplify app.appId (string) required
environmentName (string) required
clientToken (string)
componentToCreate: {
. name (string)
. sourceId (string)
. componentType (string)
. properties (object)
. children (array)
. variants (array)
. overrides (object)
. bindingProperties (object)
. collectionProperties (object)
. tags (object)
. events (object)
. schemaVersion (string)
} (object) required
amplifyuibuilder/get_componentReturns an existing component for an Amplify app.appId (string) required
environmentName (string) required
id (string) required
amplifyuibuilder/update_componentUpdates an existing component.appId (string) required
environmentName (string) required
id (string) required
clientToken (string)
updatedComponent: {
. id (string)
. name (string)
. sourceId (string)
. componentType (string)
. properties (object)
. children (array)
. variants (array)
. overrides (object)
. bindingProperties (object)
. collectionProperties (object)
. events (object)
. schemaVersion (string)
} (object) required
amplifyuibuilder/delete_componentDeletes a component from an Amplify app.appId (string) required
environmentName (string) required
id (string) required
amplifyuibuilder/list_componentsRetrieves a list of components for a specified Amplify app and backend environment.appId (string) required
environmentName (string) required
nextToken (string)
maxResults (integer)
amplifyuibuilder/export_formsExports form configurations to code that is ready to integrate into an Amplify app.appId (string) required
environmentName (string) required
nextToken (string)
amplifyuibuilder/create_formCreates a new form for an Amplify app.appId (string) required
environmentName (string) required
clientToken (string)
formToCreate: {
. name (string)
. dataType (object)
. formActionType (string)
. fields (object)
. style (object)
. sectionalElements (object)
. schemaVersion (string)
. cta (object)
. tags (object)
. labelDecorator (string)
} (object) required
amplifyuibuilder/get_formReturns an existing form for an Amplify app.appId (string) required
environmentName (string) required
id (string) required
amplifyuibuilder/update_formUpdates an existing form.appId (string) required
environmentName (string) required
id (string) required
clientToken (string)
updatedForm: {
. name (string)
. dataType (object)
. formActionType (string)
. fields (object)
. style (object)
. sectionalElements (object)
. schemaVersion (string)
. cta (object)
. labelDecorator (string)
} (object) required
amplifyuibuilder/delete_formDeletes a form from an Amplify app.appId (string) required
environmentName (string) required
id (string) required
amplifyuibuilder/list_formsRetrieves a list of forms for a specified Amplify app and backend environment.appId (string) required
environmentName (string) required
nextToken (string)
maxResults (integer)
amplifyuibuilder/export_themesExports theme configurations to code that is ready to integrate into an Amplify app.appId (string) required
environmentName (string) required
nextToken (string)
amplifyuibuilder/create_themeCreates a theme to apply to the components in an Amplify app.appId (string) required
environmentName (string) required
clientToken (string)
themeToCreate: {
. name (string)
. values (array)
. overrides (array)
. tags (object)
} (object) required
amplifyuibuilder/get_themeReturns an existing theme for an Amplify app.appId (string) required
environmentName (string) required
id (string) required
amplifyuibuilder/update_themeUpdates an existing theme.appId (string) required
environmentName (string) required
id (string) required
clientToken (string)
updatedTheme: {
. id (string)
. name (string)
. values (array)
. overrides (array)
} (object) required
amplifyuibuilder/delete_themeDeletes a theme from an Amplify app.appId (string) required
environmentName (string) required
id (string) required
amplifyuibuilder/list_themesRetrieves a list of themes for a specified Amplify app and backend environment.appId (string) required
environmentName (string) required
nextToken (string)
maxResults (integer)
api_gateway/create_api_keyCreate an ApiKey resource.name (string)
description (string)
enabled (boolean)
generateDistinctId (boolean)
value (string)
stageKeys (array)
customerId (string)
tags (object)
api_gateway/create_authorizerAdds a new Authorizer resource to an existing RestApi resource.restApiId (string) required
name (string) required
type (string) required
providerARNs (array)
authType (string)
authorizerUri (string)
authorizerCredentials (string)
identitySource (string)
identityValidationExpression (string)
authorizerResultTtlInSeconds (integer)
api_gateway/create_base_path_mappingCreates a new BasePathMapping resource.domainName (string) required
domainNameId (string)
basePath (string)
restApiId (string) required
stage (string)
api_gateway/create_deploymentCreates a Deployment resource, which makes a specified RestApi callable over the internet.restApiId (string) required
stageName (string)
stageDescription (string)
description (string)
cacheClusterEnabled (boolean)
cacheClusterSize (string)
variables (object)
canarySettings: {
. percentTraffic (number)
. stageVariableOverrides (object)
. useStageCache (boolean)
} (object)
tracingEnabled (boolean)
api_gateway/create_documentation_partCreates a documentation part.restApiId (string) required
location: {
. type (string)
. path (string)
. method (string)
. statusCode (string)
. name (string)
} (object) required
properties (string) required
api_gateway/create_documentation_versionCreates a documentation versionrestApiId (string) required
documentationVersion (string) required
stageName (string)
description (string)
api_gateway/create_domain_nameCreates a new domain name.domainName (string) required
certificateName (string)
certificateBody (string)
certificatePrivateKey (string)
certificateChain (string)
certificateArn (string)
regionalCertificateName (string)
regionalCertificateArn (string)
endpointConfiguration: {
. types (array)
. ipAddressType (string)
. vpcEndpointIds (array)
} (object)
tags (object)
securityPolicy (string)
endpointAccessMode (string)
mutualTlsAuthentication: {
. truststoreUri (string)
. truststoreVersion (string)
} (object)
ownershipVerificationCertificateArn (string)
policy (string)
routingMode (string)
api_gateway/create_domain_name_access_associationCreates a domain name access association resource between an access association source and a private custom domain name.domainNameArn (string) required
accessAssociationSourceType (string) required
accessAssociationSource (string) required
tags (object)
api_gateway/create_modelAdds a new Model resource to an existing RestApi resource.restApiId (string) required
name (string) required
description (string)
schema (string)
contentType (string) required
api_gateway/create_request_validatorCreates a RequestValidator of a given RestApi.restApiId (string) required
name (string)
validateRequestBody (boolean)
validateRequestParameters (boolean)
api_gateway/create_resourceCreates a Resource resource.restApiId (string) required
parentId (string) required
pathPart (string) required
api_gateway/create_rest_apiCreates a new RestApi resource.name (string) required
description (string)
version (string)
cloneFrom (string)
binaryMediaTypes (array)
minimumCompressionSize (integer)
apiKeySource (string)
endpointConfiguration: {
. types (array)
. ipAddressType (string)
. vpcEndpointIds (array)
} (object)
policy (string)
tags (object)
disableExecuteApiEndpoint (boolean)
securityPolicy (string)
endpointAccessMode (string)
api_gateway/create_stageCreates a new Stage resource that references a pre-existing Deployment for the API.restApiId (string) required
stageName (string) required
deploymentId (string) required
description (string)
cacheClusterEnabled (boolean)
cacheClusterSize (string)
variables (object)
documentationVersion (string)
canarySettings: {
. percentTraffic (number)
. deploymentId (string)
. stageVariableOverrides (object)
. useStageCache (boolean)
} (object)
tracingEnabled (boolean)
tags (object)
api_gateway/create_usage_planCreates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.name (string) required
description (string)
apiStages (array)
throttle: {
. burstLimit (integer)
. rateLimit (number)
} (object)
quota: {
. limit (integer)
. offset (integer)
. period (string)
} (object)
tags (object)
api_gateway/create_usage_plan_keyCreates a usage plan key for adding an existing API key to a usage plan.usagePlanId (string) required
keyId (string) required
keyType (string) required
api_gateway/create_vpc_linkCreates 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.name (string) required
description (string)
targetArns (array) required
tags (object)
api_gateway/delete_api_keyDeletes the ApiKey resource.apiKey (string) required
api_gateway/delete_authorizerDeletes an existing Authorizer resource.restApiId (string) required
authorizerId (string) required
api_gateway/delete_base_path_mappingDeletes the BasePathMapping resource.domainName (string) required
domainNameId (string)
basePath (string) required
api_gateway/delete_client_certificateDeletes the ClientCertificate resource.clientCertificateId (string) required
api_gateway/delete_deploymentDeletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.restApiId (string) required
deploymentId (string) required
api_gateway/delete_documentation_partDeletes a documentation partrestApiId (string) required
documentationPartId (string) required
api_gateway/delete_documentation_versionDeletes a documentation version.restApiId (string) required
documentationVersion (string) required
api_gateway/delete_domain_nameDeletes the DomainName resource.domainName (string) required
domainNameId (string)
api_gateway/delete_domain_name_access_associationDeletes the DomainNameAccessAssociation resource. Only the AWS account that created the DomainNameAccessAssociation resource can delete it. To stop an access association source in another AWS account from accessing your private custom domain name, use the RejectDomainNameAccessAssociation operation.domainNameAccessAssociationArn (string) required
api_gateway/delete_gateway_responseClears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.restApiId (string) required
responseType (string) required
api_gateway/delete_integrationRepresents a delete integration.restApiId (string) required
resourceId (string) required
httpMethod (string) required
api_gateway/delete_integration_responseRepresents a delete integration response.restApiId (string) required
resourceId (string) required
httpMethod (string) required
statusCode (string) required
api_gateway/delete_methodDeletes an existing Method resource.restApiId (string) required
resourceId (string) required
httpMethod (string) required
api_gateway/delete_method_responseDeletes an existing MethodResponse resource.restApiId (string) required
resourceId (string) required
httpMethod (string) required
statusCode (string) required
api_gateway/delete_modelDeletes a model.restApiId (string) required
modelName (string) required
api_gateway/delete_request_validatorDeletes a RequestValidator of a given RestApi.restApiId (string) required
requestValidatorId (string) required
api_gateway/delete_resourceDeletes a Resource resource.restApiId (string) required
resourceId (string) required
api_gateway/delete_rest_apiDeletes the specified API.restApiId (string) required
api_gateway/delete_stageDeletes a Stage resource.restApiId (string) required
stageName (string) required
api_gateway/delete_usage_planDeletes a usage plan of a given plan Id.usagePlanId (string) required
api_gateway/delete_usage_plan_keyDeletes a usage plan key and remove the underlying API key from the associated usage plan.usagePlanId (string) required
keyId (string) required
api_gateway/delete_vpc_linkDeletes an existing VpcLink of a specified identifier.vpcLinkId (string) required
api_gateway/flush_stage_authorizers_cacheFlushes all authorizer cache entries on a stage.restApiId (string) required
stageName (string) required
api_gateway/flush_stage_cacheFlushes a stage's cache.restApiId (string) required
stageName (string) required
api_gateway/generate_client_certificateGenerates a ClientCertificate resource.description (string)
tags (object)
api_gateway/get_accountGets information about the current Account resource.No parameters
api_gateway/get_api_keyGets information about the current ApiKey resource.apiKey (string) required
includeValue (boolean)
api_gateway/get_api_keysGets information about the current ApiKeys resource.position (string)
limit (integer)
nameQuery (string)
customerId (string)
includeValues (boolean)
api_gateway/get_authorizerDescribe an existing Authorizer resource.restApiId (string) required
authorizerId (string) required
api_gateway/get_authorizersDescribe an existing Authorizers resource.restApiId (string) required
position (string)
limit (integer)
api_gateway/get_base_path_mappingDescribe a BasePathMapping resource.domainName (string) required
domainNameId (string)
basePath (string) required
api_gateway/get_base_path_mappingsRepresents a collection of BasePathMapping resources.domainName (string) required
domainNameId (string)
position (string)
limit (integer)
api_gateway/get_client_certificateGets information about the current ClientCertificate resource.clientCertificateId (string) required
api_gateway/get_client_certificatesGets a collection of ClientCertificate resources.position (string)
limit (integer)
api_gateway/get_deploymentGets information about a Deployment resource.restApiId (string) required
deploymentId (string) required
embed (array)
api_gateway/get_deploymentsGets information about a Deployments collection.restApiId (string) required
position (string)
limit (integer)
api_gateway/get_documentation_partGets a documentation part.restApiId (string) required
documentationPartId (string) required
api_gateway/get_documentation_partsGets documentation parts.restApiId (string) required
type (string)
nameQuery (string)
path (string)
position (string)
limit (integer)
locationStatus (string)
api_gateway/get_documentation_versionGets a documentation version.restApiId (string) required
documentationVersion (string) required
api_gateway/get_documentation_versionsGets documentation versions.restApiId (string) required
position (string)
limit (integer)
api_gateway/get_domain_nameRepresents a domain name that is contained in a simpler, more intuitive URL that can be called.domainName (string) required
domainNameId (string)
api_gateway/get_domain_name_access_associationsRepresents a collection on DomainNameAccessAssociations resources.position (string)
limit (integer)
resourceOwner (string)
api_gateway/get_domain_namesRepresents a collection of DomainName resources.position (string)
limit (integer)
resourceOwner (string)
api_gateway/get_exportExports a deployed version of a RestApi in a specified format.restApiId (string) required
stageName (string) required
exportType (string) required
parameters (object)
accepts (string)
api_gateway/get_gateway_responseGets a GatewayResponse of a specified response type on the given RestApi.restApiId (string) required
responseType (string) required
api_gateway/get_gateway_responsesGets 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.restApiId (string) required
position (string)
limit (integer)
api_gateway/get_integrationGet the integration settings.restApiId (string) required
resourceId (string) required
httpMethod (string) required
api_gateway/get_integration_responseRepresents a get integration response.restApiId (string) required
resourceId (string) required
httpMethod (string) required
statusCode (string) required
api_gateway/get_methodDescribe an existing Method resource.restApiId (string) required
resourceId (string) required
httpMethod (string) required
api_gateway/get_method_responseDescribes a MethodResponse resource.restApiId (string) required
resourceId (string) required
httpMethod (string) required
statusCode (string) required
api_gateway/get_modelDescribes an existing model defined for a RestApi resource.restApiId (string) required
modelName (string) required
flatten (boolean)
api_gateway/get_modelsDescribes existing Models defined for a RestApi resource.restApiId (string) required
position (string)
limit (integer)
api_gateway/get_model_templateGenerates a sample mapping template that can be used to transform a payload into the structure of a model.restApiId (string) required
modelName (string) required
api_gateway/get_request_validatorGets a RequestValidator of a given RestApi.restApiId (string) required
requestValidatorId (string) required
api_gateway/get_request_validatorsGets the RequestValidators collection of a given RestApi.restApiId (string) required
position (string)
limit (integer)
api_gateway/get_resourceLists information about a resource.restApiId (string) required
resourceId (string) required
embed (array)
api_gateway/get_resourcesLists information about a collection of Resource resources.restApiId (string) required
position (string)
limit (integer)
embed (array)
api_gateway/get_rest_apiLists the RestApi resource in the collection.restApiId (string) required
api_gateway/get_rest_apisLists the RestApis resources for your collection.position (string)
limit (integer)
api_gateway/get_sdkGenerates a client SDK for a RestApi and Stage.restApiId (string) required
stageName (string) required
sdkType (string) required
parameters (object)
api_gateway/get_sdk_typeGets an SDK type.id (string) required
api_gateway/get_sdk_typesGets SDK typesposition (string)
limit (integer)
api_gateway/get_stageGets information about a Stage resource.restApiId (string) required
stageName (string) required
api_gateway/get_stagesGets information about one or more Stage resources.restApiId (string) required
deploymentId (string)
api_gateway/get_tagsGets the Tags collection for a given resource.resourceArn (string) required
position (string)
limit (integer)
api_gateway/get_usageGets the usage data of a usage plan in a specified time interval.usagePlanId (string) required
keyId (string)
startDate (string) required
endDate (string) required
position (string)
limit (integer)
api_gateway/get_usage_planGets a usage plan of a given plan identifier.usagePlanId (string) required
api_gateway/get_usage_plan_keyGets a usage plan key of a given key identifier.usagePlanId (string) required
keyId (string) required
api_gateway/get_usage_plan_keysGets all the usage plan keys representing the API keys added to a specified usage plan.usagePlanId (string) required
position (string)
limit (integer)
nameQuery (string)
api_gateway/get_usage_plansGets all the usage plans of the caller's account.position (string)
keyId (string)
limit (integer)
api_gateway/get_vpc_linkGets a specified VPC link under the caller's account in a region.vpcLinkId (string) required
api_gateway/get_vpc_linksGets the VpcLinks collection under the caller's account in a selected region.position (string)
limit (integer)
api_gateway/import_api_keysImport API keys from an external source, such as a CSV-formatted file.body (string) required
format (string) required
failOnWarnings (boolean)
api_gateway/import_documentation_partsImports documentation partsrestApiId (string) required
mode (string)
failOnWarnings (boolean)
body (string) required
api_gateway/import_rest_apiA feature of the API Gateway control service for creating a new API from an external API definition file.failOnWarnings (boolean)
parameters (object)
body (string) required
api_gateway/put_gateway_responseCreates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.restApiId (string) required
responseType (string) required
statusCode (string)
responseParameters (object)
responseTemplates (object)
api_gateway/put_integrationSets up a method's integration.restApiId (string) required
resourceId (string) required
httpMethod (string) required
type (string) required
integrationHttpMethod (string)
uri (string)
connectionType (string)
connectionId (string)
credentials (string)
requestParameters (object)
requestTemplates (object)
passthroughBehavior (string)
cacheNamespace (string)
cacheKeyParameters (array)
contentHandling (string)
timeoutInMillis (integer)
tlsConfig: {
. insecureSkipVerification (boolean)
} (object)
responseTransferMode (string)
integrationTarget (string)
api_gateway/put_integration_responseRepresents a put integration.restApiId (string) required
resourceId (string) required
httpMethod (string) required
statusCode (string) required
selectionPattern (string)
responseParameters (object)
responseTemplates (object)
contentHandling (string)
api_gateway/put_methodAdd a method to an existing Resource resource.restApiId (string) required
resourceId (string) required
httpMethod (string) required
authorizationType (string) required
authorizerId (string)
apiKeyRequired (boolean)
operationName (string)
requestParameters (object)
requestModels (object)
requestValidatorId (string)
authorizationScopes (array)
api_gateway/put_method_responseAdds a MethodResponse to an existing Method resource.restApiId (string) required
resourceId (string) required
httpMethod (string) required
statusCode (string) required
responseParameters (object)
responseModels (object)
api_gateway/put_rest_apiA 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.restApiId (string) required
mode (string)
failOnWarnings (boolean)
parameters (object)
body (string) required
api_gateway/reject_domain_name_access_associationRejects a domain name access association with a private custom domain name. To reject a domain name access association with an access association source in another AWS account, use this operation. To remove a domain name access association with an access association source in your own account, use the DeleteDomainNameAccessAssociation operation.domainNameAccessAssociationArn (string) required
domainNameArn (string) required
api_gateway/tag_resourceAdds or updates a tag on a given resource.resourceArn (string) required
tags (object) required
api_gateway/test_invoke_authorizerSimulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.restApiId (string) required
authorizerId (string) required
headers (object)
multiValueHeaders (object)
pathWithQueryString (string)
body (string)
stageVariables (object)
additionalContext (object)
api_gateway/test_invoke_methodSimulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.restApiId (string) required
resourceId (string) required
httpMethod (string) required
pathWithQueryString (string)
body (string)
headers (object)
multiValueHeaders (object)
clientCertificateId (string)
stageVariables (object)
api_gateway/untag_resourceRemoves a tag from a given resource.resourceArn (string) required
tagKeys (array) required
api_gateway/update_accountChanges information about the current Account resource.patchOperations (array)
api_gateway/update_api_keyChanges information about an ApiKey resource.apiKey (string) required
patchOperations (array)
api_gateway/update_authorizerUpdates an existing Authorizer resource.restApiId (string) required
authorizerId (string) required
patchOperations (array)
api_gateway/update_base_path_mappingChanges information about the BasePathMapping resource.domainName (string) required
domainNameId (string)
basePath (string) required
patchOperations (array)
api_gateway/update_client_certificateChanges information about an ClientCertificate resource.clientCertificateId (string) required
patchOperations (array)
api_gateway/update_deploymentChanges information about a Deployment resource.restApiId (string) required
deploymentId (string) required
patchOperations (array)
api_gateway/update_documentation_partUpdates a documentation part.restApiId (string) required
documentationPartId (string) required
patchOperations (array)
api_gateway/update_documentation_versionUpdates a documentation version.restApiId (string) required
documentationVersion (string) required
patchOperations (array)
api_gateway/update_domain_nameChanges information about the DomainName resource.domainName (string) required
domainNameId (string)
patchOperations (array)
api_gateway/update_gateway_responseUpdates a GatewayResponse of a specified response type on the given RestApi.restApiId (string) required
responseType (string) required
patchOperations (array)
api_gateway/update_integrationRepresents an update integration.restApiId (string) required
resourceId (string) required
httpMethod (string) required
patchOperations (array)
api_gateway/update_integration_responseRepresents an update integration response.restApiId (string) required
resourceId (string) required
httpMethod (string) required
statusCode (string) required
patchOperations (array)
api_gateway/update_methodUpdates an existing Method resource.restApiId (string) required
resourceId (string) required
httpMethod (string) required
patchOperations (array)
api_gateway/update_method_responseUpdates an existing MethodResponse resource.restApiId (string) required
resourceId (string) required
httpMethod (string) required
statusCode (string) required
patchOperations (array)
api_gateway/update_modelChanges information about a model. The maximum size of the model is 400 KB.restApiId (string) required
modelName (string) required
patchOperations (array)
api_gateway/update_request_validatorUpdates a RequestValidator of a given RestApi.restApiId (string) required
requestValidatorId (string) required
patchOperations (array)
api_gateway/update_resourceChanges information about a Resource resource.restApiId (string) required
resourceId (string) required
patchOperations (array)
api_gateway/update_rest_apiChanges information about the specified API.restApiId (string) required
patchOperations (array)
api_gateway/update_stageChanges information about a Stage resource.restApiId (string) required
stageName (string) required
patchOperations (array)
api_gateway/update_usageGrants a temporary extension to the remaining quota of a usage plan associated with a specified API key.usagePlanId (string) required
keyId (string) required
patchOperations (array)
api_gateway/update_usage_planUpdates a usage plan of a given plan Id.usagePlanId (string) required
patchOperations (array)
api_gateway/update_vpc_linkUpdates an existing VpcLink of a specified identifier.vpcLinkId (string) required
patchOperations (array)
apigatewaymanagementapi/delete_connectionDelete the connection with the provided id.ConnectionId (string) required
apigatewaymanagementapi/get_connectionGet information about the connection with the provided id.ConnectionId (string) required
apigatewaymanagementapi/post_to_connectionSends the provided data to the specified connection.Data (string) required
ConnectionId (string) required
apigatewayv2/create_apiCreates an Api resource.ApiKeySelectionExpression (string)
CorsConfiguration: {
. AllowCredentials (boolean)
. AllowHeaders (array)
. AllowMethods (array)
. AllowOrigins (array)
. ExposeHeaders (array)
. MaxAge (integer)
} (object)
CredentialsArn (string)
Description (string)
DisableSchemaValidation (boolean)
DisableExecuteApiEndpoint (boolean)
IpAddressType (string)
Name (string) required
ProtocolType (string) required
RouteKey (string)
RouteSelectionExpression (string)
Tags (object)
Target (string)
Version (string)
apigatewayv2/create_api_mappingCreates an API mapping.ApiId (string) required
ApiMappingKey (string)
DomainName (string) required
Stage (string) required
apigatewayv2/create_authorizerCreates an Authorizer for an API.ApiId (string) required
AuthorizerCredentialsArn (string)
AuthorizerPayloadFormatVersion (string)
AuthorizerResultTtlInSeconds (integer)
AuthorizerType (string) required
AuthorizerUri (string)
EnableSimpleResponses (boolean)
IdentitySource (array) required
IdentityValidationExpression (string)
JwtConfiguration: {
. Audience (array)
. Issuer (string)
} (object)
Name (string) required
apigatewayv2/create_deploymentCreates a Deployment for an API.ApiId (string) required
Description (string)
StageName (string)
apigatewayv2/create_domain_nameCreates a domain name.DomainName (string) required
DomainNameConfigurations (array)
MutualTlsAuthentication: {
. TruststoreUri (string)
. TruststoreVersion (string)
} (object)
RoutingMode (string)
Tags (object)
apigatewayv2/create_integrationCreates an Integration.ApiId (string) required
ConnectionId (string)
ConnectionType (string)
ContentHandlingStrategy (string)
CredentialsArn (string)
Description (string)
IntegrationMethod (string)
IntegrationSubtype (string)
IntegrationType (string) required
IntegrationUri (string)
PassthroughBehavior (string)
PayloadFormatVersion (string)
RequestParameters (object)
RequestTemplates (object)
ResponseParameters (object)
TemplateSelectionExpression (string)
TimeoutInMillis (integer)
TlsConfig: {
. ServerNameToVerify (string)
} (object)
apigatewayv2/create_integration_responseCreates an IntegrationResponses.ApiId (string) required
ContentHandlingStrategy (string)
IntegrationId (string) required
IntegrationResponseKey (string) required
ResponseParameters (object)
ResponseTemplates (object)
TemplateSelectionExpression (string)
apigatewayv2/create_modelCreates a Model for an API.ApiId (string) required
ContentType (string)
Description (string)
Name (string) required
Schema (string) required
apigatewayv2/create_portalCreates a portal.Authorization: {
. CognitoConfig (object)
. None (object)
} (object) required
EndpointConfiguration: {
. AcmManaged (object)
. None (object)
} (object) required
IncludedPortalProductArns (array)
LogoUri (string)
PortalContent: {
. Description (string)
. DisplayName (string)
. Theme (object)
} (object) required
RumAppMonitorName (string)
Tags (object)
apigatewayv2/create_portal_productCreates a new portal product.Description (string)
DisplayName (string) required
Tags (object)
apigatewayv2/create_product_pageCreates a new product page for a portal product.DisplayContent: {
. Body (string)
. Title (string)
} (object) required
PortalProductId (string) required
apigatewayv2/create_product_rest_endpoint_pageCreates a product REST endpoint page for a portal product.DisplayContent: {
. None (object)
. Overrides (object)
} (object)
PortalProductId (string) required
RestEndpointIdentifier: {
. IdentifierParts (object)
} (object) required
TryItState (string)
apigatewayv2/create_routeCreates a Route for an API.ApiId (string) required
ApiKeyRequired (boolean)
AuthorizationScopes (array)
AuthorizationType (string)
AuthorizerId (string)
ModelSelectionExpression (string)
OperationName (string)
RequestModels (object)
RequestParameters (object)
RouteKey (string) required
RouteResponseSelectionExpression (string)
Target (string)
apigatewayv2/create_route_responseCreates a RouteResponse for a Route.ApiId (string) required
ModelSelectionExpression (string)
ResponseModels (object)
ResponseParameters (object)
RouteId (string) required
RouteResponseKey (string) required
apigatewayv2/create_routing_ruleCreates a RoutingRule.Actions (array) required
Conditions (array) required
DomainName (string) required
DomainNameId (string)
Priority (integer) required
apigatewayv2/create_stageCreates a Stage for an API.AccessLogSettings: {
. DestinationArn (string)
. Format (string)
} (object)
ApiId (string) required
AutoDeploy (boolean)
ClientCertificateId (string)
DefaultRouteSettings: {
. DataTraceEnabled (boolean)
. DetailedMetricsEnabled (boolean)
. LoggingLevel (string)
. ThrottlingBurstLimit (integer)
. ThrottlingRateLimit (number)
} (object)
DeploymentId (string)
Description (string)
RouteSettings (object)
StageName (string) required
StageVariables (object)
Tags (object)
apigatewayv2/create_vpc_linkCreates a VPC link.Name (string) required
SecurityGroupIds (array)
SubnetIds (array) required
Tags (object)
apigatewayv2/delete_access_log_settingsDeletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.ApiId (string) required
StageName (string) required
apigatewayv2/delete_apiDeletes an Api resource.ApiId (string) required
apigatewayv2/delete_api_mappingDeletes an API mapping.ApiMappingId (string) required
DomainName (string) required
apigatewayv2/delete_authorizerDeletes an Authorizer.ApiId (string) required
AuthorizerId (string) required
apigatewayv2/delete_cors_configurationDeletes a CORS configuration.ApiId (string) required
apigatewayv2/delete_deploymentDeletes a Deployment.ApiId (string) required
DeploymentId (string) required
apigatewayv2/delete_domain_nameDeletes a domain name.DomainName (string) required
apigatewayv2/delete_integrationDeletes an Integration.ApiId (string) required
IntegrationId (string) required
apigatewayv2/delete_integration_responseDeletes an IntegrationResponses.ApiId (string) required
IntegrationId (string) required
IntegrationResponseId (string) required
apigatewayv2/delete_modelDeletes a Model.ApiId (string) required
ModelId (string) required
apigatewayv2/delete_portalDeletes a portal.PortalId (string) required
apigatewayv2/delete_portal_productDeletes a portal product.PortalProductId (string) required
apigatewayv2/delete_portal_product_sharing_policyDeletes the sharing policy for a portal product.PortalProductId (string) required
apigatewayv2/delete_product_pageDeletes a product page of a portal product.PortalProductId (string) required
ProductPageId (string) required
apigatewayv2/delete_product_rest_endpoint_pageDeletes a product REST endpoint page.PortalProductId (string) required
ProductRestEndpointPageId (string) required
apigatewayv2/delete_routeDeletes a Route.ApiId (string) required
RouteId (string) required
apigatewayv2/delete_route_request_parameterDeletes a route request parameter. Supported only for WebSocket APIs.ApiId (string) required
RequestParameterKey (string) required
RouteId (string) required
apigatewayv2/delete_route_responseDeletes a RouteResponse.ApiId (string) required
RouteId (string) required
RouteResponseId (string) required
apigatewayv2/delete_route_settingsDeletes the RouteSettings for a stage.ApiId (string) required
RouteKey (string) required
StageName (string) required
apigatewayv2/delete_routing_ruleDeletes a routing rule.DomainName (string) required
DomainNameId (string)
RoutingRuleId (string) required
apigatewayv2/delete_stageDeletes a Stage.ApiId (string) required
StageName (string) required
apigatewayv2/delete_vpc_linkDeletes a VPC link.VpcLinkId (string) required
apigatewayv2/disable_portalDeletes the publication of a portal portal.PortalId (string) required
apigatewayv2/export_apiNo description availableApiId (string) required
ExportVersion (string)
IncludeExtensions (boolean)
OutputType (string) required
Specification (string) required
StageName (string)
apigatewayv2/get_apiGets an Api resource.ApiId (string) required
apigatewayv2/get_api_mappingGets an API mapping.ApiMappingId (string) required
DomainName (string) required
apigatewayv2/get_api_mappingsGets API mappings.DomainName (string) required
MaxResults (string)
NextToken (string)
apigatewayv2/get_apisGets a collection of Api resources.MaxResults (string)
NextToken (string)
apigatewayv2/get_authorizerGets an Authorizer.ApiId (string) required
AuthorizerId (string) required
apigatewayv2/get_authorizersGets the Authorizers for an API.ApiId (string) required
MaxResults (string)
NextToken (string)
apigatewayv2/get_deploymentGets a Deployment.ApiId (string) required
DeploymentId (string) required
apigatewayv2/get_deploymentsGets the Deployments for an API.ApiId (string) required
MaxResults (string)
NextToken (string)
apigatewayv2/get_domain_nameGets a domain name.DomainName (string) required
apigatewayv2/get_domain_namesGets the domain names for an AWS account.MaxResults (string)
NextToken (string)
apigatewayv2/get_integrationGets an Integration.ApiId (string) required
IntegrationId (string) required
apigatewayv2/get_integration_responseGets an IntegrationResponses.ApiId (string) required
IntegrationId (string) required
IntegrationResponseId (string) required
apigatewayv2/get_integration_responsesGets the IntegrationResponses for an Integration.ApiId (string) required
IntegrationId (string) required
MaxResults (string)
NextToken (string)
apigatewayv2/get_integrationsGets the Integrations for an API.ApiId (string) required
MaxResults (string)
NextToken (string)
apigatewayv2/get_modelGets a Model.ApiId (string) required
ModelId (string) required
apigatewayv2/get_modelsGets the Models for an API.ApiId (string) required
MaxResults (string)
NextToken (string)
apigatewayv2/get_model_templateGets a model template.ApiId (string) required
ModelId (string) required
apigatewayv2/get_portalGets a portal.PortalId (string) required
apigatewayv2/get_portal_productGets a portal product.PortalProductId (string) required
ResourceOwnerAccountId (string)
apigatewayv2/get_portal_product_sharing_policyGets the sharing policy for a portal product.PortalProductId (string) required
apigatewayv2/get_product_pageGets a product page of a portal product.PortalProductId (string) required
ProductPageId (string) required
ResourceOwnerAccountId (string)
apigatewayv2/get_product_rest_endpoint_pageGets a product REST endpoint page.IncludeRawDisplayContent (string)
PortalProductId (string) required
ProductRestEndpointPageId (string) required
ResourceOwnerAccountId (string)
apigatewayv2/get_routeGets a Route.ApiId (string) required
RouteId (string) required
apigatewayv2/get_route_responseGets a RouteResponse.ApiId (string) required
RouteId (string) required
RouteResponseId (string) required
apigatewayv2/get_route_responsesGets the RouteResponses for a Route.ApiId (string) required
MaxResults (string)
NextToken (string)
RouteId (string) required
apigatewayv2/get_routesGets the Routes for an API.ApiId (string) required
MaxResults (string)
NextToken (string)
apigatewayv2/get_routing_ruleGets a routing rule.DomainName (string) required
DomainNameId (string)
RoutingRuleId (string) required
apigatewayv2/get_stageGets a Stage.ApiId (string) required
StageName (string) required
apigatewayv2/get_stagesGets the Stages for an API.ApiId (string) required
MaxResults (string)
NextToken (string)
apigatewayv2/get_tagsGets a collection of Tag resources.ResourceArn (string) required
apigatewayv2/get_vpc_linkGets a VPC link.VpcLinkId (string) required
apigatewayv2/get_vpc_linksGets a collection of VPC links.MaxResults (string)
NextToken (string)
apigatewayv2/import_apiImports an API.Basepath (string)
Body (string) required
FailOnWarnings (boolean)
apigatewayv2/list_portal_productsLists portal products.MaxResults (string)
NextToken (string)
ResourceOwner (string)
apigatewayv2/list_portalsLists portals.MaxResults (string)
NextToken (string)
apigatewayv2/list_product_pagesLists the product pages for a portal product.MaxResults (string)
NextToken (string)
PortalProductId (string) required
ResourceOwnerAccountId (string)
apigatewayv2/list_product_rest_endpoint_pagesLists the product REST endpoint pages of a portal product.MaxResults (string)
NextToken (string)
PortalProductId (string) required
ResourceOwnerAccountId (string)
apigatewayv2/list_routing_rulesLists routing rules.DomainName (string) required
DomainNameId (string)
MaxResults (integer)
NextToken (string)
apigatewayv2/preview_portalCreates a portal preview.PortalId (string) required
apigatewayv2/publish_portalPublishes a portal.Description (string)
PortalId (string) required
apigatewayv2/put_portal_product_sharing_policyUpdates the sharing policy for a portal product.PolicyDocument (string) required
PortalProductId (string) required
apigatewayv2/put_routing_ruleUpdates a routing rule.Actions (array) required
Conditions (array) required
DomainName (string) required
DomainNameId (string)
Priority (integer) required
RoutingRuleId (string) required
apigatewayv2/reimport_apiPuts an Api resource.ApiId (string) required
Basepath (string)
Body (string) required
FailOnWarnings (boolean)
apigatewayv2/reset_authorizers_cacheResets all authorizer cache entries on a stage. Supported only for HTTP APIs.ApiId (string) required
StageName (string) required
apigatewayv2/tag_resourceCreates a new Tag resource to represent a tag.ResourceArn (string) required
Tags (object)
apigatewayv2/untag_resourceDeletes a Tag.ResourceArn (string) required
TagKeys (array) required
apigatewayv2/update_apiUpdates an Api resource.ApiId (string) required
ApiKeySelectionExpression (string)
CorsConfiguration: {
. AllowCredentials (boolean)
. AllowHeaders (array)
. AllowMethods (array)
. AllowOrigins (array)
. ExposeHeaders (array)
. MaxAge (integer)
} (object)
CredentialsArn (string)
Description (string)
DisableSchemaValidation (boolean)
DisableExecuteApiEndpoint (boolean)
IpAddressType (string)
Name (string)
RouteKey (string)
RouteSelectionExpression (string)
Target (string)
Version (string)
apigatewayv2/update_api_mappingThe API mapping.ApiId (string) required
ApiMappingId (string) required
ApiMappingKey (string)
DomainName (string) required
Stage (string)
apigatewayv2/update_authorizerUpdates an Authorizer.ApiId (string) required
AuthorizerCredentialsArn (string)
AuthorizerId (string) required
AuthorizerPayloadFormatVersion (string)
AuthorizerResultTtlInSeconds (integer)
AuthorizerType (string)
AuthorizerUri (string)
EnableSimpleResponses (boolean)
IdentitySource (array)
IdentityValidationExpression (string)
JwtConfiguration: {
. Audience (array)
. Issuer (string)
} (object)
Name (string)
apigatewayv2/update_deploymentUpdates a Deployment.ApiId (string) required
DeploymentId (string) required
Description (string)
apigatewayv2/update_domain_nameUpdates a domain name.DomainName (string) required
DomainNameConfigurations (array)
MutualTlsAuthentication: {
. TruststoreUri (string)
. TruststoreVersion (string)
} (object)
RoutingMode (string)
apigatewayv2/update_integrationUpdates an Integration.ApiId (string) required
ConnectionId (string)
ConnectionType (string)
ContentHandlingStrategy (string)
CredentialsArn (string)
Description (string)
IntegrationId (string) required
IntegrationMethod (string)
IntegrationSubtype (string)
IntegrationType (string)
IntegrationUri (string)
PassthroughBehavior (string)
PayloadFormatVersion (string)
RequestParameters (object)
RequestTemplates (object)
ResponseParameters (object)
TemplateSelectionExpression (string)
TimeoutInMillis (integer)
TlsConfig: {
. ServerNameToVerify (string)
} (object)
apigatewayv2/update_integration_responseUpdates an IntegrationResponses.ApiId (string) required
ContentHandlingStrategy (string)
IntegrationId (string) required
IntegrationResponseId (string) required
IntegrationResponseKey (string)
ResponseParameters (object)
ResponseTemplates (object)
TemplateSelectionExpression (string)
apigatewayv2/update_modelUpdates a Model.ApiId (string) required
ContentType (string)
Description (string)
ModelId (string) required
Name (string)
Schema (string)
apigatewayv2/update_portalUpdates a portal.Authorization: {
. CognitoConfig (object)
. None (object)
} (object)
EndpointConfiguration: {
. AcmManaged (object)
. None (object)
} (object)
IncludedPortalProductArns (array)
LogoUri (string)
PortalContent: {
. Description (string)
. DisplayName (string)
. Theme (object)
} (object)
PortalId (string) required
RumAppMonitorName (string)
apigatewayv2/update_portal_productUpdates the portal product.Description (string)
DisplayName (string)
DisplayOrder: {
. Contents (array)
. OverviewPageArn (string)
. ProductPageArns (array)
} (object)
PortalProductId (string) required
apigatewayv2/update_product_pageUpdates a product page of a portal product.DisplayContent: {
. Body (string)
. Title (string)
} (object)
PortalProductId (string) required
ProductPageId (string) required
apigatewayv2/update_product_rest_endpoint_pageUpdates a product REST endpoint page.DisplayContent: {
. None (object)
. Overrides (object)
} (object)
PortalProductId (string) required
ProductRestEndpointPageId (string) required
TryItState (string)
apigatewayv2/update_routeUpdates a Route.ApiId (string) required
ApiKeyRequired (boolean)
AuthorizationScopes (array)
AuthorizationType (string)
AuthorizerId (string)
ModelSelectionExpression (string)
OperationName (string)
RequestModels (object)
RequestParameters (object)
RouteId (string) required
RouteKey (string)
RouteResponseSelectionExpression (string)
Target (string)
apigatewayv2/update_route_responseUpdates a RouteResponse.ApiId (string) required
ModelSelectionExpression (string)
ResponseModels (object)
ResponseParameters (object)
RouteId (string) required
RouteResponseId (string) required
RouteResponseKey (string)
apigatewayv2/update_stageUpdates a Stage.AccessLogSettings: {
. DestinationArn (string)
. Format (string)
} (object)
ApiId (string) required
AutoDeploy (boolean)
ClientCertificateId (string)
DefaultRouteSettings: {
. DataTraceEnabled (boolean)
. DetailedMetricsEnabled (boolean)
. LoggingLevel (string)
. ThrottlingBurstLimit (integer)
. ThrottlingRateLimit (number)
} (object)
DeploymentId (string)
Description (string)
RouteSettings (object)
StageName (string) required
StageVariables (object)
apigatewayv2/update_vpc_linkUpdates a VPC link.Name (string)
VpcLinkId (string) required
app_mesh/list_tags_for_resourceList the tags for an App Mesh resource.resourceArn (string) required
nextToken (string)
limit (integer)
app_mesh/tag_resourceAssociates 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.resourceArn (string) required
tags (array) required
app_mesh/untag_resourceDeletes specified tags from a resource.resourceArn (string) required
tagKeys (array) required
app_mesh/describe_meshDescribes an existing service mesh.meshName (string) required
meshOwner (string)
app_mesh/update_meshUpdates an existing service mesh.meshName (string) required
spec: {
. egressFilter (object)
. serviceDiscovery (object)
} (object)
clientToken (string)
app_mesh/delete_meshDeletes 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.meshName (string) required
app_mesh/list_meshesReturns a list of existing service meshes.nextToken (string)
limit (integer)
app_mesh/create_meshCreates 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.meshName (string) required
spec: {
. egressFilter (object)
. serviceDiscovery (object)
} (object)
tags (array)
clientToken (string)
app_mesh/describe_virtual_gatewayDescribes an existing virtual gateway.virtualGatewayName (string) required
meshName (string) required
meshOwner (string)
app_mesh/update_virtual_gatewayUpdates an existing virtual gateway in a specified service mesh.virtualGatewayName (string) required
meshName (string) required
spec: {
. backendDefaults (object)
. listeners (array)
. logging (object)
} (object) required
clientToken (string)
meshOwner (string)
app_mesh/delete_virtual_gatewayDeletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.virtualGatewayName (string) required
meshName (string) required
meshOwner (string)
app_mesh/list_virtual_gatewaysReturns a list of existing virtual gateways in a service mesh.meshName (string) required
nextToken (string)
limit (integer)
meshOwner (string)
app_mesh/create_virtual_gatewayCreates 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.virtualGatewayName (string) required
meshName (string) required
spec: {
. backendDefaults (object)
. listeners (array)
. logging (object)
} (object) required
tags (array)
clientToken (string)
meshOwner (string)
app_mesh/describe_gateway_routeDescribes an existing gateway route.gatewayRouteName (string) required
meshName (string) required
virtualGatewayName (string) required
meshOwner (string)
app_mesh/update_gateway_routeUpdates an existing gateway route that is associated to a specified virtual gateway in a service mesh.gatewayRouteName (string) required
meshName (string) required
virtualGatewayName (string) required
spec: {
. priority (integer)
. httpRoute (object)
. http2Route (object)
. grpcRoute (object)
} (object) required
clientToken (string)
meshOwner (string)
app_mesh/delete_gateway_routeDeletes an existing gateway route.gatewayRouteName (string) required
meshName (string) required
virtualGatewayName (string) required
meshOwner (string)
app_mesh/list_gateway_routesReturns a list of existing gateway routes that are associated to a virtual gateway.meshName (string) required
virtualGatewayName (string) required
nextToken (string)
limit (integer)
meshOwner (string)
app_mesh/create_gateway_routeCreates 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.gatewayRouteName (string) required
meshName (string) required
virtualGatewayName (string) required
spec: {
. priority (integer)
. httpRoute (object)
. http2Route (object)
. grpcRoute (object)
} (object) required
tags (array)
clientToken (string)
meshOwner (string)
app_mesh/describe_virtual_nodeDescribes an existing virtual node.virtualNodeName (string) required
meshName (string) required
meshOwner (string)
app_mesh/update_virtual_nodeUpdates an existing virtual node in a specified service mesh.virtualNodeName (string) required
meshName (string) required
spec: {
. serviceDiscovery
. listeners (array)
. backends (array)
. backendDefaults (object)
. logging (object)
} (object) required
clientToken (string)
meshOwner (string)
app_mesh/delete_virtual_nodeDeletes 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.virtualNodeName (string) required
meshName (string) required
meshOwner (string)
app_mesh/list_virtual_nodesReturns a list of existing virtual nodes.meshName (string) required
nextToken (string)
limit (integer)
meshOwner (string)
app_mesh/create_virtual_nodeCreates 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 youvirtualNodeName (string) required
meshName (string) required
spec: {
. serviceDiscovery
. listeners (array)
. backends (array)
. backendDefaults (object)
. logging (object)
} (object) required
tags (array)
clientToken (string)
meshOwner (string)
app_mesh/describe_virtual_routerDescribes an existing virtual router.virtualRouterName (string) required
meshName (string) required
meshOwner (string)
app_mesh/update_virtual_routerUpdates an existing virtual router in a specified service mesh.virtualRouterName (string) required
meshName (string) required
spec: {
. listeners (array)
} (object) required
clientToken (string)
meshOwner (string)
app_mesh/delete_virtual_routerDeletes an existing virtual router. You must delete any routes associated with the virtual router before you can delete the router itself.virtualRouterName (string) required
meshName (string) required
meshOwner (string)
app_mesh/list_virtual_routersReturns a list of existing virtual routers in a service mesh.meshName (string) required
nextToken (string)
limit (integer)
meshOwner (string)
app_mesh/create_virtual_routerCreates 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.virtualRouterName (string) required
meshName (string) required
spec: {
. listeners (array)
} (object) required
tags (array)
clientToken (string)
meshOwner (string)
app_mesh/describe_routeDescribes an existing route.routeName (string) required
meshName (string) required
meshOwner (string)
virtualRouterName (string) required
app_mesh/update_routeUpdates an existing route for a specified service mesh and virtual router.routeName (string) required
meshName (string) required
virtualRouterName (string) required
spec: {
. priority (integer)
. httpRoute (object)
. tcpRoute (object)
. http2Route (object)
. grpcRoute (object)
} (object) required
clientToken (string)
meshOwner (string)
app_mesh/delete_routeDeletes an existing route.routeName (string) required
meshName (string) required
virtualRouterName (string) required
meshOwner (string)
app_mesh/list_routesReturns a list of existing routes in a service mesh.meshName (string) required
virtualRouterName (string) required
nextToken (string)
limit (integer)
meshOwner (string)
app_mesh/create_routeCreates 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.routeName (string) required
meshName (string) required
virtualRouterName (string) required
spec: {
. priority (integer)
. httpRoute (object)
. tcpRoute (object)
. http2Route (object)
. grpcRoute (object)
} (object) required
tags (array)
clientToken (string)
meshOwner (string)
app_mesh/describe_virtual_serviceDescribes an existing virtual service.virtualServiceName (string) required
meshName (string) required
meshOwner (string)
app_mesh/update_virtual_serviceUpdates an existing virtual service in a specified service mesh.virtualServiceName (string) required
meshName (string) required
spec: {
. provider
} (object) required
clientToken (string)
meshOwner (string)
app_mesh/delete_virtual_serviceDeletes an existing virtual service.virtualServiceName (string) required
meshName (string) required
meshOwner (string)
app_mesh/list_virtual_servicesReturns a list of existing virtual services in a service mesh.meshName (string) required
nextToken (string)
limit (integer)
meshOwner (string)
app_mesh/create_virtual_serviceCreates 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.virtualServiceName (string) required
meshName (string) required
spec: {
. provider
} (object) required
tags (array)
clientToken (string)
meshOwner (string)
appconfig/create_applicationCreates 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.Name (string) required
Description (string)
Tags (object)
appconfig/create_configuration_profileCreates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the following: Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store Configuration data stored as objects in an Amazon Simple Storage Service Amazon S3 bucket Pipelines stored in CodePipeline Secrets stored in Secrets Manager Standard and secure string parameters stored in Amazon Web Services SystemsApplicationId (string) required
Name (string) required
Description (string)
LocationUri (string) required
RetrievalRoleArn (string)
Validators (array)
Tags (object)
Type (string)
KmsKeyIdentifier (string)
appconfig/create_deployment_strategyCreates 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.Name (string) required
Description (string)
DeploymentDurationInMinutes (integer) required
FinalBakeTimeInMinutes (integer)
GrowthFactor (number) required
GrowthType (string)
ReplicateTo (string)
Tags (object)
appconfig/create_environmentCreates 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 rolApplicationId (string) required
Name (string) required
Description (string)
Monitors (array)
Tags (object)
appconfig/create_extensionCreates 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 an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing defined in the extension. If you plan to create custom versions of the Amazon Web SName (string) required
Description (string)
Actions (object) required
Parameters (object)
Tags (object)
LatestVersionNumber (integer)
appconfig/create_extension_associationWhen 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 calledExtensionIdentifier (string) required
ExtensionVersionNumber (integer)
ResourceIdentifier (string) required
Parameters (object)
Tags (object)
appconfig/create_hosted_configuration_versionCreates a new configuration in the AppConfig hosted configuration store. If you're creating a feature flag, we recommend you familiarize yourself with the JSON schema for feature flag data. For more information, see Type reference for AWS.AppConfig.FeatureFlags in the AppConfig User Guide.ApplicationId (string) required
ConfigurationProfileId (string) required
Description (string)
Content (string) required
ContentType (string) required
LatestVersionNumber (integer)
VersionLabel (string)
appconfig/delete_applicationDeletes an application.ApplicationId (string) required
appconfig/delete_configuration_profileDeletes a configuration profile. To prevent users from unintentionally deleting actively-used configuration profiles, enable deletion protection.ApplicationId (string) required
ConfigurationProfileId (string) required
DeletionProtectionCheck (string)
appconfig/delete_deployment_strategyDeletes a deployment strategy.DeploymentStrategyId (string) required
appconfig/delete_environmentDeletes an environment. To prevent users from unintentionally deleting actively-used environments, enable deletion protection.EnvironmentId (string) required
ApplicationId (string) required
DeletionProtectionCheck (string)
appconfig/delete_extensionDeletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.ExtensionIdentifier (string) required
VersionNumber (integer)
appconfig/delete_extension_associationDeletes an extension association. This action doesn't delete extensions defined in the association.ExtensionAssociationId (string) required
appconfig/delete_hosted_configuration_versionDeletes a version of a configuration from the AppConfig hosted configuration store.ApplicationId (string) required
ConfigurationProfileId (string) required
VersionNumber (integer) required
appconfig/get_account_settingsReturns information about the status of the DeletionProtection parameter.No parameters
appconfig/get_applicationRetrieves information about an application.ApplicationId (string) required
appconfig/get_configurationDeprecated Retrieves the latest deployed configuration. Note the following important information. This API action is deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead. GetConfiguration is a priced call. For more information, see Pricing.Application (string) required
Environment (string) required
Configuration (string) required
ClientId (string) required
ClientConfigurationVersion (string)
appconfig/get_configuration_profileRetrieves information about a configuration profile.ApplicationId (string) required
ConfigurationProfileId (string) required
appconfig/get_deploymentRetrieves information about a configuration deployment.ApplicationId (string) required
EnvironmentId (string) required
DeploymentNumber (integer) required
appconfig/get_deployment_strategyRetrieves 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.DeploymentStrategyId (string) required
appconfig/get_environmentRetrieves 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.ApplicationId (string) required
EnvironmentId (string) required
appconfig/get_extensionReturns information about an AppConfig extension.ExtensionIdentifier (string) required
VersionNumber (integer)
appconfig/get_extension_associationReturns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.ExtensionAssociationId (string) required
appconfig/get_hosted_configuration_versionRetrieves information about a specific configuration version.ApplicationId (string) required
ConfigurationProfileId (string) required
VersionNumber (integer) required
appconfig/list_applicationsLists all applications in your Amazon Web Services account.MaxResults (integer)
NextToken (string)
appconfig/list_configuration_profilesLists the configuration profiles for an application.ApplicationId (string) required
MaxResults (integer)
NextToken (string)
Type (string)
appconfig/list_deploymentsLists the deployments for an environment in descending deployment number order.ApplicationId (string) required
EnvironmentId (string) required
MaxResults (integer)
NextToken (string)
appconfig/list_deployment_strategiesLists deployment strategies.MaxResults (integer)
NextToken (string)
appconfig/list_environmentsLists the environments for an application.ApplicationId (string) required
MaxResults (integer)
NextToken (string)
appconfig/list_extension_associationsLists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.ResourceIdentifier (string)
ExtensionIdentifier (string)
ExtensionVersionNumber (integer)
MaxResults (integer)
NextToken (string)
appconfig/list_extensionsLists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Extending workflows in the AppConfig User Guide.MaxResults (integer)
NextToken (string)
Name (string)
appconfig/list_hosted_configuration_versionsLists configurations stored in the AppConfig hosted configuration store by version.ApplicationId (string) required
ConfigurationProfileId (string) required
MaxResults (integer)
NextToken (string)
VersionLabel (string)
appconfig/list_tags_for_resourceRetrieves the list of key-value tags assigned to the resource.ResourceArn (string) required
appconfig/start_deploymentStarts a deployment.ApplicationId (string) required
EnvironmentId (string) required
DeploymentStrategyId (string) required
ConfigurationProfileId (string) required
ConfigurationVersion (string) required
Description (string)
Tags (object)
KmsKeyIdentifier (string)
DynamicExtensionParameters (object)
appconfig/stop_deploymentStops a deployment. This API action works only on deployments that have a status of DEPLOYING, unless an AllowRevert parameter is supplied. If the AllowRevert parameter is supplied, the status of an in-progress deployment will be ROLLED_BACK. The status of a completed deployment will be REVERTED. AppConfig only allows a revert within 72 hours of deployment completion.ApplicationId (string) required
EnvironmentId (string) required
DeploymentNumber (integer) required
AllowRevert (boolean)
appconfig/tag_resourceAssigns 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.ResourceArn (string) required
Tags (object) required
appconfig/untag_resourceDeletes a tag key and value from an AppConfig resource.ResourceArn (string) required
TagKeys (array) required
appconfig/update_account_settingsUpdates the value of the DeletionProtection parameter.DeletionProtection: {
. Enabled (boolean)
. ProtectionPeriodInMinutes (integer)
} (object)
appconfig/update_applicationUpdates an application.ApplicationId (string) required
Name (string)
Description (string)
appconfig/update_configuration_profileUpdates a configuration profile.ApplicationId (string) required
ConfigurationProfileId (string) required
Name (string)
Description (string)
RetrievalRoleArn (string)
Validators (array)
KmsKeyIdentifier (string)
appconfig/update_deployment_strategyUpdates a deployment strategy.DeploymentStrategyId (string) required
Description (string)
DeploymentDurationInMinutes (integer)
FinalBakeTimeInMinutes (integer)
GrowthFactor (number)
GrowthType (string)
appconfig/update_environmentUpdates an environment.ApplicationId (string) required
EnvironmentId (string) required
Name (string)
Description (string)
Monitors (array)
appconfig/update_extensionUpdates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.ExtensionIdentifier (string) required
Description (string)
Actions (object)
Parameters (object)
VersionNumber (integer)
appconfig/update_extension_associationUpdates an association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.ExtensionAssociationId (string) required
Parameters (object)
appconfig/validate_configurationUses the validators in a configuration profile to validate a configuration.ApplicationId (string) required
ConfigurationProfileId (string) required
ConfigurationVersion (string) required
appconfigdata/get_latest_configurationRetrieves the latest deployed configuration. This API may return empty configuration data if the client already has the latest version. For more information about this API action and to view example CLI commands that show how to use it with the StartConfigurationSession API action, see Retrieving the configuration in the AppConfig User Guide. Note the following important information. Each configuration token is only valid for one call to GetLatestConfiguration. The GetLatestConfiguration responsConfigurationToken (string) required
appconfigdata/start_configuration_sessionStarts a configuration session used to retrieve a deployed configuration. For more information about this API action and to view example CLI commands that show how to use it with the GetLatestConfiguration API action, see Retrieving the configuration in the AppConfig User Guide.ApplicationIdentifier (string) required
EnvironmentIdentifier (string) required
ConfigurationProfileIdentifier (string) required
RequiredMinimumPollIntervalInSeconds (integer)
appfabric/batch_get_user_access_tasksGets user access details in a batch request. This action polls data from the tasks that are kicked off by the StartUserAccessTasks action.appBundleIdentifier (string) required
taskIdList (array) required
appfabric/connect_app_authorizationEstablishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application.appBundleIdentifier (string) required
appAuthorizationIdentifier (string) required
authRequest: {
. redirectUri (string)
. code (string)
} (object)
appfabric/create_app_authorizationCreates an app authorization within an app bundle, which allows AppFabric to connect to an application.appBundleIdentifier (string) required
app (string) required
credential (undefined) required
tenant: {
. tenantIdentifier (string)
. tenantDisplayName (string)
} (object) required
authType (string) required
clientToken (string)
tags (array)
appfabric/create_app_bundleCreates an app bundle to collect data from an application using AppFabric.clientToken (string)
customerManagedKeyIdentifier (string)
tags (array)
appfabric/create_ingestionCreates a data ingestion for an application.appBundleIdentifier (string) required
app (string) required
tenantId (string) required
ingestionType (string) required
clientToken (string)
tags (array)
appfabric/create_ingestion_destinationCreates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.appBundleIdentifier (string) required
ingestionIdentifier (string) required
processingConfiguration (undefined) required
destinationConfiguration (undefined) required
clientToken (string)
tags (array)
appfabric/delete_app_authorizationDeletes an app authorization. You must delete the associated ingestion before you can delete an app authorization.appBundleIdentifier (string) required
appAuthorizationIdentifier (string) required
appfabric/delete_app_bundleDeletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle.appBundleIdentifier (string) required
appfabric/delete_ingestionDeletes an ingestion. You must stop disable the ingestion and you must delete all associated ingestion destinations before you can delete an app ingestion.appBundleIdentifier (string) required
ingestionIdentifier (string) required
appfabric/delete_ingestion_destinationDeletes an ingestion destination. This deletes the association between an ingestion and it's destination. It doesn't delete previously ingested data or the storage destination, such as the Amazon S3 bucket where the data is delivered. If the ingestion destination is deleted while the associated ingestion is enabled, the ingestion will fail and is eventually disabled.appBundleIdentifier (string) required
ingestionIdentifier (string) required
ingestionDestinationIdentifier (string) required
appfabric/get_app_authorizationReturns information about an app authorization.appBundleIdentifier (string) required
appAuthorizationIdentifier (string) required
appfabric/get_app_bundleReturns information about an app bundle.appBundleIdentifier (string) required
appfabric/get_ingestionReturns information about an ingestion.appBundleIdentifier (string) required
ingestionIdentifier (string) required
appfabric/get_ingestion_destinationReturns information about an ingestion destination.appBundleIdentifier (string) required
ingestionIdentifier (string) required
ingestionDestinationIdentifier (string) required
appfabric/list_app_authorizationsReturns a list of all app authorizations configured for an app bundle.appBundleIdentifier (string) required
maxResults (integer)
nextToken (string)
appfabric/list_app_bundlesReturns a list of app bundles.maxResults (integer)
nextToken (string)
appfabric/list_ingestion_destinationsReturns a list of all ingestion destinations configured for an ingestion.appBundleIdentifier (string) required
ingestionIdentifier (string) required
maxResults (integer)
nextToken (string)
appfabric/list_ingestionsReturns a list of all ingestions configured for an app bundle.appBundleIdentifier (string) required
maxResults (integer)
nextToken (string)
appfabric/list_tags_for_resourceReturns a list of tags for a resource.resourceArn (string) required
appfabric/start_ingestionStarts enables an ingestion, which collects data from an application.ingestionIdentifier (string) required
appBundleIdentifier (string) required
appfabric/start_user_access_tasksStarts the tasks to search user access status for a specific email address. The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.appBundleIdentifier (string) required
email (string) required
appfabric/stop_ingestionStops disables an ingestion.ingestionIdentifier (string) required
appBundleIdentifier (string) required
appfabric/tag_resourceAssigns one or more tags key-value pairs to the specified resource.resourceArn (string) required
tags (array) required
appfabric/untag_resourceRemoves a tag or tags from a resource.resourceArn (string) required
tagKeys (array) required
appfabric/update_app_authorizationUpdates an app authorization within an app bundle, which allows AppFabric to connect to an application. If the app authorization was in a connected state, updating the app authorization will set it back to a PendingConnect state.appBundleIdentifier (string) required
appAuthorizationIdentifier (string) required
credential (undefined)
tenant: {
. tenantIdentifier (string)
. tenantDisplayName (string)
} (object)
appfabric/update_ingestion_destinationUpdates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.appBundleIdentifier (string) required
ingestionIdentifier (string) required
ingestionDestinationIdentifier (string) required
destinationConfiguration (undefined) required
appflow/cancel_flow_executionsCancels active runs for a flow. You can cancel all of the active runs for a flow, or you can cancel specific runs by providing their IDs. You can cancel a flow run only when the run is in progress. You can't cancel a run that has already completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To prevent a scheduled run, you can deactivate the flow with the StopFlow action. You cannot resume a run after you cancel it. When you send your request, the statflowName (string) required
executionIds (array)
appflow/create_connector_profileCreates 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.connectorProfileName (string) required
kmsArn (string)
connectorType (string) required
connectorLabel (string)
connectionMode (string) required
connectorProfileConfig: {
. connectorProfileProperties (object)
. connectorProfileCredentials (object)
} (object) required
clientToken (string)
appflow/create_flowEnables 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.flowName (string) required
description (string)
kmsArn (string)
triggerConfig: {
. triggerType (string)
. triggerProperties (object)
} (object) required
sourceFlowConfig: {
. connectorType (string)
. apiVersion (string)
. connectorProfileName (string)
. sourceConnectorProperties (object)
. incrementalPullConfig (object)
} (object) required
destinationFlowConfigList (array) required
tasks (array) required
tags (object)
metadataCatalogConfig: {
. glueDataCatalog (object)
} (object)
clientToken (string)
appflow/delete_connector_profileEnables you to delete an existing connector profile.connectorProfileName (string) required
forceDelete (boolean)
appflow/delete_flowEnables 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.flowName (string) required
forceDelete (boolean)
appflow/describe_connectorDescribes 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.connectorType (string) required
connectorLabel (string)
appflow/describe_connector_entityProvides details regarding the entity used with the connector, with a description of the data model for each field in that entity.connectorEntityName (string) required
connectorType (string)
connectorProfileName (string)
apiVersion (string)
appflow/describe_connector_profilesReturns 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.connectorProfileNames (array)
connectorType (string)
connectorLabel (string)
maxResults (integer)
nextToken (string)
appflow/describe_connectorsDescribes 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.connectorTypes (array)
maxResults (integer)
nextToken (string)
appflow/describe_flowProvides a description of the specified flow.flowName (string) required
appflow/describe_flow_execution_recordsFetches the execution history of the flow.flowName (string) required
maxResults (integer)
nextToken (string)
appflow/list_connector_entitiesReturns 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.connectorProfileName (string)
connectorType (string)
entitiesPath (string)
apiVersion (string)
maxResults (integer)
nextToken (string)
appflow/list_connectorsReturns 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.maxResults (integer)
nextToken (string)
appflow/list_flowsLists all of the flows associated with your account.maxResults (integer)
nextToken (string)
appflow/list_tags_for_resourceRetrieves the tags that are associated with a specified flow.resourceArn (string) required
appflow/register_connectorRegisters a new custom connector with your Amazon Web Services account. Before you can register the connector, you must deploy the associated AWS lambda function in your account.connectorLabel (string)
description (string)
connectorProvisioningType (string)
connectorProvisioningConfig: {
. lambda (object)
} (object)
clientToken (string)
appflow/reset_connector_metadata_cacheResets metadata about your connector entities that Amazon AppFlow stored in its cache. Use this action when you want Amazon AppFlow to return the latest information about the data that you have in a source application. Amazon AppFlow returns metadata about your entities when you use the ListConnectorEntities or DescribeConnectorEntities actions. Following these actions, Amazon AppFlow caches the metadata to reduce the number of API requests that it must send to the source application. Amazon AppconnectorProfileName (string)
connectorType (string)
connectorEntityName (string)
entitiesPath (string)
apiVersion (string)
appflow/start_flowActivates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.flowName (string) required
clientToken (string)
appflow/stop_flowDeactivates 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.flowName (string) required
appflow/tag_resourceApplies a tag to the specified flow.resourceArn (string) required
tags (object) required
appflow/unregister_connectorUnregisters the custom connector registered in your account that matches the connector label provided in the request.connectorLabel (string) required
forceDelete (boolean)
appflow/untag_resourceRemoves a tag from the specified flow.resourceArn (string) required
tagKeys (array) required
appflow/update_connector_profileUpdates a given connector profile associated with your account.connectorProfileName (string) required
connectionMode (string) required
connectorProfileConfig: {
. connectorProfileProperties (object)
. connectorProfileCredentials (object)
} (object) required
clientToken (string)
appflow/update_connector_registrationUpdates a custom connector that you've previously registered. This operation updates the connector with one of the following: The latest version of the AWS Lambda function that's assigned to the connector A new AWS Lambda function that you specifyconnectorLabel (string) required
description (string)
connectorProvisioningConfig: {
. lambda (object)
} (object)
clientToken (string)
appflow/update_flowUpdates an existing flow.flowName (string) required
description (string)
triggerConfig: {
. triggerType (string)
. triggerProperties (object)
} (object) required
sourceFlowConfig: {
. connectorType (string)
. apiVersion (string)
. connectorProfileName (string)
. sourceConnectorProperties (object)
. incrementalPullConfig (object)
} (object) required
destinationFlowConfigList (array) required
tasks (array) required
metadataCatalogConfig: {
. glueDataCatalog (object)
} (object)
clientToken (string)
appintegrations/create_applicationCreates and persists an Application resource.Name (string) required
Namespace (string) required
Description (string)
ApplicationSourceConfig: {
. ExternalUrlConfig (object)
} (object) required
Subscriptions (array)
Publications (array)
ClientToken (string)
Tags (object)
Permissions (array)
IsService (boolean)
InitializationTimeout (integer)
ApplicationConfig: {
. ContactHandling (object)
} (object)
IframeConfig: {
. Allow (array)
. Sandbox (array)
} (object)
ApplicationType (string)
appintegrations/create_data_integrationCreates 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.Name (string) required
Description (string)
KmsKey (string) required
SourceURI (string)
ScheduleConfig: {
. FirstExecutionFrom (string)
. Object (string)
. ScheduleExpression (string)
} (object)
Tags (object)
ClientToken (string)
FileConfiguration: {
. Folders (array)
. Filters (object)
} (object)
ObjectConfiguration (object)
appintegrations/create_data_integration_associationCreates and persists a DataIntegrationAssociation resource.DataIntegrationIdentifier (string) required
ClientId (string)
ObjectConfiguration (object)
DestinationURI (string)
ClientAssociationMetadata (object)
ClientToken (string)
ExecutionConfiguration: {
. ExecutionMode (string)
. OnDemandConfiguration (object)
. ScheduleConfiguration (object)
} (object)
appintegrations/create_event_integrationCreates 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.Name (string) required
Description (string)
EventFilter: {
. Source (string)
} (object) required
EventBridgeBus (string) required
ClientToken (string)
Tags (object)
appintegrations/delete_applicationDeletes the Application. Only Applications that don't have any Application Associations can be deleted.Arn (string) required
appintegrations/delete_data_integrationDeletes 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.DataIntegrationIdentifier (string) required
appintegrations/delete_event_integrationDeletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.Name (string) required
appintegrations/get_applicationGet an Application resource.Arn (string) required
appintegrations/get_data_integrationReturns 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.Identifier (string) required
appintegrations/get_event_integrationReturns information about the event integration.Name (string) required
appintegrations/list_application_associationsReturns a paginated list of application associations for an application.ApplicationId (string) required
NextToken (string)
MaxResults (integer)
appintegrations/list_applicationsLists applications in the account.NextToken (string)
MaxResults (integer)
ApplicationType (string)
appintegrations/list_data_integration_associationsReturns 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.DataIntegrationIdentifier (string) required
NextToken (string)
MaxResults (integer)
appintegrations/list_data_integrationsReturns 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.NextToken (string)
MaxResults (integer)
appintegrations/list_event_integration_associationsReturns a paginated list of event integration associations in the account.EventIntegrationName (string) required
NextToken (string)
MaxResults (integer)
appintegrations/list_event_integrationsReturns a paginated list of event integrations in the account.NextToken (string)
MaxResults (integer)
appintegrations/list_tags_for_resourceLists the tags for the specified resource.resourceArn (string) required
appintegrations/tag_resourceAdds the specified tags to the specified resource.resourceArn (string) required
tags (object) required
appintegrations/untag_resourceRemoves the specified tags from the specified resource.resourceArn (string) required
tagKeys (array) required
appintegrations/update_applicationUpdates and persists an Application resource.Arn (string) required
Name (string)
Description (string)
ApplicationSourceConfig: {
. ExternalUrlConfig (object)
} (object)
Subscriptions (array)
Publications (array)
Permissions (array)
IsService (boolean)
InitializationTimeout (integer)
ApplicationConfig: {
. ContactHandling (object)
} (object)
IframeConfig: {
. Allow (array)
. Sandbox (array)
} (object)
ApplicationType (string)
appintegrations/update_data_integrationUpdates 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.Identifier (string) required
Name (string)
Description (string)
appintegrations/update_data_integration_associationUpdates and persists a DataIntegrationAssociation resource. Updating a DataIntegrationAssociation with ExecutionConfiguration will rerun the on-demand job.DataIntegrationIdentifier (string) required
DataIntegrationAssociationIdentifier (string) required
ExecutionConfiguration: {
. ExecutionMode (string)
. OnDemandConfiguration (object)
. ScheduleConfiguration (object)
} (object) required
appintegrations/update_event_integrationUpdates the description of an event integration.Name (string) required
Description (string)
application_auto_scaling/delete_scaling_policyDeletes 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.PolicyName (string) required
ServiceNamespace (string) required
ResourceId (string) required
ScalableDimension (string) required
application_auto_scaling/delete_scheduled_actionDeletes 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.ServiceNamespace (string) required
ScheduledActionName (string) required
ResourceId (string) required
ScalableDimension (string) required
application_auto_scaling/deregister_scalable_targetDeregisters 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.ServiceNamespace (string) required
ResourceId (string) required
ScalableDimension (string) required
application_auto_scaling/describe_scalable_targetsGets information about the scalable targets in the specified namespace. You can filter the results using ResourceIds and ScalableDimension.ServiceNamespace (string) required
ResourceIds (array)
ScalableDimension (string)
MaxResults (integer)
NextToken (string)
application_auto_scaling/describe_scaling_activitiesProvides descriptive information about the scaling activities in the specified namespace from the previous six weeks. You can filter the results using ResourceId and ScalableDimension. For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling.ServiceNamespace (string) required
ResourceId (string)
ScalableDimension (string)
MaxResults (integer)
NextToken (string)
IncludeNotScaledActivities (boolean)
application_auto_scaling/describe_scaling_policiesDescribes 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.PolicyNames (array)
ServiceNamespace (string) required
ResourceId (string)
ScalableDimension (string)
MaxResults (integer)
NextToken (string)
application_auto_scaling/describe_scheduled_actionsDescribes the Application Auto Scaling scheduled actions for the specified service namespace. You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters. For more information, see Scheduled scaling in the Application Auto Scaling User Guide.ScheduledActionNames (array)
ServiceNamespace (string) required
ResourceId (string)
ScalableDimension (string)
MaxResults (integer)
NextToken (string)
application_auto_scaling/get_predictive_scaling_forecastRetrieves 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 fServiceNamespace (string) required
ResourceId (string) required
ScalableDimension (string) required
PolicyName (string) required
StartTime (string) required
EndTime (string) required
application_auto_scaling/list_tags_for_resourceReturns all the tags on the specified Application Auto Scaling scalable target. For general information about tags, including the format and syntax, see Tagging your Amazon Web Services resources in the Amazon Web Services General Reference.ResourceARN (string) required
application_auto_scaling/put_scaling_policyCreates 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 scalingPolicyName (string) required
ServiceNamespace (string) required
ResourceId (string) required
ScalableDimension (string) required
PolicyType (string)
StepScalingPolicyConfiguration: {
. AdjustmentType (string)
. StepAdjustments (array)
. MinAdjustmentMagnitude (integer)
. Cooldown (integer)
. MetricAggregationType (string)
} (object)
TargetTrackingScalingPolicyConfiguration: {
. TargetValue (number)
. PredefinedMetricSpecification (object)
. CustomizedMetricSpecification (object)
. ScaleOutCooldown (integer)
. ScaleInCooldown (integer)
. DisableScaleIn (boolean)
} (object)
PredictiveScalingPolicyConfiguration: {
. MetricSpecifications (array)
. Mode (string)
. SchedulingBufferTime (integer)
. MaxCapacityBreachBehavior (string)
. MaxCapacityBuffer (integer)
} (object)
application_auto_scaling/put_scheduled_actionCreates or updates a scheduled action for an Application Auto Scaling scalable target. Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target. When you specify start and end times with a recurring schedule using a cron expression or rates, they form the boundaries for whenServiceNamespace (string) required
Schedule (string)
Timezone (string)
ScheduledActionName (string) required
ResourceId (string) required
ScalableDimension (string) required
StartTime (string)
EndTime (string)
ScalableTargetAction: {
. MinCapacity (integer)
. MaxCapacity (integer)
} (object)
application_auto_scaling/register_scalable_targetRegisters or updates a scalable target, which is the resource that you want to scale. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, which represents some capacity dimension of the underlying service. When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the specified resource is not active in the target service, this operation does not change the resource's current capacity. OtherServiceNamespace (string) required
ResourceId (string) required
ScalableDimension (string) required
MinCapacity (integer)
MaxCapacity (integer)
RoleARN (string)
SuspendedState: {
. DynamicScalingInSuspended (boolean)
. DynamicScalingOutSuspended (boolean)
. ScheduledScalingSuspended (boolean)
} (object)
Tags (object)
application_auto_scaling/tag_resourceAdds or edits tags on an Application Auto Scaling scalable target. Each tag consists of a tag key and a tag value, which are both case-sensitive strings. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a scaling policy or scheduled action. You can also add tags to an Application Auto Scaling scalable target while creating it RegistResourceARN (string) required
Tags (object) required
application_auto_scaling/untag_resourceDeletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target.ResourceARN (string) required
TagKeys (array) required
application_discovery_service/associate_configuration_items_to_applicationAssociates one or more configuration items with an application.applicationConfigurationId (string) required
configurationIds (array) required
application_discovery_service/batch_delete_agentsDeletes one or more agents or collectors as specified by ID. Deleting an agent or collector does not delete the previously discovered data. To delete the data collected, use StartBatchDeleteConfigurationTask.deleteAgents (array) required
application_discovery_service/batch_delete_import_dataDeletes 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 inimportTaskIds (array) required
deleteHistory (boolean)
application_discovery_service/create_applicationCreates an application with the given name and description.name (string) required
description (string)
wave (string)
application_discovery_service/create_tagsCreates 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.configurationIds (array) required
tags (array) required
application_discovery_service/delete_applicationsDeletes a list of applications and their associations with configuration items.configurationIds (array) required
application_discovery_service/delete_tagsDeletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.configurationIds (array) required
tags (array)
application_discovery_service/describe_agentsLists agents or collectors as specified by ID or other filters. All agents/collectors associated with your user can be listed if you call DescribeAgents as is without passing any parameters.agentIds (array)
filters (array)
maxResults (integer)
nextToken (string)
application_discovery_service/describe_batch_delete_configuration_taskTakes a unique deletion task identifier as input and returns metadata about a configuration deletion task.taskId (string) required
application_discovery_service/describe_configurationsRetrieves 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 ActiconfigurationIds (array) required
application_discovery_service/describe_continuous_exportsLists exports as specified by ID. All continuous exports associated with your user can be listed if you call DescribeContinuousExports as is without passing any parameters.exportIds (array)
maxResults (integer)
nextToken (string)
application_discovery_service/describe_export_configurationsDescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.exportIds (array)
maxResults (integer)
nextToken (string)
application_discovery_service/describe_export_tasksRetrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.exportIds (array)
filters (array)
maxResults (integer)
nextToken (string)
application_discovery_service/describe_import_tasksReturns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.filters (array)
maxResults (integer)
nextToken (string)
application_discovery_service/describe_tagsRetrieves 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 that have tags can be listed if you call DescribeTags as is without passing any parameters.filters (array)
maxResults (integer)
nextToken (string)
application_discovery_service/disassociate_configuration_items_from_applicationDisassociates one or more configuration items from an application.applicationConfigurationId (string) required
configurationIds (array) required
application_discovery_service/export_configurationsDeprecated. Use StartExportTask instead. Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID that you can query using the DescribeExportConfigurations API. The system imposes a limit of two configuration exports in six hours.No parameters
application_discovery_service/get_discovery_summaryRetrieves 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.No parameters
application_discovery_service/list_configurationsRetrieves 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.configurationType (string) required
filters (array)
maxResults (integer)
nextToken (string)
orderBy (array)
application_discovery_service/list_server_neighborsRetrieves a list of servers that are one network hop away from a specified server.configurationId (string) required
portInformationNeeded (boolean)
neighborConfigurationIds (array)
maxResults (integer)
nextToken (string)
application_discovery_service/start_batch_delete_configuration_taskTakes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.configurationType (string) required
configurationIds (array) required
application_discovery_service/start_continuous_exportStart the continuous flow of agent's discovered data into Amazon Athena.No parameters
application_discovery_service/start_data_collection_by_agent_idsInstructs the specified agents to start collecting data.agentIds (array) required
application_discovery_service/start_export_taskBegins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services. Exports might provide an estimate of fees and savings based on certain information that you provide. Fee estimates do not include any taxes that might apply. Your actual fees and savings depend on a variety of factors, including your actual usage of Amazon Web Services services, which might vary from the estimates provided in this report. If you do not specify preferences or agentIds in the filteexportDataFormat (array)
filters (array)
startTime (string)
endTime (string)
preferences (undefined)
application_discovery_service/start_import_taskStarts 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 Amazon Web Services Application Discovery Service Application Discovery Service tools such as the Amazon Web Services Application Discovery Service Agentless Collector or Application Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to groupclientRequestToken (string)
name (string) required
importUrl (string) required
application_discovery_service/stop_continuous_exportStop the continuous flow of agent's discovered data into Amazon Athena.exportId (string) required
application_discovery_service/stop_data_collection_by_agent_idsInstructs the specified agents to stop collecting data.agentIds (array) required
application_discovery_service/update_applicationUpdates metadata about an application.configurationId (string) required
name (string)
description (string)
wave (string)
application_insights/add_workloadAdds a workload to a component. Each component can have at most five workloads.ResourceGroupName (string) required
ComponentName (string) required
WorkloadConfiguration: {
. WorkloadName (string)
. Tier (string)
. Configuration (string)
} (object) required
application_insights/create_applicationAdds an application that is created from a resource group.ResourceGroupName (string)
OpsCenterEnabled (boolean)
CWEMonitorEnabled (boolean)
OpsItemSNSTopicArn (string)
SNSNotificationArn (string)
Tags (array)
AutoConfigEnabled (boolean)
AutoCreate (boolean)
GroupingType (string)
AttachMissingPermission (boolean)
application_insights/create_componentCreates a custom component by grouping similar standalone instances to monitor.ResourceGroupName (string) required
ComponentName (string) required
ResourceList (array) required
application_insights/create_log_patternAdds an log pattern to a LogPatternSet.ResourceGroupName (string) required
PatternSetName (string) required
PatternName (string) required
Pattern (string) required
Rank (integer) required
application_insights/delete_applicationRemoves the specified application from monitoring. Does not delete the application.ResourceGroupName (string) required
application_insights/delete_componentUngroups 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.ResourceGroupName (string) required
ComponentName (string) required
application_insights/delete_log_patternRemoves the specified log pattern from a LogPatternSet.ResourceGroupName (string) required
PatternSetName (string) required
PatternName (string) required
application_insights/describe_applicationDescribes the application.ResourceGroupName (string) required
AccountId (string)
application_insights/describe_componentDescribes a component and lists the resources that are grouped together in a component.ResourceGroupName (string) required
ComponentName (string) required
AccountId (string)
application_insights/describe_component_configurationDescribes the monitoring configuration of the component.ResourceGroupName (string) required
ComponentName (string) required
AccountId (string)
application_insights/describe_component_configuration_recommendationDescribes the recommended monitoring configuration of the component.ResourceGroupName (string) required
ComponentName (string) required
Tier (string) required
WorkloadName (string)
RecommendationType (string)
application_insights/describe_log_patternDescribe a specific log pattern from a LogPatternSet.ResourceGroupName (string) required
PatternSetName (string) required
PatternName (string) required
AccountId (string)
application_insights/describe_observationDescribes an anomaly or error with the application.ObservationId (string) required
AccountId (string)
application_insights/describe_problemDescribes an application problem.ProblemId (string) required
AccountId (string)
application_insights/describe_problem_observationsDescribes the anomalies or errors associated with the problem.ProblemId (string) required
AccountId (string)
application_insights/describe_workloadDescribes a workload and its configuration.ResourceGroupName (string) required
ComponentName (string) required
WorkloadId (string) required
AccountId (string)
application_insights/list_applicationsLists the IDs of the applications that you are monitoring.MaxResults (integer)
NextToken (string)
AccountId (string)
application_insights/list_componentsLists the auto-grouped, standalone, and custom components of the application.ResourceGroupName (string) required
MaxResults (integer)
NextToken (string)
AccountId (string)
application_insights/list_configuration_historyLists 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.ResourceGroupName (string)
StartTime (string)
EndTime (string)
EventStatus (string)
MaxResults (integer)
NextToken (string)
AccountId (string)
application_insights/list_log_patternsLists the log patterns in the specific log LogPatternSet.ResourceGroupName (string) required
PatternSetName (string)
MaxResults (integer)
NextToken (string)
AccountId (string)
application_insights/list_log_pattern_setsLists the log pattern sets in the specific application.ResourceGroupName (string) required
MaxResults (integer)
NextToken (string)
AccountId (string)
application_insights/list_problemsLists the problems with your application.AccountId (string)
ResourceGroupName (string)
StartTime (string)
EndTime (string)
MaxResults (integer)
NextToken (string)
ComponentName (string)
Visibility (string)
application_insights/list_tags_for_resourceRetrieve 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.ResourceARN (string) required
application_insights/list_workloadsLists the workloads that are configured on a given component.ResourceGroupName (string) required
ComponentName (string) required
MaxResults (integer)
NextToken (string)
AccountId (string)
application_insights/remove_workloadRemove workload from a component.ResourceGroupName (string) required
ComponentName (string) required
WorkloadId (string) required
application_insights/tag_resourceAdd 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 keResourceARN (string) required
Tags (array) required
application_insights/untag_resourceRemove one or more tags keys and values from a specified application.ResourceARN (string) required
TagKeys (array) required
application_insights/update_applicationUpdates the application.ResourceGroupName (string) required
OpsCenterEnabled (boolean)
CWEMonitorEnabled (boolean)
OpsItemSNSTopicArn (string)
SNSNotificationArn (string)
RemoveSNSTopic (boolean)
AutoConfigEnabled (boolean)
AttachMissingPermission (boolean)
application_insights/update_componentUpdates the custom component name and/or the list of resources that make up the component.ResourceGroupName (string) required
ComponentName (string) required
NewComponentName (string)
ResourceList (array)
application_insights/update_component_configurationUpdates 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.ResourceGroupName (string) required
ComponentName (string) required
Monitor (boolean)
Tier (string)
ComponentConfiguration (string)
AutoConfigEnabled (boolean)
application_insights/update_log_patternAdds a log pattern to a LogPatternSet.ResourceGroupName (string) required
PatternSetName (string) required
PatternName (string) required
Pattern (string)
Rank (integer)
application_insights/update_problemUpdates the visibility of the problem or specifies the problem as RESOLVED.ProblemId (string) required
UpdateStatus (string)
Visibility (string)
application_insights/update_workloadAdds a workload to a component. Each component can have at most five workloads.ResourceGroupName (string) required
ComponentName (string) required
WorkloadId (string)
WorkloadConfiguration: {
. WorkloadName (string)
. Tier (string)
. Configuration (string)
} (object) required
application_signals/batch_get_service_level_objective_budget_reportUse this operation to retrieve one or more service level objective SLO budget reports. An error budget is the amount of time or requests in an unhealthy state that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. For example, an SLO with a threshold of 99.95% and a monthly interval translates to an error budget of 21.9 minutes of downtime in a 30-day month. Budget reports include a health indicator, the attainTimestamp (string) required
SloIds (array) required
application_signals/batch_update_exclusion_windowsAdd or remove time window exclusions for one or more Service Level Objectives SLOs.SloIds (array) required
AddExclusionWindows (array)
RemoveExclusionWindows (array)
application_signals/delete_grouping_configurationDeletes the grouping configuration for this account. This removes all custom grouping attribute definitions that were previously configured.No parameters
application_signals/get_serviceReturns information about a service discovered by Application Signals.StartTime (string) required
EndTime (string) required
KeyAttributes (object) required
application_signals/list_audit_findingsReturns a list of audit findings that provide automated analysis of service behavior and root cause analysis. These findings help identify the most significant observations about your services, including performance issues, anomalies, and potential problems. The findings are generated using heuristic algorithms based on established troubleshooting patterns.StartTime (string) required
EndTime (string) required
Auditors (array)
AuditTargets (array) required
DetailLevel (string)
NextToken (string)
MaxResults (integer)
application_signals/list_entity_eventsReturns a list of change events for a specific entity, such as deployments, configuration changes, or other state-changing activities. This operation helps track the history of changes that may have affected service performance.Entity (object) required
StartTime (string) required
EndTime (string) required
MaxResults (integer)
NextToken (string)
application_signals/list_grouping_attribute_definitionsReturns the current grouping configuration for this account, including all custom grouping attribute definitions that have been configured. These definitions determine how services are logically grouped based on telemetry attributes, Amazon Web Services tags, or predefined mappings.NextToken (string)
AwsAccountId (string)
IncludeLinkedAccounts (boolean)
application_signals/list_service_dependenciesReturns a list of service dependencies of the service that you specify. A dependency is an infrastructure component that an operation of this service connects with. Dependencies can include Amazon Web Services services, Amazon Web Services resources, and third-party services.StartTime (string) required
EndTime (string) required
KeyAttributes (object) required
MaxResults (integer)
NextToken (string)
application_signals/list_service_dependentsReturns the list of dependents that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.StartTime (string) required
EndTime (string) required
KeyAttributes (object) required
MaxResults (integer)
NextToken (string)
application_signals/list_service_level_objective_exclusion_windowsRetrieves all exclusion windows configured for a specific SLO.Id (string) required
MaxResults (integer)
NextToken (string)
application_signals/list_service_operationsReturns a list of the operations of this service that have been discovered by Application Signals. Only the operations that were invoked during the specified time range are returned.StartTime (string) required
EndTime (string) required
KeyAttributes (object) required
MaxResults (integer)
NextToken (string)
application_signals/list_servicesReturns a list of services that have been discovered by Application Signals. A service represents a minimum logical and transactional unit that completes a business function. Services are discovered through Application Signals instrumentation.StartTime (string) required
EndTime (string) required
MaxResults (integer)
NextToken (string)
IncludeLinkedAccounts (boolean)
AwsAccountId (string)
application_signals/list_service_statesReturns information about the last deployment and other change states of services. This API provides visibility into recent changes that may have affected service performance, helping with troubleshooting and change correlation.StartTime (string) required
EndTime (string) required
MaxResults (integer)
NextToken (string)
IncludeLinkedAccounts (boolean)
AwsAccountId (string)
AttributeFilters (array)
application_signals/list_tags_for_resourceDisplays the tags associated with a CloudWatch resource. Tags can be assigned to service level objectives.ResourceArn (string) required
application_signals/put_grouping_configurationCreates or updates the grouping configuration for this account. This operation allows you to define custom grouping attributes that determine how services are logically grouped based on telemetry attributes, Amazon Web Services tags, or predefined mappings. These grouping attributes can then be used to organize and filter services in the Application Signals console and APIs.GroupingAttributeDefinitions (array) required
application_signals/start_discoveryEnables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role. This service- linked role has the following permissions: xray:GetServiceGraph logs:StartQuery logs:GetQueryResults cloudwatch:GetMetricData cloudwatch:ListMetrics tag:GetResources autoscaling:DescribeAutoScalingGroups A service-linked CloudTrail event channel is created to process CloudTrail events and return change event infNo parameters
application_signals/tag_resourceAssigns one or more tags key-value pairs to the specified CloudWatch resource, such as a service level objective. 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. IfResourceArn (string) required
Tags (array) required
application_signals/untag_resourceRemoves one or more tags from the specified resource.ResourceArn (string) required
TagKeys (array) required
application_signals/create_service_level_objectiveCreates a service level objective SLO, which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators SLIs to calculate whether the application is performing at the level that you want. Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequeName (string) required
Description (string)
SliConfig: {
. SliMetricConfig (object)
. MetricThreshold (number)
. ComparisonOperator (string)
} (object)
RequestBasedSliConfig: {
. RequestBasedSliMetricConfig (object)
. MetricThreshold (number)
. ComparisonOperator (string)
} (object)
Goal: {
. Interval
. AttainmentGoal (number)
. WarningThreshold (number)
} (object)
Tags (array)
BurnRateConfigurations (array)
application_signals/get_service_level_objectiveReturns information about one SLO created in the account.Id (string) required
application_signals/update_service_level_objectiveUpdates an existing service level objective SLO. If you omit parameters, the previous values of those parameters are retained. You cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.Id (string) required
Description (string)
SliConfig: {
. SliMetricConfig (object)
. MetricThreshold (number)
. ComparisonOperator (string)
} (object)
RequestBasedSliConfig: {
. RequestBasedSliMetricConfig (object)
. MetricThreshold (number)
. ComparisonOperator (string)
} (object)
Goal: {
. Interval
. AttainmentGoal (number)
. WarningThreshold (number)
} (object)
BurnRateConfigurations (array)
application_signals/delete_service_level_objectiveDeletes the specified service level objective.Id (string) required
application_signals/list_service_level_objectivesReturns a list of SLOs created in this account.KeyAttributes (object)
OperationName (string)
DependencyConfig: {
. DependencyKeyAttributes (object)
. DependencyOperationName (string)
} (object)
MaxResults (integer)
NextToken (string)
IncludeLinkedAccounts (boolean)
SloOwnerAwsAccountId (string)
MetricSourceTypes (array)
applicationcostprofiler/delete_report_definitionDeletes the specified report definition in AWS Application Cost Profiler. This stops the report from being generated.reportId (string) required
applicationcostprofiler/get_report_definitionRetrieves the definition of a report already configured in AWS Application Cost Profiler.reportId (string) required
applicationcostprofiler/import_application_usageIngests 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.sourceS3Location: {
. bucket (string)
. key (string)
. region (string)
} (object) required
applicationcostprofiler/list_report_definitionsRetrieves a list of all reports and their configurations for your AWS account. The maximum number of reports is one.nextToken (string)
maxResults (integer)
applicationcostprofiler/put_report_definitionCreates the report definition for a report in Application Cost Profiler.reportId (string) required
reportDescription (string) required
reportFrequency (string) required
format (string) required
destinationS3Location: {
. bucket (string)
. prefix (string)
} (object) required
applicationcostprofiler/update_report_definitionUpdates existing report in AWS Application Cost Profiler.reportId (string) required
reportDescription (string) required
reportFrequency (string) required
format (string) required
destinationS3Location: {
. bucket (string)
. prefix (string)
} (object) required
apprunner/associate_custom_domainAssociate 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 thaServiceArn (string) required
DomainName (string) required
EnableWWWSubdomain (boolean)
apprunner/create_auto_scaling_configurationCreate 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 configurAutoScalingConfigurationName (string) required
MaxConcurrency (integer)
MinSize (integer)
MaxSize (integer)
Tags (array)
apprunner/create_connectionCreate 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 and Bitbucket repositories. Both require a user interface approval process through the App Runner console before you can use the connection.ConnectionName (string) required
ProviderType (string) required
Tags (array)
apprunner/create_observability_configurationCreate 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 andObservabilityConfigurationName (string) required
TraceConfiguration: {
. Vendor (string)
} (object)
Tags (array)
apprunner/create_serviceCreate 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.ServiceName (string) required
SourceConfiguration: {
. CodeRepository (object)
. ImageRepository (object)
. AutoDeploymentsEnabled (boolean)
. AuthenticationConfiguration (object)
} (object) required
InstanceConfiguration: {
. Cpu (string)
. Memory (string)
. InstanceRoleArn (string)
} (object)
Tags (array)
EncryptionConfiguration: {
. KmsKey (string)
} (object)
HealthCheckConfiguration: {
. Protocol (string)
. Path (string)
. Interval (integer)
. Timeout (integer)
. HealthyThreshold (integer)
. UnhealthyThreshold (integer)
} (object)
AutoScalingConfigurationArn (string)
NetworkConfiguration: {
. EgressConfiguration (object)
. IngressConfiguration (object)
. IpAddressType (string)
} (object)
ObservabilityConfiguration: {
. ObservabilityEnabled (boolean)
. ObservabilityConfigurationArn (string)
} (object)
apprunner/create_vpc_connectorCreate 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.VpcConnectorName (string) required
Subnets (array) required
SecurityGroups (array)
Tags (array)
apprunner/create_vpc_ingress_connectionCreate an App Runner VPC Ingress Connection resource. App Runner requires this resource when you want to associate your App Runner service with an Amazon VPC endpoint.ServiceArn (string) required
VpcIngressConnectionName (string) required
IngressVpcConfiguration: {
. VpcId (string)
. VpcEndpointId (string)
} (object) required
Tags (array)
apprunner/delete_auto_scaling_configurationDelete an App Runner automatic scaling configuration resource. You can delete a top level auto scaling configuration, a specific revision of one, or all revisions associated with the top level configuration. You can't delete the default auto scaling configuration or a configuration that's used by one or more App Runner services.AutoScalingConfigurationArn (string) required
DeleteAllRevisions (boolean)
apprunner/delete_connectionDelete 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.ConnectionArn (string) required
apprunner/delete_observability_configurationDelete 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.ObservabilityConfigurationArn (string) required
apprunner/delete_serviceDelete 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. Make sure that you don't have any active VPCIngressConnections associated with the service you want to delete.ServiceArn (string) required
apprunner/delete_vpc_connectorDelete an App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.VpcConnectorArn (string) required
apprunner/delete_vpc_ingress_connectionDelete an App Runner VPC Ingress Connection resource that's associated with an App Runner service. The VPC Ingress Connection must be in one of the following states to be deleted: AVAILABLE FAILED_CREATION FAILED_UPDATE FAILED_DELETIONVpcIngressConnectionArn (string) required
apprunner/describe_auto_scaling_configurationReturn a full description of an App Runner automatic scaling configuration resource.AutoScalingConfigurationArn (string) required
apprunner/describe_custom_domainsReturn a description of custom domain names that are associated with an App Runner service.ServiceArn (string) required
NextToken (string)
MaxResults (integer)
apprunner/describe_observability_configurationReturn a full description of an App Runner observability configuration resource.ObservabilityConfigurationArn (string) required
apprunner/describe_serviceReturn a full description of an App Runner service.ServiceArn (string) required
apprunner/describe_vpc_connectorReturn a description of an App Runner VPC connector resource.VpcConnectorArn (string) required
apprunner/describe_vpc_ingress_connectionReturn a full description of an App Runner VPC Ingress Connection resource.VpcIngressConnectionArn (string) required
apprunner/disassociate_custom_domainDisassociate 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.ServiceArn (string) required
DomainName (string) required
apprunner/list_auto_scaling_configurationsReturns 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.AutoScalingConfigurationName (string)
LatestOnly (boolean)
MaxResults (integer)
NextToken (string)
apprunner/list_connectionsReturns a list of App Runner connections that are associated with your Amazon Web Services account.ConnectionName (string)
MaxResults (integer)
NextToken (string)
apprunner/list_observability_configurationsReturns 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.ObservabilityConfigurationName (string)
LatestOnly (boolean)
MaxResults (integer)
NextToken (string)
apprunner/list_operationsReturn 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.ServiceArn (string) required
NextToken (string)
MaxResults (integer)
apprunner/list_servicesReturns a list of running App Runner services in your Amazon Web Services account.NextToken (string)
MaxResults (integer)
apprunner/list_services_for_auto_scaling_configurationReturns a list of the associated App Runner services using an auto scaling configuration.AutoScalingConfigurationArn (string) required
MaxResults (integer)
NextToken (string)
apprunner/list_tags_for_resourceList tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs.ResourceArn (string) required
apprunner/list_vpc_connectorsReturns a list of App Runner VPC connectors in your Amazon Web Services account.MaxResults (integer)
NextToken (string)
apprunner/list_vpc_ingress_connectionsReturn a list of App Runner VPC Ingress Connections in your Amazon Web Services account.Filter: {
. ServiceArn (string)
. VpcEndpointId (string)
} (object)
MaxResults (integer)
NextToken (string)
apprunner/pause_servicePause 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.ServiceArn (string) required
apprunner/resume_serviceResume 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.ServiceArn (string) required
apprunner/start_deploymentInitiate 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 reServiceArn (string) required
apprunner/tag_resourceAdd tags to, or update the tag values of, an App Runner resource. A tag is a key-value pair.ResourceArn (string) required
Tags (array) required
apprunner/untag_resourceRemove tags from an App Runner resource.ResourceArn (string) required
TagKeys (array) required
apprunner/update_default_auto_scaling_configurationUpdate an auto scaling configuration to be the default. The existing default auto scaling configuration will be set to non-default automatically.AutoScalingConfigurationArn (string) required
apprunner/update_serviceUpdate 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 succesServiceArn (string) required
SourceConfiguration: {
. CodeRepository (object)
. ImageRepository (object)
. AutoDeploymentsEnabled (boolean)
. AuthenticationConfiguration (object)
} (object)
InstanceConfiguration: {
. Cpu (string)
. Memory (string)
. InstanceRoleArn (string)
} (object)
AutoScalingConfigurationArn (string)
HealthCheckConfiguration: {
. Protocol (string)
. Path (string)
. Interval (integer)
. Timeout (integer)
. HealthyThreshold (integer)
. UnhealthyThreshold (integer)
} (object)
NetworkConfiguration: {
. EgressConfiguration (object)
. IngressConfiguration (object)
. IpAddressType (string)
} (object)
ObservabilityConfiguration: {
. ObservabilityEnabled (boolean)
. ObservabilityConfigurationArn (string)
} (object)
apprunner/update_vpc_ingress_connectionUpdate an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated: AVAILABLE FAILED_CREATION FAILED_UPDATEVpcIngressConnectionArn (string) required
IngressVpcConfiguration: {
. VpcId (string)
. VpcEndpointId (string)
} (object) required
appstream/associate_app_block_builder_app_blockAssociates the specified app block builder with the specified app block.AppBlockArn (string) required
AppBlockBuilderName (string) required
appstream/associate_application_fleetAssociates the specified application with the specified fleet. This is only supported for Elastic fleets.FleetName (string) required
ApplicationArn (string) required
appstream/associate_application_to_entitlementAssociates an application to entitle.StackName (string) required
EntitlementName (string) required
ApplicationIdentifier (string) required
appstream/associate_fleetAssociates the specified fleet with the specified stack.FleetName (string) required
StackName (string) required
appstream/associate_software_to_image_builderAssociates license included applications with an existing image builder instance.ImageBuilderName (string) required
SoftwareNames (array) required
appstream/batch_associate_user_stackAssociates 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.UserStackAssociations (array) required
appstream/batch_disassociate_user_stackDisassociates the specified users from the specified stacks.UserStackAssociations (array) required
appstream/copy_imageCopies 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.SourceImageName (string) required
DestinationImageName (string) required
DestinationRegion (string) required
DestinationImageDescription (string)
appstream/create_app_blockCreates an app block. App blocks are a WorkSpaces Applications 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.Name (string) required
Description (string)
DisplayName (string)
SourceS3Location: {
. S3Bucket (string)
. S3Key (string)
} (object) required
SetupScriptDetails: {
. ScriptS3Location (object)
. ExecutablePath (string)
. ExecutableParameters (string)
. TimeoutInSeconds (integer)
} (object)
Tags (object)
PostSetupScriptDetails: {
. ScriptS3Location (object)
. ExecutablePath (string)
. ExecutableParameters (string)
. TimeoutInSeconds (integer)
} (object)
PackagingType (string)
appstream/create_app_block_builderCreates an app block builder.Name (string) required
Description (string)
DisplayName (string)
Tags (object)
Platform (string) required
InstanceType (string) required
VpcConfig: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object) required
EnableDefaultInternetAccess (boolean)
IamRoleArn (string)
AccessEndpoints (array)
appstream/create_app_block_builder_streaming_urlCreates a URL to start a create app block builder streaming session.AppBlockBuilderName (string) required
Validity (integer)
appstream/create_applicationCreates an application. Applications are a WorkSpaces Applications 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.Name (string) required
DisplayName (string)
Description (string)
IconS3Location: {
. S3Bucket (string)
. S3Key (string)
} (object) required
LaunchPath (string) required
WorkingDirectory (string)
LaunchParameters (string)
Platforms (array) required
InstanceFamilies (array) required
AppBlockArn (string) required
Tags (object)
appstream/create_directory_configCreates a Directory Config object in WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.DirectoryName (string) required
OrganizationalUnitDistinguishedNames (array) required
ServiceAccountCredentials: {
. AccountName (string)
. AccountPassword (string)
} (object)
CertificateBasedAuthProperties: {
. Status (string)
. CertificateAuthorityArn (string)
} (object)
appstream/create_entitlementCreates 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. WorkSpaces Applications 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.Name (string) required
StackName (string) required
Description (string)
AppVisibility (string) required
Attributes (array) required
appstream/create_export_image_taskCreates a task to export a WorkSpaces Applications image to an EC2 AMI. This allows you to use your customized WorkSpaces Applications images with other AWS services or for backup purposes.ImageName (string) required
AmiName (string) required
IamRoleArn (string) required
TagSpecifications (object)
AmiDescription (string)
appstream/create_fleetCreates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.Name (string) required
ImageName (string)
ImageArn (string)
InstanceType (string) required
FleetType (string)
ComputeCapacity: {
. DesiredInstances (integer)
. DesiredSessions (integer)
} (object)
VpcConfig: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object)
MaxUserDurationInSeconds (integer)
DisconnectTimeoutInSeconds (integer)
Description (string)
DisplayName (string)
EnableDefaultInternetAccess (boolean)
DomainJoinInfo: {
. DirectoryName (string)
. OrganizationalUnitDistinguishedName (string)
} (object)
Tags (object)
IdleDisconnectTimeoutInSeconds (integer)
IamRoleArn (string)
StreamView (string)
Platform (string)
MaxConcurrentSessions (integer)
UsbDeviceFilterStrings (array)
SessionScriptS3Location: {
. S3Bucket (string)
. S3Key (string)
} (object)
MaxSessionsPerInstance (integer)
RootVolumeConfig: {
. VolumeSizeInGb (integer)
} (object)
appstream/create_image_builderCreates 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.Name (string) required
ImageName (string)
ImageArn (string)
InstanceType (string) required
Description (string)
DisplayName (string)
VpcConfig: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object)
IamRoleArn (string)
EnableDefaultInternetAccess (boolean)
DomainJoinInfo: {
. DirectoryName (string)
. OrganizationalUnitDistinguishedName (string)
} (object)
AppstreamAgentVersion (string)
Tags (object)
AccessEndpoints (array)
RootVolumeConfig: {
. VolumeSizeInGb (integer)
} (object)
SoftwaresToInstall (array)
SoftwaresToUninstall (array)
appstream/create_image_builder_streaming_urlCreates a URL to start an image builder streaming session.Name (string) required
Validity (integer)
appstream/create_imported_imageCreates a custom WorkSpaces Applications image by importing an EC2 AMI. This allows you to use your own customized AMI to create WorkSpaces Applications images that support additional instance types beyond the standard stream. instances.Name (string) required
SourceAmiId (string) required
IamRoleArn (string) required
Description (string)
DisplayName (string)
Tags (object)
RuntimeValidationConfig: {
. IntendedInstanceType (string)
} (object)
AgentSoftwareVersion (string)
AppCatalogConfig (array)
DryRun (boolean)
appstream/create_stackCreates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.Name (string) required
Description (string)
DisplayName (string)
StorageConnectors (array)
RedirectURL (string)
FeedbackURL (string)
UserSettings (array)
ApplicationSettings: {
. Enabled (boolean)
. SettingsGroup (string)
} (object)
Tags (object)
AccessEndpoints (array)
EmbedHostDomains (array)
StreamingExperienceSettings: {
. PreferredProtocol (string)
} (object)
appstream/create_streaming_urlCreates a temporary URL to start an WorkSpaces Applications streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.StackName (string) required
FleetName (string) required
UserId (string) required
ApplicationId (string)
Validity (integer)
SessionContext (string)
appstream/create_theme_for_stackCreates custom branding that customizes the appearance of the streaming application catalog page.StackName (string) required
FooterLinks (array)
TitleText (string) required
ThemeStyling (string) required
OrganizationLogoS3Location: {
. S3Bucket (string)
. S3Key (string)
} (object) required
FaviconS3Location: {
. S3Bucket (string)
. S3Key (string)
} (object) required
appstream/create_updated_imageCreates a new image with the latest Windows operating system updates, driver updates, and WorkSpaces Applications agent software. For more information, see the 'Update an Image by Using Managed WorkSpaces Applications Image Updates' section in Administer Your WorkSpaces Applications Images, in the Amazon WorkSpaces Applications Administration Guide.existingImageName (string) required
newImageName (string) required
newImageDescription (string)
newImageDisplayName (string)
newImageTags (object)
dryRun (boolean)
appstream/create_usage_report_subscriptionCreates a usage report subscription. Usage reports are generated daily.No parameters
appstream/create_userCreates a new user in the user pool.UserName (string) required
MessageAction (string)
FirstName (string)
LastName (string)
AuthenticationType (string) required
appstream/delete_app_blockDeletes an app block.Name (string) required
appstream/delete_app_block_builderDeletes an app block builder. An app block builder can only be deleted when it has no association with an app block.Name (string) required
appstream/delete_applicationDeletes an application.Name (string) required
appstream/delete_directory_configDeletes the specified Directory Config object from WorkSpaces Applications. This object includes the information required to join streaming instances to an Active Directory domain.DirectoryName (string) required
appstream/delete_entitlementDeletes the specified entitlement.Name (string) required
StackName (string) required
appstream/delete_fleetDeletes the specified fleet.Name (string) required
appstream/delete_imageDeletes 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.Name (string) required
appstream/delete_image_builderDeletes the specified image builder and releases the capacity.Name (string) required
appstream/delete_image_permissionsDeletes 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.Name (string) required
SharedAccountId (string) required
appstream/delete_stackDeletes 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.Name (string) required
appstream/delete_theme_for_stackDeletes custom branding that customizes the appearance of the streaming application catalog page.StackName (string) required
appstream/delete_usage_report_subscriptionDisables usage report generation.No parameters
appstream/delete_userDeletes a user from the user pool.UserName (string) required
AuthenticationType (string) required
appstream/describe_app_block_builder_app_block_associationsRetrieves a list that describes one or more app block builder associations.AppBlockArn (string)
AppBlockBuilderName (string)
MaxResults (integer)
NextToken (string)
appstream/describe_app_block_buildersRetrieves a list that describes one or more app block builders.Names (array)
NextToken (string)
MaxResults (integer)
appstream/describe_app_blocksRetrieves a list that describes one or more app blocks.Arns (array)
NextToken (string)
MaxResults (integer)
appstream/describe_application_fleet_associationsRetrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.FleetName (string)
ApplicationArn (string)
MaxResults (integer)
NextToken (string)
appstream/describe_applicationsRetrieves a list that describes one or more applications.Arns (array)
NextToken (string)
MaxResults (integer)
appstream/describe_app_license_usageRetrieves license included application usage information.BillingPeriod (string) required
MaxResults (integer)
NextToken (string)
appstream/describe_directory_configsRetrieves a list that describes one or more specified Directory Config objects for WorkSpaces Applications, 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.DirectoryNames (array)
MaxResults (integer)
NextToken (string)
appstream/describe_entitlementsRetrieves a list that describes one of more entitlements.Name (string)
StackName (string) required
NextToken (string)
MaxResults (integer)
appstream/describe_fleetsRetrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.Names (array)
NextToken (string)
appstream/describe_image_buildersRetrieves 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.Names (array)
MaxResults (integer)
NextToken (string)
appstream/describe_image_permissionsRetrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.Name (string) required
MaxResults (integer)
SharedAwsAccountIds (array)
NextToken (string)
appstream/describe_imagesRetrieves 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.Names (array)
Arns (array)
Type (string)
NextToken (string)
MaxResults (integer)
appstream/describe_sessionsRetrieves 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.StackName (string) required
FleetName (string) required
UserId (string)
NextToken (string)
Limit (integer)
AuthenticationType (string)
InstanceId (string)
appstream/describe_software_associationsRetrieves license included application associations for a specified resource.AssociatedResource (string) required
MaxResults (integer)
NextToken (string)
appstream/describe_stacksRetrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.Names (array)
NextToken (string)
appstream/describe_theme_for_stackRetrieves a list that describes the theme for a specified stack. A theme is custom branding that customizes the appearance of the streaming application catalog page.StackName (string) required
appstream/describe_usage_report_subscriptionsRetrieves a list that describes one or more usage report subscriptions.MaxResults (integer)
NextToken (string)
appstream/describe_usersRetrieves a list that describes one or more specified users in the user pool.AuthenticationType (string) required
MaxResults (integer)
NextToken (string)
appstream/describe_user_stack_associationsRetrieves 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 userStackName (string)
UserName (string)
AuthenticationType (string)
MaxResults (integer)
NextToken (string)
appstream/disable_userDisables the specified user in the user pool. Users can't sign in to WorkSpaces Applications until they are re-enabled. This action does not delete the user.UserName (string) required
AuthenticationType (string) required
appstream/disassociate_app_block_builder_app_blockDisassociates a specified app block builder from a specified app block.AppBlockArn (string) required
AppBlockBuilderName (string) required
appstream/disassociate_application_fleetDisassociates the specified application from the fleet.FleetName (string) required
ApplicationArn (string) required
appstream/disassociate_application_from_entitlementDeletes the specified application from the specified entitlement.StackName (string) required
EntitlementName (string) required
ApplicationIdentifier (string) required
appstream/disassociate_fleetDisassociates the specified fleet from the specified stack.FleetName (string) required
StackName (string) required
appstream/disassociate_software_from_image_builderRemoves license included applications associations from an image builder instance.ImageBuilderName (string) required
SoftwareNames (array) required
appstream/enable_userEnables a user in the user pool. After being enabled, users can sign in to WorkSpaces Applications and open applications from the stacks to which they are assigned.UserName (string) required
AuthenticationType (string) required
appstream/expire_sessionImmediately stops the specified streaming session.SessionId (string) required
appstream/get_export_image_taskRetrieves information about an export image task, including its current state, progress, and any error details.TaskId (string)
appstream/list_associated_fleetsRetrieves the name of the fleet that is associated with the specified stack.StackName (string) required
NextToken (string)
appstream/list_associated_stacksRetrieves the name of the stack with which the specified fleet is associated.FleetName (string) required
NextToken (string)
appstream/list_entitled_applicationsRetrieves a list of entitled applications.StackName (string) required
EntitlementName (string) required
NextToken (string)
MaxResults (integer)
appstream/list_export_image_tasksLists export image tasks, with optional filtering and pagination. Use this operation to monitor the status of multiple export operations.Filters (array)
MaxResults (integer)
NextToken (string)
appstream/list_tags_for_resourceRetrieves a list of all tags for the specified WorkSpaces Applications resource. You can tag WorkSpaces Applications image builders, images, fleets, and stacks. For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.ResourceArn (string) required
appstream/start_app_block_builderStarts an app block builder. An app block builder can only be started when it's associated with an app block. Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.Name (string) required
appstream/start_fleetStarts the specified fleet.Name (string) required
appstream/start_image_builderStarts the specified image builder.Name (string) required
AppstreamAgentVersion (string)
appstream/start_software_deployment_to_image_builderInitiates license included applications deployment to an image builder instance.ImageBuilderName (string) required
RetryFailedDeployments (boolean)
appstream/stop_app_block_builderStops an app block builder. Stopping an app block builder terminates the instance, and the instance state is not persisted.Name (string) required
appstream/stop_fleetStops the specified fleet.Name (string) required
appstream/stop_image_builderStops the specified image builder.Name (string) required
appstream/tag_resourceAdds or overwrites one or more tags for the specified WorkSpaces Applications resource. You can tag WorkSpaces Applications 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 theResourceArn (string) required
Tags (object) required
appstream/untag_resourceDisassociates one or more specified tags from the specified WorkSpaces Applications resource. To list the current tags for your resources, use ListTagsForResource. For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.ResourceArn (string) required
TagKeys (array) required
appstream/update_app_block_builderUpdates an app block builder. If the app block builder is in the STARTING or STOPPING state, you can't update it. If the app block builder is in the RUNNING state, you can only update the DisplayName and Description. If the app block builder is in the STOPPED state, you can update any attribute except the Name.Name (string) required
Description (string)
DisplayName (string)
Platform (string)
InstanceType (string)
VpcConfig: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object)
EnableDefaultInternetAccess (boolean)
IamRoleArn (string)
AccessEndpoints (array)
AttributesToDelete (array)
appstream/update_applicationUpdates the specified application.Name (string) required
DisplayName (string)
Description (string)
IconS3Location: {
. S3Bucket (string)
. S3Key (string)
} (object)
LaunchPath (string)
WorkingDirectory (string)
LaunchParameters (string)
AppBlockArn (string)
AttributesToDelete (array)
appstream/update_directory_configUpdates the specified Directory Config object in WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.DirectoryName (string) required
OrganizationalUnitDistinguishedNames (array)
ServiceAccountCredentials: {
. AccountName (string)
. AccountPassword (string)
} (object)
CertificateBasedAuthProperties: {
. Status (string)
. CertificateAuthorityArn (string)
} (object)
appstream/update_entitlementUpdates the specified entitlement.Name (string) required
StackName (string) required
Description (string)
AppVisibility (string)
Attributes (array)
appstream/update_fleetUpdates 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, DisconnectTimeoutInSecondImageName (string)
ImageArn (string)
Name (string)
InstanceType (string)
ComputeCapacity: {
. DesiredInstances (integer)
. DesiredSessions (integer)
} (object)
VpcConfig: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object)
MaxUserDurationInSeconds (integer)
DisconnectTimeoutInSeconds (integer)
DeleteVpcConfig (boolean)
Description (string)
DisplayName (string)
EnableDefaultInternetAccess (boolean)
DomainJoinInfo: {
. DirectoryName (string)
. OrganizationalUnitDistinguishedName (string)
} (object)
IdleDisconnectTimeoutInSeconds (integer)
AttributesToDelete (array)
IamRoleArn (string)
StreamView (string)
Platform (string)
MaxConcurrentSessions (integer)
UsbDeviceFilterStrings (array)
SessionScriptS3Location: {
. S3Bucket (string)
. S3Key (string)
} (object)
MaxSessionsPerInstance (integer)
RootVolumeConfig: {
. VolumeSizeInGb (integer)
} (object)
appstream/update_image_permissionsAdds or updates permissions for the specified private image.Name (string) required
SharedAccountId (string) required
ImagePermissions: {
. allowFleet (boolean)
. allowImageBuilder (boolean)
} (object) required
appstream/update_stackUpdates the specified fields for the specified stack.DisplayName (string)
Description (string)
Name (string) required
StorageConnectors (array)
DeleteStorageConnectors (boolean)
RedirectURL (string)
FeedbackURL (string)
AttributesToDelete (array)
UserSettings (array)
ApplicationSettings: {
. Enabled (boolean)
. SettingsGroup (string)
} (object)
AccessEndpoints (array)
EmbedHostDomains (array)
StreamingExperienceSettings: {
. PreferredProtocol (string)
} (object)
appstream/update_theme_for_stackUpdates custom branding that customizes the appearance of the streaming application catalog page.StackName (string) required
FooterLinks (array)
TitleText (string)
ThemeStyling (string)
OrganizationLogoS3Location: {
. S3Bucket (string)
. S3Key (string)
} (object)
FaviconS3Location: {
. S3Bucket (string)
. S3Key (string)
} (object)
State (string)
AttributesToDelete (array)
appsync/associate_apiMaps an endpoint to your custom domain.domainName (string) required
apiId (string) required
appsync/associate_merged_graphql_apiCreates an association between a Merged API and source API using the source API's identifier.sourceApiIdentifier (string) required
mergedApiIdentifier (string) required
description (string)
sourceApiAssociationConfig: {
. mergeType (string)
} (object)
appsync/associate_source_graphql_apiCreates an association between a Merged API and source API using the Merged API's identifier.mergedApiIdentifier (string) required
sourceApiIdentifier (string) required
description (string)
sourceApiAssociationConfig: {
. mergeType (string)
} (object)
appsync/create_apiCreates an Api object. Use this operation to create an AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.name (string) required
ownerContact (string)
tags (object)
eventConfig: {
. authProviders (array)
. connectionAuthModes (array)
. defaultPublishAuthModes (array)
. defaultSubscribeAuthModes (array)
. logConfig (object)
} (object) required
appsync/create_api_cacheCreates a cache for the GraphQL API.apiId (string) required
ttl (integer) required
transitEncryptionEnabled (boolean)
atRestEncryptionEnabled (boolean)
apiCachingBehavior (string) required
type (string) required
healthMetricsConfig (string)
appsync/create_api_keyCreates a unique key that you can distribute to clients who invoke your API.apiId (string) required
description (string)
expires (integer)
appsync/create_channel_namespaceCreates a ChannelNamespace for an Api.apiId (string) required
name (string) required
subscribeAuthModes (array)
publishAuthModes (array)
codeHandlers (string)
tags (object)
handlerConfigs: {
. onPublish (object)
. onSubscribe (object)
} (object)
appsync/create_data_sourceCreates a DataSource object.apiId (string) required
name (string) required
description (string)
type (string) required
serviceRoleArn (string)
dynamodbConfig: {
. tableName (string)
. awsRegion (string)
. useCallerCredentials (boolean)
. deltaSyncConfig (object)
. versioned (boolean)
} (object)
lambdaConfig: {
. lambdaFunctionArn (string)
} (object)
elasticsearchConfig: {
. endpoint (string)
. awsRegion (string)
} (object)
openSearchServiceConfig: {
. endpoint (string)
. awsRegion (string)
} (object)
httpConfig: {
. endpoint (string)
. authorizationConfig (object)
} (object)
relationalDatabaseConfig: {
. relationalDatabaseSourceType (string)
. rdsHttpEndpointConfig (object)
} (object)
eventBridgeConfig: {
. eventBusArn (string)
} (object)
metricsConfig (string)
appsync/create_domain_nameCreates a custom DomainName object.domainName (string) required
certificateArn (string) required
description (string)
tags (object)
appsync/create_functionCreates a Function object. A function is a reusable entity. You can use multiple functions to compose the resolver logic.apiId (string) required
name (string) required
description (string)
dataSourceName (string) required
requestMappingTemplate (string)
responseMappingTemplate (string)
functionVersion (string)
syncConfig: {
. conflictHandler (string)
. conflictDetection (string)
. lambdaConflictHandlerConfig (object)
} (object)
maxBatchSize (integer)
runtime: {
. name (string)
. runtimeVersion (string)
} (object)
code (string)
appsync/create_graphql_apiCreates a GraphqlApi object.name (string) required
logConfig: {
. fieldLogLevel (string)
. cloudWatchLogsRoleArn (string)
. excludeVerboseContent (boolean)
} (object)
authenticationType (string) required
userPoolConfig: {
. userPoolId (string)
. awsRegion (string)
. defaultAction (string)
. appIdClientRegex (string)
} (object)
openIDConnectConfig: {
. issuer (string)
. clientId (string)
. iatTTL (integer)
. authTTL (integer)
} (object)
tags (object)
additionalAuthenticationProviders (array)
xrayEnabled (boolean)
lambdaAuthorizerConfig: {
. authorizerResultTtlInSeconds (integer)
. authorizerUri (string)
. identityValidationExpression (string)
} (object)
apiType (string)
mergedApiExecutionRoleArn (string)
visibility (string)
ownerContact (string)
introspectionConfig (string)
queryDepthLimit (integer)
resolverCountLimit (integer)
enhancedMetricsConfig: {
. resolverLevelMetricsBehavior (string)
. dataSourceLevelMetricsBehavior (string)
. operationLevelMetricsConfig (string)
} (object)
appsync/create_resolverCreates 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.apiId (string) required
typeName (string) required
fieldName (string) required
dataSourceName (string)
requestMappingTemplate (string)
responseMappingTemplate (string)
kind (string)
pipelineConfig: {
. functions (array)
} (object)
syncConfig: {
. conflictHandler (string)
. conflictDetection (string)
. lambdaConflictHandlerConfig (object)
} (object)
cachingConfig: {
. ttl (integer)
. cachingKeys (array)
} (object)
maxBatchSize (integer)
runtime: {
. name (string)
. runtimeVersion (string)
} (object)
code (string)
metricsConfig (string)
appsync/create_typeCreates a Type object.apiId (string) required
definition (string) required
format (string) required
appsync/delete_apiDeletes an Api objectapiId (string) required
appsync/delete_api_cacheDeletes an ApiCache object.apiId (string) required
appsync/delete_api_keyDeletes an API key.apiId (string) required
id (string) required
appsync/delete_channel_namespaceDeletes a ChannelNamespace.apiId (string) required
name (string) required
appsync/delete_data_sourceDeletes a DataSource object.apiId (string) required
name (string) required
appsync/delete_domain_nameDeletes a custom DomainName object.domainName (string) required
appsync/delete_functionDeletes a Function.apiId (string) required
functionId (string) required
appsync/delete_graphql_apiDeletes a GraphqlApi object.apiId (string) required
appsync/delete_resolverDeletes a Resolver object.apiId (string) required
typeName (string) required
fieldName (string) required
appsync/delete_typeDeletes a Type object.apiId (string) required
typeName (string) required
appsync/disassociate_apiRemoves an ApiAssociation object from a custom domain.domainName (string) required
appsync/disassociate_merged_graphql_apiDeletes an association between a Merged API and source API using the source API's identifier and the association ID.sourceApiIdentifier (string) required
associationId (string) required
appsync/disassociate_source_graphql_apiDeletes an association between a Merged API and source API using the Merged API's identifier and the association ID.mergedApiIdentifier (string) required
associationId (string) required
appsync/evaluate_codeEvaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type.runtime: {
. name (string)
. runtimeVersion (string)
} (object) required
code (string) required
context (string) required
function (string)
appsync/evaluate_mapping_templateEvaluates 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.template (string) required
context (string) required
appsync/flush_api_cacheFlushes an ApiCache object.apiId (string) required
appsync/get_apiRetrieves an Api object.apiId (string) required
appsync/get_api_associationRetrieves an ApiAssociation object.domainName (string) required
appsync/get_api_cacheRetrieves an ApiCache object.apiId (string) required
appsync/get_channel_namespaceRetrieves the channel namespace for a specified Api.apiId (string) required
name (string) required
appsync/get_data_sourceRetrieves a DataSource object.apiId (string) required
name (string) required
appsync/get_data_source_introspectionRetrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.introspectionId (string) required
includeModelsSDL (boolean)
nextToken (string)
maxResults (integer)
appsync/get_domain_nameRetrieves a custom DomainName object.domainName (string) required
appsync/get_functionGet a Function.apiId (string) required
functionId (string) required
appsync/get_graphql_apiRetrieves a GraphqlApi object.apiId (string) required
appsync/get_graphql_api_environment_variablesRetrieves the list of environmental variable key-value pairs associated with an API by its ID value.apiId (string) required
appsync/get_introspection_schemaRetrieves the introspection schema for a GraphQL API.apiId (string) required
format (string) required
includeDirectives (boolean)
appsync/get_resolverRetrieves a Resolver object.apiId (string) required
typeName (string) required
fieldName (string) required
appsync/get_schema_creation_statusRetrieves the current status of a schema creation operation.apiId (string) required
appsync/get_source_api_associationRetrieves a SourceApiAssociation object.mergedApiIdentifier (string) required
associationId (string) required
appsync/get_typeRetrieves a Type object.apiId (string) required
typeName (string) required
format (string) required
appsync/list_api_keysLists 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.apiId (string) required
nextToken (string)
maxResults (integer)
appsync/list_apisLists the APIs in your AppSync account. ListApis returns only the high level API details. For more detailed information about an API, use GetApi.nextToken (string)
maxResults (integer)
appsync/list_channel_namespacesLists the channel namespaces for a specified Api. ListChannelNamespaces returns only high level details for the channel namespace. To retrieve code handlers, use GetChannelNamespace.apiId (string) required
nextToken (string)
maxResults (integer)
appsync/list_data_sourcesLists the data sources for a given API.apiId (string) required
nextToken (string)
maxResults (integer)
appsync/list_domain_namesLists multiple custom domain names.nextToken (string)
maxResults (integer)
appsync/list_functionsList multiple functions.apiId (string) required
nextToken (string)
maxResults (integer)
appsync/list_graphql_apisLists your GraphQL APIs.nextToken (string)
maxResults (integer)
apiType (string)
owner (string)
appsync/list_resolversLists the resolvers for a given API and type.apiId (string) required
typeName (string) required
nextToken (string)
maxResults (integer)
appsync/list_resolvers_by_functionList the resolvers that are associated with a specific function.apiId (string) required
functionId (string) required
nextToken (string)
maxResults (integer)
appsync/list_source_api_associationsLists the SourceApiAssociationSummary data.apiId (string) required
nextToken (string)
maxResults (integer)
appsync/list_tags_for_resourceLists the tags for a resource.resourceArn (string) required
appsync/list_typesLists the types for a given API.apiId (string) required
format (string) required
nextToken (string)
maxResults (integer)
appsync/list_types_by_associationLists Type objects by the source API association ID.mergedApiIdentifier (string) required
associationId (string) required
format (string) required
nextToken (string)
maxResults (integer)
appsync/put_graphql_api_environment_variablesCreates a list of environmental variables in an API by its ID value. When creating an environmental variable, it must follow the constraints below: Both JavaScript and VTL templates support environmental variables. Environmental variables are not evaluated before function invocation. Environmental variables only support string values. Any defined value in an environmental variable is considered a string literal and not expanded. Variable evaluations should ideally be performed in the function coapiId (string) required
environmentVariables (object) required
appsync/start_data_source_introspectionCreates a new introspection. Returns the introspectionId of the new introspection after its creation.rdsDataApiConfig: {
. resourceArn (string)
. secretArn (string)
. databaseName (string)
} (object)
appsync/start_schema_creationAdds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed.apiId (string) required
definition (string) required
appsync/start_schema_mergeInitiates a merge operation. Returns a status that shows the result of the merge operation.associationId (string) required
mergedApiIdentifier (string) required
appsync/tag_resourceTags a resource with user-supplied tags.resourceArn (string) required
tags (object) required
appsync/untag_resourceUntags a resource.resourceArn (string) required
tagKeys (array) required
appsync/update_apiUpdates an Api.apiId (string) required
name (string) required
ownerContact (string)
eventConfig: {
. authProviders (array)
. connectionAuthModes (array)
. defaultPublishAuthModes (array)
. defaultSubscribeAuthModes (array)
. logConfig (object)
} (object) required
appsync/update_api_cacheUpdates the cache for the GraphQL API.apiId (string) required
ttl (integer) required
apiCachingBehavior (string) required
type (string) required
healthMetricsConfig (string)
appsync/update_api_keyUpdates an API key. You can update the key as long as it's not deleted.apiId (string) required
id (string) required
description (string)
expires (integer)
appsync/update_channel_namespaceUpdates a ChannelNamespace associated with an Api.apiId (string) required
name (string) required
subscribeAuthModes (array)
publishAuthModes (array)
codeHandlers (string)
handlerConfigs: {
. onPublish (object)
. onSubscribe (object)
} (object)
appsync/update_data_sourceUpdates a DataSource object.apiId (string) required
name (string) required
description (string)
type (string) required
serviceRoleArn (string)
dynamodbConfig: {
. tableName (string)
. awsRegion (string)
. useCallerCredentials (boolean)
. deltaSyncConfig (object)
. versioned (boolean)
} (object)
lambdaConfig: {
. lambdaFunctionArn (string)
} (object)
elasticsearchConfig: {
. endpoint (string)
. awsRegion (string)
} (object)
openSearchServiceConfig: {
. endpoint (string)
. awsRegion (string)
} (object)
httpConfig: {
. endpoint (string)
. authorizationConfig (object)
} (object)
relationalDatabaseConfig: {
. relationalDatabaseSourceType (string)
. rdsHttpEndpointConfig (object)
} (object)
eventBridgeConfig: {
. eventBusArn (string)
} (object)
metricsConfig (string)
appsync/update_domain_nameUpdates a custom DomainName object.domainName (string) required
description (string)
appsync/update_functionUpdates a Function object.apiId (string) required
name (string) required
description (string)
functionId (string) required
dataSourceName (string) required
requestMappingTemplate (string)
responseMappingTemplate (string)
functionVersion (string)
syncConfig: {
. conflictHandler (string)
. conflictDetection (string)
. lambdaConflictHandlerConfig (object)
} (object)
maxBatchSize (integer)
runtime: {
. name (string)
. runtimeVersion (string)
} (object)
code (string)
appsync/update_graphql_apiUpdates a GraphqlApi object.apiId (string) required
name (string) required
logConfig: {
. fieldLogLevel (string)
. cloudWatchLogsRoleArn (string)
. excludeVerboseContent (boolean)
} (object)
authenticationType (string) required
userPoolConfig: {
. userPoolId (string)
. awsRegion (string)
. defaultAction (string)
. appIdClientRegex (string)
} (object)
openIDConnectConfig: {
. issuer (string)
. clientId (string)
. iatTTL (integer)
. authTTL (integer)
} (object)
additionalAuthenticationProviders (array)
xrayEnabled (boolean)
lambdaAuthorizerConfig: {
. authorizerResultTtlInSeconds (integer)
. authorizerUri (string)
. identityValidationExpression (string)
} (object)
mergedApiExecutionRoleArn (string)
ownerContact (string)
introspectionConfig (string)
queryDepthLimit (integer)
resolverCountLimit (integer)
enhancedMetricsConfig: {
. resolverLevelMetricsBehavior (string)
. dataSourceLevelMetricsBehavior (string)
. operationLevelMetricsConfig (string)
} (object)
appsync/update_resolverUpdates a Resolver object.apiId (string) required
typeName (string) required
fieldName (string) required
dataSourceName (string)
requestMappingTemplate (string)
responseMappingTemplate (string)
kind (string)
pipelineConfig: {
. functions (array)
} (object)
syncConfig: {
. conflictHandler (string)
. conflictDetection (string)
. lambdaConflictHandlerConfig (object)
} (object)
cachingConfig: {
. ttl (integer)
. cachingKeys (array)
} (object)
maxBatchSize (integer)
runtime: {
. name (string)
. runtimeVersion (string)
} (object)
code (string)
metricsConfig (string)
appsync/update_source_api_associationUpdates some of the configuration choices of a particular source API association.associationId (string) required
mergedApiIdentifier (string) required
description (string)
sourceApiAssociationConfig: {
. mergeType (string)
} (object)
appsync/update_typeUpdates a Type object.apiId (string) required
typeName (string) required
definition (string)
format (string) required
arc_region_switch/approve_plan_execution_stepApproves a step in a plan execution that requires manual approval. When you create a plan, you can include approval steps that require manual intervention before the execution can proceed. This operation allows you to provide that approval. You must specify the plan ARN, execution ID, step name, and approval status. You can also provide an optional comment explaining the approval decision.planArn (string) required
executionId (string) required
stepName (string) required
approval (string) required
comment (string)
arc_region_switch/cancel_plan_executionCancels an in-progress plan execution. This operation stops the execution of the plan and prevents any further steps from being processed. You must specify the plan ARN and execution ID. You can also provide an optional comment explaining why the execution was canceled.planArn (string) required
executionId (string) required
comment (string)
arc_region_switch/get_plan_evaluation_statusRetrieves the evaluation status of a Region switch plan. The evaluation status provides information about the last time the plan was evaluated and any warnings or issues detected.planArn (string) required
maxResults (integer)
nextToken (string)
arc_region_switch/get_plan_executionRetrieves detailed information about a specific plan execution. You must specify the plan ARN and execution ID.planArn (string) required
executionId (string) required
maxResults (integer)
nextToken (string)
arc_region_switch/get_plan_in_regionRetrieves information about a Region switch plan in a specific Amazon Web Services Region. This operation is useful for getting Region-specific information about a plan.arn (string) required
arc_region_switch/list_plan_execution_eventsLists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.planArn (string) required
executionId (string) required
maxResults (integer)
nextToken (string)
name (string)
arc_region_switch/list_plan_executionsLists the executions of a Region switch plan. This operation returns information about both current and historical executions.planArn (string) required
maxResults (integer)
nextToken (string)
state (string)
arc_region_switch/list_plans_in_regionLists all Region switch plans in your Amazon Web Services account that are available in the current Amazon Web Services Region.maxResults (integer)
nextToken (string)
arc_region_switch/list_route53health_checksList the Amazon Route 53 health checks.arn (string) required
hostedZoneId (string)
recordName (string)
maxResults (integer)
nextToken (string)
arc_region_switch/list_route53health_checks_in_regionList the Amazon Route 53 health checks in a specific Amazon Web Services Region.arn (string) required
hostedZoneId (string)
recordName (string)
maxResults (integer)
nextToken (string)
arc_region_switch/start_plan_executionStarts the execution of a Region switch plan. You can execute a plan in either PRACTICE or RECOVERY mode. In PRACTICE mode, the execution simulates the steps without making actual changes to your application's traffic routing. In RECOVERY mode, the execution performs actual changes to shift traffic between Regions.planArn (string) required
targetRegion (string) required
action (string) required
mode (string)
comment (string)
latestVersion (string)
arc_region_switch/update_plan_executionUpdates an in-progress plan execution. This operation allows you to modify certain aspects of the execution, such as adding a comment or changing the action.planArn (string) required
executionId (string) required
action (string) required
comment (string)
arc_region_switch/update_plan_execution_stepUpdates a specific step in an in-progress plan execution. This operation allows you to modify the step's comment or action.planArn (string) required
executionId (string) required
comment (string) required
stepName (string) required
actionToTake (string) required
arc_region_switch/list_tags_for_resourceLists the tags attached to a Region switch resource.arn (string) required
arc_region_switch/tag_resourceAdds or updates tags for a Region switch resource. You can assign metadata to your resources in the form of tags, which are key-value pairs.arn (string) required
tags (object) required
arc_region_switch/untag_resourceRemoves tags from a Region switch resource.arn (string) required
resourceTagKeys (array) required
arc_region_switch/create_planCreates a new Region switch plan. A plan defines the steps required to shift traffic from one Amazon Web Services Region to another. You must specify a name for the plan, the primary Region, and at least one additional Region. You can also provide a description, execution role, recovery time objective, associated alarms, triggers, and workflows that define the steps to execute during a Region switch.description (string)
workflows (array) required
executionRole (string) required
recoveryTimeObjectiveMinutes (integer)
associatedAlarms (object)
triggers (array)
reportConfiguration: {
. reportOutput (array)
} (object)
name (string) required
regions (array) required
recoveryApproach (string) required
primaryRegion (string)
tags (object)
arc_region_switch/get_planRetrieves detailed information about a Region switch plan. You must specify the ARN of the plan.arn (string) required
arc_region_switch/update_planUpdates an existing Region switch plan. You can modify the plan's description, workflows, execution role, recovery time objective, associated alarms, and triggers.arn (string) required
description (string)
workflows (array) required
executionRole (string) required
recoveryTimeObjectiveMinutes (integer)
associatedAlarms (object)
triggers (array)
reportConfiguration: {
. reportOutput (array)
} (object)
arc_region_switch/delete_planDeletes a Region switch plan. You must specify the ARN of the plan to delete. You cannot delete a plan that has an active execution in progress.arn (string) required
arc_region_switch/list_plansLists all Region switch plans in your Amazon Web Services account.maxResults (integer)
nextToken (string)
arc_zonal_shift/list_autoshiftsReturns the autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts.nextToken (string)
status (string)
maxResults (integer)
arc_zonal_shift/get_autoshift_observer_notification_statusReturns the status of the autoshift observer notification. Autoshift observer notifications notify you through Amazon EventBridge when there is an autoshift event for zonal autoshift. The status can be ENABLED or DISABLED. When ENABLED, a notification is sent when an autoshift is triggered. When DISABLED, notifications are not sent.No parameters
arc_zonal_shift/update_autoshift_observer_notification_statusUpdate the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift. If the status is ENABLED, ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift. For more information, see Notificationsstatus (string) required
arc_zonal_shift/update_zonal_autoshift_configurationThe zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuration, ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone. You can update the zonal autoshift status to enable or disableresourceIdentifier (string) required
zonalAutoshiftStatus (string) required
arc_zonal_shift/get_managed_resourceGet information about a resource that's been registered for zonal shifts with Amazon Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in ARC. You can start zonal shifts and configure zonal autoshift for managed resources.resourceIdentifier (string) required
arc_zonal_shift/list_managed_resourcesLists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name ARN, the Availability Zones that each resource is deployed in, and the resource name.nextToken (string)
maxResults (integer)
arc_zonal_shift/create_practice_run_configurationA practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting. When a resource has a practice run configuration, ARC startresourceIdentifier (string) required
blockedWindows (array)
blockedDates (array)
blockingAlarms (array)
allowedWindows (array)
outcomeAlarms (array) required
arc_zonal_shift/update_practice_run_configurationUpdate a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.resourceIdentifier (string) required
blockedWindows (array)
blockedDates (array)
blockingAlarms (array)
allowedWindows (array)
outcomeAlarms (array)
arc_zonal_shift/delete_practice_run_configurationDeletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.resourceIdentifier (string) required
arc_zonal_shift/cancel_practice_runCancel an in-progress practice run zonal shift in Amazon Application Recovery Controller.zonalShiftId (string) required
arc_zonal_shift/cancel_zonal_shiftCancel a zonal shift in Amazon Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID. A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift.zonalShiftId (string) required
arc_zonal_shift/update_zonal_shiftUpdate an active zonal shift in Amazon Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or edit or replace the comment for the zonal shift.zonalShiftId (string) required
comment (string)
expiresIn (string)
arc_zonal_shift/start_practice_runStart an on-demand practice run zonal shift in Amazon Application Recovery Controller. With zonal autoshift enabled, you can start an on-demand practice run to verify preparedness at any time. Amazon Web Services also runs automated practice runs about weekly when you have enabled zonal autoshift. For more information, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.resourceIdentifier (string) required
awayFrom (string) required
comment (string) required
arc_zonal_shift/start_zonal_shiftYou start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with ARC by AmaresourceIdentifier (string) required
awayFrom (string) required
expiresIn (string) required
comment (string) required
arc_zonal_shift/list_zonal_shiftsLists all active and completed zonal shifts in Amazon Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that ARC started on your behalf for zonal autoshift. For more information about listing autoshifts, see 'ListAutoshifts.nextToken (string)
status (string)
maxResults (integer)
resourceIdentifier (string)
artifact/get_account_settingsGet the account settings for Artifact.No parameters
artifact/put_account_settingsPut the account settings for Artifact.notificationSubscriptionStatus (string)
artifact/list_customer_agreementsList active customer-agreements applicable to calling identity.maxResults (integer)
nextToken (string)
artifact/get_reportGet the content for a single report.reportId (string) required
reportVersion (integer)
termToken (string) required
artifact/get_term_for_reportGet the Term content associated with a single report.reportId (string) required
reportVersion (integer)
artifact/list_report_versionsList available report versions for a given report.reportId (string) required
maxResults (integer)
nextToken (string)
artifact/get_report_metadataGet the metadata for a single report.reportId (string) required
reportVersion (integer)
artifact/list_reportsList available reports.maxResults (integer)
nextToken (string)
athena/batch_get_named_queryReturns 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 BatchGetQueryNamedQueryIds (array) required
athena/batch_get_prepared_statementReturns 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.PreparedStatementNames (array) required
WorkGroup (string) required
athena/batch_get_query_executionReturns 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.QueryExecutionIds (array) required
athena/cancel_capacity_reservationCancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.Name (string) required
athena/create_capacity_reservationCreates a capacity reservation with the specified name and number of requested data processing units.TargetDpus (integer) required
Name (string) required
Tags (array)
athena/create_data_catalogCreates registers a data catalog with the specified name and properties. Catalogs created are visible to all users of the same Amazon Web Services account. For a FEDERATED catalog, this API operation creates the following resources. CFN Stack Name with a maximum length of 128 characters and prefix athenafederatedcatalog-CATALOG_NAME_SANITIZED with length 23 characters. Lambda Function Name with a maximum length of 64 characters and prefix athenafederatedcatalog_CATALOG_NAME_SANITIZED with lengthName (string) required
Type (string) required
Description (string)
Parameters (object)
Tags (array)
athena/create_named_queryCreates a named query in the specified workgroup. Requires that you have access to the workgroup.Name (string) required
Description (string)
Database (string) required
QueryString (string) required
ClientRequestToken (string)
WorkGroup (string)
athena/create_notebookCreates an empty ipynb file in the specified Apache Spark enabled workgroup. Throws an error if a file in the workgroup with the same name already exists.WorkGroup (string) required
Name (string) required
ClientRequestToken (string)
athena/create_prepared_statementCreates a prepared statement for use with SQL queries in Athena.StatementName (string) required
WorkGroup (string) required
QueryStatement (string) required
Description (string)
athena/create_presigned_notebook_urlGets an authentication token and the URL at which the notebook can be accessed. During programmatic access, CreatePresignedNotebookUrl must be called every 10 minutes to refresh the authentication token. For information about granting programmatic access, see Grant programmatic access.SessionId (string) required
athena/create_work_groupCreates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.Name (string) required
Configuration: {
. ResultConfiguration (object)
. ManagedQueryResultsConfiguration (object)
. EnforceWorkGroupConfiguration (boolean)
. PublishCloudWatchMetricsEnabled (boolean)
. BytesScannedCutoffPerQuery (integer)
. RequesterPaysEnabled (boolean)
. EngineVersion (object)
. AdditionalConfiguration (string)
. ExecutionRole (string)
. MonitoringConfiguration (object)
. EngineConfiguration (object)
. CustomerContentEncryptionConfiguration (object)
. EnableMinimumEncryptionConfiguration (boolean)
. IdentityCenterConfiguration (object)
. QueryResultsS3AccessGrantsConfiguration (object)
} (object)
Description (string)
Tags (array)
athena/delete_capacity_reservationDeletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation, and deleted reservations do not appear in the output of ListCapacityReservations.Name (string) required
athena/delete_data_catalogDeletes a data catalog.Name (string) required
DeleteCatalogOnly (boolean)
athena/delete_named_queryDeletes the named query if you have access to the workgroup in which the query was saved.NamedQueryId (string) required
athena/delete_notebookDeletes the specified notebook.NotebookId (string) required
athena/delete_prepared_statementDeletes the prepared statement with the specified name from the specified workgroup.StatementName (string) required
WorkGroup (string) required
athena/delete_work_groupDeletes the workgroup with the specified name. The primary workgroup cannot be deleted.WorkGroup (string) required
RecursiveDeleteOption (boolean)
athena/export_notebookExports the specified notebook and its metadata.NotebookId (string) required
athena/get_calculation_executionDescribes a previously submitted calculation execution.CalculationExecutionId (string) required
athena/get_calculation_execution_codeRetrieves the unencrypted code that was executed for the calculation.CalculationExecutionId (string) required
athena/get_calculation_execution_statusGets the status of a current calculation.CalculationExecutionId (string) required
athena/get_capacity_assignment_configurationGets the capacity assignment configuration for a capacity reservation, if one exists.CapacityReservationName (string) required
athena/get_capacity_reservationReturns information about the capacity reservation with the specified name.Name (string) required
athena/get_databaseReturns a database object for the specified database and data catalog.CatalogName (string) required
DatabaseName (string) required
WorkGroup (string)
athena/get_data_catalogReturns the specified data catalog.Name (string) required
WorkGroup (string)
athena/get_named_queryReturns information about a single query. Requires that you have access to the workgroup in which the query was saved.NamedQueryId (string) required
athena/get_notebook_metadataRetrieves notebook metadata for the specified notebook ID.NotebookId (string) required
athena/get_prepared_statementRetrieves the prepared statement with the specified name from the specified workgroup.StatementName (string) required
WorkGroup (string) required
athena/get_query_executionReturns 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.QueryExecutionId (string) required
athena/get_query_resultsStreams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Working with query results, recent queries, and output files 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 GetObjecQueryExecutionId (string) required
NextToken (string)
MaxResults (integer)
QueryResultType (string)
athena/get_query_runtime_statisticsReturns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Statistics from the Timeline section of the response object are available as soon as QueryExecutionStatus$State is in a SUCCEEDED or FAILED state. The remaining non-timeline statistics in the response like stage-level input and output row count and data size are updated asynchronously and may not be available immediately after a query completes or, in soQueryExecutionId (string) required
athena/get_resource_dashboardGets the Live UI/Persistence UI for a session.ResourceARN (string) required
athena/get_sessionGets the full details of a previously created session, including the session status and configuration.SessionId (string) required
athena/get_session_endpointGets a connection endpoint and authentication token for a given session Id.SessionId (string) required
athena/get_session_statusGets the current status of a session.SessionId (string) required
athena/get_table_metadataReturns table metadata for the specified catalog, database, and table.CatalogName (string) required
DatabaseName (string) required
TableName (string) required
WorkGroup (string)
athena/get_work_groupReturns information about the workgroup with the specified name.WorkGroup (string) required
athena/import_notebookImports a single ipynb file to a Spark enabled workgroup. To import the notebook, the request must specify a value for either Payload or NoteBookS3LocationUri. If neither is specified or both are specified, an InvalidRequestException occurs. The maximum file size that can be imported is 10 megabytes. If an ipynb file with the same name already exists in the workgroup, throws an error.WorkGroup (string) required
Name (string) required
Payload (string)
Type (string) required
NotebookS3LocationUri (string)
ClientRequestToken (string)
athena/list_application_dpusizesReturns the supported DPU sizes for the supported application runtimes for example, Athena notebook version 1.MaxResults (integer)
NextToken (string)
athena/list_calculation_executionsLists the calculations that have been submitted to a session in descending order. Newer calculations are listed first; older calculations are listed later.SessionId (string) required
StateFilter (string)
MaxResults (integer)
NextToken (string)
athena/list_capacity_reservationsLists the capacity reservations for the current account.NextToken (string)
MaxResults (integer)
athena/list_databasesLists the databases in the specified data catalog.CatalogName (string) required
NextToken (string)
MaxResults (integer)
WorkGroup (string)
athena/list_data_catalogsLists the data catalogs in the current Amazon Web Services account. In the Athena console, data catalogs are listed as 'data sources' on the Data sources page under the Data source name column.NextToken (string)
MaxResults (integer)
WorkGroup (string)
athena/list_engine_versionsReturns a list of engine versions that are available to choose from, including the Auto option.NextToken (string)
MaxResults (integer)
athena/list_executorsLists, in descending order, the executors that joined a session. Newer executors are listed first; older executors are listed later. The result can be optionally filtered by state.SessionId (string) required
ExecutorStateFilter (string)
MaxResults (integer)
NextToken (string)
athena/list_named_queriesProvides 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.NextToken (string)
MaxResults (integer)
WorkGroup (string)
athena/list_notebook_metadataDisplays the notebook files for the specified workgroup in paginated format.Filters: {
. Name (string)
} (object)
NextToken (string)
MaxResults (integer)
WorkGroup (string) required
athena/list_notebook_sessionsLists, in descending order, the sessions that have been created in a notebook that are in an active state like CREATING, CREATED, IDLE or BUSY. Newer sessions are listed first; older sessions are listed later.NotebookId (string) required
MaxResults (integer)
NextToken (string)
athena/list_prepared_statementsLists the prepared statements in the specified workgroup.WorkGroup (string) required
NextToken (string)
MaxResults (integer)
athena/list_query_executionsProvides a list of available query execution IDs for the queries in the specified workgroup. Athena keeps a query history for 45 days. 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.NextToken (string)
MaxResults (integer)
WorkGroup (string)
athena/list_sessionsLists the sessions in a workgroup that are in an active state like CREATING, CREATED, IDLE, or BUSY. Newer sessions are listed first; older sessions are listed later.WorkGroup (string) required
StateFilter (string)
MaxResults (integer)
NextToken (string)
athena/list_table_metadataLists the metadata for the tables in the specified data catalog database.CatalogName (string) required
DatabaseName (string) required
Expression (string)
NextToken (string)
MaxResults (integer)
WorkGroup (string)
athena/list_tags_for_resourceLists the tags associated with an Athena resource.ResourceARN (string) required
NextToken (string)
MaxResults (integer)
athena/list_work_groupsLists available workgroups for the account.NextToken (string)
MaxResults (integer)
athena/put_capacity_assignment_configurationPuts a new capacity assignment configuration for a specified capacity reservation. If a capacity assignment configuration already exists for the capacity reservation, replaces the existing capacity assignment configuration.CapacityReservationName (string) required
CapacityAssignments (array) required
athena/start_calculation_executionSubmits calculations for execution within a session. You can supply the code to run as an inline code block within the request. The request syntax requires the StartCalculationExecutionRequest$CodeBlock parameter or the CalculationConfiguration$CodeBlock parameter, but not both. Because CalculationConfiguration$CodeBlock is deprecated, use the StartCalculationExecutionRequest$CodeBlock parameter instead.SessionId (string) required
Description (string)
CalculationConfiguration: {
. CodeBlock (string)
} (object)
CodeBlock (string)
ClientRequestToken (string)
athena/start_query_executionRuns 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.QueryString (string) required
ClientRequestToken (string)
QueryExecutionContext: {
. Database (string)
. Catalog (string)
} (object)
ResultConfiguration: {
. OutputLocation (string)
. EncryptionConfiguration (object)
. ExpectedBucketOwner (string)
. AclConfiguration (object)
} (object)
WorkGroup (string)
ExecutionParameters (array)
ResultReuseConfiguration: {
. ResultReuseByAgeConfiguration (object)
} (object)
EngineConfiguration: {
. CoordinatorDpuSize (integer)
. MaxConcurrentDpus (integer)
. DefaultExecutorDpuSize (integer)
. AdditionalConfigs (object)
. SparkProperties (object)
. Classifications (array)
} (object)
athena/start_sessionCreates a session for running calculations within a workgroup. The session is ready when it reaches an IDLE state.Description (string)
WorkGroup (string) required
EngineConfiguration: {
. CoordinatorDpuSize (integer)
. MaxConcurrentDpus (integer)
. DefaultExecutorDpuSize (integer)
. AdditionalConfigs (object)
. SparkProperties (object)
. Classifications (array)
} (object) required
ExecutionRole (string)
MonitoringConfiguration: {
. CloudWatchLoggingConfiguration (object)
. ManagedLoggingConfiguration (object)
. S3LoggingConfiguration (object)
} (object)
NotebookVersion (string)
SessionIdleTimeoutInMinutes (integer)
ClientRequestToken (string)
Tags (array)
CopyWorkGroupTags (boolean)
athena/stop_calculation_executionRequests the cancellation of a calculation. A StopCalculationExecution call on a calculation that is already in a terminal state for example, STOPPED, FAILED, or COMPLETED succeeds but has no effect. Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.CalculationExecutionId (string) required
athena/stop_query_executionStops a query execution. Requires you to have access to the workgroup in which the query ran.QueryExecutionId (string) required
athena/tag_resourceAdds one or more tags to an Athena resource. A tag is a label that you assign to a resource. 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, data catalogs, or capacity reservations by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter the resources in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 UnicodResourceARN (string) required
Tags (array) required
athena/terminate_sessionTerminates an active session. A TerminateSession call on a session that is already inactive for example, in a FAILED, TERMINATED or TERMINATING state succeeds but has no effect. Calculations running in the session when TerminateSession is called are forcefully stopped, but may display as FAILED instead of STOPPED.SessionId (string) required
athena/untag_resourceRemoves one or more tags from an Athena resource.ResourceARN (string) required
TagKeys (array) required
athena/update_capacity_reservationUpdates the number of requested data processing units for the capacity reservation with the specified name.TargetDpus (integer) required
Name (string) required
athena/update_data_catalogUpdates the data catalog that has the specified name.Name (string) required
Type (string) required
Description (string)
Parameters (object)
athena/update_named_queryUpdates a NamedQuery object. The database or workgroup cannot be updated.NamedQueryId (string) required
Name (string) required
Description (string)
QueryString (string) required
athena/update_notebookUpdates the contents of a Spark notebook.NotebookId (string) required
Payload (string) required
Type (string) required
SessionId (string)
ClientRequestToken (string)
athena/update_notebook_metadataUpdates the metadata for a notebook.NotebookId (string) required
ClientRequestToken (string)
Name (string) required
athena/update_prepared_statementUpdates a prepared statement.StatementName (string) required
WorkGroup (string) required
QueryStatement (string) required
Description (string)
athena/update_work_groupUpdates the workgroup with the specified name. The workgroup's name cannot be changed. Only ConfigurationUpdates can be specified.WorkGroup (string) required
Description (string)
ConfigurationUpdates: {
. EnforceWorkGroupConfiguration (boolean)
. ResultConfigurationUpdates (object)
. ManagedQueryResultsConfigurationUpdates (object)
. PublishCloudWatchMetricsEnabled (boolean)
. BytesScannedCutoffPerQuery (integer)
. RemoveBytesScannedCutoffPerQuery (boolean)
. RequesterPaysEnabled (boolean)
. EngineVersion (object)
. RemoveCustomerContentEncryptionConfiguration (boolean)
. AdditionalConfiguration (string)
. ExecutionRole (string)
. CustomerContentEncryptionConfiguration (object)
. EnableMinimumEncryptionConfiguration (boolean)
. QueryResultsS3AccessGrantsConfiguration (object)
. MonitoringConfiguration (object)
. EngineConfiguration (object)
} (object)
State (string)
auditmanager/associate_assessment_report_evidence_folderAssociates an evidence folder to an assessment report in an Audit Manager assessment.assessmentId (string) required
evidenceFolderId (string) required
auditmanager/batch_associate_assessment_report_evidenceAssociates a list of evidence to an assessment report in an Audit Manager assessment.assessmentId (string) required
evidenceFolderId (string) required
evidenceIds (array) required
auditmanager/batch_create_delegation_by_assessmentCreates a batch of delegations for an assessment in Audit Manager.createDelegationRequests (array) required
assessmentId (string) required
auditmanager/batch_delete_delegation_by_assessmentDeletes a batch of delegations for an assessment in Audit Manager.delegationIds (array) required
assessmentId (string) required
auditmanager/batch_disassociate_assessment_report_evidenceDisassociates a list of evidence from an assessment report in Audit Manager.assessmentId (string) required
evidenceFolderId (string) required
evidenceIds (array) required
auditmanager/batch_import_evidence_to_assessment_controlAdds one or more pieces of evidence to a control in an Audit Manager assessment. You can import manual evidence from any S3 bucket by specifying the S3 URI of the object. You can also upload a file from your browser, or enter plain text in response to a risk assessment question. The following restrictions apply to this action: manualEvidence can be only one of the following: evidenceFileName, s3ResourcePath, or textResponse Maximum size of an individual evidence file: 100 MB Number of daily manuassessmentId (string) required
controlSetId (string) required
controlId (string) required
manualEvidence (array) required
auditmanager/create_assessmentCreates an assessment in Audit Manager.name (string) required
description (string)
assessmentReportsDestination: {
. destinationType (string)
. destination (string)
} (object) required
scope: {
. awsAccounts (array)
. awsServices (array)
} (object) required
roles (array) required
frameworkId (string) required
tags (object)
auditmanager/create_assessment_frameworkCreates a custom framework in Audit Manager.name (string) required
description (string)
complianceType (string)
controlSets (array) required
tags (object)
auditmanager/create_assessment_reportCreates an assessment report for the specified assessment.name (string) required
description (string)
assessmentId (string) required
queryStatement (string)
auditmanager/create_controlCreates a new custom control in Audit Manager.name (string) required
description (string)
testingInformation (string)
actionPlanTitle (string)
actionPlanInstructions (string)
controlMappingSources (array) required
tags (object)
auditmanager/delete_assessmentDeletes an assessment in Audit Manager.assessmentId (string) required
auditmanager/delete_assessment_frameworkDeletes a custom framework in Audit Manager.frameworkId (string) required
auditmanager/delete_assessment_framework_shareDeletes a share request for a custom framework in Audit Manager.requestId (string) required
requestType (string) required
auditmanager/delete_assessment_reportDeletes 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 muassessmentId (string) required
assessmentReportId (string) required
auditmanager/delete_controlDeletes a custom control in Audit Manager. When you invoke this operation, the custom control is deleted from any frameworks or assessments that it’s currently part of. As a result, Audit Manager will stop collecting evidence for that custom control in all of your assessments. This includes assessments that you previously created before you deleted the custom control.controlId (string) required
auditmanager/deregister_accountDeregisters an account in Audit Manager. Before you deregister, you can use the UpdateSettings API operation to set your preferred data retention policy. By default, Audit Manager retains your data. If you want to delete your data, you can use the DeregistrationPolicy attribute to request the deletion of your data. For more information about data retention, see Data Protection in the Audit Manager User Guide.No parameters
auditmanager/deregister_organization_admin_accountRemoves 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 stops collecting and attaching evidence to that delegated administrator account moving forward. Keep in mind the followinadminAccountId (string)
auditmanager/disassociate_assessment_report_evidence_folderDisassociates an evidence folder from the specified assessment report in Audit Manager.assessmentId (string) required
evidenceFolderId (string) required
auditmanager/get_account_statusGets the registration status of an account in Audit Manager.No parameters
auditmanager/get_assessmentGets information about a specified assessment.assessmentId (string) required
auditmanager/get_assessment_frameworkGets information about a specified framework.frameworkId (string) required
auditmanager/get_assessment_report_urlGets the URL of an assessment report in Audit Manager.assessmentReportId (string) required
assessmentId (string) required
auditmanager/get_change_logsGets a list of changelogs from Audit Manager.assessmentId (string) required
controlSetId (string)
controlId (string)
nextToken (string)
maxResults (integer)
auditmanager/get_controlGets information about a specified control.controlId (string) required
auditmanager/get_delegationsGets a list of delegations from an audit owner to a delegate.nextToken (string)
maxResults (integer)
auditmanager/get_evidenceGets information about a specified evidence item.assessmentId (string) required
controlSetId (string) required
evidenceFolderId (string) required
evidenceId (string) required
auditmanager/get_evidence_by_evidence_folderGets all evidence from a specified evidence folder in Audit Manager.assessmentId (string) required
controlSetId (string) required
evidenceFolderId (string) required
nextToken (string)
maxResults (integer)
auditmanager/get_evidence_file_upload_urlCreates a presigned Amazon S3 URL that can be used to upload a file as manual evidence. For instructions on how to use this operation, see Upload a file from your browser in the Audit Manager User Guide. The following restrictions apply to this operation: Maximum size of an individual evidence file: 100 MB Number of daily manual evidence uploads per control: 100 Supported file formats: See Supported file types for manual evidence in the Audit Manager User Guide For more information about Audit MfileName (string) required
auditmanager/get_evidence_folderGets an evidence folder from a specified assessment in Audit Manager.assessmentId (string) required
controlSetId (string) required
evidenceFolderId (string) required
auditmanager/get_evidence_folders_by_assessmentGets the evidence folders from a specified assessment in Audit Manager.assessmentId (string) required
nextToken (string)
maxResults (integer)
auditmanager/get_evidence_folders_by_assessment_controlGets a list of evidence folders that are associated with a specified control in an Audit Manager assessment.assessmentId (string) required
controlSetId (string) required
controlId (string) required
nextToken (string)
maxResults (integer)
auditmanager/get_insightsGets the latest analytics data for all your current active assessments.No parameters
auditmanager/get_insights_by_assessmentGets the latest analytics data for a specific active assessment.assessmentId (string) required
auditmanager/get_organization_admin_accountGets the name of the delegated Amazon Web Services administrator account for a specified organization.No parameters
auditmanager/get_services_in_scopeGets a list of the Amazon Web Services services from which Audit Manager can collect evidence. Audit Manager defines which Amazon Web Services services are in scope for an assessment. Audit Manager infers this scope by examining the assessment’s controls and their data sources, and then mapping this information to one or more of the corresponding Amazon Web Services services that are in this list. For information about why it's no longer possible to specify services in scope manually, see I can'No parameters
auditmanager/get_settingsGets the settings for a specified Amazon Web Services account.attribute (string) required
auditmanager/list_assessment_control_insights_by_control_domainLists 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.controlDomainId (string) required
assessmentId (string) required
nextToken (string)
maxResults (integer)
auditmanager/list_assessment_frameworksReturns a list of the frameworks that are available in the Audit Manager framework library.frameworkType (string) required
nextToken (string)
maxResults (integer)
auditmanager/list_assessment_framework_share_requestsReturns a list of sent or received share requests for custom frameworks in Audit Manager.requestType (string) required
nextToken (string)
maxResults (integer)
auditmanager/list_assessment_reportsReturns a list of assessment reports created in Audit Manager.nextToken (string)
maxResults (integer)
auditmanager/list_assessmentsReturns a list of current and past assessments from Audit Manager.status (string)
nextToken (string)
maxResults (integer)
auditmanager/list_control_domain_insightsLists the latest analytics data for control domains across all of your active assessments. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. 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 connextToken (string)
maxResults (integer)
auditmanager/list_control_domain_insights_by_assessmentLists analytics data for control domains within a specified active assessment. Audit Manager supports the control domains that are provided by Amazon Web Services Control Catalog. For information about how to find a list of available control domains, see ListDomains in the Amazon Web Services Control Catalog API Reference. 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’tassessmentId (string) required
nextToken (string)
maxResults (integer)
auditmanager/list_control_insights_by_control_domainLists 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.controlDomainId (string) required
nextToken (string)
maxResults (integer)
auditmanager/list_controlsReturns a list of controls from Audit Manager.controlType (string) required
nextToken (string)
maxResults (integer)
controlCatalogId (string)
auditmanager/list_keywords_for_data_sourceReturns a list of keywords that are pre-mapped to the specified control data source.source (string) required
nextToken (string)
maxResults (integer)
auditmanager/list_notificationsReturns a list of all Audit Manager notifications.nextToken (string)
maxResults (integer)
auditmanager/list_tags_for_resourceReturns a list of tags for the specified resource in Audit Manager.resourceArn (string) required
auditmanager/register_accountEnables Audit Manager for the specified Amazon Web Services account.kmsKey (string)
delegatedAdminAccount (string)
auditmanager/register_organization_admin_accountEnables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager.adminAccountId (string) required
auditmanager/start_assessment_framework_shareCreates 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 AmazonframeworkId (string) required
destinationAccount (string) required
destinationRegion (string) required
comment (string)
auditmanager/tag_resourceTags the specified resource in Audit Manager.resourceArn (string) required
tags (object) required
auditmanager/untag_resourceRemoves a tag from a resource in Audit Manager.resourceArn (string) required
tagKeys (array) required
auditmanager/update_assessmentEdits an Audit Manager assessment.assessmentId (string) required
assessmentName (string)
assessmentDescription (string)
scope: {
. awsAccounts (array)
. awsServices (array)
} (object) required
assessmentReportsDestination: {
. destinationType (string)
. destination (string)
} (object)
roles (array)
auditmanager/update_assessment_controlUpdates a control within an assessment in Audit Manager.assessmentId (string) required
controlSetId (string) required
controlId (string) required
controlStatus (string)
commentBody (string)
auditmanager/update_assessment_control_set_statusUpdates the status of a control set in an Audit Manager assessment.assessmentId (string) required
controlSetId (string) required
status (string) required
comment (string) required
auditmanager/update_assessment_frameworkUpdates a custom framework in Audit Manager.frameworkId (string) required
name (string) required
description (string)
complianceType (string)
controlSets (array) required
auditmanager/update_assessment_framework_shareUpdates a share request for a custom framework in Audit Manager.requestId (string) required
requestType (string) required
action (string) required
auditmanager/update_assessment_statusUpdates the status of an assessment in Audit Manager.assessmentId (string) required
status (string) required
auditmanager/update_controlUpdates a custom control in Audit Manager.controlId (string) required
name (string) required
description (string)
testingInformation (string)
actionPlanTitle (string)
actionPlanInstructions (string)
controlMappingSources (array) required
auditmanager/update_settingsUpdates Audit Manager settings for the current account.snsTopic (string)
defaultAssessmentReportsDestination: {
. destinationType (string)
. destination (string)
} (object)
defaultProcessOwners (array)
kmsKey (string)
evidenceFinderEnabled (boolean)
deregistrationPolicy: {
. deleteResources (string)
} (object)
defaultExportDestination: {
. destinationType (string)
. destination (string)
} (object)
auditmanager/validate_assessment_report_integrityValidates the integrity of an assessment report in Audit Manager.s3RelativePath (string) required
auto_scaling_plans/create_scaling_planCreates a scaling plan.ScalingPlanName (string) required
ApplicationSource: {
. CloudFormationStackARN (string)
. TagFilters (array)
} (object) required
ScalingInstructions (array) required
auto_scaling_plans/delete_scaling_planDeletes 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.ScalingPlanName (string) required
ScalingPlanVersion (integer) required
auto_scaling_plans/describe_scaling_plan_resourcesDescribes the scalable resources in the specified scaling plan.ScalingPlanName (string) required
ScalingPlanVersion (integer) required
MaxResults (integer)
NextToken (string)
auto_scaling_plans/describe_scaling_plansDescribes one or more of your scaling plans.ScalingPlanNames (array)
ScalingPlanVersion (integer)
ApplicationSources (array)
MaxResults (integer)
NextToken (string)
auto_scaling_plans/get_scaling_plan_resource_forecast_dataRetrieves 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.ScalingPlanName (string) required
ScalingPlanVersion (integer) required
ServiceNamespace (string) required
ResourceId (string) required
ScalableDimension (string) required
ForecastDataType (string) required
StartTime (string) required
EndTime (string) required
auto_scaling_plans/update_scaling_planUpdates the specified scaling plan. You cannot update a scaling plan if it is in the process of being created, updated, or deleted.ScalingPlanName (string) required
ScalingPlanVersion (integer) required
ApplicationSource: {
. CloudFormationStackARN (string)
. TagFilters (array)
} (object)
ScalingInstructions (array)
auto_scaling/attach_instancesAttaches 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 targeInstanceIds (array)
AutoScalingGroupName (string) required
auto_scaling/attach_load_balancersThis API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we continue to support AttachLoadBalancers. You can use both the original AttachLoadBalancers API operation and AttachTrafficSources on the same Auto Scaling group. Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instanceAutoScalingGroupName (string) required
LoadBalancerNames (array) required
auto_scaling/attach_load_balancer_target_groupsThis API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we continue to support AttachLoadBalancerTargetGroups. You can use both the original AttachLoadBalancerTargetGroups API operation and AttachTrafficSources on the same Auto Scaling group. Attaches one or more target groups to the specified Auto Scaling group. This operation is used with the followingAutoScalingGroupName (string) required
TargetGroupARNs (array) required
auto_scaling/attach_traffic_sourcesAttaches one or more traffic sources to the specified Auto Scaling group. You can use any of the following as traffic sources for an Auto Scaling group: Application Load Balancer Classic Load Balancer Gateway Load Balancer Network Load Balancer VPC Lattice This operation is additive and does not detach existing traffic sources from the Auto Scaling group. After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sourcesAutoScalingGroupName (string) required
TrafficSources (array) required
SkipZonalShiftValidation (boolean)
auto_scaling/batch_delete_scheduled_actionDeletes one or more scheduled actions for the specified Auto Scaling group.AutoScalingGroupName (string) required
ScheduledActionNames (array) required
auto_scaling/batch_put_scheduled_update_group_actionCreates or updates one or more scheduled scaling actions for an Auto Scaling group.AutoScalingGroupName (string) required
ScheduledUpdateGroupActions (array) required
auto_scaling/cancel_instance_refreshCancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error occurs. 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. When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.AutoScalingGroupName (string) required
WaitForTransitioningInstances (boolean)
auto_scaling/complete_lifecycle_actionCompletes 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 lifLifecycleHookName (string) required
AutoScalingGroupName (string) required
LifecycleActionToken (string)
LifecycleActionResult (string) required
InstanceId (string)
auto_scaling/create_auto_scaling_groupWe 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. If you're new to Amazon EC2AutoScalingGroupName (string) required
LaunchConfigurationName (string)
LaunchTemplate: {
. LaunchTemplateId (string)
. LaunchTemplateName (string)
. Version (string)
} (object)
MixedInstancesPolicy: {
. LaunchTemplate (object)
. InstancesDistribution (object)
} (object)
InstanceId (string)
MinSize (integer) required
MaxSize (integer) required
DesiredCapacity (integer)
DefaultCooldown (integer)
AvailabilityZones (array)
LoadBalancerNames (array)
TargetGroupARNs (array)
HealthCheckType (string)
HealthCheckGracePeriod (integer)
PlacementGroup (string)
VPCZoneIdentifier (string)
TerminationPolicies (array)
NewInstancesProtectedFromScaleIn (boolean)
CapacityRebalance (boolean)
LifecycleHookSpecificationList (array)
DeletionProtection (string)
Tags (array)
ServiceLinkedRoleARN (string)
MaxInstanceLifetime (integer)
Context (string)
DesiredCapacityType (string)
DefaultInstanceWarmup (integer)
TrafficSources (array)
InstanceMaintenancePolicy: {
. MinHealthyPercentage (integer)
. MaxHealthyPercentage (integer)
} (object)
AvailabilityZoneDistribution: {
. CapacityDistributionStrategy (string)
} (object)
AvailabilityZoneImpairmentPolicy: {
. ZonalShiftEnabled (boolean)
. ImpairedZoneHealthCheckBehavior (string)
} (object)
SkipZonalShiftValidation (boolean)
CapacityReservationSpecification: {
. CapacityReservationPreference (string)
. CapacityReservationTarget (object)
} (object)
InstanceLifecyclePolicy: {
. RetentionTriggers (object)
} (object)
auto_scaling/create_launch_configurationCreates 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. Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template orLaunchConfigurationName (string) required
ImageId (string)
KeyName (string)
SecurityGroups (array)
ClassicLinkVPCId (string)
ClassicLinkVPCSecurityGroups (array)
UserData (string)
InstanceId (string)
InstanceType (string)
KernelId (string)
RamdiskId (string)
BlockDeviceMappings (array)
InstanceMonitoring: {
. Enabled (boolean)
} (object)
SpotPrice (string)
IamInstanceProfile (string)
EbsOptimized (boolean)
AssociatePublicIpAddress (boolean)
PlacementTenancy (string)
MetadataOptions: {
. HttpTokens (string)
. HttpPutResponseHopLimit (integer)
. HttpEndpoint (string)
} (object)
auto_scaling/create_or_update_tagsCreates 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.Tags (array) required
auto_scaling/delete_auto_scaling_groupDeletes 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. The force delete operation will also terminate the EC2 instances. If the group has a warm pool, the force delete option also deletes the warm pool. 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 capaciAutoScalingGroupName (string) required
ForceDelete (boolean)
auto_scaling/delete_launch_configurationDeletes 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.LaunchConfigurationName (string) required
auto_scaling/delete_lifecycle_hookDeletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first ABANDON for launching instances, CONTINUE for terminating instances.LifecycleHookName (string) required
AutoScalingGroupName (string) required
auto_scaling/delete_notification_configurationDeletes the specified notification.AutoScalingGroupName (string) required
TopicARN (string) required
auto_scaling/delete_policyDeletes 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 Delete a scaling policy in the Amazon EC2 Auto Scaling User Guide.AutoScalingGroupName (string)
PolicyName (string) required
auto_scaling/delete_scheduled_actionDeletes the specified scheduled action.AutoScalingGroupName (string) required
ScheduledActionName (string) required
auto_scaling/delete_tagsDeletes the specified tags.Tags (array) required
auto_scaling/delete_warm_poolDeletes 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.AutoScalingGroupName (string) required
ForceDelete (boolean)
auto_scaling/describe_account_limitsDescribes the current Amazon EC2 Auto Scaling resource quotas for your account. When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.No parameters
auto_scaling/describe_adjustment_typesDescribes the available adjustment types for step scaling and simple scaling policies. The following adjustment types are supported: ChangeInCapacity ExactCapacity PercentChangeInCapacityNo parameters
auto_scaling/describe_auto_scaling_groupsGets 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.AutoScalingGroupNames (array)
IncludeInstances (boolean)
NextToken (string)
MaxRecords (integer)
Filters (array)
auto_scaling/describe_auto_scaling_instancesGets information about the Auto Scaling instances in the account and Region.InstanceIds (array)
MaxRecords (integer)
NextToken (string)
auto_scaling/describe_auto_scaling_notification_typesDescribes the notification types that are supported by Amazon EC2 Auto Scaling.No parameters
auto_scaling/describe_instance_refreshesGets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks. 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, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the pAutoScalingGroupName (string) required
InstanceRefreshIds (array)
NextToken (string)
MaxRecords (integer)
auto_scaling/describe_launch_configurationsGets information about the launch configurations in the account and Region.LaunchConfigurationNames (array)
NextToken (string)
MaxRecords (integer)
auto_scaling/describe_lifecycle_hooksGets information about the lifecycle hooks for the specified Auto Scaling group.AutoScalingGroupName (string) required
LifecycleHookNames (array)
auto_scaling/describe_lifecycle_hook_typesDescribes the available types of lifecycle hooks. The following hook types are supported: autoscaling:EC2_INSTANCE_LAUNCHING autoscaling:EC2_INSTANCE_TERMINATINGNo parameters
auto_scaling/describe_load_balancersThis API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DescribeTrafficSources to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancers. You can use both the original DescribeLoadBalancers API operation and DescribeTrafficSources on the same Auto Scaling group. Gets information about the load balancers for the specified Auto Scaling group. This operation describes only Classic LoadAutoScalingGroupName (string) required
NextToken (string)
MaxRecords (integer)
auto_scaling/describe_load_balancer_target_groupsThis API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancerTargetGroups. You can use both the original DescribeLoadBalancerTargetGroups API operation and DescribeTrafficSources on the same Auto Scaling group. Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group. TAutoScalingGroupName (string) required
NextToken (string)
MaxRecords (integer)
auto_scaling/describe_metric_collection_typesDescribes the available CloudWatch metrics for Amazon EC2 Auto Scaling.No parameters
auto_scaling/describe_notification_configurationsGets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.AutoScalingGroupNames (array)
NextToken (string)
MaxRecords (integer)
auto_scaling/describe_policiesGets information about the scaling policies in the account and Region.AutoScalingGroupName (string)
PolicyNames (array)
PolicyTypes (array)
NextToken (string)
MaxRecords (integer)
auto_scaling/describe_scaling_activitiesGets 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 Verify 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 elemeActivityIds (array)
AutoScalingGroupName (string)
IncludeDeletedGroups (boolean)
MaxRecords (integer)
NextToken (string)
Filters (array)
auto_scaling/describe_scaling_process_typesDescribes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.No parameters
auto_scaling/describe_scheduled_actionsGets 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.AutoScalingGroupName (string)
ScheduledActionNames (array)
StartTime (string)
EndTime (string)
NextToken (string)
MaxRecords (integer)
auto_scaling/describe_tagsDescribes 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 AutoFilters (array)
NextToken (string)
MaxRecords (integer)
auto_scaling/describe_termination_policy_typesDescribes the termination policies supported by Amazon EC2 Auto Scaling. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.No parameters
auto_scaling/describe_traffic_sourcesGets information about the traffic sources for the specified Auto Scaling group. You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type. If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.AutoScalingGroupName (string) required
TrafficSourceType (string)
NextToken (string)
MaxRecords (integer)
auto_scaling/describe_warm_poolGets 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.AutoScalingGroupName (string) required
MaxRecords (integer)
NextToken (string)
auto_scaling/detach_instancesRemoves 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 groupInstanceIds (array)
AutoScalingGroupName (string) required
ShouldDecrementDesiredCapacity (boolean) required
auto_scaling/detach_load_balancersThis API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DetachLoadBalancers. You can use both the original DetachLoadBalancers API operation and DetachTrafficSources on the same Auto Scaling group. Detaches one or more Classic Load Balancers from the specified Auto Scaling group. This operation detaches only Classic Load Balancers.AutoScalingGroupName (string) required
LoadBalancerNames (array) required
auto_scaling/detach_load_balancer_target_groupsThis API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DetachLoadBalancerTargetGroups. You can use both the original DetachLoadBalancerTargetGroups API operation and DetachTrafficSources on the same Auto Scaling group. Detaches one or more target groups from the specified Auto Scaling group. When you detach a target group, it enteAutoScalingGroupName (string) required
TargetGroupARNs (array) required
auto_scaling/detach_traffic_sourcesDetaches one or more traffic sources from the specified Auto Scaling group. When you detach a traffic source, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.AutoScalingGroupName (string) required
TrafficSources (array) required
auto_scaling/disable_metrics_collectionDisables group metrics collection for the specified Auto Scaling group.AutoScalingGroupName (string) required
Metrics (array)
auto_scaling/enable_metrics_collectionEnables 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.AutoScalingGroupName (string) required
Metrics (array)
Granularity (string) required
auto_scaling/enter_standbyMoves 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 infInstanceIds (array)
AutoScalingGroupName (string) required
ShouldDecrementDesiredCapacity (boolean) required
auto_scaling/execute_policyExecutes the specified policy. This can be useful for testing the design of your scaling policy.AutoScalingGroupName (string)
PolicyName (string) required
HonorCooldown (boolean)
MetricValue (number)
BreachThreshold (number)
auto_scaling/exit_standbyMoves 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.InstanceIds (array)
AutoScalingGroupName (string) required
auto_scaling/get_predictive_scaling_forecastRetrieves 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 fAutoScalingGroupName (string) required
PolicyName (string) required
StartTime (string) required
EndTime (string) required
auto_scaling/launch_instancesLaunches a specified number of instances in an Auto Scaling group. Returns instance IDs and other details if launch is successful or error details if launch is unsuccessful.AutoScalingGroupName (string) required
RequestedCapacity (integer) required
ClientToken (string) required
AvailabilityZones (array)
AvailabilityZoneIds (array)
SubnetIds (array)
RetryStrategy (string)
auto_scaling/put_lifecycle_hookCreates 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 toLifecycleHookName (string) required
AutoScalingGroupName (string) required
LifecycleTransition (string)
RoleARN (string)
NotificationTargetARN (string)
NotificationMetadata (string)
HeartbeatTimeout (integer)
DefaultResult (string)
auto_scaling/put_notification_configurationConfigures 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 Amazon SNS notification options for Amazon EC2 Auto Scaling 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.AutoScalingGroupName (string) required
TopicARN (string) required
NotificationTypes (array) required
auto_scaling/put_scaling_policyCreates 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 EAutoScalingGroupName (string) required
PolicyName (string) required
PolicyType (string)
AdjustmentType (string)
MinAdjustmentStep (integer)
MinAdjustmentMagnitude (integer)
ScalingAdjustment (integer)
Cooldown (integer)
MetricAggregationType (string)
StepAdjustments (array)
EstimatedInstanceWarmup (integer)
TargetTrackingConfiguration: {
. PredefinedMetricSpecification (object)
. CustomizedMetricSpecification (object)
. TargetValue (number)
. DisableScaleIn (boolean)
} (object)
Enabled (boolean)
PredictiveScalingConfiguration: {
. MetricSpecifications (array)
. Mode (string)
. SchedulingBufferTime (integer)
. MaxCapacityBreachBehavior (string)
. MaxCapacityBuffer (integer)
} (object)
auto_scaling/put_scheduled_update_group_actionCreates 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.AutoScalingGroupName (string) required
ScheduledActionName (string) required
Time (string)
StartTime (string)
EndTime (string)
Recurrence (string)
MinSize (integer)
MaxSize (integer)
DesiredCapacity (integer)
TimeZone (string)
auto_scaling/put_warm_poolCreates 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. This operation must be called from the Region in which the Auto Scaling group was created. You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a waAutoScalingGroupName (string) required
MaxGroupPreparedCapacity (integer)
MinSize (integer)
PoolState (string)
InstanceReusePolicy: {
. ReuseOnScaleIn (boolean)
} (object)
auto_scaling/record_lifecycle_action_heartbeatRecords 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 EventLifecycleHookName (string) required
AutoScalingGroupName (string) required
LifecycleActionToken (string)
InstanceId (string)
auto_scaling/resume_processesResumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group. For more information, see Suspend and resume Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.AutoScalingGroupName (string) required
ScalingProcesses (array)
auto_scaling/rollback_instance_refreshCancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh. 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. A rollback is noAutoScalingGroupName (string) required
auto_scaling/set_desired_capacitySets 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.AutoScalingGroupName (string) required
DesiredCapacity (integer) required
HonorCooldown (boolean)
auto_scaling/set_instance_healthSets the health status of the specified instance. For more information, see Set up a custom health check for your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.InstanceId (string) required
HealthStatus (string) required
ShouldRespectGracePeriod (boolean)
auto_scaling/set_instance_protectionUpdates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool. For more information, see Use 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.InstanceIds (array) required
AutoScalingGroupName (string) required
ProtectedFromScaleIn (boolean) required
auto_scaling/start_instance_refreshStarts an instance refresh. 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 successful, the request's response containAutoScalingGroupName (string) required
Strategy (string)
DesiredConfiguration: {
. LaunchTemplate (object)
. MixedInstancesPolicy (object)
} (object)
Preferences: {
. MinHealthyPercentage (integer)
. InstanceWarmup (integer)
. CheckpointPercentages (array)
. CheckpointDelay (integer)
. SkipMatching (boolean)
. AutoRollback (boolean)
. ScaleInProtectedInstances (string)
. StandbyInstances (string)
. AlarmSpecification (object)
. MaxHealthyPercentage (integer)
. BakeTime (integer)
} (object)
auto_scaling/suspend_processesSuspends 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 Suspend and resume Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide. To resume processes that have been suspended, call the ResumeProcesses API.AutoScalingGroupName (string) required
ScalingProcesses (array)
auto_scaling/terminate_instance_in_auto_scaling_groupTerminates 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 tInstanceId (string) required
ShouldDecrementDesiredCapacity (boolean) required
auto_scaling/update_auto_scaling_groupWe 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 launcAutoScalingGroupName (string) required
LaunchConfigurationName (string)
LaunchTemplate: {
. LaunchTemplateId (string)
. LaunchTemplateName (string)
. Version (string)
} (object)
MixedInstancesPolicy: {
. LaunchTemplate (object)
. InstancesDistribution (object)
} (object)
MinSize (integer)
MaxSize (integer)
DesiredCapacity (integer)
DefaultCooldown (integer)
AvailabilityZones (array)
HealthCheckType (string)
HealthCheckGracePeriod (integer)
PlacementGroup (string)
VPCZoneIdentifier (string)
TerminationPolicies (array)
NewInstancesProtectedFromScaleIn (boolean)
ServiceLinkedRoleARN (string)
MaxInstanceLifetime (integer)
CapacityRebalance (boolean)
Context (string)
DesiredCapacityType (string)
DefaultInstanceWarmup (integer)
InstanceMaintenancePolicy: {
. MinHealthyPercentage (integer)
. MaxHealthyPercentage (integer)
} (object)
AvailabilityZoneDistribution: {
. CapacityDistributionStrategy (string)
} (object)
AvailabilityZoneImpairmentPolicy: {
. ZonalShiftEnabled (boolean)
. ImpairedZoneHealthCheckBehavior (string)
} (object)
SkipZonalShiftValidation (boolean)
CapacityReservationSpecification: {
. CapacityReservationPreference (string)
. CapacityReservationTarget (object)
} (object)
InstanceLifecyclePolicy: {
. RetentionTriggers (object)
} (object)
DeletionProtection (string)
b2bi/create_starter_mapping_templateAmazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI. If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template. The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it into the JSON oroutputSampleLocation: {
. bucketName (string)
. key (string)
} (object)
mappingType (string) required
templateDetails (undefined) required
b2bi/generate_mappingTakes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically. Depending on the accuracy and other factors, you can then edit the mapping for your needs. Before you can use the AI-assisted feature for Amazon Web Services B2B Data Interchange you must enable models in Amazon Bedrock. For details, see AI-assisted template mapping prerequisites in the Amazon Web Services B2B Data Interchange User guide. To generate a mapping, perform the following steps: StartinputFileContent (string) required
outputFileContent (string) required
mappingType (string) required
b2bi/get_transformer_jobReturns the details of the transformer run, based on the Transformer job ID. If 30 days have elapsed since your transformer job was started, the system deletes it. So, if you run GetTransformerJob and supply a transformerId and transformerJobId for a job that was started more than 30 days previously, you receive a 404 response.transformerJobId (string) required
transformerId (string) required
b2bi/list_tags_for_resourceLists all of the tags associated with the Amazon Resource Name ARN that you specify. The resource can be a capability, partnership, profile, or transformer.ResourceARN (string) required
b2bi/start_transformer_jobRuns a job, using a transformer, to parse input EDI electronic data interchange file into the output structures used by Amazon Web Services B2B Data Interchange. If you only want to transform EDI electronic data interchange documents, you don't need to create profiles, partnerships or capabilities. Just create and configure a transformer, and then run the StartTransformerJob API to process your files. The system stores transformer jobs for 30 days. During that period, you can run GetTransformerJinputFile: {
. bucketName (string)
. key (string)
} (object) required
outputLocation: {
. bucketName (string)
. key (string)
} (object) required
transformerId (string) required
clientToken (string)
b2bi/tag_resourceAttaches a key-value pair to a resource, as identified by its Amazon Resource Name ARN. Resources are capability, partnership, profile, transformers and other entities. There is no response returned from this call.ResourceARN (string) required
Tags (array) required
b2bi/test_conversionThis operation mimics the latter half of a typical Outbound EDI request. It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI string, and return that string.source: {
. fileFormat (string)
. inputFile
} (object) required
target: {
. fileFormat (string)
. formatDetails
. outputSampleFile
. advancedOptions (object)
} (object) required
b2bi/test_mappingMaps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the inputFileContent parameter.inputFileContent (string) required
mappingTemplate (string) required
fileFormat (string) required
b2bi/test_parsingParses the input EDI electronic data interchange file. The input file has a file size limit of 250 KB.inputFile: {
. bucketName (string)
. key (string)
} (object) required
fileFormat (string) required
ediType (undefined) required
advancedOptions: {
. x12 (object)
} (object)
b2bi/untag_resourceDetaches a key-value pair from the specified resource, as identified by its Amazon Resource Name ARN. Resources are capability, partnership, profile, transformers and other entities.ResourceARN (string) required
TagKeys (array) required
b2bi/create_capabilityInstantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.name (string) required
type (string) required
configuration (undefined) required
instructionsDocuments (array)
clientToken (string)
tags (array)
b2bi/get_capabilityRetrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.capabilityId (string) required
b2bi/update_capabilityUpdates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.capabilityId (string) required
name (string)
configuration (undefined)
instructionsDocuments (array)
b2bi/delete_capabilityDeletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.capabilityId (string) required
b2bi/list_capabilitiesLists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.nextToken (string)
maxResults (integer)
b2bi/create_partnershipCreates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.profileId (string) required
name (string) required
email (string) required
phone (string)
capabilities (array) required
capabilityOptions: {
. outboundEdi
. inboundEdi (object)
} (object)
clientToken (string)
tags (array)
b2bi/get_partnershipRetrieves the details for a partnership, based on the partner and profile IDs specified. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.partnershipId (string) required
b2bi/update_partnershipUpdates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.partnershipId (string) required
name (string)
capabilities (array)
capabilityOptions: {
. outboundEdi
. inboundEdi (object)
} (object)
b2bi/delete_partnershipDeletes the specified partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.partnershipId (string) required
b2bi/list_partnershipsLists the partnerships associated with your Amazon Web Services account for your current or specified region. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.profileId (string)
nextToken (string)
maxResults (integer)
b2bi/create_profileCreates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.name (string) required
email (string)
phone (string) required
businessName (string) required
logging (string) required
clientToken (string)
tags (array)
b2bi/get_profileRetrieves the details for the profile specified by the profile ID. A profile is the mechanism used to create the concept of a private network.profileId (string) required
b2bi/update_profileUpdates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.profileId (string) required
name (string)
email (string)
phone (string)
businessName (string)
b2bi/delete_profileDeletes the specified profile. A profile is the mechanism used to create the concept of a private network.profileId (string) required
b2bi/list_profilesLists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of a private network.nextToken (string)
maxResults (integer)
b2bi/create_transformerCreates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios: Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires. Outbouname (string) required
clientToken (string)
tags (array)
fileFormat (string)
mappingTemplate (string)
ediType (undefined)
sampleDocument (string)
inputConversion: {
. fromFormat (string)
. formatOptions
. advancedOptions (object)
} (object)
mapping: {
. templateLanguage (string)
. template (string)
} (object)
outputConversion: {
. toFormat (string)
. formatOptions
. advancedOptions (object)
} (object)
sampleDocuments: {
. bucketName (string)
. keys (array)
} (object)
b2bi/get_transformerRetrieves the details for the transformer specified by the transformer ID. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.transformerId (string) required
b2bi/update_transformerUpdates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.transformerId (string) required
name (string)
status (string)
fileFormat (string)
mappingTemplate (string)
ediType (undefined)
sampleDocument (string)
inputConversion: {
. fromFormat (string)
. formatOptions
. advancedOptions (object)
} (object)
mapping: {
. templateLanguage (string)
. template (string)
} (object)
outputConversion: {
. toFormat (string)
. formatOptions
. advancedOptions (object)
} (object)
sampleDocuments: {
. bucketName (string)
. keys (array)
} (object)
b2bi/delete_transformerDeletes the specified transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.transformerId (string) required
b2bi/list_transformersLists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.nextToken (string)
maxResults (integer)
backup_gateway/list_tags_for_resourceLists the tags applied to the resource identified by its Amazon Resource Name ARN.ResourceArn (string) required
backup_gateway/tag_resourceTag the resource.ResourceARN (string) required
Tags (array) required
backup_gateway/untag_resourceRemoves tags from the resource.ResourceARN (string) required
TagKeys (array) required
backup_gateway/associate_gateway_to_serverAssociates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.GatewayArn (string) required
ServerArn (string) required
backup_gateway/disassociate_gateway_from_serverDisassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.GatewayArn (string) required
backup_gateway/put_maintenance_start_timeSet the maintenance start time for a gateway.GatewayArn (string) required
HourOfDay (integer) required
MinuteOfHour (integer) required
DayOfWeek (integer)
DayOfMonth (integer)
backup_gateway/test_hypervisor_configurationTests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.GatewayArn (string) required
Host (string) required
Username (string)
Password (string)
backup_gateway/update_gateway_software_nowUpdates 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.GatewayArn (string) required
backup_gateway/create_gatewayCreates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.ActivationKey (string) required
GatewayDisplayName (string) required
GatewayType (string) required
Tags (array)
backup_gateway/get_gatewayBy providing the ARN Amazon Resource Name, this API returns the gateway.GatewayArn (string) required
backup_gateway/update_gateway_informationUpdates a gateway's name. Specify which gateway to update using the Amazon Resource Name ARN of the gateway in your request.GatewayArn (string) required
GatewayDisplayName (string)
backup_gateway/delete_gatewayDeletes a backup gateway.GatewayArn (string) required
backup_gateway/list_gatewaysLists 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.MaxResults (integer)
NextToken (string)
backup_gateway/get_bandwidth_rate_limit_scheduleRetrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.GatewayArn (string) required
backup_gateway/put_bandwidth_rate_limit_scheduleThis action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.GatewayArn (string) required
BandwidthRateLimitIntervals (array) required
backup_gateway/start_virtual_machines_metadata_syncThis action sends a request to sync metadata across the specified virtual machines.HypervisorArn (string) required
backup_gateway/import_hypervisor_configurationConnect to a hypervisor by importing its configuration.Name (string) required
Host (string) required
Username (string)
Password (string)
KmsKeyArn (string)
Tags (array)
backup_gateway/get_hypervisorThis action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.HypervisorArn (string) required
backup_gateway/update_hypervisorUpdates 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.HypervisorArn (string) required
Host (string)
Username (string)
Password (string)
Name (string)
LogGroupArn (string)
backup_gateway/delete_hypervisorDeletes a hypervisor.HypervisorArn (string) required
backup_gateway/list_hypervisorsLists your hypervisors.MaxResults (integer)
NextToken (string)
backup_gateway/get_hypervisor_property_mappingsThis action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.HypervisorArn (string) required
backup_gateway/put_hypervisor_property_mappingsThis action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.HypervisorArn (string) required
VmwareToAwsTagMappings (array) required
IamRoleArn (string) required
backup_gateway/get_virtual_machineBy providing the ARN Amazon Resource Name, this API returns the virtual machine.ResourceArn (string) required
backup_gateway/list_virtual_machinesLists your virtual machines.HypervisorArn (string)
MaxResults (integer)
NextToken (string)
backup/associate_backup_vault_mpa_approval_teamAssociates an MPA approval team with a backup vault.BackupVaultName (string) required
MpaApprovalTeamArn (string) required
RequesterComment (string)
backup/cancel_legal_holdRemoves the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.LegalHoldId (string) required
CancelDescription (string) required
RetainRecordInDays (integer)
backup/create_backup_planCreates 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.BackupPlan: {
. BackupPlanName (string)
. Rules (array)
. AdvancedBackupSettings (array)
. ScanSettings (array)
} (object) required
BackupPlanTags (object)
CreatorRequestId (string)
backup/create_backup_selectionCreates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.BackupPlanId (string) required
BackupSelection: {
. SelectionName (string)
. IamRoleArn (string)
. Resources (array)
. ListOfTags (array)
. NotResources (array)
. Conditions (object)
} (object) required
CreatorRequestId (string)
backup/create_backup_vaultCreates 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.BackupVaultName (string) required
BackupVaultTags (object)
EncryptionKeyArn (string)
CreatorRequestId (string)
backup/create_frameworkCreates 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.FrameworkName (string) required
FrameworkDescription (string)
FrameworkControls (array) required
IdempotencyToken (string)
FrameworkTags (object)
backup/create_legal_holdCreates a legal hold on a recovery point backup. A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.Title (string) required
Description (string) required
IdempotencyToken (string)
RecoveryPointSelection: {
. VaultNames (array)
. ResourceIdentifiers (array)
. DateRange (object)
} (object)
Tags (object)
backup/create_logically_air_gapped_backup_vaultCreates a logical container to where backups may be copied. This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID. Do not include sensitive data, such as passport numbers, in the name of a backup vault.BackupVaultName (string) required
BackupVaultTags (object)
CreatorRequestId (string)
MinRetentionDays (integer) required
MaxRetentionDays (integer) required
EncryptionKeyArn (string)
backup/create_report_planCreates 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.ReportPlanName (string) required
ReportPlanDescription (string)
ReportDeliveryChannel: {
. S3BucketName (string)
. S3KeyPrefix (string)
. Formats (array)
} (object) required
ReportSetting: {
. ReportTemplate (string)
. FrameworkArns (array)
. NumberOfFrameworks (integer)
. Accounts (array)
. OrganizationUnits (array)
. Regions (array)
} (object) required
ReportPlanTags (object)
IdempotencyToken (string)
backup/create_restore_access_backup_vaultCreates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval.SourceBackupVaultArn (string) required
BackupVaultName (string)
BackupVaultTags (object)
CreatorRequestId (string)
RequesterComment (string)
backup/create_restore_testing_planCreates a restore testing plan. The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.CreatorRequestId (string)
RestoreTestingPlan: {
. RecoveryPointSelection (object)
. RestoreTestingPlanName (string)
. ScheduleExpression (string)
. ScheduleExpressionTimezone (string)
. StartWindowHours (integer)
} (object) required
Tags (object)
backup/create_restore_testing_selectionThis request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially. This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following: ProtectedResourceArns ProtectedResourceConditions Each protected resource type can have one single value. A restore testing selection can include a wildcard value '' for ProtectedResourceArns along with ProtectedResourcCreatorRequestId (string)
RestoreTestingPlanName (string) required
RestoreTestingSelection: {
. IamRoleArn (string)
. ProtectedResourceArns (array)
. ProtectedResourceConditions (object)
. ProtectedResourceType (string)
. RestoreMetadataOverrides (object)
. RestoreTestingSelectionName (string)
. ValidationWindowHours (integer)
} (object) required
backup/create_tiering_configurationCreates a tiering configuration. A tiering configuration enables automatic movement of backup data to a lower-cost storage tier based on the age of backed-up objects in the backup vault. Each vault can only have one vault-specific tiering configuration, in addition to any global configuration that applies to all vaults.TieringConfiguration: {
. TieringConfigurationName (string)
. BackupVaultName (string)
. ResourceSelection (array)
} (object) required
TieringConfigurationTags (object)
CreatorRequestId (string)
backup/delete_backup_planDeletes 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.BackupPlanId (string) required
backup/delete_backup_selectionDeletes the resource selection associated with a backup plan that is specified by the SelectionId.BackupPlanId (string) required
SelectionId (string) required
backup/delete_backup_vaultDeletes the backup vault identified by its name. A vault can be deleted only if it is empty.BackupVaultName (string) required
backup/delete_backup_vault_access_policyDeletes the policy document that manages permissions on a backup vault.BackupVaultName (string) required
backup/delete_backup_vault_lock_configurationDeletes 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.BackupVaultName (string) required
backup/delete_backup_vault_notificationsDeletes event notifications for the specified backup vault.BackupVaultName (string) required
backup/delete_frameworkDeletes the framework specified by a framework name.FrameworkName (string) required
backup/delete_recovery_pointDeletes 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. When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state. EXPIRED recovery points can be deleted with this API once the IAM role hasBackupVaultName (string) required
RecoveryPointArn (string) required
backup/delete_report_planDeletes the report plan specified by a report plan name.ReportPlanName (string) required
backup/delete_restore_testing_planThis request deletes the specified restore testing plan. Deletion can only successfully occur if all associated restore testing selections are deleted first.RestoreTestingPlanName (string) required
backup/delete_restore_testing_selectionInput the Restore Testing Plan name and Restore Testing Selection name. All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted.RestoreTestingPlanName (string) required
RestoreTestingSelectionName (string) required
backup/delete_tiering_configurationDeletes the tiering configuration specified by a tiering configuration name.TieringConfigurationName (string) required
backup/describe_backup_jobReturns backup job details for the specified BackupJobId.BackupJobId (string) required
backup/describe_backup_vaultReturns metadata about a backup vault specified by its name.BackupVaultName (string) required
BackupVaultAccountId (string)
backup/describe_copy_jobReturns metadata associated with creating a copy of a resource.CopyJobId (string) required
backup/describe_frameworkReturns the framework details for the specified FrameworkName.FrameworkName (string) required
backup/describe_global_settingsDescribes 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-2No parameters
backup/describe_protected_resourceReturns 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.ResourceArn (string) required
backup/describe_recovery_pointReturns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.BackupVaultName (string) required
RecoveryPointArn (string) required
BackupVaultAccountId (string)
backup/describe_region_settingsReturns 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.No parameters
backup/describe_report_jobReturns the details associated with creating a report as specified by its ReportJobId.ReportJobId (string) required
backup/describe_report_planReturns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.ReportPlanName (string) required
backup/describe_restore_jobReturns metadata associated with a restore job that is specified by a job ID.RestoreJobId (string) required
backup/describe_scan_jobReturns scan job details for the specified ScanJobID.ScanJobId (string) required
backup/disassociate_backup_vault_mpa_approval_teamRemoves the association between an MPA approval team and a backup vault, disabling the MPA approval workflow for restore operations.BackupVaultName (string) required
RequesterComment (string)
backup/disassociate_recovery_pointDeletes 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.BackupVaultName (string) required
RecoveryPointArn (string) required
backup/disassociate_recovery_point_from_parentThis action to a specific child nested recovery point removes the relationship between the specified recovery point and its parent composite recovery point.BackupVaultName (string) required
RecoveryPointArn (string) required
backup/export_backup_plan_templateReturns the backup plan that is specified by the plan ID as a backup template.BackupPlanId (string) required
backup/get_backup_planReturns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.BackupPlanId (string) required
VersionId (string)
MaxScheduledRunsPreview (integer)
backup/get_backup_plan_from_jsonReturns a valid JSON document specifying a backup plan or an error.BackupPlanTemplateJson (string) required
backup/get_backup_plan_from_templateReturns the template specified by its templateId as a backup plan.BackupPlanTemplateId (string) required
backup/get_backup_selectionReturns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.BackupPlanId (string) required
SelectionId (string) required
backup/get_backup_vault_access_policyReturns the access policy document that is associated with the named backup vault.BackupVaultName (string) required
backup/get_backup_vault_notificationsReturns event notifications for the specified backup vault.BackupVaultName (string) required
backup/get_legal_holdThis action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.LegalHoldId (string) required
backup/get_recovery_point_index_detailsThis operation returns the metadata and details specific to the backup index associated with the specified recovery point.BackupVaultName (string) required
RecoveryPointArn (string) required
backup/get_recovery_point_restore_metadataReturns a set of metadata key-value pairs that were used to create the backup.BackupVaultName (string) required
RecoveryPointArn (string) required
BackupVaultAccountId (string)
backup/get_restore_job_metadataThis request returns the metadata for the specified restore job.RestoreJobId (string) required
backup/get_restore_testing_inferred_metadataThis request returns the minimal required set of metadata needed to start a restore job with secure default settings. BackupVaultName and RecoveryPointArn are required parameters. BackupVaultAccountId is an optional parameter.BackupVaultAccountId (string)
BackupVaultName (string) required
RecoveryPointArn (string) required
backup/get_restore_testing_planReturns RestoreTestingPlan details for the specified RestoreTestingPlanName. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.RestoreTestingPlanName (string) required
backup/get_restore_testing_selectionReturns RestoreTestingSelection, which displays resources and elements of the restore testing plan.RestoreTestingPlanName (string) required
RestoreTestingSelectionName (string) required
backup/get_supported_resource_typesReturns the Amazon Web Services resource types supported by Backup.No parameters
backup/get_tiering_configurationReturns TieringConfiguration details for the specified TieringConfigurationName. The details are the body of a tiering configuration in JSON format, in addition to configuration metadata.TieringConfigurationName (string) required
backup/list_backup_jobsReturns 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.NextToken (string)
MaxResults (integer)
ByResourceArn (string)
ByState (string)
ByBackupVaultName (string)
ByCreatedBefore (string)
ByCreatedAfter (string)
ByResourceType (string)
ByAccountId (string)
ByCompleteAfter (string)
ByCompleteBefore (string)
ByParentJobId (string)
ByMessageCategory (string)
backup/list_backup_job_summariesThis is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.AccountId (string)
State (string)
ResourceType (string)
MessageCategory (string)
AggregationPeriod (string)
MaxResults (integer)
NextToken (string)
backup/list_backup_plansLists the active backup plans for the account.NextToken (string)
MaxResults (integer)
IncludeDeleted (boolean)
backup/list_backup_plan_templatesLists the backup plan templates.NextToken (string)
MaxResults (integer)
backup/list_backup_plan_versionsReturns version metadata of your backup plans, including Amazon Resource Names ARNs, backup plan IDs, creation and deletion dates, plan names, and version IDs.BackupPlanId (string) required
NextToken (string)
MaxResults (integer)
backup/list_backup_selectionsReturns an array containing metadata of the resources associated with the target backup plan.BackupPlanId (string) required
NextToken (string)
MaxResults (integer)
backup/list_backup_vaultsReturns a list of recovery point storage containers along with information about them.ByVaultType (string)
ByShared (boolean)
NextToken (string)
MaxResults (integer)
backup/list_copy_jobsReturns metadata about your copy jobs.NextToken (string)
MaxResults (integer)
ByResourceArn (string)
ByState (string)
ByCreatedBefore (string)
ByCreatedAfter (string)
ByResourceType (string)
ByDestinationVaultArn (string)
ByAccountId (string)
ByCompleteBefore (string)
ByCompleteAfter (string)
ByParentJobId (string)
ByMessageCategory (string)
BySourceRecoveryPointArn (string)
backup/list_copy_job_summariesThis request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.AccountId (string)
State (string)
ResourceType (string)
MessageCategory (string)
AggregationPeriod (string)
MaxResults (integer)
NextToken (string)
backup/list_frameworksReturns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.MaxResults (integer)
NextToken (string)
backup/list_indexed_recovery_pointsThis operation returns a list of recovery points that have an associated index, belonging to the specified account. Optional parameters you can include are: MaxResults; NextToken; SourceResourceArns; CreatedBefore; CreatedAfter; and ResourceType.NextToken (string)
MaxResults (integer)
SourceResourceArn (string)
CreatedBefore (string)
CreatedAfter (string)
ResourceType (string)
IndexStatus (string)
backup/list_legal_holdsThis action returns metadata about active and previous legal holds.NextToken (string)
MaxResults (integer)
backup/list_protected_resourcesReturns 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.NextToken (string)
MaxResults (integer)
backup/list_protected_resources_by_backup_vaultThis request lists the protected resources corresponding to each backup vault.BackupVaultName (string) required
BackupVaultAccountId (string)
NextToken (string)
MaxResults (integer)
backup/list_recovery_points_by_backup_vaultReturns detailed information about the recovery points stored in a backup vault.BackupVaultName (string) required
BackupVaultAccountId (string)
NextToken (string)
MaxResults (integer)
ByResourceArn (string)
ByResourceType (string)
ByBackupPlanId (string)
ByCreatedBefore (string)
ByCreatedAfter (string)
ByParentRecoveryPointArn (string)
backup/list_recovery_points_by_legal_holdThis action returns recovery point ARNs Amazon Resource Names of the specified legal hold.LegalHoldId (string) required
NextToken (string)
MaxResults (integer)
backup/list_recovery_points_by_resourceThe information about 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.ResourceArn (string) required
NextToken (string)
MaxResults (integer)
ManagedByAWSBackupOnly (boolean)
backup/list_report_jobsReturns details about your report jobs.ByReportPlanName (string)
ByCreationBefore (string)
ByCreationAfter (string)
ByStatus (string)
MaxResults (integer)
NextToken (string)
backup/list_report_plansReturns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.MaxResults (integer)
NextToken (string)
backup/list_restore_access_backup_vaultsReturns a list of restore access backup vaults associated with a specified backup vault.BackupVaultName (string) required
NextToken (string)
MaxResults (integer)
backup/list_restore_jobsReturns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.NextToken (string)
MaxResults (integer)
ByAccountId (string)
ByResourceType (string)
ByCreatedBefore (string)
ByCreatedAfter (string)
ByStatus (string)
ByCompleteBefore (string)
ByCompleteAfter (string)
ByRestoreTestingPlanArn (string)
ByParentJobId (string)
backup/list_restore_jobs_by_protected_resourceThis returns restore jobs that contain the specified protected resource. You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.ResourceArn (string) required
ByStatus (string)
ByRecoveryPointCreationDateAfter (string)
ByRecoveryPointCreationDateBefore (string)
NextToken (string)
MaxResults (integer)
backup/list_restore_job_summariesThis request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.AccountId (string)
State (string)
ResourceType (string)
AggregationPeriod (string)
MaxResults (integer)
NextToken (string)
backup/list_restore_testing_plansReturns a list of restore testing plans.MaxResults (integer)
NextToken (string)
backup/list_restore_testing_selectionsReturns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName.MaxResults (integer)
NextToken (string)
RestoreTestingPlanName (string) required
backup/list_scan_jobsReturns a list of existing scan jobs for an authenticated account for the last 30 days.ByAccountId (string)
ByBackupVaultName (string)
ByCompleteAfter (string)
ByCompleteBefore (string)
ByMalwareScanner (string)
ByRecoveryPointArn (string)
ByResourceArn (string)
ByResourceType (string)
ByScanResultStatus (string)
ByState (string)
MaxResults (integer)
NextToken (string)
backup/list_scan_job_summariesThis is a request for a summary of scan jobs created or running within the most recent 30 days.AccountId (string)
ResourceType (string)
MalwareScanner (string)
ScanResultStatus (string)
State (string)
AggregationPeriod (string)
MaxResults (integer)
NextToken (string)
backup/list_tagsReturns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault. This operation returns results depending on the resource type used in the value for resourceArn. For example, recovery points of Amazon DynamoDB with Advanced Settings have an ARN Amazon Resource Name that begins with arn:aws:backup. Recovery points backups of DynamoDB without Advanced Settings enabled have an ARN that begins with arn:aws:dynamodb. When this operation is called and when youResourceArn (string) required
NextToken (string)
MaxResults (integer)
backup/list_tiering_configurationsReturns a list of tiering configurations.MaxResults (integer)
NextToken (string)
backup/put_backup_vault_access_policySets 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.BackupVaultName (string) required
Policy (string)
backup/put_backup_vault_lock_configurationApplies 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 been assessed by Cohasset Associates for use in envirBackupVaultName (string) required
MinRetentionDays (integer)
MaxRetentionDays (integer)
ChangeableForDays (integer)
backup/put_backup_vault_notificationsTurns on notifications on a backup vault for the specified topic and events.BackupVaultName (string) required
SNSTopicArn (string) required
BackupVaultEvents (array) required
backup/put_restore_validation_resultThis request allows you to send your independent self-run restore test validation results. RestoreJobId and ValidationStatus are required. Optionally, you can input a ValidationStatusMessage.RestoreJobId (string) required
ValidationStatus (string) required
ValidationStatusMessage (string)
backup/revoke_restore_access_backup_vaultRevokes access to a restore access backup vault, removing the ability to restore from its recovery points and permanently deleting the vault.BackupVaultName (string) required
RestoreAccessBackupVaultArn (string) required
RequesterComment (string)
backup/start_backup_jobStarts an on-demand backup job for the specified resource.BackupVaultName (string) required
LogicallyAirGappedBackupVaultArn (string)
ResourceArn (string) required
IamRoleArn (string) required
IdempotencyToken (string)
StartWindowMinutes (integer)
CompleteWindowMinutes (integer)
Lifecycle: {
. MoveToColdStorageAfterDays (integer)
. DeleteAfterDays (integer)
. OptInToArchiveForSupportedResources (boolean)
. DeleteAfterEvent (string)
} (object)
RecoveryPointTags (object)
BackupOptions (object)
Index (string)
backup/start_copy_jobStarts a job to create a one-time copy of the specified resource. Does not support continuous backups. See Copy job retry for information on how Backup retries copy job operations.RecoveryPointArn (string) required
SourceBackupVaultName (string) required
DestinationBackupVaultArn (string) required
IamRoleArn (string) required
IdempotencyToken (string)
Lifecycle: {
. MoveToColdStorageAfterDays (integer)
. DeleteAfterDays (integer)
. OptInToArchiveForSupportedResources (boolean)
. DeleteAfterEvent (string)
} (object)
backup/start_report_jobStarts an on-demand report job for the specified report plan.ReportPlanName (string) required
IdempotencyToken (string)
backup/start_restore_jobRecovers the saved resource identified by an Amazon Resource Name ARN.RecoveryPointArn (string) required
Metadata (object) required
IamRoleArn (string)
IdempotencyToken (string)
ResourceType (string)
CopySourceTagsToRestoredResource (boolean)
backup/start_scan_jobStarts scanning jobs for specific resources.BackupVaultName (string) required
IamRoleArn (string) required
IdempotencyToken (string)
MalwareScanner (string) required
RecoveryPointArn (string) required
ScanBaseRecoveryPointArn (string)
ScanMode (string) required
ScannerRoleArn (string) required
backup/stop_backup_jobAttempts to cancel a job to create a one-time backup of a resource. This action is not supported for the following services: Amazon Aurora Amazon DocumentDB with MongoDB compatibility Amazon FSx for Lustre Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server Amazon Neptune SAP HANA databases on Amazon EC2 instances Amazon RDSBackupJobId (string) required
backup/tag_resourceAssigns a set of key-value pairs to a resource.ResourceArn (string) required
Tags (object) required
backup/untag_resourceRemoves a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name ARN This API is not supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon RDS.ResourceArn (string) required
TagKeyList (array) required
backup/update_backup_planUpdates the specified backup plan. The new version is uniquely identified by its ID.BackupPlanId (string) required
BackupPlan: {
. BackupPlanName (string)
. Rules (array)
. AdvancedBackupSettings (array)
. ScanSettings (array)
} (object) required
backup/update_frameworkUpdates the specified framework.FrameworkName (string) required
FrameworkDescription (string)
FrameworkControls (array)
IdempotencyToken (string)
backup/update_global_settingsUpdates 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.GlobalSettings (object)
backup/update_recovery_point_index_settingsThis operation updates the settings of a recovery point index. Required: BackupVaultName, RecoveryPointArn, and IAMRoleArnBackupVaultName (string) required
RecoveryPointArn (string) required
IamRoleArn (string)
Index (string) required
backup/update_recovery_point_lifecycleSets 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. Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types. Backups transitioned to cold storage must be stored in cold storage for a minimum ofBackupVaultName (string) required
RecoveryPointArn (string) required
Lifecycle: {
. MoveToColdStorageAfterDays (integer)
. DeleteAfterDays (integer)
. OptInToArchiveForSupportedResources (boolean)
. DeleteAfterEvent (string)
} (object)
backup/update_region_settingsUpdates the current service opt-in settings for the Region. Use the DescribeRegionSettings API to determine the resource types that are supported.ResourceTypeOptInPreference (object)
ResourceTypeManagementPreference (object)
backup/update_report_planUpdates the specified report plan.ReportPlanName (string) required
ReportPlanDescription (string)
ReportDeliveryChannel: {
. S3BucketName (string)
. S3KeyPrefix (string)
. Formats (array)
} (object)
ReportSetting: {
. ReportTemplate (string)
. FrameworkArns (array)
. NumberOfFrameworks (integer)
. Accounts (array)
. OrganizationUnits (array)
. Regions (array)
} (object)
IdempotencyToken (string)
backup/update_restore_testing_planThis request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot be updated after it is created. RecoveryPointSelection can contain: Algorithm ExcludeVaults IncludeVaults RecoveryPointTypes SelectionWindowDaysRestoreTestingPlan: {
. RecoveryPointSelection (object)
. ScheduleExpression (string)
. ScheduleExpressionTimezone (string)
. StartWindowHours (integer)
} (object) required
RestoreTestingPlanName (string) required
backup/update_restore_testing_selectionUpdates the specified restore testing selection. Most elements except the RestoreTestingSelectionName can be updated with this request. You can use either protected resource ARNs or conditions, but not both.RestoreTestingPlanName (string) required
RestoreTestingSelection: {
. IamRoleArn (string)
. ProtectedResourceArns (array)
. ProtectedResourceConditions (object)
. RestoreMetadataOverrides (object)
. ValidationWindowHours (integer)
} (object) required
RestoreTestingSelectionName (string) required
backup/update_tiering_configurationThis request will send changes to your specified tiering configuration. TieringConfigurationName cannot be updated after it is created. ResourceSelection can contain: Resources TieringDownSettingsInDays ResourceTypeTieringConfigurationName (string) required
TieringConfiguration: {
. ResourceSelection (array)
. BackupVaultName (string)
} (object) required
backupsearch/list_search_job_backupsThis operation returns a list of all backups recovery points in a paginated format that were included in the search job. If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message. Only recovery points with a backup index that has a status of ACTIVE will be included in search reSearchJobIdentifier (string) required
NextToken (string)
MaxResults (integer)
backupsearch/list_search_job_resultsThis operation returns a list of a specified search job.SearchJobIdentifier (string) required
NextToken (string)
MaxResults (integer)
backupsearch/list_tags_for_resourceThis operation returns the tags for a resource type.ResourceArn (string) required
backupsearch/tag_resourceThis operation puts tags on the resource you indicate.ResourceArn (string) required
Tags (object) required
backupsearch/untag_resourceThis operation removes tags from the specified resource.ResourceArn (string) required
TagKeys (array) required
backupsearch/start_search_jobThis operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters. You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.Tags (object)
Name (string)
EncryptionKeyArn (string)
ClientToken (string)
SearchScope: {
. BackupResourceTypes (array)
. BackupResourceCreationTime (object)
. SourceResourceArns (array)
. BackupResourceArns (array)
. BackupResourceTags (object)
} (object) required
ItemFilters: {
. S3ItemFilters (array)
. EBSItemFilters (array)
} (object)
backupsearch/get_search_jobThis operation retrieves metadata of a search job, including its progress.SearchJobIdentifier (string) required
backupsearch/stop_search_jobThis operations ends a search job. Only a search job with a status of RUNNING can be stopped.SearchJobIdentifier (string) required
backupsearch/list_search_jobsThis operation returns a list of search jobs belonging to an account.ByStatus (string)
NextToken (string)
MaxResults (integer)
backupsearch/start_search_result_export_jobThis operations starts a job to export the results of search job to a designated S3 bucket.SearchJobIdentifier (string) required
ExportSpecification (undefined) required
ClientToken (string)
Tags (object)
RoleArn (string)
backupsearch/get_search_result_export_jobThis operation retrieves the metadata of an export job. An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file. An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.ExportJobIdentifier (string) required
backupsearch/list_search_result_export_jobsThis operation exports search results of a search job to a specified destination S3 bucket.Status (string)
SearchJobIdentifier (string)
NextToken (string)
MaxResults (integer)
batch/cancel_jobCancels a job in an Batch job queue. Jobs that are in a SUBMITTED, PENDING, or RUNNABLE state are cancelled and the job status is updated to FAILED. A PENDING job is canceled after all dependency jobs are completed. Therefore, it may take longer than expected to cancel a job in PENDING status. When you try to cancel an array parent job in PENDING, Batch attempts to cancel all child jobs. The array parent job is canceled when all child jobs are completed. Jobs that progressed to the STARTING or RjobId (string) required
reason (string) required
batch/create_compute_environmentCreates 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 environmencomputeEnvironmentName (string) required
type (string) required
state (string)
unmanagedvCpus (integer)
computeResources: {
. type (string)
. allocationStrategy (string)
. minvCpus (integer)
. maxvCpus (integer)
. desiredvCpus (integer)
. instanceTypes (array)
. imageId (string)
. subnets (array)
. securityGroupIds (array)
. ec2KeyPair (string)
. instanceRole (string)
. tags (object)
. placementGroup (string)
. bidPercentage (integer)
. spotIamFleetRole (string)
. launchTemplate (object)
. ec2Configuration (array)
} (object)
serviceRole (string)
tags (object)
eksConfiguration: {
. eksClusterArn (string)
. kubernetesNamespace (string)
} (object)
context (string)
batch/create_consumable_resourceCreates an Batch consumable resource.consumableResourceName (string) required
totalQuantity (integer)
resourceType (string)
tags (object)
batch/create_job_queueCreates 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 computjobQueueName (string) required
state (string)
schedulingPolicyArn (string)
priority (integer) required
computeEnvironmentOrder (array)
serviceEnvironmentOrder (array)
jobQueueType (string)
tags (object)
jobStateTimeLimitActions (array)
batch/create_scheduling_policyCreates an Batch scheduling policy.name (string) required
fairsharePolicy: {
. shareDecaySeconds (integer)
. computeReservation (integer)
. shareDistribution (array)
} (object)
tags (object)
batch/create_service_environmentCreates a service environment for running service jobs. Service environments define capacity limits for specific service types such as SageMaker Training jobs.serviceEnvironmentName (string) required
serviceEnvironmentType (string) required
state (string)
capacityLimits (array) required
tags (object)
batch/delete_compute_environmentDeletes 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.computeEnvironment (string) required
batch/delete_consumable_resourceDeletes the specified consumable resource.consumableResource (string) required
batch/delete_job_queueDeletes 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.jobQueue (string) required
batch/delete_scheduling_policyDeletes the specified scheduling policy. You can't delete a scheduling policy that's used in any job queues.arn (string) required
batch/delete_service_environmentDeletes a Service environment. Before you can delete a service environment, you must first set its state to DISABLED with the UpdateServiceEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.serviceEnvironment (string) required
batch/deregister_job_definitionDeregisters an Batch job definition. Job definitions are permanently deleted after 180 days.jobDefinition (string) required
batch/describe_compute_environmentsDescribes 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.computeEnvironments (array)
maxResults (integer)
nextToken (string)
batch/describe_consumable_resourceReturns a description of the specified consumable resource.consumableResource (string) required
batch/describe_job_definitionsDescribes a list of job definitions. You can specify a status such as ACTIVE to only return job definitions that match that status.jobDefinitions (array)
maxResults (integer)
jobDefinitionName (string)
status (string)
nextToken (string)
batch/describe_job_queuesDescribes one or more of your job queues.jobQueues (array)
maxResults (integer)
nextToken (string)
batch/describe_jobsDescribes a list of Batch jobs.jobs (array) required
batch/describe_scheduling_policiesDescribes one or more of your scheduling policies.arns (array) required
batch/describe_service_environmentsDescribes one or more of your service environments.serviceEnvironments (array)
maxResults (integer)
nextToken (string)
batch/describe_service_jobThe details of a service job.jobId (string) required
batch/get_job_queue_snapshotProvides a list of the first 100 RUNNABLE jobs associated to a single job queue and includes capacity utilization, including total usage and breakdown by share for fairshare scheduling job queues.jobQueue (string) required
batch/list_consumable_resourcesReturns a list of Batch consumable resources.filters (array)
maxResults (integer)
nextToken (string)
batch/list_jobsReturns 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 jobjobQueue (string)
arrayJobId (string)
multiNodeJobId (string)
jobStatus (string)
maxResults (integer)
nextToken (string)
filters (array)
batch/list_jobs_by_consumable_resourceReturns a list of Batch jobs that require a specific consumable resource.consumableResource (string) required
filters (array)
maxResults (integer)
nextToken (string)
batch/list_scheduling_policiesReturns a list of Batch scheduling policies.maxResults (integer)
nextToken (string)
batch/list_service_jobsReturns a list of service jobs for a specified job queue.jobQueue (string)
jobStatus (string)
maxResults (integer)
nextToken (string)
filters (array)
batch/list_tags_for_resourceLists 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 aren't supported.resourceArn (string) required
batch/register_job_definitionRegisters an Batch job definition.jobDefinitionName (string) required
type (string) required
parameters (object)
schedulingPriority (integer)
containerProperties: {
. image (string)
. vcpus (integer)
. memory (integer)
. command (array)
. jobRoleArn (string)
. executionRoleArn (string)
. volumes (array)
. environment (array)
. mountPoints (array)
. readonlyRootFilesystem (boolean)
. privileged (boolean)
. ulimits (array)
. user (string)
. instanceType (string)
. resourceRequirements (array)
. linuxParameters (object)
. logConfiguration (object)
. secrets (array)
. networkConfiguration (object)
. fargatePlatformConfiguration (object)
. enableExecuteCommand (boolean)
. ephemeralStorage (object)
. runtimePlatform (object)
. repositoryCredentials (object)
} (object)
nodeProperties: {
. numNodes (integer)
. mainNode (integer)
. nodeRangeProperties (array)
} (object)
retryStrategy: {
. attempts (integer)
. evaluateOnExit (array)
} (object)
propagateTags (boolean)
timeout: {
. attemptDurationSeconds (integer)
} (object)
tags (object)
platformCapabilities (array)
eksProperties: {
. podProperties (object)
} (object)
ecsProperties: {
. taskProperties (array)
} (object)
consumableResourceProperties: {
. consumableResourceList (array)
} (object)
batch/submit_jobSubmits 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 wjobName (string) required
jobQueue (string) required
shareIdentifier (string)
schedulingPriorityOverride (integer)
arrayProperties: {
. size (integer)
} (object)
dependsOn (array)
jobDefinition (string) required
parameters (object)
containerOverrides: {
. vcpus (integer)
. memory (integer)
. command (array)
. instanceType (string)
. environment (array)
. resourceRequirements (array)
} (object)
nodeOverrides: {
. numNodes (integer)
. nodePropertyOverrides (array)
} (object)
retryStrategy: {
. attempts (integer)
. evaluateOnExit (array)
} (object)
propagateTags (boolean)
timeout: {
. attemptDurationSeconds (integer)
} (object)
tags (object)
eksPropertiesOverride: {
. podProperties (object)
} (object)
ecsPropertiesOverride: {
. taskProperties (array)
} (object)
consumableResourcePropertiesOverride: {
. consumableResourceList (array)
} (object)
batch/submit_service_jobSubmits a service job to a specified job queue to run on SageMaker AI. A service job is a unit of work that you submit to Batch for execution on SageMaker AI.jobName (string) required
jobQueue (string) required
retryStrategy: {
. attempts (integer)
. evaluateOnExit (array)
} (object)
schedulingPriority (integer)
serviceRequestPayload (string) required
serviceJobType (string) required
shareIdentifier (string)
timeoutConfig: {
. attemptDurationSeconds (integer)
} (object)
tags (object)
clientToken (string)
batch/tag_resourceAssociates 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 aren't supported.resourceArn (string) required
tags (object) required
batch/terminate_jobTerminates 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.jobId (string) required
reason (string) required
batch/terminate_service_jobTerminates a service job in a job queue.jobId (string) required
reason (string) required
batch/untag_resourceDeletes specified tags from an Batch resource.resourceArn (string) required
tagKeys (array) required
batch/update_compute_environmentUpdates an Batch compute environment.computeEnvironment (string) required
state (string)
unmanagedvCpus (integer)
computeResources: {
. minvCpus (integer)
. maxvCpus (integer)
. desiredvCpus (integer)
. subnets (array)
. securityGroupIds (array)
. allocationStrategy (string)
. instanceTypes (array)
. ec2KeyPair (string)
. instanceRole (string)
. tags (object)
. placementGroup (string)
. bidPercentage (integer)
. launchTemplate (object)
. ec2Configuration (array)
. updateToLatestImageVersion (boolean)
. type (string)
. imageId (string)
} (object)
serviceRole (string)
updatePolicy: {
. terminateJobsOnUpdate (boolean)
. jobExecutionTimeoutMinutes (integer)
} (object)
context (string)
batch/update_consumable_resourceUpdates a consumable resource.consumableResource (string) required
operation (string)
quantity (integer)
clientToken (string)
batch/update_job_queueUpdates a job queue.jobQueue (string) required
state (string)
schedulingPolicyArn (string)
priority (integer)
computeEnvironmentOrder (array)
serviceEnvironmentOrder (array)
jobStateTimeLimitActions (array)
batch/update_scheduling_policyUpdates a scheduling policy.arn (string) required
fairsharePolicy: {
. shareDecaySeconds (integer)
. computeReservation (integer)
. shareDistribution (array)
} (object)
batch/update_service_environmentUpdates a service environment. You can update the state of a service environment from ENABLED to DISABLED to prevent new service jobs from being placed in the service environment.serviceEnvironment (string) required
state (string)
capacityLimits (array)
bcm_dashboards/create_dashboardCreates a new dashboard that can contain multiple widgets displaying cost and usage data. You can add custom widgets or use predefined widgets, arranging them in your preferred layout.name (string) required
description (string)
widgets (array) required
resourceTags (array)
bcm_dashboards/delete_dashboardDeletes a specified dashboard. This action cannot be undone.arn (string) required
bcm_dashboards/get_dashboardRetrieves the configuration and metadata of a specified dashboard, including its widgets and layout settings.arn (string) required
bcm_dashboards/get_resource_policyRetrieves the resource-based policy attached to a dashboard, showing sharing configurations and permissions.resourceArn (string) required
bcm_dashboards/list_dashboardsReturns a list of all dashboards in your account.maxResults (integer)
nextToken (string)
bcm_dashboards/list_tags_for_resourceReturns a list of all tags associated with a specified dashboard resource.resourceArn (string) required
bcm_dashboards/tag_resourceAdds or updates tags for a specified dashboard resource.resourceArn (string) required
resourceTags (array) required
bcm_dashboards/untag_resourceRemoves specified tags from a dashboard resource.resourceArn (string) required
resourceTagKeys (array) required
bcm_dashboards/update_dashboardUpdates an existing dashboard's properties, including its name, description, and widget configurations.arn (string) required
name (string)
description (string)
widgets (array)
bcm_data_exports/create_exportCreates a data export and specifies the data query, the delivery preference, and any optional resource tags. A DataQuery consists of both a QueryStatement and TableConfigurations. The QueryStatement is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query. To view the available tables and columns, see the Data Exports table dictionary. The TableConfigurations is a collection of specified TablePropExport: {
. ExportArn (string)
. Name (string)
. Description (string)
. DataQuery (object)
. DestinationConfigurations (object)
. RefreshCadence (object)
} (object) required
ResourceTags (array)
bcm_data_exports/delete_exportDeletes an existing data export.ExportArn (string) required
bcm_data_exports/get_executionExports data based on the source data update.ExportArn (string) required
ExecutionId (string) required
bcm_data_exports/get_exportViews the definition of an existing data export.ExportArn (string) required
bcm_data_exports/get_tableReturns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.TableName (string) required
TableProperties (object)
bcm_data_exports/list_executionsLists the historical executions for the export.ExportArn (string) required
MaxResults (integer)
NextToken (string)
bcm_data_exports/list_exportsLists all data export definitions.MaxResults (integer)
NextToken (string)
bcm_data_exports/list_tablesLists all available tables in data exports.NextToken (string)
MaxResults (integer)
bcm_data_exports/list_tags_for_resourceList tags associated with an existing data export.ResourceArn (string) required
MaxResults (integer)
NextToken (string)
bcm_data_exports/tag_resourceAdds tags for an existing data export definition.ResourceArn (string) required
ResourceTags (array) required
bcm_data_exports/untag_resourceDeletes tags associated with an existing data export definition.ResourceArn (string) required
ResourceTagKeys (array) required
bcm_data_exports/update_exportUpdates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.ExportArn (string) required
Export: {
. ExportArn (string)
. Name (string)
. Description (string)
. DataQuery (object)
. DestinationConfigurations (object)
. RefreshCadence (object)
} (object) required
bcm_pricing_calculator/get_preferencesRetrieves the current preferences for Pricing Calculator.No parameters
bcm_pricing_calculator/list_tags_for_resourceLists all tags associated with a specified resource.arn (string) required
bcm_pricing_calculator/tag_resourceAdds one or more tags to a specified resource.arn (string) required
tags (object) required
bcm_pricing_calculator/untag_resourceRemoves one or more tags from a specified resource.arn (string) required
tagKeys (array) required
bcm_pricing_calculator/update_preferencesUpdates the preferences for Pricing Calculator.managementAccountRateTypeSelections (array)
memberAccountRateTypeSelections (array)
standaloneAccountRateTypeSelections (array)
bcm_pricing_calculator/create_bill_estimateCreate a Bill estimate from a Bill scenario. In the Bill scenario you can model usage addition, usage changes, and usage removal. You can also model commitment addition and commitment removal. After all changes in a Bill scenario is made satisfactorily, you can call this API with a Bill scenario ID to generate the Bill estimate. Bill estimate calculates the pre-tax cost for your consolidated billing family, incorporating all modeled usage and commitments alongside existing usage and commitmentsbillScenarioId (string) required
name (string) required
clientToken (string)
tags (object)
bcm_pricing_calculator/get_bill_estimateRetrieves details of a specific bill estimate.identifier (string) required
bcm_pricing_calculator/update_bill_estimateUpdates an existing bill estimate.identifier (string) required
name (string)
expiresAt (string)
bcm_pricing_calculator/delete_bill_estimateDeletes an existing bill estimate.identifier (string) required
bcm_pricing_calculator/list_bill_estimatesLists all bill estimates for the account.filters (array)
createdAtFilter: {
. afterTimestamp (string)
. beforeTimestamp (string)
} (object)
expiresAtFilter: {
. afterTimestamp (string)
. beforeTimestamp (string)
} (object)
nextToken (string)
maxResults (integer)
bcm_pricing_calculator/list_bill_estimate_commitmentsLists the commitments associated with a bill estimate.billEstimateId (string) required
nextToken (string)
maxResults (integer)
bcm_pricing_calculator/list_bill_estimate_input_commitment_modificationsLists the input commitment modifications associated with a bill estimate.billEstimateId (string) required
nextToken (string)
maxResults (integer)
bcm_pricing_calculator/list_bill_estimate_input_usage_modificationsLists the input usage modifications associated with a bill estimate.billEstimateId (string) required
filters (array)
nextToken (string)
maxResults (integer)
bcm_pricing_calculator/list_bill_estimate_line_itemsLists the line items associated with a bill estimate.billEstimateId (string) required
filters (array)
nextToken (string)
maxResults (integer)
bcm_pricing_calculator/create_bill_scenarioCreates a new bill scenario to model potential changes to Amazon Web Services usage and costs.name (string) required
clientToken (string)
tags (object)
groupSharingPreference (string)
costCategoryGroupSharingPreferenceArn (string)
bcm_pricing_calculator/get_bill_scenarioRetrieves details of a specific bill scenario.identifier (string) required
bcm_pricing_calculator/update_bill_scenarioUpdates an existing bill scenario.identifier (string) required
name (string)
expiresAt (string)
groupSharingPreference (string)
costCategoryGroupSharingPreferenceArn (string)
bcm_pricing_calculator/delete_bill_scenarioDeletes an existing bill scenario.identifier (string) required
bcm_pricing_calculator/list_bill_scenariosLists all bill scenarios for the account.filters (array)
createdAtFilter: {
. afterTimestamp (string)
. beforeTimestamp (string)
} (object)
expiresAtFilter: {
. afterTimestamp (string)
. beforeTimestamp (string)
} (object)
nextToken (string)
maxResults (integer)
bcm_pricing_calculator/batch_create_bill_scenario_commitment_modificationCreate Compute Savings Plans, EC2 Instance Savings Plans, or EC2 Reserved Instances commitments that you want to model in a Bill Scenario. The BatchCreateBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:CreateBillScenarioCommitmentModification in your policies.billScenarioId (string) required
commitmentModifications (array) required
clientToken (string)
bcm_pricing_calculator/batch_delete_bill_scenario_commitment_modificationDelete commitment that you have created in a Bill Scenario. You can only delete a commitment that you had added and cannot model deletion or removal of a existing commitment. If you want model deletion of an existing commitment, see the negate BillScenarioCommitmentModificationAction of BatchCreateBillScenarioCommitmentModification operation. The BatchDeleteBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services princibillScenarioId (string) required
ids (array) required
bcm_pricing_calculator/batch_update_bill_scenario_commitment_modificationUpdate a newly added or existing commitment. You can update the commitment group based on a commitment ID and a Bill scenario ID. The BatchUpdateBillScenarioCommitmentModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:UpdateBillScenarioCommitmentModification in your policies.billScenarioId (string) required
commitmentModifications (array) required
bcm_pricing_calculator/list_bill_scenario_commitment_modificationsLists the commitment modifications associated with a bill scenario.billScenarioId (string) required
nextToken (string)
maxResults (integer)
bcm_pricing_calculator/batch_create_bill_scenario_usage_modificationCreate Amazon Web Services service usage that you want to model in a Bill Scenario. The BatchCreateBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:CreateBillScenarioUsageModification in your policies.billScenarioId (string) required
usageModifications (array) required
clientToken (string)
bcm_pricing_calculator/batch_delete_bill_scenario_usage_modificationDelete usage that you have created in a Bill Scenario. You can only delete usage that you had added and cannot model deletion or removal of a existing usage. If you want model removal of an existing usage, see BatchUpdateBillScenarioUsageModification. The BatchDeleteBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:DeleteBillScenarioUsageModification in your pobillScenarioId (string) required
ids (array) required
bcm_pricing_calculator/batch_update_bill_scenario_usage_modificationUpdate a newly added or existing usage lines. You can update the usage amounts, usage hour, and usage group based on a usage ID and a Bill scenario ID. The BatchUpdateBillScenarioUsageModification operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:UpdateBillScenarioUsageModification in your policies.billScenarioId (string) required
usageModifications (array) required
bcm_pricing_calculator/list_bill_scenario_usage_modificationsLists the usage modifications associated with a bill scenario.billScenarioId (string) required
filters (array)
nextToken (string)
maxResults (integer)
bcm_pricing_calculator/create_workload_estimateCreates a new workload estimate to model costs for a specific workload.name (string) required
clientToken (string)
rateType (string)
tags (object)
bcm_pricing_calculator/get_workload_estimateRetrieves details of a specific workload estimate.identifier (string) required
bcm_pricing_calculator/update_workload_estimateUpdates an existing workload estimate.identifier (string) required
name (string)
expiresAt (string)
bcm_pricing_calculator/delete_workload_estimateDeletes an existing workload estimate.identifier (string) required
bcm_pricing_calculator/list_workload_estimatesLists all workload estimates for the account.createdAtFilter: {
. afterTimestamp (string)
. beforeTimestamp (string)
} (object)
expiresAtFilter: {
. afterTimestamp (string)
. beforeTimestamp (string)
} (object)
filters (array)
nextToken (string)
maxResults (integer)
bcm_pricing_calculator/batch_create_workload_estimate_usageCreate Amazon Web Services service usage that you want to model in a Workload Estimate. The BatchCreateWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:CreateWorkloadEstimateUsage in your policies.workloadEstimateId (string) required
usage (array) required
clientToken (string)
bcm_pricing_calculator/batch_delete_workload_estimate_usageDelete usage that you have created in a Workload estimate. You can only delete usage that you had added and cannot model deletion or removal of a existing usage. If you want model removal of an existing usage, see BatchUpdateWorkloadEstimateUsage. The BatchDeleteWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:DeleteWorkloadEstimateUsage in your policies.workloadEstimateId (string) required
ids (array) required
bcm_pricing_calculator/batch_update_workload_estimate_usageUpdate a newly added or existing usage lines. You can update the usage amounts and usage group based on a usage ID and a Workload estimate ID. The BatchUpdateWorkloadEstimateUsage operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission bcm-pricing-calculator:UpdateWorkloadEstimateUsage in your policies.workloadEstimateId (string) required
usage (array) required
bcm_pricing_calculator/list_workload_estimate_usageLists the usage associated with a workload estimate.workloadEstimateId (string) required
filters (array)
nextToken (string)
maxResults (integer)
bcm_recommended_actions/list_recommended_actionsReturns a list of recommended actions that match the filter criteria.filter: {
. actions (array)
} (object)
maxResults (integer)
nextToken (string)
bedrock_agent_runtime/get_execution_flow_snapshotRetrieves the flow definition snapshot used for a flow execution. The snapshot represents the flow metadata and definition as it existed at the time the execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged. Flow executions is in preview release for Amazon Bedrock and is subject to change.flowIdentifier (string) required
flowAliasIdentifier (string) required
executionIdentifier (string) required
bedrock_agent_runtime/get_flow_executionRetrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.flowIdentifier (string) required
flowAliasIdentifier (string) required
executionIdentifier (string) required
bedrock_agent_runtime/list_flow_execution_eventsLists events that occurred during a flow execution. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events. Flow executions is in preview release for Amazon Bedrock and is subject to change.flowIdentifier (string) required
flowAliasIdentifier (string) required
executionIdentifier (string) required
maxResults (integer)
nextToken (string)
eventType (string) required
bedrock_agent_runtime/list_flow_executionsLists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name ARN. Flow executions is in preview release for Amazon Bedrock and is subject to change.flowIdentifier (string) required
flowAliasIdentifier (string)
maxResults (integer)
nextToken (string)
bedrock_agent_runtime/start_flow_executionStarts an execution of an Amazon Bedrock flow. Unlike flows that run until completion or time out after five minutes, flow executions let you run flows asynchronously for longer durations. Flow executions also yield control so that your application can perform other tasks. This operation returns an Amazon Resource Name ARN that you can use to track and manage your flow execution. Flow executions is in preview release for Amazon Bedrock and is subject to change.flowIdentifier (string) required
flowAliasIdentifier (string) required
flowExecutionName (string)
inputs (array) required
modelPerformanceConfiguration: {
. performanceConfig (object)
} (object)
bedrock_agent_runtime/stop_flow_executionStops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to Aborted.flowIdentifier (string) required
flowAliasIdentifier (string) required
executionIdentifier (string) required
bedrock_agent_runtime/invoke_flowInvokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide. The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeFlow.flowIdentifier (string) required
flowAliasIdentifier (string) required
inputs (array) required
enableTrace (boolean)
modelPerformanceConfiguration: {
. performanceConfig (object)
} (object)
executionId (string)
bedrock_agent_runtime/generate_queryGenerates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide.queryGenerationInput: {
. type (string)
. text (string)
} (object) required
transformationConfiguration: {
. mode (string)
. textToSqlConfiguration (object)
} (object) required
bedrock_agent_runtime/invoke_agentSends a prompt for the agent to process and respond to. Note the following fields for the request: To continue the same conversation with an agent, use the same sessionId value in the request. To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement. End a conversation by setting endSession tosessionState: {
. sessionAttributes (object)
. promptSessionAttributes (object)
. returnControlInvocationResults (array)
. invocationId (string)
. files (array)
. knowledgeBaseConfigurations (array)
. conversationHistory (object)
} (object)
agentId (string) required
agentAliasId (string) required
sessionId (string) required
endSession (boolean)
enableTrace (boolean)
inputText (string)
memoryId (string)
bedrockModelConfigurations: {
. performanceConfig (object)
} (object)
streamingConfigurations: {
. streamFinalResponse (boolean)
. applyGuardrailInterval (integer)
} (object)
promptCreationConfigurations: {
. previousConversationTurnsToInclude (integer)
. excludePreviousThinkingSteps (boolean)
} (object)
sourceArn (string)
bedrock_agent_runtime/invoke_inline_agentInvokes an inline Amazon Bedrock agent using the configurations you provide with the request. Specify the following fields for security purposes. Optional customerEncryptionKeyArn – The Amazon Resource Name ARN of a KMS key to encrypt the creation of the agent. Optional idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session. To override the default promcustomerEncryptionKeyArn (string)
foundationModel (string) required
instruction (string) required
idleSessionTTLInSeconds (integer)
actionGroups (array)
knowledgeBases (array)
guardrailConfiguration: {
. guardrailIdentifier (string)
. guardrailVersion (string)
} (object)
promptOverrideConfiguration: {
. promptConfigurations (array)
. overrideLambda (string)
} (object)
agentCollaboration (string)
collaboratorConfigurations (array)
agentName (string)
sessionId (string) required
endSession (boolean)
enableTrace (boolean)
inputText (string)
streamingConfigurations: {
. streamFinalResponse (boolean)
. applyGuardrailInterval (integer)
} (object)
promptCreationConfigurations: {
. previousConversationTurnsToInclude (integer)
. excludePreviousThinkingSteps (boolean)
} (object)
inlineSessionState: {
. sessionAttributes (object)
. promptSessionAttributes (object)
. returnControlInvocationResults (array)
. invocationId (string)
. files (array)
. conversationHistory (object)
} (object)
collaborators (array)
bedrockModelConfigurations: {
. performanceConfig (object)
} (object)
orchestrationType (string)
customOrchestration: {
. executor
} (object)
bedrock_agent_runtime/delete_agent_memoryDeletes memory from the specified memory identifier.agentId (string) required
agentAliasId (string) required
memoryId (string)
sessionId (string)
bedrock_agent_runtime/get_agent_memoryGets the sessions stored in the memory of the agent.nextToken (string)
maxItems (integer)
agentId (string) required
agentAliasId (string) required
memoryType (string) required
memoryId (string) required
bedrock_agent_runtime/optimize_promptOptimizes a prompt for the task that you specify. For more information, see Optimize a prompt in the Amazon Bedrock User Guide.input (undefined) required
targetModelId (string) required
bedrock_agent_runtime/rerankReranks the relevance of sources based on queries. For more information, see Improve the relevance of query responses with a reranker model.queries (array) required
sources (array) required
rerankingConfiguration: {
. type (string)
. bedrockRerankingConfiguration (object)
} (object) required
nextToken (string)
bedrock_agent_runtime/retrieve_and_generateQueries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile. The response only cites sources that are relevant to the query.sessionId (string)
input: {
. text (string)
} (object) required
retrieveAndGenerateConfiguration: {
. type (string)
. knowledgeBaseConfiguration (object)
. externalSourcesConfiguration (object)
} (object)
sessionConfiguration: {
. kmsKeyArn (string)
} (object)
bedrock_agent_runtime/retrieve_and_generate_streamQueries a knowledge base and generates responses based on the retrieved results, with output in streaming format. The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream. This operation requires permission for the bedrock:RetrieveAndGenerate action.sessionId (string)
input: {
. text (string)
} (object) required
retrieveAndGenerateConfiguration: {
. type (string)
. knowledgeBaseConfiguration (object)
. externalSourcesConfiguration (object)
} (object)
sessionConfiguration: {
. kmsKeyArn (string)
} (object)
bedrock_agent_runtime/retrieveQueries a knowledge base and retrieves information from it.knowledgeBaseId (string) required
retrievalQuery: {
. type (string)
. text (string)
. image (object)
} (object) required
retrievalConfiguration: {
. vectorSearchConfiguration (object)
} (object)
guardrailConfiguration: {
. guardrailId (string)
. guardrailVersion (string)
} (object)
nextToken (string)
bedrock_agent_runtime/end_sessionEnds the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.sessionIdentifier (string) required
bedrock_agent_runtime/create_sessionCreates a session to temporarily store conversations for generative AI GenAI applications built with open-source frameworks such as LangGraph and LlamaIndex. Sessions enable you to save the state of conversations at checkpoints, with the added security and infrastructure of Amazon Web Services. For more information, see Store and retrieve conversation history and context with Amazon Bedrock sessions. By default, Amazon Bedrock uses Amazon Web Services-managed keys for session encryption, includisessionMetadata (object)
encryptionKeyArn (string)
tags (object)
bedrock_agent_runtime/get_sessionRetrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.sessionIdentifier (string) required
bedrock_agent_runtime/update_sessionUpdates the metadata or encryption settings of a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.sessionMetadata (object)
sessionIdentifier (string) required
bedrock_agent_runtime/delete_sessionDeletes a session that you ended. You can't delete a session with an ACTIVE status. To delete an active session, you must first end it with the EndSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.sessionIdentifier (string) required
bedrock_agent_runtime/list_sessionsLists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.maxResults (integer)
nextToken (string)
bedrock_agent_runtime/create_invocationCreates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions. Related APIs ListInvocations ListSessions GetSessioninvocationId (string)
description (string)
sessionIdentifier (string) required
bedrock_agent_runtime/list_invocationsLists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.nextToken (string)
maxResults (integer)
sessionIdentifier (string) required
bedrock_agent_runtime/put_invocation_stepAdd an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions. Related APIs: GetInvocationStep ListInvocationSteps ListInvocations ListSessionssessionIdentifier (string) required
invocationIdentifier (string) required
invocationStepTime (string) required
payload (undefined) required
invocationStepId (string)
bedrock_agent_runtime/get_invocation_stepRetrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.invocationIdentifier (string) required
invocationStepId (string) required
sessionIdentifier (string) required
bedrock_agent_runtime/list_invocation_stepsLists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.invocationIdentifier (string)
nextToken (string)
maxResults (integer)
sessionIdentifier (string) required
bedrock_agent_runtime/list_tags_for_resourceList all the tags for the resource you specify.resourceArn (string) required
bedrock_agent_runtime/tag_resourceAssociate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.resourceArn (string) required
tags (object) required
bedrock_agent_runtime/untag_resourceRemove tags from a resource.resourceArn (string) required
tagKeys (array) required
bedrock_agent/validate_flow_definitionValidates the definition of a flow.definition: {
. nodes (array)
. connections (array)
} (object) required
bedrock_agent/create_agent_action_groupCreates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them. To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group withagentId (string) required
agentVersion (string) required
actionGroupName (string) required
clientToken (string)
description (string)
parentActionGroupSignature (string)
parentActionGroupSignatureParams (object)
actionGroupExecutor (undefined)
apiSchema (undefined)
actionGroupState (string)
functionSchema (undefined)
bedrock_agent/delete_agent_action_groupDeletes an action group in an agent.agentId (string) required
agentVersion (string) required
actionGroupId (string) required
skipResourceInUseCheck (boolean)
bedrock_agent/get_agent_action_groupGets information about an action group for an agent.agentId (string) required
agentVersion (string) required
actionGroupId (string) required
bedrock_agent/list_agent_action_groupsLists the action groups for an agent and information about each one.agentId (string) required
agentVersion (string) required
maxResults (integer)
nextToken (string)
bedrock_agent/update_agent_action_groupUpdates the configuration for an action group for an agent.agentId (string) required
agentVersion (string) required
actionGroupId (string) required
actionGroupName (string) required
description (string)
parentActionGroupSignature (string)
parentActionGroupSignatureParams (object)
actionGroupExecutor (undefined)
actionGroupState (string)
apiSchema (undefined)
functionSchema (undefined)
bedrock_agent/associate_agent_collaboratorMakes an agent a collaborator for another agent.agentId (string) required
agentVersion (string) required
agentDescriptor: {
. aliasArn (string)
} (object) required
collaboratorName (string) required
collaborationInstruction (string) required
relayConversationHistory (string)
clientToken (string)
bedrock_agent/disassociate_agent_collaboratorDisassociates an agent collaborator.agentId (string) required
agentVersion (string) required
collaboratorId (string) required
bedrock_agent/get_agent_collaboratorRetrieves information about an agent's collaborator.agentId (string) required
agentVersion (string) required
collaboratorId (string) required
bedrock_agent/list_agent_collaboratorsRetrieve a list of an agent's collaborators.agentId (string) required
agentVersion (string) required
maxResults (integer)
nextToken (string)
bedrock_agent/update_agent_collaboratorUpdates an agent's collaborator.agentId (string) required
agentVersion (string) required
collaboratorId (string) required
agentDescriptor: {
. aliasArn (string)
} (object) required
collaboratorName (string) required
collaborationInstruction (string) required
relayConversationHistory (string)
bedrock_agent/create_agentCreates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers. Specify the following fields for security purposes. agentResourceRoleArn – The Amazon Resource Name ARN of the role with permissions to invoke API operations on an agent. Optional customerEncryptionKeyArn – The Amazon Resource Name ARN of a KMS key to encrypt the creation of the agent. Optional idleSessionTTLinSeconds –agentName (string) required
clientToken (string)
instruction (string)
foundationModel (string)
description (string)
orchestrationType (string)
customOrchestration: {
. executor
} (object)
idleSessionTTLInSeconds (integer)
agentResourceRoleArn (string)
customerEncryptionKeyArn (string)
tags (object)
promptOverrideConfiguration: {
. promptConfigurations (array)
. overrideLambda (string)
} (object)
guardrailConfiguration: {
. guardrailIdentifier (string)
. guardrailVersion (string)
} (object)
memoryConfiguration: {
. enabledMemoryTypes (array)
. storageDays (integer)
. sessionSummaryConfiguration (object)
} (object)
agentCollaboration (string)
bedrock_agent/delete_agentDeletes an agent.agentId (string) required
skipResourceInUseCheck (boolean)
bedrock_agent/get_agentGets information about an agent.agentId (string) required
bedrock_agent/list_agentsLists the agents belonging to an account and information about each agent.maxResults (integer)
nextToken (string)
bedrock_agent/prepare_agentCreates a DRAFT version of the agent that can be used for internal testing.agentId (string) required
bedrock_agent/update_agentUpdates the configuration of an agent.agentId (string) required
agentName (string) required
instruction (string)
foundationModel (string) required
description (string)
orchestrationType (string)
customOrchestration: {
. executor
} (object)
idleSessionTTLInSeconds (integer)
agentResourceRoleArn (string) required
customerEncryptionKeyArn (string)
promptOverrideConfiguration: {
. promptConfigurations (array)
. overrideLambda (string)
} (object)
guardrailConfiguration: {
. guardrailIdentifier (string)
. guardrailVersion (string)
} (object)
memoryConfiguration: {
. enabledMemoryTypes (array)
. storageDays (integer)
. sessionSummaryConfiguration (object)
} (object)
agentCollaboration (string)
bedrock_agent/create_agent_aliasCreates an alias of an agent that can be used to deploy the agent.agentId (string) required
agentAliasName (string) required
clientToken (string)
description (string)
routingConfiguration (array)
tags (object)
bedrock_agent/delete_agent_aliasDeletes an alias of an agent.agentId (string) required
agentAliasId (string) required
bedrock_agent/get_agent_aliasGets information about an alias of an agent.agentId (string) required
agentAliasId (string) required
bedrock_agent/list_agent_aliasesLists the aliases of an agent and information about each one.agentId (string) required
maxResults (integer)
nextToken (string)
bedrock_agent/update_agent_aliasUpdates configurations for an alias of an agent.agentId (string) required
agentAliasId (string) required
agentAliasName (string) required
description (string)
routingConfiguration (array)
aliasInvocationState (string)
bedrock_agent/create_data_sourceConnects a knowledge base to a data source. You specify the configuration for the specific data source service in the dataSourceConfiguration field. You can't change the chunkingConfiguration after you create the data source connector.knowledgeBaseId (string) required
clientToken (string)
name (string) required
description (string)
dataSourceConfiguration: {
. type (string)
. s3Configuration (object)
. webConfiguration (object)
. confluenceConfiguration (object)
. salesforceConfiguration (object)
. sharePointConfiguration (object)
} (object) required
dataDeletionPolicy (string)
serverSideEncryptionConfiguration: {
. kmsKeyArn (string)
} (object)
vectorIngestionConfiguration: {
. chunkingConfiguration (object)
. customTransformationConfiguration (object)
. parsingConfiguration (object)
. contextEnrichmentConfiguration (object)
} (object)
bedrock_agent/delete_data_sourceDeletes a data source from a knowledge base.knowledgeBaseId (string) required
dataSourceId (string) required
bedrock_agent/get_data_sourceGets information about a data source.knowledgeBaseId (string) required
dataSourceId (string) required
bedrock_agent/list_data_sourcesLists the data sources in a knowledge base and information about each one.knowledgeBaseId (string) required
maxResults (integer)
nextToken (string)
bedrock_agent/update_data_sourceUpdates the configurations for a data source connector. You can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.knowledgeBaseId (string) required
dataSourceId (string) required
name (string) required
description (string)
dataSourceConfiguration: {
. type (string)
. s3Configuration (object)
. webConfiguration (object)
. confluenceConfiguration (object)
. salesforceConfiguration (object)
. sharePointConfiguration (object)
} (object) required
dataDeletionPolicy (string)
serverSideEncryptionConfiguration: {
. kmsKeyArn (string)
} (object)
vectorIngestionConfiguration: {
. chunkingConfiguration (object)
. customTransformationConfiguration (object)
. parsingConfiguration (object)
. contextEnrichmentConfiguration (object)
} (object)
bedrock_agent/prepare_flowPrepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.flowIdentifier (string) required
bedrock_agent/create_flowCreates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.name (string) required
description (string)
executionRoleArn (string) required
customerEncryptionKeyArn (string)
definition: {
. nodes (array)
. connections (array)
} (object)
clientToken (string)
tags (object)
bedrock_agent/get_flowRetrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.flowIdentifier (string) required
bedrock_agent/update_flowModifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.name (string) required
description (string)
executionRoleArn (string) required
customerEncryptionKeyArn (string)
definition: {
. nodes (array)
. connections (array)
} (object)
flowIdentifier (string) required
bedrock_agent/delete_flowDeletes a flow.flowIdentifier (string) required
skipResourceInUseCheck (boolean)
bedrock_agent/list_flowsReturns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.maxResults (integer)
nextToken (string)
bedrock_agent/create_flow_aliasCreates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.name (string) required
description (string)
routingConfiguration (array) required
concurrencyConfiguration: {
. type (string)
. maxConcurrency (integer)
} (object)
flowIdentifier (string) required
clientToken (string)
tags (object)
bedrock_agent/get_flow_aliasRetrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.flowIdentifier (string) required
aliasIdentifier (string) required
bedrock_agent/update_flow_aliasModifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.name (string) required
description (string)
routingConfiguration (array) required
concurrencyConfiguration: {
. type (string)
. maxConcurrency (integer)
} (object)
flowIdentifier (string) required
aliasIdentifier (string) required
bedrock_agent/delete_flow_aliasDeletes an alias of a flow.flowIdentifier (string) required
aliasIdentifier (string) required
bedrock_agent/list_flow_aliasesReturns a list of aliases for a flow.flowIdentifier (string) required
maxResults (integer)
nextToken (string)
bedrock_agent/create_flow_versionCreates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.flowIdentifier (string) required
description (string)
clientToken (string)
bedrock_agent/get_flow_versionRetrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.flowIdentifier (string) required
flowVersion (string) required
bedrock_agent/delete_flow_versionDeletes a version of a flow.flowIdentifier (string) required
flowVersion (string) required
skipResourceInUseCheck (boolean)
bedrock_agent/list_flow_versionsReturns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.flowIdentifier (string) required
maxResults (integer)
nextToken (string)
bedrock_agent/get_ingestion_jobGets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models LLMs can use your data.knowledgeBaseId (string) required
dataSourceId (string) required
ingestionJobId (string) required
bedrock_agent/list_ingestion_jobsLists the data ingestion jobs for a data source. The list also includes information about each job.knowledgeBaseId (string) required
dataSourceId (string) required
filters (array)
sortBy: {
. attribute (string)
. order (string)
} (object)
maxResults (integer)
nextToken (string)
bedrock_agent/start_ingestion_jobBegins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models LLMs can use your data.knowledgeBaseId (string) required
dataSourceId (string) required
clientToken (string)
description (string)
bedrock_agent/stop_ingestion_jobStops a currently running data ingestion job. You can send a StartIngestionJob request again to ingest the rest of your data when you are ready.knowledgeBaseId (string) required
dataSourceId (string) required
ingestionJobId (string) required
bedrock_agent/delete_knowledge_base_documentsDeletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.knowledgeBaseId (string) required
dataSourceId (string) required
clientToken (string)
documentIdentifiers (array) required
bedrock_agent/get_knowledge_base_documentsRetrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.knowledgeBaseId (string) required
dataSourceId (string) required
documentIdentifiers (array) required
bedrock_agent/ingest_knowledge_base_documentsIngests documents directly into the knowledge base that is connected to the data source. The dataSourceType specified in the content for each document must match the type of the data source that you specify in the header. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.knowledgeBaseId (string) required
dataSourceId (string) required
clientToken (string)
documents (array) required
bedrock_agent/list_knowledge_base_documentsRetrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.knowledgeBaseId (string) required
dataSourceId (string) required
maxResults (integer)
nextToken (string)
bedrock_agent/associate_agent_knowledge_baseAssociates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.agentId (string) required
agentVersion (string) required
knowledgeBaseId (string) required
description (string) required
knowledgeBaseState (string)
bedrock_agent/create_knowledge_baseCreates a knowledge base. A knowledge base contains your data sources so that Large Language Models LLMs can use your data. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up a knowledge base. If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base. Provide the name and an optional descripticlientToken (string)
name (string) required
description (string)
roleArn (string) required
knowledgeBaseConfiguration: {
. type (string)
. vectorKnowledgeBaseConfiguration (object)
. kendraKnowledgeBaseConfiguration (object)
. sqlKnowledgeBaseConfiguration (object)
} (object) required
storageConfiguration: {
. type (string)
. opensearchServerlessConfiguration (object)
. opensearchManagedClusterConfiguration (object)
. pineconeConfiguration (object)
. redisEnterpriseCloudConfiguration (object)
. rdsConfiguration (object)
. mongoDbAtlasConfiguration (object)
. neptuneAnalyticsConfiguration (object)
. s3VectorsConfiguration (object)
} (object)
tags (object)
bedrock_agent/delete_knowledge_baseDeletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.knowledgeBaseId (string) required
bedrock_agent/disassociate_agent_knowledge_baseDisassociates a knowledge base from an agent.agentId (string) required
agentVersion (string) required
knowledgeBaseId (string) required
bedrock_agent/get_agent_knowledge_baseGets information about a knowledge base associated with an agent.agentId (string) required
agentVersion (string) required
knowledgeBaseId (string) required
bedrock_agent/get_knowledge_baseGets information about a knowledge base.knowledgeBaseId (string) required
bedrock_agent/list_agent_knowledge_basesLists knowledge bases associated with an agent and information about each one.agentId (string) required
agentVersion (string) required
maxResults (integer)
nextToken (string)
bedrock_agent/list_knowledge_basesLists the knowledge bases in an account. The list also includesinformation about each knowledge base.maxResults (integer)
nextToken (string)
bedrock_agent/update_agent_knowledge_baseUpdates the configuration for a knowledge base that has been associated with an agent.agentId (string) required
agentVersion (string) required
knowledgeBaseId (string) required
description (string)
knowledgeBaseState (string)
bedrock_agent/update_knowledge_baseUpdates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same. You can change the following fields: name description roleArn You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.knowledgeBaseId (string) required
name (string) required
description (string)
roleArn (string) required
knowledgeBaseConfiguration: {
. type (string)
. vectorKnowledgeBaseConfiguration (object)
. kendraKnowledgeBaseConfiguration (object)
. sqlKnowledgeBaseConfiguration (object)
} (object) required
storageConfiguration: {
. type (string)
. opensearchServerlessConfiguration (object)
. opensearchManagedClusterConfiguration (object)
. pineconeConfiguration (object)
. redisEnterpriseCloudConfiguration (object)
. rdsConfiguration (object)
. mongoDbAtlasConfiguration (object)
. neptuneAnalyticsConfiguration (object)
. s3VectorsConfiguration (object)
} (object)
bedrock_agent/create_prompt_versionCreates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.promptIdentifier (string) required
description (string)
clientToken (string)
tags (object)
bedrock_agent/create_promptCreates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.name (string) required
description (string)
customerEncryptionKeyArn (string)
defaultVariant (string)
variants (array)
clientToken (string)
tags (object)
bedrock_agent/get_promptRetrieves information about the working draft DRAFT version of a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.promptIdentifier (string) required
promptVersion (string)
bedrock_agent/update_promptModifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.name (string) required
description (string)
customerEncryptionKeyArn (string)
defaultVariant (string)
variants (array)
promptIdentifier (string) required
bedrock_agent/delete_promptDeletes a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.promptIdentifier (string) required
promptVersion (string)
bedrock_agent/list_promptsReturns either information about the working draft DRAFT version of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the promptIdentifier field or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.promptIdentifier (string)
maxResults (integer)
nextToken (string)
bedrock_agent/list_tags_for_resourceList all the tags for the resource you specify.resourceArn (string) required
bedrock_agent/tag_resourceAssociate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.resourceArn (string) required
tags (object) required
bedrock_agent/untag_resourceRemove tags from a resource.resourceArn (string) required
tagKeys (array) required
bedrock_agent/delete_agent_versionDeletes a version of an agent.agentId (string) required
agentVersion (string) required
skipResourceInUseCheck (boolean)
bedrock_agent/get_agent_versionGets details about a version of an agent.agentId (string) required
agentVersion (string) required
bedrock_agent/list_agent_versionsLists the versions of an agent and information about each version.agentId (string) required
maxResults (integer)
nextToken (string)
bedrock_agentcore_control/delete_resource_policyDeletes the resource-based policy for a specified resource. This feature is currently available only for AgentCore Runtime and Gateway.resourceArn (string) required
bedrock_agentcore_control/get_resource_policyRetrieves the resource-based policy for a specified resource. This feature is currently available only for AgentCore Runtime and Gateway.resourceArn (string) required
bedrock_agentcore_control/get_token_vaultRetrieves information about a token vault.tokenVaultId (string)
bedrock_agentcore_control/list_tags_for_resourceLists the tags associated with the specified resource. This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.resourceArn (string) required
bedrock_agentcore_control/put_resource_policyCreates or updates a resource-based policy for a resource with the specified resourceArn. This feature is currently available only for AgentCore Runtime and Gateway.resourceArn (string) required
policy (string) required
bedrock_agentcore_control/set_token_vault_cmkSets the customer master key CMK for a token vault.tokenVaultId (string)
kmsConfiguration: {
. keyType (string)
. kmsKeyArn (string)
} (object) required
bedrock_agentcore_control/tag_resourceAssociates 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. This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.resourceArn (string) required
tags (object) required
bedrock_agentcore_control/untag_resourceRemoves the specified tags from the specified resource. This feature is currently available only for AgentCore Runtime, Browser, Browser Profile, Code Interpreter tool, and Gateway.resourceArn (string) required
tagKeys (array) required
bedrock_agentcore_control/create_agent_runtime_endpointCreates an AgentCore Runtime endpoint.agentRuntimeId (string) required
name (string) required
agentRuntimeVersion (string)
description (string)
clientToken (string)
tags (object)
bedrock_agentcore_control/get_agent_runtime_endpointGets information about an Amazon Secure AgentEndpoint.agentRuntimeId (string) required
endpointName (string) required
bedrock_agentcore_control/update_agent_runtime_endpointUpdates an existing Amazon Bedrock AgentCore Runtime endpoint.agentRuntimeId (string) required
endpointName (string) required
agentRuntimeVersion (string)
description (string)
clientToken (string)
bedrock_agentcore_control/delete_agent_runtime_endpointDeletes an AAgentCore Runtime endpoint.agentRuntimeId (string) required
endpointName (string) required
clientToken (string)
bedrock_agentcore_control/list_agent_runtime_endpointsLists all endpoints for a specific Amazon Secure Agent.agentRuntimeId (string) required
maxResults (integer)
nextToken (string)
bedrock_agentcore_control/list_agent_runtime_versionsLists all versions of a specific Amazon Secure Agent.agentRuntimeId (string) required
maxResults (integer)
nextToken (string)
bedrock_agentcore_control/create_agent_runtimeCreates an Amazon Bedrock AgentCore Runtime.agentRuntimeName (string) required
agentRuntimeArtifact (undefined) required
roleArn (string) required
networkConfiguration: {
. networkMode (string)
. networkModeConfig (object)
} (object) required
clientToken (string)
description (string)
authorizerConfiguration (undefined)
requestHeaderConfiguration (undefined)
protocolConfiguration: {
. serverProtocol (string)
} (object)
lifecycleConfiguration: {
. idleRuntimeSessionTimeout (integer)
. maxLifetime (integer)
} (object)
environmentVariables (object)
tags (object)
bedrock_agentcore_control/get_agent_runtimeGets an Amazon Bedrock AgentCore Runtime.agentRuntimeId (string) required
agentRuntimeVersion (string)
bedrock_agentcore_control/update_agent_runtimeUpdates an existing Amazon Secure Agent.agentRuntimeId (string) required
agentRuntimeArtifact (undefined) required
roleArn (string) required
networkConfiguration: {
. networkMode (string)
. networkModeConfig (object)
} (object) required
description (string)
authorizerConfiguration (undefined)
requestHeaderConfiguration (undefined)
protocolConfiguration: {
. serverProtocol (string)
} (object)
lifecycleConfiguration: {
. idleRuntimeSessionTimeout (integer)
. maxLifetime (integer)
} (object)
environmentVariables (object)
clientToken (string)
bedrock_agentcore_control/delete_agent_runtimeDeletes an Amazon Bedrock AgentCore Runtime.agentRuntimeId (string) required
clientToken (string)
bedrock_agentcore_control/list_agent_runtimesLists all Amazon Secure Agents in your account.maxResults (integer)
nextToken (string)
bedrock_agentcore_control/list_api_key_credential_providersLists all API key credential providers in your account.nextToken (string)
maxResults (integer)
bedrock_agentcore_control/get_api_key_credential_providerRetrieves information about an API key credential provider.name (string) required
bedrock_agentcore_control/update_api_key_credential_providerUpdates an existing API key credential provider.name (string) required
apiKey (string) required
bedrock_agentcore_control/delete_api_key_credential_providerDeletes an API key credential provider.name (string) required
bedrock_agentcore_control/create_api_key_credential_providerCreates a new API key credential provider.name (string) required
apiKey (string) required
tags (object)
bedrock_agentcore_control/create_browser_profileCreates a browser profile in Amazon Bedrock AgentCore. A browser profile stores persistent browser data such as cookies, local storage, session storage, and browsing history that can be saved from browser sessions and reused in subsequent sessions.name (string) required
description (string)
clientToken (string)
tags (object)
bedrock_agentcore_control/get_browser_profileGets information about a browser profile.profileId (string) required
bedrock_agentcore_control/delete_browser_profileDeletes a browser profile.profileId (string) required
clientToken (string)
bedrock_agentcore_control/list_browser_profilesLists all browser profiles in your account.maxResults (integer)
nextToken (string)
bedrock_agentcore_control/create_browserCreates a custom browser.name (string) required
description (string)
executionRoleArn (string)
networkConfiguration: {
. networkMode (string)
. vpcConfig (object)
} (object) required
recording: {
. enabled (boolean)
. s3Location (object)
} (object)
browserSigning: {
. enabled (boolean)
} (object)
clientToken (string)
tags (object)
bedrock_agentcore_control/get_browserGets information about a custom browser.browserId (string) required
bedrock_agentcore_control/delete_browserDeletes a custom browser.browserId (string) required
clientToken (string)
bedrock_agentcore_control/list_browsersLists all custom browsers in your account.maxResults (integer)
nextToken (string)
type (string)
bedrock_agentcore_control/create_code_interpreterCreates a custom code interpreter.name (string) required
description (string)
executionRoleArn (string)
networkConfiguration: {
. networkMode (string)
. vpcConfig (object)
} (object) required
clientToken (string)
tags (object)
bedrock_agentcore_control/get_code_interpreterGets information about a custom code interpreter.codeInterpreterId (string) required
bedrock_agentcore_control/delete_code_interpreterDeletes a custom code interpreter.codeInterpreterId (string) required
clientToken (string)
bedrock_agentcore_control/list_code_interpretersLists all custom code interpreters in your account.maxResults (integer)
nextToken (string)
type (string)
bedrock_agentcore_control/create_evaluatorCreates a custom evaluator for agent quality assessment. Custom evaluators use LLM-as-a-Judge configurations with user-defined prompts, rating scales, and model settings to evaluate agent performance at tool call, trace, or session levels.clientToken (string)
evaluatorName (string) required
description (string)
evaluatorConfig (undefined) required
level (string) required
tags (object)
bedrock_agentcore_control/get_evaluatorRetrieves detailed information about an evaluator, including its configuration, status, and metadata. Works with both built-in and custom evaluators.evaluatorId (string) required
bedrock_agentcore_control/update_evaluatorUpdates a custom evaluator's configuration, description, or evaluation level. Built-in evaluators cannot be updated. The evaluator must not be locked for modification.clientToken (string)
evaluatorId (string) required
description (string)
evaluatorConfig (undefined)
level (string)
bedrock_agentcore_control/delete_evaluatorDeletes a custom evaluator. Builtin evaluators cannot be deleted. The evaluator must not be referenced by any active online evaluation configurations.evaluatorId (string) required
bedrock_agentcore_control/list_evaluatorsLists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.nextToken (string)
maxResults (integer)
bedrock_agentcore_control/create_gatewayCreates a gateway for Amazon Bedrock Agent. A gateway serves as an integration point between your agent and external services. If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.name (string) required
description (string)
clientToken (string)
roleArn (string) required
protocolType (string) required
protocolConfiguration (undefined)
authorizerType (string) required
authorizerConfiguration (undefined)
kmsKeyArn (string)
interceptorConfigurations (array)
policyEngineConfiguration: {
. arn (string)
. mode (string)
} (object)
exceptionLevel (string)
tags (object)
bedrock_agentcore_control/delete_gatewayDeletes a gateway.gatewayIdentifier (string) required
bedrock_agentcore_control/get_gatewayRetrieves information about a specific Gateway.gatewayIdentifier (string) required
bedrock_agentcore_control/list_gatewaysLists all gateways in the account.maxResults (integer)
nextToken (string)
bedrock_agentcore_control/update_gatewayUpdates an existing gateway.gatewayIdentifier (string) required
name (string) required
description (string)
roleArn (string) required
protocolType (string) required
protocolConfiguration (undefined)
authorizerType (string) required
authorizerConfiguration (undefined)
kmsKeyArn (string)
interceptorConfigurations (array)
policyEngineConfiguration: {
. arn (string)
. mode (string)
} (object)
exceptionLevel (string)
bedrock_agentcore_control/create_gateway_targetCreates a target for a gateway. A target defines an endpoint that the gateway can connect to.gatewayIdentifier (string) required
name (string) required
description (string)
clientToken (string)
targetConfiguration (undefined) required
credentialProviderConfigurations (array)
metadataConfiguration: {
. allowedRequestHeaders (array)
. allowedQueryParameters (array)
. allowedResponseHeaders (array)
} (object)
bedrock_agentcore_control/delete_gateway_targetDeletes a gateway target.gatewayIdentifier (string) required
targetId (string) required
bedrock_agentcore_control/get_gateway_targetRetrieves information about a specific gateway target.gatewayIdentifier (string) required
targetId (string) required
bedrock_agentcore_control/list_gateway_targetsLists all targets for a specific gateway.gatewayIdentifier (string) required
maxResults (integer)
nextToken (string)
bedrock_agentcore_control/synchronize_gateway_targetsThe gateway targets.gatewayIdentifier (string) required
targetIdList (array) required
bedrock_agentcore_control/update_gateway_targetUpdates an existing gateway target.gatewayIdentifier (string) required
targetId (string) required
name (string) required
description (string)
targetConfiguration (undefined) required
credentialProviderConfigurations (array)
metadataConfiguration: {
. allowedRequestHeaders (array)
. allowedQueryParameters (array)
. allowedResponseHeaders (array)
} (object)
bedrock_agentcore_control/create_memoryCreates a new Amazon Bedrock AgentCore Memory resource.clientToken (string)
name (string) required
description (string)
encryptionKeyArn (string)
memoryExecutionRoleArn (string)
eventExpiryDuration (integer) required
memoryStrategies (array)
tags (object)
bedrock_agentcore_control/get_memoryRetrieve an existing Amazon Bedrock AgentCore Memory resource.memoryId (string) required
view (string)
bedrock_agentcore_control/update_memoryUpdate an Amazon Bedrock AgentCore Memory resource memory.clientToken (string)
memoryId (string) required
description (string)
eventExpiryDuration (integer)
memoryExecutionRoleArn (string)
memoryStrategies: {
. addMemoryStrategies (array)
. modifyMemoryStrategies (array)
. deleteMemoryStrategies (array)
} (object)
bedrock_agentcore_control/delete_memoryDeletes an Amazon Bedrock AgentCore Memory resource.clientToken (string)
memoryId (string) required
bedrock_agentcore_control/list_memoriesLists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.maxResults (integer)
nextToken (string)
bedrock_agentcore_control/list_oauth2credential_providersLists all OAuth2 credential providers in your account.nextToken (string)
maxResults (integer)
bedrock_agentcore_control/get_oauth2credential_providerRetrieves information about an OAuth2 credential provider.name (string) required
bedrock_agentcore_control/update_oauth2credential_providerUpdates an existing OAuth2 credential provider.name (string) required
credentialProviderVendor (string) required
oauth2ProviderConfigInput (undefined) required
bedrock_agentcore_control/delete_oauth2credential_providerDeletes an OAuth2 credential provider.name (string) required
bedrock_agentcore_control/create_oauth2credential_providerCreates a new OAuth2 credential provider.name (string) required
credentialProviderVendor (string) required
oauth2ProviderConfigInput (undefined) required
tags (object)
bedrock_agentcore_control/create_online_evaluation_configCreates an online evaluation configuration for continuous monitoring of agent performance. Online evaluation automatically samples live traffic from CloudWatch logs at specified rates and applies evaluators to assess agent quality in production.clientToken (string)
onlineEvaluationConfigName (string) required
description (string)
rule: {
. samplingConfig (object)
. filters (array)
. sessionConfig (object)
} (object) required
dataSourceConfig (undefined) required
evaluators (array) required
evaluationExecutionRoleArn (string) required
enableOnCreate (boolean) required
tags (object)
bedrock_agentcore_control/get_online_evaluation_configRetrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.onlineEvaluationConfigId (string) required
bedrock_agentcore_control/update_online_evaluation_configUpdates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status. Changes take effect immediately for ongoing evaluations.clientToken (string)
onlineEvaluationConfigId (string) required
description (string)
rule: {
. samplingConfig (object)
. filters (array)
. sessionConfig (object)
} (object)
dataSourceConfig (undefined)
evaluators (array)
evaluationExecutionRoleArn (string)
executionStatus (string)
bedrock_agentcore_control/delete_online_evaluation_configDeletes an online evaluation configuration and stops any ongoing evaluation processes associated with it.onlineEvaluationConfigId (string) required
bedrock_agentcore_control/list_online_evaluation_configsLists all online evaluation configurations in the account, providing summary information about each configuration's status and settings.nextToken (string)
maxResults (integer)
bedrock_agentcore_control/create_policy_engineCreates a new policy engine within the AgentCore Policy system. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with Gateways each Gateway can be associated with at most one policy engine, but multiple Gateways can be associated with the same engine, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies. This is an asynchronous operation. Use the GetPolicyEnginename (string) required
description (string)
clientToken (string)
bedrock_agentcore_control/get_policy_engineRetrieves detailed information about a specific policy engine within the AgentCore Policy system. This operation returns the complete policy engine configuration, metadata, and current status, allowing administrators to review and manage policy engine settings.policyEngineId (string) required
bedrock_agentcore_control/update_policy_engineUpdates an existing policy engine within the AgentCore Policy system. This operation allows modification of the policy engine description while maintaining its identity. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.policyEngineId (string) required
description (string)
bedrock_agentcore_control/delete_policy_engineDeletes an existing policy engine from the AgentCore Policy system. The policy engine must not have any associated policies before deletion. Once deleted, the policy engine and all its configurations become unavailable for policy management and evaluation. This is an asynchronous operation. Use the GetPolicyEngine operation to poll the status field to track completion.policyEngineId (string) required
bedrock_agentcore_control/list_policy_enginesRetrieves a list of policy engines within the AgentCore Policy system. This operation supports pagination to help administrators discover and manage policy engines across their account. Each policy engine serves as a container for related policies.nextToken (string)
maxResults (integer)
bedrock_agentcore_control/list_policy_generation_assetsRetrieves a list of generated policy assets from a policy generation request within the AgentCore Policy system. This operation returns the actual Cedar policies and related artifacts produced by the AI-powered policy generation process, allowing users to review and select from multiple generated policy options.policyGenerationId (string) required
policyEngineId (string) required
nextToken (string)
maxResults (integer)
bedrock_agentcore_control/start_policy_generationInitiates the AI-powered generation of Cedar policies from natural language descriptions within the AgentCore Policy system. This feature enables both technical and non-technical users to create policies by describing their authorization requirements in plain English, which is then automatically translated into formal Cedar policy statements. The generation process analyzes the natural language input along with the Gateway's tool context to produce validated policy options. Generated policy assepolicyEngineId (string) required
resource (undefined) required
content (undefined) required
name (string) required
clientToken (string)
bedrock_agentcore_control/get_policy_generationRetrieves information about a policy generation request within the AgentCore Policy system. Policy generation converts natural language descriptions into Cedar policy statements using AI-powered translation, enabling non-technical users to create policies.policyGenerationId (string) required
policyEngineId (string) required
bedrock_agentcore_control/list_policy_generationsRetrieves a list of policy generation requests within the AgentCore Policy system. This operation supports pagination and filtering to help track and manage AI-powered policy generation operations.nextToken (string)
maxResults (integer)
policyEngineId (string) required
bedrock_agentcore_control/create_policyCreates a policy within the AgentCore Policy system. Policies provide real-time, deterministic control over agentic interactions with AgentCore Gateway. Using the Cedar policy language, you can define fine-grained policies that specify which interactions with Gateway tools are permitted based on input parameters and OAuth claims, ensuring agents operate within defined boundaries and business rules. The policy is validated during creation against the Cedar schema generated from the Gateway's toolname (string) required
definition (undefined) required
description (string)
validationMode (string)
policyEngineId (string) required
clientToken (string)
bedrock_agentcore_control/get_policyRetrieves detailed information about a specific policy within the AgentCore Policy system. This operation returns the complete policy definition, metadata, and current status, allowing administrators to review and manage policy configurations.policyEngineId (string) required
policyId (string) required
bedrock_agentcore_control/update_policyUpdates an existing policy within the AgentCore Policy system. This operation allows modification of the policy description and definition while maintaining the policy's identity. The updated policy is validated against the Cedar schema before being applied. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.policyEngineId (string) required
policyId (string) required
description (string)
definition (undefined) required
validationMode (string)
bedrock_agentcore_control/delete_policyDeletes an existing policy from the AgentCore Policy system. Once deleted, the policy can no longer be used for agent behavior control and all references to it become invalid. This is an asynchronous operation. Use the GetPolicy operation to poll the status field to track completion.policyEngineId (string) required
policyId (string) required
bedrock_agentcore_control/list_policiesRetrieves a list of policies within the AgentCore Policy engine. This operation supports pagination and filtering to help administrators manage and discover policies across policy engines. Results can be filtered by policy engine or resource associations.nextToken (string)
maxResults (integer)
policyEngineId (string) required
targetResourceScope (string)
bedrock_agentcore_control/list_workload_identitiesLists all workload identities in your account.nextToken (string)
maxResults (integer)
bedrock_agentcore_control/get_workload_identityRetrieves information about a workload identity.name (string) required
bedrock_agentcore_control/update_workload_identityUpdates an existing workload identity.name (string) required
allowedResourceOauth2ReturnUrls (array)
bedrock_agentcore_control/delete_workload_identityDeletes a workload identity.name (string) required
bedrock_agentcore_control/create_workload_identityCreates a new workload identity.name (string) required
allowedResourceOauth2ReturnUrls (array)
tags (object)
bedrock_agentcore/complete_resource_token_authConfirms the user authentication session for obtaining OAuth2.0 tokens for a resource.userIdentifier (undefined) required
sessionUri (string) required
bedrock_agentcore/get_resource_api_keyRetrieves the API key associated with an API key credential provider.workloadIdentityToken (string) required
resourceCredentialProviderName (string) required
bedrock_agentcore/get_resource_oauth2tokenReturns the OAuth 2.0 token of the provided resource.workloadIdentityToken (string) required
resourceCredentialProviderName (string) required
scopes (array) required
oauth2Flow (string) required
sessionUri (string)
resourceOauth2ReturnUrl (string)
forceAuthentication (boolean)
customParameters (object)
customState (string)
bedrock_agentcore/get_workload_access_tokenObtains a workload access token for agentic workloads not acting on behalf of a user.workloadName (string) required
bedrock_agentcore/get_workload_access_token_for_jwtObtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.workloadName (string) required
userToken (string) required
bedrock_agentcore/get_workload_access_token_for_user_idObtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.workloadName (string) required
userId (string) required
bedrock_agentcore/invoke_code_interpreterExecutes code within an active code interpreter session in Amazon Bedrock AgentCore. This operation processes the provided code, runs it in a secure environment, and returns the execution results including output, errors, and generated visualizations. To execute code, you must specify the code interpreter identifier, session ID, and the code to run in the arguments parameter. The operation returns a stream containing the execution results, which can include text output, error messages, and datacodeInterpreterIdentifier (string) required
sessionId (string)
traceId (string)
traceParent (string)
name (string) required
arguments: {
. code (string)
. language (string)
. clearContext (boolean)
. command (string)
. path (string)
. paths (array)
. content (array)
. directoryPath (string)
. taskId (string)
} (object)
bedrock_agentcore/get_agent_cardRetrieves the A2A agent card associated with an AgentCore Runtime agent.runtimeSessionId (string)
agentRuntimeArn (string) required
qualifier (string)
bedrock_agentcore/invoke_agent_runtimeSends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time. To invoke an agent you must specify the AgentCore Runtime ARN and provide a payload containing your request. You can optionally specify a qualifier to target a specific version or endpoint of the agent. This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returncontentType (string)
accept (string)
mcpSessionId (string)
runtimeSessionId (string)
mcpProtocolVersion (string)
runtimeUserId (string)
traceId (string)
traceParent (string)
traceState (string)
baggage (string)
agentRuntimeArn (string) required
qualifier (string)
accountId (string)
payload (string) required
bedrock_agentcore/stop_runtime_sessionStops a session that is running in an running AgentCore Runtime agent.runtimeSessionId (string) required
agentRuntimeArn (string) required
qualifier (string)
clientToken (string)
bedrock_agentcore/save_browser_session_profileSaves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore. A browser profile captures persistent browser data such as cookies and local storage from an active session, enabling you to reuse this data in future browser sessions. To save a browser session profile, you must specify the profile identifier, browser identifier, and session ID. The session must be active when saving the profile. Once saved, the profile can be used with the StartBrowserSession operattraceId (string)
traceParent (string)
profileIdentifier (string) required
browserIdentifier (string) required
sessionId (string) required
clientToken (string)
bedrock_agentcore/list_browser_sessionsRetrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps. You can filter the results by browser identifier and session status. The operation supports pagination to handle large result sets efficiently. We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions. The followibrowserIdentifier (string) required
maxResults (integer)
nextToken (string)
status (string)
bedrock_agentcore/start_browser_sessionCreates and initializes a browser session in Amazon Bedrock AgentCore. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation. To create a session, you must specify a browser identifier and a name. You can also configure the viewport dimensions to control the visible area of web content. The session remains active until it times out or you explicitly stop it using the StopBrowserSestraceId (string)
traceParent (string)
browserIdentifier (string) required
name (string)
sessionTimeoutSeconds (integer)
viewPort: {
. width (integer)
. height (integer)
} (object)
extensions (array)
profileConfiguration: {
. profileIdentifier (string)
} (object)
proxyConfiguration: {
. proxies (array)
. bypass (object)
} (object)
clientToken (string)
bedrock_agentcore/stop_browser_sessionTerminates an active browser session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use. To stop a browser session, you must specify both the browser identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartBrowserSession. The following operations are related to StopBrowserSession: StartBrowserSession GetBrowserSessiontraceId (string)
traceParent (string)
browserIdentifier (string) required
sessionId (string) required
clientToken (string)
bedrock_agentcore/update_browser_streamUpdates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.browserIdentifier (string) required
sessionId (string) required
streamUpdate (undefined) required
clientToken (string)
bedrock_agentcore/get_browser_sessionRetrieves detailed information about a specific browser session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, associated streams, and metadata. To get a browser session, you must specify both the browser identifier and the session ID. The response includes information about the session's viewport configuration, timeout settings, and stream endpoints. The following operations are related to GetBrowserSession: StartBrowserSession ListBrowserSessiobrowserIdentifier (string) required
sessionId (string) required
bedrock_agentcore/list_code_interpreter_sessionsRetrieves a list of code interpreter sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps. You can filter the results by code interpreter identifier and session status. The operation supports pagination to handle large result sets efficiently. We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sescodeInterpreterIdentifier (string) required
maxResults (integer)
nextToken (string)
status (string)
bedrock_agentcore/start_code_interpreter_sessionCreates and initializes a code interpreter session in Amazon Bedrock AgentCore. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks. To create a session, you must specify a code interpreter identifier and a name. The session remains active until it times out or you explicitly stop it using the StopCodeInterpreterSession operation. The following operations are relattraceId (string)
traceParent (string)
codeInterpreterIdentifier (string) required
name (string)
sessionTimeoutSeconds (integer)
clientToken (string)
bedrock_agentcore/stop_code_interpreter_sessionTerminates an active code interpreter session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use. To stop a code interpreter session, you must specify both the code interpreter identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartCodeInterpreterSession. The following operations are related to StopCodeInterpreterSession: StartCodeInterpreterStraceId (string)
traceParent (string)
codeInterpreterIdentifier (string) required
sessionId (string) required
clientToken (string)
bedrock_agentcore/get_code_interpreter_sessionRetrieves detailed information about a specific code interpreter session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, and metadata. To get a code interpreter session, you must specify both the code interpreter identifier and the session ID. The response includes information about the session's timeout settings and current status. The following operations are related to GetCodeInterpreterSession: StartCodeInterpreterSession ListCodeInterpreterSecodeInterpreterIdentifier (string) required
sessionId (string) required
bedrock_agentcore/evaluatePerforms on-demand evaluation of agent traces using a specified evaluator. This synchronous API accepts traces in OpenTelemetry format and returns immediate scoring results with detailed explanations.evaluatorId (string) required
evaluationInput (undefined) required
evaluationTarget (undefined)
bedrock_agentcore/batch_create_memory_recordsCreates multiple memory records in a single batch operation for the specified memory with custom content.memoryId (string) required
records (array) required
clientToken (string)
bedrock_agentcore/batch_delete_memory_recordsDeletes multiple memory records in a single batch operation from the specified memory.memoryId (string) required
records (array) required
bedrock_agentcore/batch_update_memory_recordsUpdates multiple memory records with custom content in a single batch operation within the specified memory.memoryId (string) required
records (array) required
bedrock_agentcore/create_eventCreates an event in an AgentCore Memory resource. Events represent interactions or activities that occur within a session and are associated with specific actors. To use this operation, you must have the bedrock-agentcore:CreateEvent permission. This operation is subject to request rate limiting.memoryId (string) required
actorId (string) required
sessionId (string)
eventTimestamp (string) required
payload (array) required
branch: {
. rootEventId (string)
. name (string)
} (object)
clientToken (string)
metadata (object)
bedrock_agentcore/delete_eventDeletes an event from an AgentCore Memory resource. When you delete an event, it is permanently removed. To use this operation, you must have the bedrock-agentcore:DeleteEvent permission.memoryId (string) required
sessionId (string) required
eventId (string) required
actorId (string) required
bedrock_agentcore/delete_memory_recordDeletes a memory record from an AgentCore Memory resource. When you delete a memory record, it is permanently removed. To use this operation, you must have the bedrock-agentcore:DeleteMemoryRecord permission.memoryId (string) required
memoryRecordId (string) required
bedrock_agentcore/get_eventRetrieves information about a specific event in an AgentCore Memory resource. To use this operation, you must have the bedrock-agentcore:GetEvent permission.memoryId (string) required
sessionId (string) required
actorId (string) required
eventId (string) required
bedrock_agentcore/get_memory_recordRetrieves a specific memory record from an AgentCore Memory resource. To use this operation, you must have the bedrock-agentcore:GetMemoryRecord permission.memoryId (string) required
memoryRecordId (string) required
bedrock_agentcore/list_actorsLists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully. To use this operation, you must have the bedrock-agentcore:ListActors permission.memoryId (string) required
maxResults (integer)
nextToken (string)
bedrock_agentcore/list_eventsLists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully. To use this operation, you must have the bedrock-agentcore:ListEvents permission.memoryId (string) required
sessionId (string) required
actorId (string) required
includePayloads (boolean)
filter: {
. branch (object)
. eventMetadata (array)
} (object)
maxResults (integer)
nextToken (string)
bedrock_agentcore/list_memory_extraction_jobsLists all long-term memory extraction jobs that are eligible to be started with optional filtering. To use this operation, you must have the bedrock-agentcore:ListMemoryExtractionJobs permission.memoryId (string) required
maxResults (integer)
filter: {
. strategyId (string)
. sessionId (string)
. actorId (string)
. status (string)
} (object)
nextToken (string)
bedrock_agentcore/list_memory_recordsLists memory records in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully. To use this operation, you must have the bedrock-agentcore:ListMemoryRecords permission.memoryId (string) required
namespace (string) required
memoryStrategyId (string)
maxResults (integer)
nextToken (string)
bedrock_agentcore/list_sessionsLists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully. To use this operation, you must have the bedrock-agentcore:ListSessions permission.memoryId (string) required
actorId (string) required
maxResults (integer)
nextToken (string)
bedrock_agentcore/retrieve_memory_recordsSearches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully. To use this operation, you must have the bedrock-agentcore:RetrieveMemoryRecords permission.memoryId (string) required
namespace (string) required
searchCriteria: {
. searchQuery (string)
. memoryStrategyId (string)
. topK (integer)
. metadataFilters (array)
} (object) required
nextToken (string)
maxResults (integer)
bedrock_agentcore/start_memory_extraction_jobStarts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records. When earlier extraction attempts have left events unprocessed, this job will pick up and extract those as well. To use this operation, you must have the bedrock-agentcore:StartMemoryExtractionJob permission.memoryId (string) required
extractionJob: {
. jobId (string)
} (object) required
clientToken (string)
bedrock_data_automation_runtime/invoke_data_automationSync API: Invoke data automation.inputConfiguration: {
. bytes (string)
. s3Uri (string)
} (object) required
dataAutomationConfiguration: {
. dataAutomationProjectArn (string)
. stage (string)
} (object)
blueprints (array)
dataAutomationProfileArn (string) required
encryptionConfiguration: {
. kmsKeyId (string)
. kmsEncryptionContext (object)
} (object)
outputConfiguration: {
. s3Uri (string)
} (object)
bedrock_data_automation_runtime/list_tags_for_resourceList tags for an Amazon Bedrock Data Automation resourceresourceARN (string) required
bedrock_data_automation_runtime/tag_resourceTag an Amazon Bedrock Data Automation resourceresourceARN (string) required
tags (array) required
bedrock_data_automation_runtime/untag_resourceUntag an Amazon Bedrock Data Automation resourceresourceARN (string) required
tagKeys (array) required
bedrock_data_automation_runtime/invoke_data_automation_asyncAsync API: Invoke data automation.clientToken (string)
inputConfiguration: {
. s3Uri (string)
. assetProcessingConfiguration (object)
} (object) required
outputConfiguration: {
. s3Uri (string)
} (object) required
dataAutomationConfiguration: {
. dataAutomationProjectArn (string)
. stage (string)
} (object)
encryptionConfiguration: {
. kmsKeyId (string)
. kmsEncryptionContext (object)
} (object)
notificationConfiguration: {
. eventBridgeConfiguration (object)
} (object)
blueprints (array)
dataAutomationProfileArn (string) required
tags (array)
bedrock_data_automation_runtime/get_data_automation_statusAPI used to get data automation status.invocationArn (string) required
bedrock_data_automation/copy_blueprint_stageCopies a Blueprint from one stage to anotherblueprintArn (string) required
sourceStage (string) required
targetStage (string) required
clientToken (string)
bedrock_data_automation/create_blueprint_versionCreates a new version of an existing Amazon Bedrock Data Automation BlueprintblueprintArn (string) required
clientToken (string)
bedrock_data_automation/list_tags_for_resourceList tags for an Amazon Bedrock Data Automation resourceresourceARN (string) required
bedrock_data_automation/tag_resourceTag an Amazon Bedrock Data Automation resourceresourceARN (string) required
tags (array) required
bedrock_data_automation/untag_resourceUntag an Amazon Bedrock Data Automation resourceresourceARN (string) required
tagKeys (array) required
bedrock_data_automation/invoke_blueprint_optimization_asyncInvoke an async job to perform Blueprint Optimizationblueprint: {
. blueprintArn (string)
. stage (string)
} (object) required
samples (array) required
outputConfiguration: {
. s3Object (object)
} (object) required
dataAutomationProfileArn (string) required
encryptionConfiguration: {
. kmsKeyId (string)
. kmsEncryptionContext (object)
} (object)
tags (array)
bedrock_data_automation/get_blueprint_optimization_statusAPI used to get blueprint optimization status.invocationArn (string) required
bedrock_data_automation/create_blueprintCreates an Amazon Bedrock Data Automation BlueprintblueprintName (string) required
type (string) required
blueprintStage (string)
schema (string) required
clientToken (string)
encryptionConfiguration: {
. kmsKeyId (string)
. kmsEncryptionContext (object)
} (object)
tags (array)
bedrock_data_automation/get_blueprintGets an existing Amazon Bedrock Data Automation BlueprintblueprintArn (string) required
blueprintVersion (string)
blueprintStage (string)
bedrock_data_automation/update_blueprintUpdates an existing Amazon Bedrock Data Automation BlueprintblueprintArn (string) required
schema (string) required
blueprintStage (string)
encryptionConfiguration: {
. kmsKeyId (string)
. kmsEncryptionContext (object)
} (object)
bedrock_data_automation/delete_blueprintDeletes an existing Amazon Bedrock Data Automation BlueprintblueprintArn (string) required
blueprintVersion (string)
bedrock_data_automation/list_blueprintsLists all existing Amazon Bedrock Data Automation BlueprintsblueprintArn (string)
resourceOwner (string)
blueprintStageFilter (string)
maxResults (integer)
nextToken (string)
projectFilter: {
. projectArn (string)
. projectStage (string)
} (object)
bedrock_data_automation/create_data_automation_projectCreates an Amazon Bedrock Data Automation ProjectprojectName (string) required
projectDescription (string)
projectStage (string)
projectType (string)
standardOutputConfiguration: {
. document (object)
. image (object)
. video (object)
. audio (object)
} (object) required
customOutputConfiguration: {
. blueprints (array)
} (object)
overrideConfiguration: {
. document (object)
. image (object)
. video (object)
. audio (object)
. modalityRouting (object)
} (object)
clientToken (string)
encryptionConfiguration: {
. kmsKeyId (string)
. kmsEncryptionContext (object)
} (object)
tags (array)
bedrock_data_automation/get_data_automation_projectGets an existing Amazon Bedrock Data Automation ProjectprojectArn (string) required
projectStage (string)
bedrock_data_automation/update_data_automation_projectUpdates an existing Amazon Bedrock Data Automation ProjectprojectArn (string) required
projectStage (string)
projectDescription (string)
standardOutputConfiguration: {
. document (object)
. image (object)
. video (object)
. audio (object)
} (object) required
customOutputConfiguration: {
. blueprints (array)
} (object)
overrideConfiguration: {
. document (object)
. image (object)
. video (object)
. audio (object)
. modalityRouting (object)
} (object)
encryptionConfiguration: {
. kmsKeyId (string)
. kmsEncryptionContext (object)
} (object)
bedrock_data_automation/delete_data_automation_projectDeletes an existing Amazon Bedrock Data Automation ProjectprojectArn (string) required
bedrock_data_automation/list_data_automation_projectsLists all existing Amazon Bedrock Data Automation ProjectsmaxResults (integer)
nextToken (string)
projectStageFilter (string)
blueprintFilter: {
. blueprintArn (string)
. blueprintVersion (string)
. blueprintStage (string)
} (object)
resourceOwner (string)
bedrock_runtime/get_async_invokeRetrieve information about an asynchronous invocation.invocationArn (string) required
bedrock_runtime/list_async_invokesLists asynchronous invocations.submitTimeAfter (string)
submitTimeBefore (string)
statusEquals (string)
maxResults (integer)
nextToken (string)
sortBy (string)
sortOrder (string)
bedrock_runtime/start_async_invokeStarts an asynchronous invocation. This operation requires permission for the bedrock:InvokeModel action. To deny all inference access to resources that you specify in the modelId field, you need to deny access to the bedrock:InvokeModel and bedrock:InvokeModelWithResponseStream actions. Doing this also denies access to the resource through the Converse API actions Converse and ConverseStream. For more information see Deny access for inference on specific models.clientRequestToken (string)
modelId (string) required
modelInput (undefined) required
outputDataConfig (undefined) required
tags (array)
bedrock_runtime/apply_guardrailThe action to apply a guardrail. For troubleshooting some of the common errors you might encounter when using the ApplyGuardrail API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User GuideguardrailIdentifier (string) required
guardrailVersion (string) required
source (string) required
content (array) required
outputScope (string)
bedrock_runtime/converseSends messages to the specified Amazon Bedrock model. Converse provides a consistent interface that works with all models that support messages. This allows you to write code once and use it with different models. If a model has unique inference parameters, you can also pass those unique parameters to the model. Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response. You can submit a prompt by including it in the memodelId (string) required
messages (array)
system (array)
inferenceConfig: {
. maxTokens (integer)
. temperature (number)
. topP (number)
. stopSequences (array)
} (object)
toolConfig: {
. tools (array)
. toolChoice
} (object)
guardrailConfig: {
. guardrailIdentifier (string)
. guardrailVersion (string)
. trace (string)
} (object)
additionalModelRequestFields (undefined)
promptVariables (object)
additionalModelResponseFieldPaths (array)
requestMetadata (object)
performanceConfig: {
. latency (string)
} (object)
serviceTier: {
. type (string)
} (object)
outputConfig: {
. textFormat (object)
} (object)
bedrock_runtime/converse_streamSends messages to the specified Amazon Bedrock model and returns the response in a stream. ConverseStream provides a consistent API that works with all Amazon Bedrock models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model. To find out if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the responsemodelId (string) required
messages (array)
system (array)
inferenceConfig: {
. maxTokens (integer)
. temperature (number)
. topP (number)
. stopSequences (array)
} (object)
toolConfig: {
. tools (array)
. toolChoice
} (object)
guardrailConfig: {
. guardrailIdentifier (string)
. guardrailVersion (string)
. trace (string)
. streamProcessingMode (string)
} (object)
additionalModelRequestFields (undefined)
promptVariables (object)
additionalModelResponseFieldPaths (array)
requestMetadata (object)
performanceConfig: {
. latency (string)
} (object)
serviceTier: {
. type (string)
} (object)
outputConfig: {
. textFormat (object)
} (object)
bedrock_runtime/invoke_modelInvokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. You use model inference to generate text, images, and embeddings. For example code, see Invoke model code examples in the Amazon Bedrock User Guide. This operation requires permission for the bedrock:InvokeModel action. To deny all inference access to resources that you specify in the modelId field, you need to deny access to the bedrock:InvokeModel and bedrock:Invobody (string)
contentType (string)
accept (string)
modelId (string) required
trace (string)
guardrailIdentifier (string)
guardrailVersion (string)
performanceConfigLatency (string)
serviceTier (string)
bedrock_runtime/invoke_model_with_bidirectional_streamInvoke the specified Amazon Bedrock model to run inference using the bidirectional stream. The response is returned in a stream that remains open for 8 minutes. A single session can contain multiple prompts and responses from the model. The prompts to the model are provided as audio files and the model's responses are spoken back to the user and transcribed. It is possible for users to interrupt the model's response with a new prompt, which will halt the response speech. The model will retain comodelId (string) required
body (undefined) required
bedrock_runtime/invoke_model_with_response_streamInvoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream. To see if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response. The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream. For example code, see Invoke model with streaming code example in the Amazon Bedrock User Guide. Thibody (string)
contentType (string)
accept (string)
modelId (string) required
trace (string)
guardrailIdentifier (string)
guardrailVersion (string)
performanceConfigLatency (string)
serviceTier (string)
bedrock_runtime/count_tokensReturns the token count for a given inference request. This operation helps you estimate token usage before sending requests to foundation models by returning the token count that would be used if the same input were sent to the model in an inference request. Token counting is model-specific because different models use different tokenization strategies. The token count returned by this operation will match the token count that would be charged if the same input were sent to the model in an InvomodelId (string) required
input (undefined) required
bedrock/get_use_case_for_model_accessGet usecase for model access.No parameters
bedrock/put_use_case_for_model_accessPut usecase for model access.formData (string) required
bedrock/cancel_automated_reasoning_policy_build_workflowCancels a running Automated Reasoning policy build workflow. This stops the policy generation process and prevents further processing of the source documents.policyArn (string) required
buildWorkflowId (string) required
bedrock/create_automated_reasoning_policy_test_caseCreates a test for an Automated Reasoning policy. Tests validate that your policy works as expected by providing sample inputs and expected outcomes. Use tests to verify policy behavior before deploying to production.policyArn (string) required
guardContent (string) required
queryContent (string)
expectedAggregatedFindingsResult (string) required
clientRequestToken (string)
confidenceThreshold (number)
bedrock/create_automated_reasoning_policy_versionCreates a new version of an existing Automated Reasoning policy. This allows you to iterate on your policy rules while maintaining previous versions for rollback or comparison purposes.policyArn (string) required
clientRequestToken (string)
lastUpdatedDefinitionHash (string) required
tags (array)
bedrock/delete_automated_reasoning_policy_build_workflowDeletes an Automated Reasoning policy build workflow and its associated artifacts. This permanently removes the workflow history and any generated assets.policyArn (string) required
buildWorkflowId (string) required
lastUpdatedAt (string) required
bedrock/delete_automated_reasoning_policy_test_caseDeletes an Automated Reasoning policy test. This operation is idempotent; if you delete a test more than once, each call succeeds.policyArn (string) required
testCaseId (string) required
lastUpdatedAt (string) required
bedrock/export_automated_reasoning_policy_versionExports the policy definition for an Automated Reasoning policy version. Returns the complete policy definition including rules, variables, and custom variable types in a structured format.policyArn (string) required
bedrock/get_automated_reasoning_policy_annotationsRetrieves the current annotations for an Automated Reasoning policy build workflow. Annotations contain corrections to the rules, variables and types to be applied to the policy.policyArn (string) required
buildWorkflowId (string) required
bedrock/get_automated_reasoning_policy_build_workflowRetrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.policyArn (string) required
buildWorkflowId (string) required
bedrock/get_automated_reasoning_policy_build_workflow_result_assetsRetrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts.policyArn (string) required
buildWorkflowId (string) required
assetType (string) required
bedrock/get_automated_reasoning_policy_next_scenarioRetrieves the next test scenario for validating an Automated Reasoning policy. This is used during the interactive policy refinement process to test policy behavior.policyArn (string) required
buildWorkflowId (string) required
bedrock/get_automated_reasoning_policy_test_caseRetrieves details about a specific Automated Reasoning policy test.policyArn (string) required
testCaseId (string) required
bedrock/get_automated_reasoning_policy_test_resultRetrieves the test result for a specific Automated Reasoning policy test. Returns detailed validation findings and execution status.policyArn (string) required
buildWorkflowId (string) required
testCaseId (string) required
bedrock/list_automated_reasoning_policy_build_workflowsLists all build workflows for an Automated Reasoning policy, showing the history of policy creation and modification attempts.policyArn (string) required
nextToken (string)
maxResults (integer)
bedrock/list_automated_reasoning_policy_test_casesLists tests for an Automated Reasoning policy. We recommend using pagination to ensure that the operation returns quickly and successfully.policyArn (string) required
nextToken (string)
maxResults (integer)
bedrock/list_automated_reasoning_policy_test_resultsLists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks.policyArn (string) required
buildWorkflowId (string) required
nextToken (string)
maxResults (integer)
bedrock/start_automated_reasoning_policy_build_workflowStarts a new build workflow for an Automated Reasoning policy. This initiates the process of analyzing source documents and generating policy rules, variables, and types.policyArn (string) required
buildWorkflowType (string) required
clientRequestToken (string)
sourceContent: {
. policyDefinition (object)
. workflowContent
} (object) required
bedrock/start_automated_reasoning_policy_test_workflowInitiates a test workflow to validate Automated Reasoning policy tests. The workflow executes the specified tests against the policy and generates validation results.policyArn (string) required
buildWorkflowId (string) required
testCaseIds (array)
clientRequestToken (string)
bedrock/update_automated_reasoning_policy_annotationsUpdates the annotations for an Automated Reasoning policy build workflow. This allows you to modify extracted rules, variables, and types before finalizing the policy.policyArn (string) required
buildWorkflowId (string) required
annotations (array) required
lastUpdatedAnnotationSetHash (string) required
bedrock/update_automated_reasoning_policy_test_caseUpdates an existing Automated Reasoning policy test. You can modify the content, query, expected result, and confidence threshold.policyArn (string) required
testCaseId (string) required
guardContent (string) required
queryContent (string)
lastUpdatedAt (string) required
expectedAggregatedFindingsResult (string) required
confidenceThreshold (number)
clientRequestToken (string)
bedrock/create_automated_reasoning_policyCreates an Automated Reasoning policy for Amazon Bedrock Guardrails. Automated Reasoning policies use mathematical techniques to detect hallucinations, suggest corrections, and highlight unstated assumptions in the responses of your GenAI application. To create a policy, you upload a source document that describes the rules that you're encoding. Automated Reasoning extracts important concepts from the source document that will become variables in the policy and infers policy rules.name (string) required
description (string)
clientRequestToken (string)
policyDefinition: {
. version (string)
. types (array)
. rules (array)
. variables (array)
} (object)
kmsKeyId (string)
tags (array)
bedrock/get_automated_reasoning_policyRetrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps.policyArn (string) required
bedrock/update_automated_reasoning_policyUpdates an existing Automated Reasoning policy with new rules, variables, or configuration. This creates a new version of the policy while preserving the previous version.policyArn (string) required
policyDefinition: {
. version (string)
. types (array)
. rules (array)
. variables (array)
} (object) required
name (string)
description (string)
bedrock/delete_automated_reasoning_policyDeletes an Automated Reasoning policy or policy version. This operation is idempotent. If you delete a policy more than once, each call succeeds. Deleting a policy removes it permanently and cannot be undone.policyArn (string) required
force (boolean)
bedrock/list_automated_reasoning_policiesLists all Automated Reasoning policies in your account, with optional filtering by policy ARN. This helps you manage and discover existing policies.policyArn (string)
nextToken (string)
maxResults (integer)
bedrock/create_marketplace_model_endpointCreates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.modelSourceIdentifier (string) required
endpointConfig (undefined) required
acceptEula (boolean)
endpointName (string) required
clientRequestToken (string)
tags (array)
bedrock/delete_marketplace_model_endpointDeletes an endpoint for a model from Amazon Bedrock Marketplace.endpointArn (string) required
bedrock/deregister_marketplace_model_endpointDeregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint.endpointArn (string) required
bedrock/get_marketplace_model_endpointRetrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.endpointArn (string) required
bedrock/list_marketplace_model_endpointsLists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.maxResults (integer)
nextToken (string)
modelSourceEquals (string)
bedrock/register_marketplace_model_endpointRegisters an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.endpointIdentifier (string) required
modelSourceIdentifier (string) required
bedrock/update_marketplace_model_endpointUpdates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.endpointArn (string) required
endpointConfig (undefined) required
clientRequestToken (string)
bedrock/create_custom_model_deploymentDeploys a custom model for on-demand inference in Amazon Bedrock. After you deploy your custom model, you use the deployment's Amazon Resource Name ARN as the modelId parameter when you submit prompts and generate responses with model inference. For more information about setting up on-demand inference for custom models, see Set up inference for a custom model. The following actions are related to the CreateCustomModelDeployment operation: GetCustomModelDeployment ListCustomModelDeployments DelemodelDeploymentName (string) required
modelArn (string) required
description (string)
tags (array)
clientRequestToken (string)
bedrock/delete_custom_model_deploymentDeletes a custom model deployment. This operation stops the deployment and removes it from your account. After deletion, the deployment ARN can no longer be used for inference requests. The following actions are related to the DeleteCustomModelDeployment operation: CreateCustomModelDeployment GetCustomModelDeployment ListCustomModelDeploymentscustomModelDeploymentIdentifier (string) required
bedrock/get_custom_model_deploymentRetrieves information about a custom model deployment, including its status, configuration, and metadata. Use this operation to monitor the deployment status and retrieve details needed for inference requests. The following actions are related to the GetCustomModelDeployment operation: CreateCustomModelDeployment ListCustomModelDeployments DeleteCustomModelDeploymentcustomModelDeploymentIdentifier (string) required
bedrock/list_custom_model_deploymentsLists custom model deployments in your account. You can filter the results by creation time, name, status, and associated model. Use this operation to manage and monitor your custom model deployments. We recommend using pagination to ensure that the operation returns quickly and successfully. The following actions are related to the ListCustomModelDeployments operation: CreateCustomModelDeployment GetCustomModelDeployment DeleteCustomModelDeploymentcreatedBefore (string)
createdAfter (string)
nameContains (string)
maxResults (integer)
nextToken (string)
sortBy (string)
sortOrder (string)
statusEquals (string)
modelArnEquals (string)
bedrock/update_custom_model_deploymentUpdates a custom model deployment with a new custom model. This allows you to deploy updated models without creating new deployment endpoints.modelArn (string) required
customModelDeploymentIdentifier (string) required
bedrock/create_custom_modelCreates a new custom model in Amazon Bedrock. After the model is active, you can use it for inference. To use the model for inference, you must purchase Provisioned Throughput for it. You can't use On-demand inference with these custom models. For more information about Provisioned Throughput, see Provisioned Throughput. The model appears in ListCustomModels with a customizationType of imported. To track the status of the new model, you use the GetCustomModel API operation. The model can be in tmodelName (string) required
modelSourceConfig (undefined) required
modelKmsKeyArn (string)
roleArn (string)
modelTags (array)
clientRequestToken (string)
bedrock/delete_custom_modelDeletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.modelIdentifier (string) required
bedrock/get_custom_modelGet the properties associated with a Amazon Bedrock custom model that you have created. For more information, see Custom models in the Amazon Bedrock User Guide.modelIdentifier (string) required
bedrock/list_custom_modelsReturns a list of the custom models that you have created with the CreateModelCustomizationJob operation. For more information, see Custom models in the Amazon Bedrock User Guide.creationTimeBefore (string)
creationTimeAfter (string)
nameContains (string)
baseModelArnEquals (string)
foundationModelArnEquals (string)
maxResults (integer)
nextToken (string)
sortBy (string)
sortOrder (string)
isOwned (boolean)
modelStatus (string)
bedrock/delete_enforced_guardrail_configurationDeletes the account-level enforced guardrail configuration.configId (string) required
bedrock/list_enforced_guardrails_configurationLists the account-level enforced guardrail configurations.nextToken (string)
bedrock/put_enforced_guardrail_configurationSets the account-level enforced guardrail configuration.configId (string)
guardrailInferenceConfig: {
. guardrailIdentifier (string)
. guardrailVersion (string)
. inputTags (string)
} (object) required
bedrock/batch_delete_evaluation_jobDeletes a batch of evaluation jobs. An evaluation job can only be deleted if it has following status FAILED, COMPLETED, and STOPPED. You can request up to 25 model evaluation jobs be deleted in a single request.jobIdentifiers (array) required
bedrock/create_evaluation_jobCreates an evaluation job.jobName (string) required
jobDescription (string)
clientRequestToken (string)
roleArn (string) required
customerEncryptionKeyId (string)
jobTags (array)
applicationType (string)
evaluationConfig (undefined) required
inferenceConfig (undefined) required
outputDataConfig: {
. s3Uri (string)
} (object) required
bedrock/get_evaluation_jobGets information about an evaluation job, such as the status of the job.jobIdentifier (string) required
bedrock/list_evaluation_jobsLists all existing evaluation jobs.creationTimeAfter (string)
creationTimeBefore (string)
statusEquals (string)
applicationTypeEquals (string)
nameContains (string)
maxResults (integer)
nextToken (string)
sortBy (string)
sortOrder (string)
bedrock/stop_evaluation_jobStops an evaluation job that is current being created or running.jobIdentifier (string) required
bedrock/create_guardrail_versionCreates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.guardrailIdentifier (string) required
description (string)
clientRequestToken (string)
bedrock/create_guardrailCreates a guardrail to block topics and to implement safeguards for your generative AI applications. You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection. Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content. Denied topics - Define a set of topics that are undesirable in the context of your application.name (string) required
description (string)
topicPolicyConfig: {
. topicsConfig (array)
. tierConfig (object)
} (object)
contentPolicyConfig: {
. filtersConfig (array)
. tierConfig (object)
} (object)
wordPolicyConfig: {
. wordsConfig (array)
. managedWordListsConfig (array)
} (object)
sensitiveInformationPolicyConfig: {
. piiEntitiesConfig (array)
. regexesConfig (array)
} (object)
contextualGroundingPolicyConfig: {
. filtersConfig (array)
} (object)
automatedReasoningPolicyConfig: {
. policies (array)
. confidenceThreshold (number)
} (object)
crossRegionConfig: {
. guardrailProfileIdentifier (string)
} (object)
blockedInputMessaging (string) required
blockedOutputsMessaging (string) required
kmsKeyId (string)
tags (array)
clientRequestToken (string)
bedrock/get_guardrailGets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.guardrailIdentifier (string) required
guardrailVersion (string)
bedrock/update_guardrailUpdates a guardrail with the values you specify. Specify a name and optional description. Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields. Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic. Give a name and description so that the guardrail can properly identify the topic. Specify DENY in thguardrailIdentifier (string) required
name (string) required
description (string)
topicPolicyConfig: {
. topicsConfig (array)
. tierConfig (object)
} (object)
contentPolicyConfig: {
. filtersConfig (array)
. tierConfig (object)
} (object)
wordPolicyConfig: {
. wordsConfig (array)
. managedWordListsConfig (array)
} (object)
sensitiveInformationPolicyConfig: {
. piiEntitiesConfig (array)
. regexesConfig (array)
} (object)
contextualGroundingPolicyConfig: {
. filtersConfig (array)
} (object)
automatedReasoningPolicyConfig: {
. policies (array)
. confidenceThreshold (number)
} (object)
crossRegionConfig: {
. guardrailProfileIdentifier (string)
} (object)
blockedInputMessaging (string) required
blockedOutputsMessaging (string) required
kmsKeyId (string)
bedrock/delete_guardrailDeletes a guardrail. To delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier field. If you delete a guardrail, all of its versions will be deleted. To delete a version of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field and the version in the guardrailVersion field.guardrailIdentifier (string) required
guardrailVersion (string)
bedrock/list_guardrailsLists details about all the guardrails in an account. To list the DRAFT version of all your guardrails, don't specify the guardrailIdentifier field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field. You can set the maximum number of results to return in a response in the maxResults field. If there are more results than the number you set, the response returns a nextToken that you can send in another ListGuardrails request to see the next batcguardrailIdentifier (string)
maxResults (integer)
nextToken (string)
bedrock/create_inference_profileCreates an application inference profile to track metrics and costs when invoking a model. To create an application inference profile for a foundation model in one region, specify the ARN of the model in that region. To create an application inference profile for a foundation model across multiple regions, specify the ARN of the system-defined inference profile that contains the regions that you want to route requests to. For more information, see Increase throughput and resilience with cross-reinferenceProfileName (string) required
description (string)
clientRequestToken (string)
modelSource (undefined) required
tags (array)
bedrock/get_inference_profileGets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.inferenceProfileIdentifier (string) required
bedrock/delete_inference_profileDeletes an application inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.inferenceProfileIdentifier (string) required
bedrock/list_inference_profilesReturns a list of inference profiles that you can use. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.maxResults (integer)
nextToken (string)
typeEquals (string)
bedrock/delete_model_invocation_logging_configurationDelete the invocation logging.No parameters
bedrock/get_model_invocation_logging_configurationGet the current configuration values for model invocation logging.No parameters
bedrock/put_model_invocation_logging_configurationSet the configuration values for model invocation logging.loggingConfig: {
. cloudWatchConfig (object)
. s3Config (object)
. textDataDeliveryEnabled (boolean)
. imageDataDeliveryEnabled (boolean)
. embeddingDataDeliveryEnabled (boolean)
. videoDataDeliveryEnabled (boolean)
. audioDataDeliveryEnabled (boolean)
} (object) required
bedrock/create_model_copy_jobCopies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.sourceModelArn (string) required
targetModelName (string) required
modelKmsKeyId (string)
targetModelTags (array)
clientRequestToken (string)
bedrock/get_model_copy_jobRetrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.jobArn (string) required
bedrock/list_model_copy_jobsReturns a list of model copy jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.creationTimeAfter (string)
creationTimeBefore (string)
statusEquals (string)
sourceAccountEquals (string)
sourceModelArnEquals (string)
targetModelNameContains (string)
maxResults (integer)
nextToken (string)
sortBy (string)
sortOrder (string)
bedrock/create_model_import_jobCreates a model import job to import model that you have customized in other environments, such as Amazon SageMaker. For more information, see Import a customized modeljobName (string) required
importedModelName (string) required
roleArn (string) required
modelDataSource (undefined) required
jobTags (array)
importedModelTags (array)
clientRequestToken (string)
vpcConfig: {
. subnetIds (array)
. securityGroupIds (array)
} (object)
importedModelKmsKeyId (string)
bedrock/delete_imported_modelDeletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.modelIdentifier (string) required
bedrock/get_imported_modelGets properties associated with a customized model you imported.modelIdentifier (string) required
bedrock/get_model_import_jobRetrieves the properties associated with import model job, including the status of the job. For more information, see Import a customized model in the Amazon Bedrock User Guide.jobIdentifier (string) required
bedrock/list_imported_modelsReturns a list of models you've imported. You can filter the results to return based on one or more criteria. For more information, see Import a customized model in the Amazon Bedrock User Guide.creationTimeBefore (string)
creationTimeAfter (string)
nameContains (string)
maxResults (integer)
nextToken (string)
sortBy (string)
sortOrder (string)
bedrock/list_model_import_jobsReturns a list of import jobs you've submitted. You can filter the results to return based on one or more criteria. For more information, see Import a customized model in the Amazon Bedrock User Guide.creationTimeAfter (string)
creationTimeBefore (string)
statusEquals (string)
nameContains (string)
maxResults (integer)
nextToken (string)
sortBy (string)
sortOrder (string)
bedrock/create_model_invocation_jobCreates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference. The response returns a jobArn that you can use to stop or get details about the job.jobName (string) required
roleArn (string) required
clientRequestToken (string)
modelId (string) required
inputDataConfig (undefined) required
outputDataConfig (undefined) required
vpcConfig: {
. subnetIds (array)
. securityGroupIds (array)
} (object)
timeoutDurationInHours (integer)
tags (array)
bedrock/get_model_invocation_jobGets details about a batch inference job. For more information, see Monitor batch inference jobsjobIdentifier (string) required
bedrock/list_model_invocation_jobsLists all batch inference jobs in the account. For more information, see View details about a batch inference job.submitTimeAfter (string)
submitTimeBefore (string)
statusEquals (string)
nameContains (string)
maxResults (integer)
nextToken (string)
sortBy (string)
sortOrder (string)
bedrock/stop_model_invocation_jobStops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.jobIdentifier (string) required
bedrock/get_foundation_modelGet details about a Amazon Bedrock foundation model.modelIdentifier (string) required
bedrock/list_foundation_modelsLists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.byProvider (string)
byCustomizationType (string)
byOutputModality (string)
byInferenceType (string)
bedrock/create_prompt_routerCreates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.clientRequestToken (string)
promptRouterName (string) required
models (array) required
description (string)
routingCriteria: {
. responseQualityDifference (number)
} (object) required
fallbackModel: {
. modelArn (string)
} (object) required
tags (array)
bedrock/get_prompt_routerRetrieves details about a prompt router.promptRouterArn (string) required
bedrock/delete_prompt_routerDeletes a specified prompt router. This action cannot be undone.promptRouterArn (string) required
bedrock/list_prompt_routersRetrieves a list of prompt routers.maxResults (integer)
nextToken (string)
type (string)
bedrock/create_provisioned_model_throughputCreates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.clientRequestToken (string)
modelUnits (integer) required
provisionedModelName (string) required
modelId (string) required
commitmentDuration (string)
tags (array)
bedrock/delete_provisioned_model_throughputDeletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.provisionedModelId (string) required
bedrock/get_provisioned_model_throughputReturns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.provisionedModelId (string) required
bedrock/list_provisioned_model_throughputsLists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.creationTimeAfter (string)
creationTimeBefore (string)
statusEquals (string)
modelArnEquals (string)
nameContains (string)
maxResults (integer)
nextToken (string)
sortBy (string)
sortOrder (string)
bedrock/update_provisioned_model_throughputUpdates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.provisionedModelId (string) required
desiredProvisionedModelName (string)
desiredModelId (string)
bedrock/create_foundation_model_agreementRequest a model access agreement for the specified model.offerToken (string) required
modelId (string) required
bedrock/delete_foundation_model_agreementDelete the model access agreement for the specified model.modelId (string) required
bedrock/get_foundation_model_availabilityGet information about the Foundation model availability.modelId (string) required
bedrock/list_foundation_model_agreement_offersGet the offers associated with the specified model.modelId (string) required
offerType (string)
bedrock/list_tags_for_resourceList the tags associated with the specified resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.resourceARN (string) required
bedrock/tag_resourceAssociate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.resourceARN (string) required
tags (array) required
bedrock/untag_resourceRemove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.resourceARN (string) required
tagKeys (array) required
bedrock/create_model_customization_jobCreates a fine-tuning job to customize a base model. You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes. For information on the format of training and validation data, see Prepare the datasets. Model-customization jobs are asynchronous and the completion time depends on thjobName (string) required
customModelName (string) required
roleArn (string) required
clientRequestToken (string)
baseModelIdentifier (string) required
customizationType (string)
customModelKmsKeyId (string)
jobTags (array)
customModelTags (array)
trainingDataConfig: {
. s3Uri (string)
. invocationLogsConfig (object)
} (object) required
validationDataConfig: {
. validators (array)
} (object)
outputDataConfig: {
. s3Uri (string)
} (object) required
hyperParameters (object)
vpcConfig: {
. subnetIds (array)
. securityGroupIds (array)
} (object)
customizationConfig (undefined)
bedrock/get_model_customization_jobRetrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Amazon Bedrock User Guide.jobIdentifier (string) required
bedrock/list_model_customization_jobsReturns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Custom models in the Amazon Bedrock User Guide.creationTimeAfter (string)
creationTimeBefore (string)
statusEquals (string)
nameContains (string)
maxResults (integer)
nextToken (string)
sortBy (string)
sortOrder (string)
bedrock/stop_model_customization_jobStops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.jobIdentifier (string) required
billing/associate_source_viewsAssociates one or more source billing views with an existing billing view. This allows creating aggregate billing views that combine data from multiple sources.arn (string) required
sourceViews (array) required
billing/create_billing_viewCreates a billing view with the specified billing view attributes.name (string) required
description (string)
sourceViews (array) required
dataFilterExpression: {
. dimensions (object)
. tags (object)
. costCategories (object)
. timeRange (object)
} (object)
clientToken (string)
resourceTags (array)
billing/delete_billing_viewDeletes the specified billing view.arn (string) required
force (boolean)
billing/disassociate_source_viewsRemoves the association between one or more source billing views and an existing billing view. This allows modifying the composition of aggregate billing views.arn (string) required
sourceViews (array) required
billing/get_billing_viewReturns the metadata associated to the specified billing view ARN.arn (string) required
billing/get_resource_policyReturns the resource-based policy document attached to the resource in JSON format.resourceArn (string) required
billing/list_billing_viewsLists the billing views available for a given time period. Every Amazon Web Services account has a unique PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.activeTimeRange: {
. activeAfterInclusive (string)
. activeBeforeInclusive (string)
} (object)
arns (array)
billingViewTypes (array)
names (array)
ownerAccountId (string)
sourceAccountId (string)
maxResults (integer)
nextToken (string)
billing/list_source_views_for_billing_viewLists the source views managed Amazon Web Services billing views associated with the billing view.arn (string) required
maxResults (integer)
nextToken (string)
billing/list_tags_for_resourceLists tags associated with the billing view resource.resourceArn (string) required
billing/tag_resourceAn API operation for adding one or more tags key-value pairs to a resource.resourceArn (string) required
resourceTags (array) required
billing/untag_resourceRemoves one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.resourceArn (string) required
resourceTagKeys (array) required
billing/update_billing_viewAn API to update the attributes of the billing view.arn (string) required
name (string)
description (string)
dataFilterExpression: {
. dimensions (object)
. tags (object)
. costCategories (object)
. timeRange (object)
} (object)
billingconductor/get_billing_group_cost_reportRetrieves the margin summary report, which includes the Amazon Web Services cost and charged amount pro forma cost by Amazon Web Services service for a specific billing group.Arn (string) required
BillingPeriodRange: {
. InclusiveStartBillingPeriod (string)
. ExclusiveEndBillingPeriod (string)
} (object)
GroupBy (array)
MaxResults (integer)
NextToken (string)
billingconductor/list_account_associationsThis 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 that's associated with the linked account.BillingPeriod (string)
Filters: {
. Association (string)
. AccountId (string)
. AccountIds (array)
} (object)
NextToken (string)
billingconductor/list_billing_group_cost_reportsA 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.BillingPeriod (string)
MaxResults (integer)
NextToken (string)
Filters: {
. BillingGroupArns (array)
} (object)
billingconductor/list_tags_for_resourceA list the tags for a resource.ResourceArn (string) required
billingconductor/tag_resourceAssociates 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.ResourceArn (string) required
Tags (object) required
billingconductor/untag_resourceDeletes specified tags from a resource.ResourceArn (string) required
TagKeys (array) required
billingconductor/associate_accountsConnects 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.Arn (string) required
AccountIds (array) required
billingconductor/disassociate_accountsRemoves the specified list of account IDs from the given billing group.Arn (string) required
AccountIds (array) required
billingconductor/create_billing_groupCreates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation.ClientToken (string)
Name (string) required
AccountGrouping: {
. LinkedAccountIds (array)
. AutoAssociate (boolean)
. ResponsibilityTransferArn (string)
} (object) required
ComputationPreference: {
. PricingPlanArn (string)
} (object) required
PrimaryAccountId (string)
Description (string)
Tags (object)
billingconductor/update_billing_groupThis updates an existing billing group.Arn (string) required
Name (string)
Status (string)
ComputationPreference: {
. PricingPlanArn (string)
} (object)
Description (string)
AccountGrouping: {
. AutoAssociate (boolean)
. ResponsibilityTransferArn (string)
} (object)
billingconductor/delete_billing_groupDeletes a billing group.Arn (string) required
billingconductor/list_billing_groupsA 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.BillingPeriod (string)
MaxResults (integer)
NextToken (string)
Filters: {
. Arns (array)
. PricingPlan (string)
. Statuses (array)
. AutoAssociate (boolean)
. PrimaryAccountIds (array)
. BillingGroupTypes (array)
. Names (array)
. ResponsibilityTransferArns (array)
} (object)
billingconductor/batch_associate_resources_to_custom_line_itemAssociates a batch of resources to a percentage custom line item.TargetArn (string) required
ResourceArns (array) required
BillingPeriodRange: {
. InclusiveStartBillingPeriod (string)
. ExclusiveEndBillingPeriod (string)
} (object)
billingconductor/batch_disassociate_resources_from_custom_line_itemDisassociates a batch of resources from a percentage custom line item.TargetArn (string) required
ResourceArns (array) required
BillingPeriodRange: {
. InclusiveStartBillingPeriod (string)
. ExclusiveEndBillingPeriod (string)
} (object)
billingconductor/list_custom_line_item_versionsA paginated call to get a list of all custom line item versions.Arn (string) required
MaxResults (integer)
NextToken (string)
Filters: {
. BillingPeriodRange (object)
} (object)
billingconductor/list_resources_associated_to_custom_line_itemList the resources that are associated to a custom line item.BillingPeriod (string)
Arn (string) required
MaxResults (integer)
NextToken (string)
Filters: {
. Relationship (string)
} (object)
billingconductor/create_custom_line_itemCreates 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.ClientToken (string)
Name (string) required
Description (string) required
BillingGroupArn (string) required
BillingPeriodRange: {
. InclusiveStartBillingPeriod (string)
. ExclusiveEndBillingPeriod (string)
} (object)
Tags (object)
ChargeDetails: {
. Flat (object)
. Percentage (object)
. Type (string)
. LineItemFilters (array)
} (object) required
AccountId (string)
ComputationRule (string)
PresentationDetails: {
. Service (string)
} (object)
billingconductor/update_custom_line_itemUpdate an existing custom line item in the current or previous billing period.Arn (string) required
Name (string)
Description (string)
ChargeDetails: {
. Flat (object)
. Percentage (object)
. LineItemFilters (array)
} (object)
BillingPeriodRange: {
. InclusiveStartBillingPeriod (string)
. ExclusiveEndBillingPeriod (string)
} (object)
billingconductor/delete_custom_line_itemDeletes the custom line item identified by the given ARN in the current, or previous billing period.Arn (string) required
BillingPeriodRange: {
. InclusiveStartBillingPeriod (string)
. ExclusiveEndBillingPeriod (string)
} (object)
billingconductor/list_custom_line_itemsA 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.BillingPeriod (string)
MaxResults (integer)
NextToken (string)
Filters: {
. Names (array)
. BillingGroups (array)
. Arns (array)
. AccountIds (array)
} (object)
billingconductor/associate_pricing_rulesConnects an array of PricingRuleArns to a defined PricingPlan. The maximum number PricingRuleArn that can be associated in one call is 30.Arn (string) required
PricingRuleArns (array) required
billingconductor/disassociate_pricing_rulesDisassociates a list of pricing rules from a pricing plan.Arn (string) required
PricingRuleArns (array) required
billingconductor/list_pricing_plans_associated_with_pricing_ruleA list of the pricing plans that are associated with a pricing rule.BillingPeriod (string)
PricingRuleArn (string) required
MaxResults (integer)
NextToken (string)
billingconductor/create_pricing_planCreates a pricing plan that is used for computing Amazon Web Services charges for billing groups.ClientToken (string)
Name (string) required
Description (string)
PricingRuleArns (array)
Tags (object)
billingconductor/update_pricing_planThis updates an existing pricing plan.Arn (string) required
Name (string)
Description (string)
billingconductor/delete_pricing_planDeletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully.Arn (string) required
billingconductor/list_pricing_plansA 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.BillingPeriod (string)
Filters: {
. Arns (array)
} (object)
MaxResults (integer)
NextToken (string)
billingconductor/list_pricing_rules_associated_to_pricing_planLists the pricing rules that are associated with a pricing plan.BillingPeriod (string)
PricingPlanArn (string) required
MaxResults (integer)
NextToken (string)
billingconductor/create_pricing_ruleCreates a pricing rule can be associated to a pricing plan, or a set of pricing plans.ClientToken (string)
Name (string) required
Description (string)
Scope (string) required
Type (string) required
ModifierPercentage (number)
Service (string)
Tags (object)
BillingEntity (string)
Tiering: {
. FreeTier (object)
} (object)
UsageType (string)
Operation (string)
billingconductor/update_pricing_ruleUpdates an existing pricing rule.Arn (string) required
Name (string)
Description (string)
Type (string)
ModifierPercentage (number)
Tiering: {
. FreeTier (object)
} (object)
billingconductor/delete_pricing_ruleDeletes the pricing rule that's identified by the input Amazon Resource Name ARN.Arn (string) required
billingconductor/list_pricing_rulesDescribes a pricing rule that can be associated to a pricing plan, or set of pricing plans.BillingPeriod (string)
Filters: {
. Arns (array)
} (object)
MaxResults (integer)
NextToken (string)
braket/list_tags_for_resourceShows the tags associated with this resource.resourceArn (string) required
braket/tag_resourceAdd a tag to the specified resource.resourceArn (string) required
tags (object) required
braket/untag_resourceRemove tags from a resource.resourceArn (string) required
tagKeys (array) required
braket/get_deviceRetrieves 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-agdeviceArn (string) required
braket/search_devicesSearches for devices using the specified filters.nextToken (string)
maxResults (integer)
filters (array) required
braket/search_jobsSearches for Amazon Braket hybrid jobs that match the specified filter values.nextToken (string)
maxResults (integer)
filters (array) required
braket/create_jobCreates an Amazon Braket hybrid job.clientToken (string) required
algorithmSpecification: {
. scriptModeConfig (object)
. containerImage (object)
} (object) required
inputDataConfig (array)
outputDataConfig: {
. kmsKeyId (string)
. s3Path (string)
} (object) required
checkpointConfig: {
. localPath (string)
. s3Uri (string)
} (object)
jobName (string) required
roleArn (string) required
stoppingCondition: {
. maxRuntimeInSeconds (integer)
} (object)
instanceConfig: {
. instanceType (string)
. volumeSizeInGb (integer)
. instanceCount (integer)
} (object) required
hyperParameters (object)
deviceConfig: {
. device (string)
} (object) required
tags (object)
associations (array)
braket/get_jobRetrieves the specified Amazon Braket hybrid job.jobArn (string) required
additionalAttributeNames (array)
braket/cancel_jobCancels an Amazon Braket hybrid job.jobArn (string) required
braket/create_quantum_taskCreates a quantum task.clientToken (string) required
deviceArn (string) required
deviceParameters (string)
shots (integer) required
outputS3Bucket (string) required
outputS3KeyPrefix (string) required
action (string) required
tags (object)
jobToken (string)
associations (array)
experimentalCapabilities (undefined)
braket/get_quantum_taskRetrieves the specified quantum task.quantumTaskArn (string) required
additionalAttributeNames (array)
braket/cancel_quantum_taskCancels the specified task.quantumTaskArn (string) required
clientToken (string) required
braket/search_quantum_tasksSearches for tasks that match the specified filter values.nextToken (string)
maxResults (integer)
filters (array) required
braket/create_spending_limitCreates a spending limit for a specified quantum device. Spending limits help you control costs by setting maximum amounts that can be spent on quantum computing tasks within a specified time period. Simulators do not support spending limits.clientToken (string) required
deviceArn (string) required
spendingLimit (string) required
timePeriod: {
. startAt (string)
. endAt (string)
} (object)
tags (object)
braket/update_spending_limitUpdates an existing spending limit. You can modify the spending amount or time period. Changes take effect immediately.spendingLimitArn (string) required
clientToken (string) required
spendingLimit (string)
timePeriod: {
. startAt (string)
. endAt (string)
} (object)
braket/delete_spending_limitDeletes an existing spending limit. This operation permanently removes the spending limit and cannot be undone. After deletion, the associated device becomes unrestricted for spending.spendingLimitArn (string) required
braket/search_spending_limitsSearches and lists spending limits based on specified filters. This operation supports pagination and allows filtering by various criteria to find specific spending limits. We recommend using pagination to ensure that the operation returns quickly and successfully.nextToken (string)
maxResults (integer)
filters (array)
budgets/create_budgetCreates 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 use case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section. Similarly, only one set of filter and metric selections can be present in the syntax at one time. Either FilterExpression and Metrics or CostFilters and CostTypes, not both or a different combinAccountId (string) required
Budget: {
. BudgetName (string)
. BudgetLimit (object)
. PlannedBudgetLimits (object)
. CostFilters (object)
. CostTypes (object)
. TimeUnit (string)
. TimePeriod (object)
. CalculatedSpend (object)
. BudgetType (string)
. LastUpdatedTime (string)
. AutoAdjustData (object)
. FilterExpression (object)
. Metrics (array)
. BillingViewArn (string)
. HealthStatus (object)
} (object) required
NotificationsWithSubscribers (array)
ResourceTags (array)
budgets/create_budget_actionCreates a budget action.AccountId (string) required
BudgetName (string) required
NotificationType (string) required
ActionType (string) required
ActionThreshold: {
. ActionThresholdValue (number)
. ActionThresholdType (string)
} (object) required
Definition: {
. IamActionDefinition (object)
. ScpActionDefinition (object)
. SsmActionDefinition (object)
} (object) required
ExecutionRoleArn (string) required
ApprovalModel (string) required
Subscribers (array) required
ResourceTags (array)
budgets/create_notificationCreates a notification. You must create the budget before you create the associated notification.AccountId (string) required
BudgetName (string) required
Notification: {
. NotificationType (string)
. ComparisonOperator (string)
. Threshold (number)
. ThresholdType (string)
. NotificationState (string)
} (object) required
Subscribers (array) required
budgets/create_subscriberCreates a subscriber. You must create the associated budget and notification before you create the subscriber.AccountId (string) required
BudgetName (string) required
Notification: {
. NotificationType (string)
. ComparisonOperator (string)
. Threshold (number)
. ThresholdType (string)
. NotificationState (string)
} (object) required
Subscriber: {
. SubscriptionType (string)
. Address (string)
} (object) required
budgets/delete_budgetDeletes 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.AccountId (string) required
BudgetName (string) required
budgets/delete_budget_actionDeletes a budget action.AccountId (string) required
BudgetName (string) required
ActionId (string) required
budgets/delete_notificationDeletes a notification. Deleting a notification also deletes the subscribers that are associated with the notification.AccountId (string) required
BudgetName (string) required
Notification: {
. NotificationType (string)
. ComparisonOperator (string)
. Threshold (number)
. ThresholdType (string)
. NotificationState (string)
} (object) required
budgets/delete_subscriberDeletes a subscriber. Deleting the last subscriber to a notification also deletes the notification.AccountId (string) required
BudgetName (string) required
Notification: {
. NotificationType (string)
. ComparisonOperator (string)
. Threshold (number)
. ThresholdType (string)
. NotificationState (string)
} (object) required
Subscriber: {
. SubscriptionType (string)
. Address (string)
} (object) required
budgets/describe_budgetDescribes a budget. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.AccountId (string) required
BudgetName (string) required
ShowFilterExpression (boolean)
budgets/describe_budget_actionDescribes a budget action detail.AccountId (string) required
BudgetName (string) required
ActionId (string) required
budgets/describe_budget_action_historiesDescribes a budget action history detail.AccountId (string) required
BudgetName (string) required
ActionId (string) required
TimePeriod: {
. Start (string)
. End (string)
} (object)
MaxResults (integer)
NextToken (string)
budgets/describe_budget_actions_for_accountDescribes all of the budget actions for an account.AccountId (string) required
MaxResults (integer)
NextToken (string)
budgets/describe_budget_actions_for_budgetDescribes all of the budget actions for a budget.AccountId (string) required
BudgetName (string) required
MaxResults (integer)
NextToken (string)
budgets/describe_budget_notifications_for_accountLists the budget names and notifications that are associated with an account.AccountId (string) required
MaxResults (integer)
NextToken (string)
budgets/describe_budget_performance_historyDescribes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.AccountId (string) required
BudgetName (string) required
TimePeriod: {
. Start (string)
. End (string)
} (object)
MaxResults (integer)
NextToken (string)
budgets/describe_budgetsLists the budgets that are associated with an account. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.AccountId (string) required
MaxResults (integer)
NextToken (string)
ShowFilterExpression (boolean)
budgets/describe_notifications_for_budgetLists the notifications that are associated with a budget.AccountId (string) required
BudgetName (string) required
MaxResults (integer)
NextToken (string)
budgets/describe_subscribers_for_notificationLists the subscribers that are associated with a notification.AccountId (string) required
BudgetName (string) required
Notification: {
. NotificationType (string)
. ComparisonOperator (string)
. Threshold (number)
. ThresholdType (string)
. NotificationState (string)
} (object) required
MaxResults (integer)
NextToken (string)
budgets/execute_budget_actionExecutes a budget action.AccountId (string) required
BudgetName (string) required
ActionId (string) required
ExecutionType (string) required
budgets/list_tags_for_resourceLists tags associated with a budget or budget action resource.ResourceARN (string) required
budgets/tag_resourceCreates tags for a budget or budget action resource.ResourceARN (string) required
ResourceTags (array) required
budgets/untag_resourceDeletes tags associated with a budget or budget action resource.ResourceARN (string) required
ResourceTagKeys (array) required
budgets/update_budgetUpdates 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. Similarly, only one set of fAccountId (string) required
NewBudget: {
. BudgetName (string)
. BudgetLimit (object)
. PlannedBudgetLimits (object)
. CostFilters (object)
. CostTypes (object)
. TimeUnit (string)
. TimePeriod (object)
. CalculatedSpend (object)
. BudgetType (string)
. LastUpdatedTime (string)
. AutoAdjustData (object)
. FilterExpression (object)
. Metrics (array)
. BillingViewArn (string)
. HealthStatus (object)
} (object) required
budgets/update_budget_actionUpdates a budget action.AccountId (string) required
BudgetName (string) required
ActionId (string) required
NotificationType (string)
ActionThreshold: {
. ActionThresholdValue (number)
. ActionThresholdType (string)
} (object)
Definition: {
. IamActionDefinition (object)
. ScpActionDefinition (object)
. SsmActionDefinition (object)
} (object)
ExecutionRoleArn (string)
ApprovalModel (string)
Subscribers (array)
budgets/update_notificationUpdates a notification.AccountId (string) required
BudgetName (string) required
OldNotification: {
. NotificationType (string)
. ComparisonOperator (string)
. Threshold (number)
. ThresholdType (string)
. NotificationState (string)
} (object) required
NewNotification: {
. NotificationType (string)
. ComparisonOperator (string)
. Threshold (number)
. ThresholdType (string)
. NotificationState (string)
} (object) required
budgets/update_subscriberUpdates a subscriber.AccountId (string) required
BudgetName (string) required
Notification: {
. NotificationType (string)
. ComparisonOperator (string)
. Threshold (number)
. ThresholdType (string)
. NotificationState (string)
} (object) required
OldSubscriber: {
. SubscriptionType (string)
. Address (string)
} (object) required
NewSubscriber: {
. SubscriptionType (string)
. Address (string)
} (object) required
chatbot/associate_to_configurationLinks a resource for example, a custom action to a channel configuration.Resource (string) required
ChatConfiguration (string) required
chatbot/create_chime_webhook_configurationCreates an AWS Chatbot configuration for Amazon Chime.WebhookDescription (string) required
WebhookUrl (string) required
SnsTopicArns (array) required
IamRoleArn (string) required
ConfigurationName (string) required
LoggingLevel (string)
Tags (array)
chatbot/create_microsoft_teams_channel_configurationCreates an AWS Chatbot configuration for Microsoft Teams.ChannelId (string) required
ChannelName (string)
TeamId (string) required
TeamName (string)
TenantId (string) required
SnsTopicArns (array)
IamRoleArn (string) required
ConfigurationName (string) required
LoggingLevel (string)
GuardrailPolicyArns (array)
UserAuthorizationRequired (boolean)
Tags (array)
chatbot/create_slack_channel_configurationCreates an AWS Chatbot confugration for Slack.SlackTeamId (string) required
SlackChannelId (string) required
SlackChannelName (string)
SnsTopicArns (array)
IamRoleArn (string) required
ConfigurationName (string) required
LoggingLevel (string)
GuardrailPolicyArns (array)
UserAuthorizationRequired (boolean)
Tags (array)
chatbot/delete_chime_webhook_configurationDeletes a Amazon Chime webhook configuration for AWS Chatbot.ChatConfigurationArn (string) required
chatbot/delete_microsoft_teams_channel_configurationDeletes a Microsoft Teams channel configuration for AWS ChatbotChatConfigurationArn (string) required
chatbot/delete_microsoft_teams_configured_teamDeletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must have no channels configured to remove it.TeamId (string) required
chatbot/delete_microsoft_teams_user_identityIdentifes a user level permission for a channel configuration.ChatConfigurationArn (string) required
UserId (string) required
chatbot/delete_slack_channel_configurationDeletes a Slack channel configuration for AWS ChatbotChatConfigurationArn (string) required
chatbot/delete_slack_user_identityDeletes a user level permission for a Slack channel configuration.ChatConfigurationArn (string) required
SlackTeamId (string) required
SlackUserId (string) required
chatbot/delete_slack_workspace_authorizationDeletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to be deleted.SlackTeamId (string) required
chatbot/describe_chime_webhook_configurationsLists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArnMaxResults (integer)
NextToken (string)
ChatConfigurationArn (string)
chatbot/describe_slack_channel_configurationsLists Slack channel configurations optionally filtered by ChatConfigurationArnMaxResults (integer)
NextToken (string)
ChatConfigurationArn (string)
chatbot/describe_slack_user_identitiesLists all Slack user identities with a mapped role.ChatConfigurationArn (string)
NextToken (string)
MaxResults (integer)
chatbot/describe_slack_workspacesList all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.MaxResults (integer)
NextToken (string)
chatbot/disassociate_from_configurationUnlink a resource, for example a custom action, from a channel configuration.Resource (string) required
ChatConfiguration (string) required
chatbot/get_account_preferencesReturns AWS Chatbot account preferences.No parameters
chatbot/get_microsoft_teams_channel_configurationReturns a Microsoft Teams channel configuration in an AWS account.ChatConfigurationArn (string) required
chatbot/list_associationsLists resources associated with a channel configuration.ChatConfiguration (string) required
MaxResults (integer)
NextToken (string)
chatbot/list_microsoft_teams_channel_configurationsLists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.MaxResults (integer)
NextToken (string)
TeamId (string)
chatbot/list_microsoft_teams_configured_teamsLists all authorized Microsoft Teams for an AWS AccountMaxResults (integer)
NextToken (string)
chatbot/list_microsoft_teams_user_identitiesA list all Microsoft Teams user identities with a mapped role.ChatConfigurationArn (string)
NextToken (string)
MaxResults (integer)
chatbot/list_tags_for_resourceLists all of the tags associated with the Amazon Resource Name ARN that you specify. The resource can be a user, server, or role.ResourceARN (string) required
chatbot/tag_resourceAttaches a key-value pair to a resource, as identified by its Amazon Resource Name ARN. Resources are users, servers, roles, and other entities.ResourceARN (string) required
Tags (array) required
chatbot/untag_resourceDetaches a key-value pair from a resource, as identified by its Amazon Resource Name ARN. Resources are users, servers, roles, and other entities.ResourceARN (string) required
TagKeys (array) required
chatbot/update_account_preferencesUpdates AWS Chatbot account preferences.UserAuthorizationRequired (boolean)
TrainingDataCollectionEnabled (boolean)
chatbot/update_chime_webhook_configurationUpdates a Amazon Chime webhook configuration.ChatConfigurationArn (string) required
WebhookDescription (string)
WebhookUrl (string)
SnsTopicArns (array)
IamRoleArn (string)
LoggingLevel (string)
chatbot/update_microsoft_teams_channel_configurationUpdates an Microsoft Teams channel configuration.ChatConfigurationArn (string) required
ChannelId (string) required
ChannelName (string)
SnsTopicArns (array)
IamRoleArn (string)
LoggingLevel (string)
GuardrailPolicyArns (array)
UserAuthorizationRequired (boolean)
chatbot/update_slack_channel_configurationUpdates a Slack channel configuration.ChatConfigurationArn (string) required
SlackChannelId (string) required
SlackChannelName (string)
SnsTopicArns (array)
IamRoleArn (string)
LoggingLevel (string)
GuardrailPolicyArns (array)
UserAuthorizationRequired (boolean)
chatbot/create_custom_actionCreates a custom action that can be invoked as an alias or as a button on a notification.Definition: {
. CommandText (string)
} (object) required
AliasName (string)
Attachments (array)
Tags (array)
ClientToken (string)
ActionName (string) required
chatbot/get_custom_actionReturns a custom action.CustomActionArn (string) required
chatbot/update_custom_actionUpdates a custom action.CustomActionArn (string) required
Definition: {
. CommandText (string)
} (object) required
AliasName (string)
Attachments (array)
chatbot/delete_custom_actionDeletes a custom action.CustomActionArn (string) required
chatbot/list_custom_actionsLists custom actions defined in this account.MaxResults (integer)
NextToken (string)
chime_sdk_identity/create_app_instanceCreates 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. identityName (string) required
Metadata (string)
ClientRequestToken (string) required
Tags (array)
chime_sdk_identity/create_app_instance_adminPromotes an AppInstanceUser or AppInstanceBot to an AppInstanceAdmin. The promoted entity can perform the following actions. ChannelModerator actions across all channels in the AppInstance. DeleteChannelMessage actions. Only an AppInstanceUser and AppInstanceBot can be promoted to an AppInstanceAdmin role.AppInstanceAdminArn (string) required
AppInstanceArn (string) required
chime_sdk_identity/create_app_instance_botCreates a bot under an Amazon Chime AppInstance. The request consists of a unique Configuration and Name for that bot.AppInstanceArn (string) required
Name (string)
Metadata (string)
ClientRequestToken (string) required
Tags (array)
Configuration: {
. Lex (object)
} (object) required
chime_sdk_identity/create_app_instance_userCreates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.AppInstanceArn (string) required
AppInstanceUserId (string) required
Name (string) required
Metadata (string)
ClientRequestToken (string) required
Tags (array)
ExpirationSettings: {
. ExpirationDays (integer)
. ExpirationCriterion (string)
} (object)
chime_sdk_identity/delete_app_instanceDeletes an AppInstance and all associated data asynchronously.AppInstanceArn (string) required
chime_sdk_identity/delete_app_instance_adminDemotes an AppInstanceAdmin to an AppInstanceUser or AppInstanceBot. This action does not delete the user.AppInstanceAdminArn (string) required
AppInstanceArn (string) required
chime_sdk_identity/delete_app_instance_botDeletes an AppInstanceBot.AppInstanceBotArn (string) required
chime_sdk_identity/delete_app_instance_userDeletes an AppInstanceUser.AppInstanceUserArn (string) required
chime_sdk_identity/deregister_app_instance_user_endpointDeregisters an AppInstanceUserEndpoint.AppInstanceUserArn (string) required
EndpointId (string) required
chime_sdk_identity/describe_app_instanceReturns the full details of an AppInstance.AppInstanceArn (string) required
chime_sdk_identity/describe_app_instance_adminReturns the full details of an AppInstanceAdmin.AppInstanceAdminArn (string) required
AppInstanceArn (string) required
chime_sdk_identity/describe_app_instance_botThe AppInstanceBot's information.AppInstanceBotArn (string) required
chime_sdk_identity/describe_app_instance_userReturns the full details of an AppInstanceUser.AppInstanceUserArn (string) required
chime_sdk_identity/describe_app_instance_user_endpointReturns the full details of an AppInstanceUserEndpoint.AppInstanceUserArn (string) required
EndpointId (string) required
chime_sdk_identity/get_app_instance_retention_settingsGets the retention settings for an AppInstance.AppInstanceArn (string) required
chime_sdk_identity/list_app_instance_adminsReturns a list of the administrators in the AppInstance.AppInstanceArn (string) required
MaxResults (integer)
NextToken (string)
chime_sdk_identity/list_app_instance_botsLists all AppInstanceBots created under a single AppInstance.AppInstanceArn (string) required
MaxResults (integer)
NextToken (string)
chime_sdk_identity/list_app_instancesLists all Amazon Chime AppInstances created under a single AWS account.MaxResults (integer)
NextToken (string)
chime_sdk_identity/list_app_instance_user_endpointsLists all the AppInstanceUserEndpoints created under a single AppInstanceUser.AppInstanceUserArn (string) required
MaxResults (integer)
NextToken (string)
chime_sdk_identity/list_app_instance_usersList all AppInstanceUsers created under a single AppInstance.AppInstanceArn (string) required
MaxResults (integer)
NextToken (string)
chime_sdk_identity/list_tags_for_resourceLists the tags applied to an Amazon Chime SDK identity resource.ResourceARN (string) required
chime_sdk_identity/put_app_instance_retention_settingsSets the amount of time in days that a given AppInstance retains data.AppInstanceArn (string) required
AppInstanceRetentionSettings: {
. ChannelRetentionSettings (object)
} (object) required
chime_sdk_identity/put_app_instance_user_expiration_settingsSets the number of days before the AppInstanceUser is automatically deleted. A background process deletes expired AppInstanceUsers within 6 hours of expiration. Actual deletion times may vary. Expired AppInstanceUsers that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.AppInstanceUserArn (string) required
ExpirationSettings: {
. ExpirationDays (integer)
. ExpirationCriterion (string)
} (object)
chime_sdk_identity/register_app_instance_user_endpointRegisters 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.AppInstanceUserArn (string) required
Name (string)
Type (string) required
ResourceArn (string) required
EndpointAttributes: {
. DeviceToken (string)
. VoipDeviceToken (string)
} (object) required
ClientRequestToken (string) required
AllowMessages (string)
chime_sdk_identity/tag_resourceApplies the specified tags to the specified Amazon Chime SDK identity resource.ResourceARN (string) required
Tags (array) required
chime_sdk_identity/untag_resourceRemoves the specified tags from the specified Amazon Chime SDK identity resource.ResourceARN (string) required
TagKeys (array) required
chime_sdk_identity/update_app_instanceUpdates AppInstance metadata.AppInstanceArn (string) required
Name (string) required
Metadata (string) required
chime_sdk_identity/update_app_instance_botUpdates the name and metadata of an AppInstanceBot.AppInstanceBotArn (string) required
Name (string) required
Metadata (string) required
Configuration: {
. Lex (object)
} (object)
chime_sdk_identity/update_app_instance_userUpdates the details of an AppInstanceUser. You can update names and metadata.AppInstanceUserArn (string) required
Name (string) required
Metadata (string) required
chime_sdk_identity/update_app_instance_user_endpointUpdates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.AppInstanceUserArn (string) required
EndpointId (string) required
Name (string)
AllowMessages (string)
chime_sdk_media_pipelines/create_media_capture_pipelineCreates a media pipeline.SourceType (string) required
SourceArn (string) required
SinkType (string) required
SinkArn (string) required
ClientRequestToken (string)
ChimeSdkMeetingConfiguration: {
. SourceConfiguration (object)
. ArtifactsConfiguration (object)
} (object)
SseAwsKeyManagementParams: {
. AwsKmsKeyId (string)
. AwsKmsEncryptionContext (string)
} (object)
SinkIamRoleArn (string)
Tags (array)
chime_sdk_media_pipelines/create_media_concatenation_pipelineCreates a media concatenation pipeline.Sources (array) required
Sinks (array) required
ClientRequestToken (string)
Tags (array)
chime_sdk_media_pipelines/create_media_insights_pipelineCreates a media insights pipeline.MediaInsightsPipelineConfigurationArn (string) required
KinesisVideoStreamSourceRuntimeConfiguration: {
. Streams (array)
. MediaEncoding (string)
. MediaSampleRate (integer)
} (object)
MediaInsightsRuntimeMetadata (object)
KinesisVideoStreamRecordingSourceRuntimeConfiguration: {
. Streams (array)
. FragmentSelector (object)
} (object)
S3RecordingSinkRuntimeConfiguration: {
. Destination (string)
. RecordingFileFormat (string)
} (object)
Tags (array)
ClientRequestToken (string)
chime_sdk_media_pipelines/create_media_insights_pipeline_configurationA structure that contains the static configurations for a media insights pipeline.MediaInsightsPipelineConfigurationName (string) required
ResourceAccessRoleArn (string) required
RealTimeAlertConfiguration: {
. Disabled (boolean)
. Rules (array)
} (object)
Elements (array) required
Tags (array)
ClientRequestToken (string)
chime_sdk_media_pipelines/create_media_live_connector_pipelineCreates a media live connector pipeline in an Amazon Chime SDK meeting.Sources (array) required
Sinks (array) required
ClientRequestToken (string)
Tags (array)
chime_sdk_media_pipelines/create_media_pipeline_kinesis_video_stream_poolCreates an Amazon Kinesis Video Stream pool for use with media stream pipelines. If a meeting uses an opt-in Region as its MediaRegion, the KVS stream must be in that same Region. For example, if a meeting uses the af-south-1 Region, the KVS stream must also be in af-south-1. However, if the meeting uses a Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses ca-central-1, the KVS stream can be in eu-west-StreamConfiguration: {
. Region (string)
. DataRetentionInHours (integer)
} (object) required
PoolName (string) required
ClientRequestToken (string)
Tags (array)
chime_sdk_media_pipelines/create_media_stream_pipelineCreates a streaming media pipeline.Sources (array) required
Sinks (array) required
ClientRequestToken (string)
Tags (array)
chime_sdk_media_pipelines/delete_media_capture_pipelineDeletes the media pipeline.MediaPipelineId (string) required
chime_sdk_media_pipelines/delete_media_insights_pipeline_configurationDeletes the specified configuration settings.Identifier (string) required
chime_sdk_media_pipelines/delete_media_pipelineDeletes the media pipeline.MediaPipelineId (string) required
chime_sdk_media_pipelines/delete_media_pipeline_kinesis_video_stream_poolDeletes an Amazon Kinesis Video Stream pool.Identifier (string) required
chime_sdk_media_pipelines/get_media_capture_pipelineGets an existing media pipeline.MediaPipelineId (string) required
chime_sdk_media_pipelines/get_media_insights_pipeline_configurationGets the configuration settings for a media insights pipeline.Identifier (string) required
chime_sdk_media_pipelines/get_media_pipelineGets an existing media pipeline.MediaPipelineId (string) required
chime_sdk_media_pipelines/get_media_pipeline_kinesis_video_stream_poolGets an Kinesis video stream pool.Identifier (string) required
chime_sdk_media_pipelines/get_speaker_search_taskRetrieves the details of the specified speaker search task.Identifier (string) required
SpeakerSearchTaskId (string) required
chime_sdk_media_pipelines/get_voice_tone_analysis_taskRetrieves the details of a voice tone analysis task.Identifier (string) required
VoiceToneAnalysisTaskId (string) required
chime_sdk_media_pipelines/list_media_capture_pipelinesReturns a list of media pipelines.NextToken (string)
MaxResults (integer)
chime_sdk_media_pipelines/list_media_insights_pipeline_configurationsLists the available media insights pipeline configurations.NextToken (string)
MaxResults (integer)
chime_sdk_media_pipelines/list_media_pipeline_kinesis_video_stream_poolsLists the video stream pools in the media pipeline.NextToken (string)
MaxResults (integer)
chime_sdk_media_pipelines/list_media_pipelinesReturns a list of media pipelines.NextToken (string)
MaxResults (integer)
chime_sdk_media_pipelines/list_tags_for_resourceLists the tags available for a media pipeline.ResourceARN (string) required
chime_sdk_media_pipelines/start_speaker_search_taskStarts a speaker search task. Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.Identifier (string) required
VoiceProfileDomainArn (string) required
KinesisVideoStreamSourceTaskConfiguration: {
. StreamArn (string)
. ChannelId (integer)
. FragmentNumber (string)
} (object)
ClientRequestToken (string)
chime_sdk_media_pipelines/start_voice_tone_analysis_taskStarts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide. Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.Identifier (string) required
LanguageCode (string) required
KinesisVideoStreamSourceTaskConfiguration: {
. StreamArn (string)
. ChannelId (integer)
. FragmentNumber (string)
} (object)
ClientRequestToken (string)
chime_sdk_media_pipelines/stop_speaker_search_taskStops a speaker search task.Identifier (string) required
SpeakerSearchTaskId (string) required
chime_sdk_media_pipelines/stop_voice_tone_analysis_taskStops a voice tone analysis task.Identifier (string) required
VoiceToneAnalysisTaskId (string) required
chime_sdk_media_pipelines/tag_resourceThe ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.ResourceARN (string) required
Tags (array) required
chime_sdk_media_pipelines/untag_resourceRemoves any tags from a media pipeline.ResourceARN (string) required
TagKeys (array) required
chime_sdk_media_pipelines/update_media_insights_pipeline_configurationUpdates the media insights pipeline's configuration settings.Identifier (string) required
ResourceAccessRoleArn (string) required
RealTimeAlertConfiguration: {
. Disabled (boolean)
. Rules (array)
} (object)
Elements (array) required
chime_sdk_media_pipelines/update_media_insights_pipeline_statusUpdates the status of a media insights pipeline.Identifier (string) required
UpdateStatus (string) required
chime_sdk_media_pipelines/update_media_pipeline_kinesis_video_stream_poolUpdates an Amazon Kinesis Video Stream pool in a media pipeline.Identifier (string) required
StreamConfiguration: {
. DataRetentionInHours (integer)
} (object)
chime_sdk_meetings/batch_create_attendeeCreates 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.MeetingId (string) required
Attendees (array) required
chime_sdk_meetings/batch_update_attendee_capabilities_exceptUpdates 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: If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejectMeetingId (string) required
ExcludedAttendeeIds (array) required
Capabilities: {
. Audio (string)
. Video (string)
. Content (string)
} (object) required
chime_sdk_meetings/create_attendeeCreates 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.MeetingId (string) required
ExternalUserId (string) required
Capabilities: {
. Audio (string)
. Video (string)
. Content (string)
} (object)
chime_sdk_meetings/create_meetingCreates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Available Regions and Using meeting Regions, both in the Amazon Chime SDK Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide. If you use this API in conjuction with the and APIs, and you don't specify the MeetingFeatures.Content.MaxResolution or MeetingFeaturesClientRequestToken (string) required
MediaRegion (string) required
MeetingHostId (string)
ExternalMeetingId (string) required
NotificationsConfiguration: {
. LambdaFunctionArn (string)
. SnsTopicArn (string)
. SqsQueueArn (string)
} (object)
MeetingFeatures: {
. Audio (object)
. Video (object)
. Content (object)
. Attendee (object)
} (object)
PrimaryMeetingId (string)
TenantIds (array)
Tags (array)
MediaPlacementNetworkType (string)
chime_sdk_meetings/create_meeting_with_attendeesCreates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Available Regions and Using meeting Regions, both in the Amazon Chime SDK Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide. If you use this API in conjuction with the and APIs, and you don't specify the MeetingFeatures.Content.MaxResolution or MeetingFeatures.Video.MaxClientRequestToken (string) required
MediaRegion (string) required
MeetingHostId (string)
ExternalMeetingId (string) required
MeetingFeatures: {
. Audio (object)
. Video (object)
. Content (object)
. Attendee (object)
} (object)
NotificationsConfiguration: {
. LambdaFunctionArn (string)
. SnsTopicArn (string)
. SqsQueueArn (string)
} (object)
Attendees (array) required
PrimaryMeetingId (string)
TenantIds (array)
Tags (array)
MediaPlacementNetworkType (string)
chime_sdk_meetings/delete_attendeeDeletes 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.MeetingId (string) required
AttendeeId (string) required
chime_sdk_meetings/delete_meetingDeletes 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.MeetingId (string) required
chime_sdk_meetings/get_attendeeGets 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.MeetingId (string) required
AttendeeId (string) required
chime_sdk_meetings/get_meetingGets 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.MeetingId (string) required
chime_sdk_meetings/list_attendeesLists 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.MeetingId (string) required
NextToken (string)
MaxResults (integer)
chime_sdk_meetings/list_tags_for_resourceReturns a list of the tags available for the specified resource.ResourceARN (string) required
chime_sdk_meetings/start_meeting_transcriptionStarts transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide. If you specify an invalid configuration, a TranscriptFailed event will be sent with the contents of the BadRequestException generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the StartStreamTranscription API in the Amazon Transcribe Developer Guide. By default, Amazon TranMeetingId (string) required
TranscriptionConfiguration: {
. EngineTranscribeSettings (object)
. EngineTranscribeMedicalSettings (object)
} (object) required
chime_sdk_meetings/stop_meeting_transcriptionStops transcription for the specified meetingId. For more information, refer to Using Amazon Chime SDK live transcription in the Amazon Chime SDK Developer Guide. By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the Amazon Web Services Service Terms. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or intercepMeetingId (string) required
chime_sdk_meetings/tag_resourceThe resource that supports tags.ResourceARN (string) required
Tags (array) required
chime_sdk_meetings/untag_resourceRemoves 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 waResourceARN (string) required
TagKeys (array) required
chime_sdk_meetings/update_attendee_capabilitiesThe capabilities 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: If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400. If you specify MeetingMeetingId (string) required
AttendeeId (string) required
Capabilities: {
. Audio (string)
. Video (string)
. Content (string)
} (object) required
chime_sdk_messaging/associate_channel_flowAssociates 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
ChannelFlowArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/batch_create_channel_membershipAdds a specified number of users and bots to a channel.ChannelArn (string) required
Type (string)
MemberArns (array) required
ChimeBearer (string) required
SubChannelId (string)
chime_sdk_messaging/channel_flow_callbackCalls back Amazon 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 messageCallbackId (string) required
ChannelArn (string) required
DeleteResource (boolean)
ChannelMessage: {
. MessageId (string)
. Content (string)
. Metadata (string)
. PushNotification (object)
. MessageAttributes (object)
. SubChannelId (string)
. ContentType (string)
} (object) required
chime_sdk_messaging/create_channelCreates 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.AppInstanceArn (string) required
Name (string) required
Mode (string)
Privacy (string)
Metadata (string)
ClientRequestToken (string) required
Tags (array)
ChimeBearer (string) required
ChannelId (string)
MemberArns (array)
ModeratorArns (array)
ElasticChannelConfiguration: {
. MaximumSubChannels (integer)
. TargetMembershipsPerSubChannel (integer)
. MinimumMembershipPercentage (integer)
} (object)
ExpirationSettings: {
. ExpirationDays (integer)
. ExpirationCriterion (string)
} (object)
chime_sdk_messaging/create_channel_banPermanently 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
MemberArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/create_channel_flowCreates 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 SyAppInstanceArn (string) required
Processors (array) required
Name (string) required
Tags (array)
ClientRequestToken (string) required
chime_sdk_messaging/create_channel_membershipAdds a member 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 ARNChannelArn (string) required
MemberArn (string) required
Type (string) required
ChimeBearer (string) required
SubChannelId (string)
chime_sdk_messaging/create_channel_moderatorCreates 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 ARN of the AppInstanceUser or AppInstanceBotof the user that makes the API call as the value in the header.ChannelArn (string) required
ChannelModeratorArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/delete_channelImmediately 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 ARN of the AppInstanceUserArn or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/delete_channel_banRemoves a member from a channel's ban list. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
MemberArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/delete_channel_flowDeletes 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.ChannelFlowArn (string) required
chime_sdk_messaging/delete_channel_membershipRemoves 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.ChannelArn (string) required
MemberArn (string) required
ChimeBearer (string) required
SubChannelId (string)
chime_sdk_messaging/delete_channel_messageDeletes 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
MessageId (string) required
ChimeBearer (string) required
SubChannelId (string)
chime_sdk_messaging/delete_channel_moderatorDeletes a channel moderator. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
ChannelModeratorArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/delete_messaging_streaming_configurationsDeletes the streaming configurations for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.AppInstanceArn (string) required
chime_sdk_messaging/describe_channelReturns the full details of a channel in an Amazon Chime AppInstance. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/describe_channel_banReturns the full details of a channel ban. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
MemberArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/describe_channel_flowReturns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.ChannelFlowArn (string) required
chime_sdk_messaging/describe_channel_membershipReturns the full details of a user's channel membership. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
MemberArn (string) required
ChimeBearer (string) required
SubChannelId (string)
chime_sdk_messaging/describe_channel_membership_for_app_instance_userReturns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
AppInstanceUserArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/describe_channel_moderated_by_app_instance_userReturns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
AppInstanceUserArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/describe_channel_moderatorReturns 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.ChannelArn (string) required
ChannelModeratorArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/disassociate_channel_flowDisassociates 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
ChannelFlowArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/get_channel_membership_preferencesGets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned. The x-amz-chime-bearer request header is mandatory. Use the ARNChannelArn (string) required
MemberArn (string) required
ChimeBearer (string) required
chime_sdk_messaging/get_channel_messageGets the full details of a channel message. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
MessageId (string) required
ChimeBearer (string) required
SubChannelId (string)
chime_sdk_messaging/get_channel_message_statusGets 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 Message denied by the processor This API does not return statuses for dChannelArn (string) required
MessageId (string) required
ChimeBearer (string) required
SubChannelId (string)
chime_sdk_messaging/get_messaging_session_endpointThe details of the endpoint for the messaging session.NetworkType (string)
chime_sdk_messaging/get_messaging_streaming_configurationsRetrieves the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.AppInstanceArn (string) required
chime_sdk_messaging/list_channel_bansLists all the users and bots banned from a particular channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
MaxResults (integer)
NextToken (string)
ChimeBearer (string) required
chime_sdk_messaging/list_channel_flowsReturns a paginated lists of all the channel flows created under a single Chime. This is a developer API.AppInstanceArn (string) required
MaxResults (integer)
NextToken (string)
chime_sdk_messaging/list_channel_membershipsLists all channel memberships in a channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot 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.ChannelArn (string) required
Type (string)
MaxResults (integer)
NextToken (string)
ChimeBearer (string) required
SubChannelId (string)
chime_sdk_messaging/list_channel_memberships_for_app_instance_userLists all channels that an AppInstanceUser or AppInstanceBot 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.AppInstanceUserArn (string)
MaxResults (integer)
NextToken (string)
ChimeBearer (string) required
chime_sdk_messaging/list_channel_messagesList 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value iChannelArn (string) required
SortOrder (string)
NotBefore (string)
NotAfter (string)
MaxResults (integer)
NextToken (string)
ChimeBearer (string) required
SubChannelId (string)
chime_sdk_messaging/list_channel_moderatorsLists all the moderators for a channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
MaxResults (integer)
NextToken (string)
ChimeBearer (string) required
chime_sdk_messaging/list_channelsLists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality and 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.AppInstanceArn (string) required
Privacy (string)
MaxResults (integer)
NextToken (string)
ChimeBearer (string) required
chime_sdk_messaging/list_channels_associated_with_channel_flowLists 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.ChannelFlowArn (string) required
MaxResults (integer)
NextToken (string)
chime_sdk_messaging/list_channels_moderated_by_app_instance_userA list of the channels moderated by an AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.AppInstanceUserArn (string)
MaxResults (integer)
NextToken (string)
ChimeBearer (string) required
chime_sdk_messaging/list_sub_channelsLists 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.ChannelArn (string) required
ChimeBearer (string) required
MaxResults (integer)
NextToken (string)
chime_sdk_messaging/list_tags_for_resourceLists the tags applied to an Amazon Chime SDK messaging resource.ResourceARN (string) required
chime_sdk_messaging/put_channel_expiration_settingsSets the number of days before the channel is automatically deleted. A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary. Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
ChimeBearer (string)
ExpirationSettings: {
. ExpirationDays (integer)
. ExpirationCriterion (string)
} (object)
chime_sdk_messaging/put_channel_membership_preferencesSets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't set preferences for other users. Banned users or bots can't set membership preferences for the channel from which they are banned. The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUsChannelArn (string) required
MemberArn (string) required
ChimeBearer (string) required
Preferences: {
. PushNotifications (object)
} (object) required
chime_sdk_messaging/put_messaging_streaming_configurationsSets the data streaming configuration for an AppInstance. For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide.AppInstanceArn (string) required
StreamingConfigurations (array) required
chime_sdk_messaging/redact_channel_messageRedacts message content and 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 ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
MessageId (string) required
ChimeBearer (string) required
SubChannelId (string)
chime_sdk_messaging/search_channelsAllows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin role can search across all channels. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header. This operation isn't supported for AppInstanceUsers with a large number of memberships.ChimeBearer (string)
Fields (array) required
MaxResults (integer)
NextToken (string)
chime_sdk_messaging/send_channel_messageSends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header. Also, STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment. CONTROL messages are limited to 30 bytes and do not contain metadata.ChannelArn (string) required
Content (string) required
Type (string) required
Persistence (string) required
Metadata (string)
ClientRequestToken (string) required
ChimeBearer (string) required
PushNotification: {
. Title (string)
. Body (string)
. Type (string)
} (object)
MessageAttributes (object)
SubChannelId (string)
ContentType (string)
Target (array)
chime_sdk_messaging/tag_resourceApplies the specified tags to the specified Amazon Chime SDK messaging resource.ResourceARN (string) required
Tags (array) required
chime_sdk_messaging/untag_resourceRemoves the specified tags from the specified Amazon Chime SDK messaging resource.ResourceARN (string) required
TagKeys (array) required
chime_sdk_messaging/update_channelUpdate a channel's attributes. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
Name (string)
Mode (string)
Metadata (string)
ChimeBearer (string) required
chime_sdk_messaging/update_channel_flowUpdates channel flow attributes. This is a developer API.ChannelFlowArn (string) required
Processors (array) required
Name (string) required
chime_sdk_messaging/update_channel_messageUpdates the content of a message. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
MessageId (string) required
Content (string) required
Metadata (string)
ChimeBearer (string) required
SubChannelId (string)
ContentType (string)
chime_sdk_messaging/update_channel_read_markerThe details of the time when a user last read messages in a channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.ChannelArn (string) required
ChimeBearer (string) required
chime_sdk_voice/associate_phone_numbers_with_voice_connectorAssociates phone numbers with the specified Amazon Chime SDK Voice Connector.VoiceConnectorId (string) required
E164PhoneNumbers (array) required
ForceAssociate (boolean)
chime_sdk_voice/associate_phone_numbers_with_voice_connector_groupAssociates phone numbers with the specified Amazon Chime SDK Voice Connector group.VoiceConnectorGroupId (string) required
E164PhoneNumbers (array) required
ForceAssociate (boolean)
chime_sdk_voice/batch_delete_phone_numberMoves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime SDK Voice Connectors before they can be deleted. Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.PhoneNumberIds (array) required
chime_sdk_voice/batch_update_phone_numberUpdates phone number product types, calling names, or phone number names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type, the calling name, or phone name. You cannot have a duplicate phoneNumberId in a request.UpdatePhoneNumberRequestItems (array) required
chime_sdk_voice/create_phone_number_orderCreates an order for phone numbers to be provisioned. For numbers outside the U.S., you must use the Amazon Chime SDK SIP media application dial-in product type.ProductType (string) required
E164PhoneNumbers (array) required
Name (string)
chime_sdk_voice/create_proxy_sessionCreates a proxy session for the specified Amazon Chime SDK Voice Connector for the specified participant phone numbers.VoiceConnectorId (string) required
ParticipantPhoneNumbers (array) required
Name (string)
ExpiryMinutes (integer)
Capabilities (array) required
NumberSelectionBehavior (string)
GeoMatchLevel (string)
GeoMatchParams: {
. Country (string)
. AreaCode (string)
} (object)
chime_sdk_voice/create_sip_media_applicationCreates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.AwsRegion (string) required
Name (string) required
Endpoints (array) required
Tags (array)
chime_sdk_voice/create_sip_media_application_callCreates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.FromPhoneNumber (string) required
ToPhoneNumber (string) required
SipMediaApplicationId (string) required
SipHeaders (object)
ArgumentsMap (object)
chime_sdk_voice/create_sip_ruleCreates a SIP rule, which can be used to run a SIP media application as a target for a specific trigger type. For more information about SIP rules, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.Name (string) required
TriggerType (string) required
TriggerValue (string) required
Disabled (boolean)
TargetApplications (array)
chime_sdk_voice/create_voice_connectorCreates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.Name (string) required
AwsRegion (string)
RequireEncryption (boolean) required
Tags (array)
IntegrationType (string)
NetworkType (string)
chime_sdk_voice/create_voice_connector_groupCreates an Amazon Chime SDK Voice Connector group under the administrator's AWS account. You can associate Amazon Chime SDK Voice Connectors with the Voice Connector group by including VoiceConnectorItems in the request. You can include Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.Name (string) required
VoiceConnectorItems (array)
chime_sdk_voice/create_voice_profileCreates a voice profile, which consists of an enrolled user and their latest voice print. Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK. For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.SpeakerSearchTaskId (string) required
chime_sdk_voice/create_voice_profile_domainCreates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio. Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK. For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.Name (string) required
Description (string)
ServerSideEncryptionConfiguration: {
. KmsKeyArn (string)
} (object) required
ClientRequestToken (string)
Tags (array)
chime_sdk_voice/delete_phone_numberMoves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime SDK Voice Connectors before it can be deleted. Deleted phone numbers remain in the Deletion queue queue for 7 days before they are deleted permanently.PhoneNumberId (string) required
chime_sdk_voice/delete_proxy_sessionDeletes the specified proxy session from the specified Amazon Chime SDK Voice Connector.VoiceConnectorId (string) required
ProxySessionId (string) required
chime_sdk_voice/delete_sip_media_applicationDeletes a SIP media application.SipMediaApplicationId (string) required
chime_sdk_voice/delete_sip_ruleDeletes a SIP rule.SipRuleId (string) required
chime_sdk_voice/delete_voice_connectorDeletes an Amazon Chime SDK Voice Connector. Any phone numbers associated with the Amazon Chime SDK Voice Connector must be disassociated from it before it can be deleted.VoiceConnectorId (string) required
chime_sdk_voice/delete_voice_connector_emergency_calling_configurationDeletes the emergency calling details from the specified Amazon Chime SDK Voice Connector.VoiceConnectorId (string) required
chime_sdk_voice/delete_voice_connector_external_systems_configurationDeletes the external systems configuration for a Voice Connector.VoiceConnectorId (string) required
chime_sdk_voice/delete_voice_connector_groupDeletes an Amazon Chime SDK Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.VoiceConnectorGroupId (string) required
chime_sdk_voice/delete_voice_connector_originationDeletes the origination settings for the specified Amazon Chime SDK Voice Connector. If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the origination settings.VoiceConnectorId (string) required
chime_sdk_voice/delete_voice_connector_proxyDeletes the proxy configuration from the specified Amazon Chime SDK Voice Connector.VoiceConnectorId (string) required
chime_sdk_voice/delete_voice_connector_streaming_configurationDeletes a Voice Connector's streaming configuration.VoiceConnectorId (string) required
chime_sdk_voice/delete_voice_connector_terminationDeletes the termination settings for the specified Amazon Chime SDK Voice Connector. If emergency calling is configured for the Voice Connector, it must be deleted prior to deleting the termination settings.VoiceConnectorId (string) required
chime_sdk_voice/delete_voice_connector_termination_credentialsDeletes the specified SIP credentials used by your equipment to authenticate during call termination.VoiceConnectorId (string) required
Usernames (array) required
chime_sdk_voice/delete_voice_profileDeletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.VoiceProfileId (string) required
chime_sdk_voice/delete_voice_profile_domainDeletes all voice profiles in the domain. WARNING: This action is not reversible.VoiceProfileDomainId (string) required
chime_sdk_voice/disassociate_phone_numbers_from_voice_connectorDisassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector.VoiceConnectorId (string) required
E164PhoneNumbers (array) required
chime_sdk_voice/disassociate_phone_numbers_from_voice_connector_groupDisassociates the specified phone numbers from the specified Amazon Chime SDK Voice Connector group.VoiceConnectorGroupId (string) required
E164PhoneNumbers (array) required
chime_sdk_voice/get_global_settingsRetrieves the global settings for the Amazon Chime SDK Voice Connectors in an AWS account.No parameters
chime_sdk_voice/get_phone_numberRetrieves details for the specified phone number ID, such as associations, capabilities, and product type.PhoneNumberId (string) required
chime_sdk_voice/get_phone_number_orderRetrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.PhoneNumberOrderId (string) required
chime_sdk_voice/get_phone_number_settingsRetrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.No parameters
chime_sdk_voice/get_proxy_sessionRetrieves the specified proxy session details for the specified Amazon Chime SDK Voice Connector.VoiceConnectorId (string) required
ProxySessionId (string) required
chime_sdk_voice/get_sip_media_applicationRetrieves the information for a SIP media application, including name, AWS Region, and endpoints.SipMediaApplicationId (string) required
chime_sdk_voice/get_sip_media_application_alexa_skill_configurationGets the Alexa Skill configuration for the SIP media application. Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.SipMediaApplicationId (string) required
chime_sdk_voice/get_sip_media_application_logging_configurationRetrieves the logging configuration for the specified SIP media application.SipMediaApplicationId (string) required
chime_sdk_voice/get_sip_ruleRetrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.SipRuleId (string) required
chime_sdk_voice/get_speaker_search_taskRetrieves the details of the specified speaker search task.VoiceConnectorId (string) required
SpeakerSearchTaskId (string) required
chime_sdk_voice/get_voice_connectorRetrieves details for the specified Amazon Chime SDK Voice Connector, such as timestamps,name, outbound host, and encryption requirements.VoiceConnectorId (string) required
chime_sdk_voice/get_voice_connector_emergency_calling_configurationRetrieves the emergency calling configuration details for the specified Voice Connector.VoiceConnectorId (string) required
chime_sdk_voice/get_voice_connector_external_systems_configurationGets information about an external systems configuration for a Voice Connector.VoiceConnectorId (string) required
chime_sdk_voice/get_voice_connector_groupRetrieves details for the specified Amazon Chime SDK Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems.VoiceConnectorGroupId (string) required
chime_sdk_voice/get_voice_connector_logging_configurationRetrieves the logging configuration settings for the specified Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.VoiceConnectorId (string) required
chime_sdk_voice/get_voice_connector_originationRetrieves the origination settings for the specified Voice Connector.VoiceConnectorId (string) required
chime_sdk_voice/get_voice_connector_proxyRetrieves the proxy configuration details for the specified Amazon Chime SDK Voice Connector.VoiceConnectorId (string) required
chime_sdk_voice/get_voice_connector_streaming_configurationRetrieves the streaming configuration details for the specified Amazon Chime SDK 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.VoiceConnectorId (string) required
chime_sdk_voice/get_voice_connector_terminationRetrieves the termination setting details for the specified Voice Connector.VoiceConnectorId (string) required
chime_sdk_voice/get_voice_connector_termination_healthRetrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime SDK Voice Connector.VoiceConnectorId (string) required
chime_sdk_voice/get_voice_profileRetrieves the details of the specified voice profile.VoiceProfileId (string) required
chime_sdk_voice/get_voice_profile_domainRetrieves the details of the specified voice profile domain.VoiceProfileDomainId (string) required
chime_sdk_voice/get_voice_tone_analysis_taskRetrieves the details of a voice tone analysis task.VoiceConnectorId (string) required
VoiceToneAnalysisTaskId (string) required
IsCaller (boolean) required
chime_sdk_voice/list_available_voice_connector_regionsLists the available AWS Regions in which you can create an Amazon Chime SDK Voice Connector.No parameters
chime_sdk_voice/list_phone_number_ordersLists the phone numbers for an administrator's Amazon Chime SDK account.NextToken (string)
MaxResults (integer)
chime_sdk_voice/list_phone_numbersLists the phone numbers for the specified Amazon Chime SDK account, Amazon Chime SDK user, Amazon Chime SDK Voice Connector, or Amazon Chime SDK Voice Connector group.Status (string)
ProductType (string)
FilterName (string)
FilterValue (string)
MaxResults (integer)
NextToken (string)
chime_sdk_voice/list_proxy_sessionsLists the proxy sessions for the specified Amazon Chime SDK Voice Connector.VoiceConnectorId (string) required
Status (string)
NextToken (string)
MaxResults (integer)
chime_sdk_voice/list_sip_media_applicationsLists the SIP media applications under the administrator's AWS account.MaxResults (integer)
NextToken (string)
chime_sdk_voice/list_sip_rulesLists the SIP rules under the administrator's AWS account.SipMediaApplicationId (string)
MaxResults (integer)
NextToken (string)
chime_sdk_voice/list_supported_phone_number_countriesLists the countries that you can order phone numbers from.ProductType (string) required
chime_sdk_voice/list_tags_for_resourceReturns a list of the tags in a given resource.ResourceARN (string) required
chime_sdk_voice/list_voice_connector_groupsLists the Amazon Chime SDK Voice Connector groups in the administrator's AWS account.NextToken (string)
MaxResults (integer)
chime_sdk_voice/list_voice_connectorsLists the Amazon Chime SDK Voice Connectors in the administrators AWS account.NextToken (string)
MaxResults (integer)
chime_sdk_voice/list_voice_connector_termination_credentialsLists the SIP credentials for the specified Amazon Chime SDK Voice Connector.VoiceConnectorId (string) required
chime_sdk_voice/list_voice_profile_domainsLists the specified voice profile domains in the administrator's AWS account.NextToken (string)
MaxResults (integer)
chime_sdk_voice/list_voice_profilesLists the voice profiles in a voice profile domain.VoiceProfileDomainId (string) required
NextToken (string)
MaxResults (integer)
chime_sdk_voice/put_sip_media_application_alexa_skill_configurationUpdates the Alexa Skill configuration for the SIP media application. Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page.SipMediaApplicationId (string) required
SipMediaApplicationAlexaSkillConfiguration: {
. AlexaSkillStatus (string)
. AlexaSkillIds (array)
} (object)
chime_sdk_voice/put_sip_media_application_logging_configurationUpdates the logging configuration for the specified SIP media application.SipMediaApplicationId (string) required
SipMediaApplicationLoggingConfiguration: {
. EnableSipMediaApplicationMessageLogs (boolean)
} (object)
chime_sdk_voice/put_voice_connector_emergency_calling_configurationUpdates a Voice Connector's emergency calling configuration.VoiceConnectorId (string) required
EmergencyCallingConfiguration: {
. DNIS (array)
} (object) required
chime_sdk_voice/put_voice_connector_external_systems_configurationAdds an external systems configuration to a Voice Connector.VoiceConnectorId (string) required
SessionBorderControllerTypes (array)
ContactCenterSystemTypes (array)
chime_sdk_voice/put_voice_connector_logging_configurationUpdates a Voice Connector's logging configuration.VoiceConnectorId (string) required
LoggingConfiguration: {
. EnableSIPLogs (boolean)
. EnableMediaMetricLogs (boolean)
} (object) required
chime_sdk_voice/put_voice_connector_originationUpdates a Voice Connector's origination settings.VoiceConnectorId (string) required
Origination: {
. Routes (array)
. Disabled (boolean)
} (object) required
chime_sdk_voice/put_voice_connector_proxyPuts the specified proxy configuration to the specified Amazon Chime SDK Voice Connector.VoiceConnectorId (string) required
DefaultSessionExpiryMinutes (integer) required
PhoneNumberPoolCountries (array) required
FallBackPhoneNumber (string)
Disabled (boolean)
chime_sdk_voice/put_voice_connector_streaming_configurationUpdates a Voice Connector's streaming configuration settings.VoiceConnectorId (string) required
StreamingConfiguration: {
. DataRetentionInHours (integer)
. Disabled (boolean)
. StreamingNotificationTargets (array)
. MediaInsightsConfiguration (object)
} (object) required
chime_sdk_voice/put_voice_connector_terminationUpdates a Voice Connector's termination settings.VoiceConnectorId (string) required
Termination: {
. CpsLimit (integer)
. DefaultPhoneNumber (string)
. CallingRegions (array)
. CidrAllowedList (array)
. Disabled (boolean)
} (object) required
chime_sdk_voice/put_voice_connector_termination_credentialsUpdates a Voice Connector's termination credentials.VoiceConnectorId (string) required
Credentials (array)
chime_sdk_voice/restore_phone_numberRestores a deleted phone number.PhoneNumberId (string) required
chime_sdk_voice/search_available_phone_numbersSearches the provisioned phone numbers in an organization.AreaCode (string)
City (string)
Country (string)
State (string)
TollFreePrefix (string)
PhoneNumberType (string)
MaxResults (integer)
NextToken (string)
chime_sdk_voice/start_speaker_search_taskStarts a speaker search task. Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.VoiceConnectorId (string) required
TransactionId (string) required
VoiceProfileDomainId (string) required
ClientRequestToken (string)
CallLeg (string)
chime_sdk_voice/start_voice_tone_analysis_taskStarts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide. Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.VoiceConnectorId (string) required
TransactionId (string) required
LanguageCode (string) required
ClientRequestToken (string)
chime_sdk_voice/stop_speaker_search_taskStops a speaker search task.VoiceConnectorId (string) required
SpeakerSearchTaskId (string) required
chime_sdk_voice/stop_voice_tone_analysis_taskStops a voice tone analysis task.VoiceConnectorId (string) required
VoiceToneAnalysisTaskId (string) required
chime_sdk_voice/tag_resourceAdds a tag to the specified resource.ResourceARN (string) required
Tags (array) required
chime_sdk_voice/untag_resourceRemoves tags from a resource.ResourceARN (string) required
TagKeys (array) required
chime_sdk_voice/update_global_settingsUpdates global settings for the Amazon Chime SDK Voice Connectors in an AWS account.VoiceConnector: {
. CdrBucket (string)
} (object)
chime_sdk_voice/update_phone_numberUpdates phone number details, such as product type, calling name, or phone number 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, calling name, or phone number name in one action. For numbers outside the U.S., you must use the Amazon Chime SDK 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 coPhoneNumberId (string) required
ProductType (string)
CallingName (string)
Name (string)
chime_sdk_voice/update_phone_number_settingsUpdates 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.CallingName (string) required
chime_sdk_voice/update_proxy_sessionUpdates the specified proxy session details, such as voice or SMS capabilities.VoiceConnectorId (string) required
ProxySessionId (string) required
Capabilities (array) required
ExpiryMinutes (integer)
chime_sdk_voice/update_sip_media_applicationUpdates the details of the specified SIP media application.SipMediaApplicationId (string) required
Name (string)
Endpoints (array)
chime_sdk_voice/update_sip_media_application_callInvokes 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.SipMediaApplicationId (string) required
TransactionId (string) required
Arguments (object) required
chime_sdk_voice/update_sip_ruleUpdates the details of the specified SIP rule.SipRuleId (string) required
Name (string) required
Disabled (boolean)
TargetApplications (array)
chime_sdk_voice/update_voice_connectorUpdates the details for the specified Amazon Chime SDK Voice Connector.VoiceConnectorId (string) required
Name (string) required
RequireEncryption (boolean) required
chime_sdk_voice/update_voice_connector_groupUpdates the settings for the specified Amazon Chime SDK Voice Connector group.VoiceConnectorGroupId (string) required
Name (string) required
VoiceConnectorItems (array) required
chime_sdk_voice/update_voice_profileUpdates the specified voice profile’s voice print and refreshes its expiration timestamp. As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information “biometric data” in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state priVoiceProfileId (string) required
SpeakerSearchTaskId (string) required
chime_sdk_voice/update_voice_profile_domainUpdates the settings for the specified voice profile domain.VoiceProfileDomainId (string) required
Name (string)
Description (string)
chime_sdk_voice/validate_e911addressValidates an address to be used for 911 calls made with Amazon Chime SDK 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.AwsAccountId (string) required
StreetNumber (string) required
StreetInfo (string) required
City (string) required
State (string) required
Country (string) required
PostalCode (string) required
chime/associate_phone_number_with_userAssociates a phone number with the specified Amazon Chime user.AccountId (string) required
UserId (string) required
E164PhoneNumber (string) required
chime/associate_signin_delegate_groups_with_accountAssociates the specified sign-in delegate groups with the specified Amazon Chime account.AccountId (string) required
SigninDelegateGroups (array) required
chime/batch_create_room_membershipAdds 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.AccountId (string) required
RoomId (string) required
MembershipItemList (array) required
chime/batch_delete_phone_numberMoves 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.PhoneNumberIds (array) required
chime/batch_suspend_userSuspends 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 froAccountId (string) required
UserIdList (array) required
chime/batch_unsuspend_userRemoves 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.AccountId (string) required
UserIdList (array) required
chime/batch_update_phone_numberUpdates 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 namesUpdatePhoneNumberRequestItems (array) required
chime/batch_update_userUpdates 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.AccountId (string) required
UpdateUserRequestItems (array) required
chime/create_accountCreates 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.Name (string) required
chime/create_botCreates a bot for an Amazon Chime Enterprise account.AccountId (string) required
DisplayName (string) required
Domain (string)
chime/create_meeting_dial_outUses 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. This API is not available in a dedicated namespace.MeetingId (string) required
FromPhoneNumber (string) required
ToPhoneNumber (string) required
JoinToken (string) required
chime/create_phone_number_orderCreates 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.ProductType (string) required
E164PhoneNumbers (array) required
chime/create_roomCreates a chat room for the specified Amazon Chime Enterprise account.AccountId (string) required
Name (string) required
ClientRequestToken (string)
chime/create_room_membershipAdds 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.AccountId (string) required
RoomId (string) required
MemberId (string) required
Role (string)
chime/create_userCreates a user under the specified Amazon Chime account.AccountId (string) required
Username (string)
Email (string)
UserType (string)
chime/delete_accountDeletes 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 contAccountId (string) required
chime/delete_events_configurationDeletes the events configuration that allows a bot to receive outgoing events.AccountId (string) required
BotId (string) required
chime/delete_phone_numberMoves 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.PhoneNumberId (string) required
chime/delete_roomDeletes a chat room in an Amazon Chime Enterprise account.AccountId (string) required
RoomId (string) required
chime/delete_room_membershipRemoves a member from a chat room in an Amazon Chime Enterprise account.AccountId (string) required
RoomId (string) required
MemberId (string) required
chime/disassociate_phone_number_from_userDisassociates the primary provisioned phone number from the specified Amazon Chime user.AccountId (string) required
UserId (string) required
chime/disassociate_signin_delegate_groups_from_accountDisassociates the specified sign-in delegate groups from the specified Amazon Chime account.AccountId (string) required
GroupNames (array) required
chime/get_accountRetrieves details for the specified Amazon Chime account, such as account type and supported licenses.AccountId (string) required
chime/get_account_settingsRetrieves 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.AccountId (string) required
chime/get_botRetrieves details for the specified bot, such as bot email address, bot type, status, and display name.AccountId (string) required
BotId (string) required
chime/get_events_configurationGets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.AccountId (string) required
BotId (string) required
chime/get_global_settingsRetrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.No parameters
chime/get_phone_numberRetrieves details for the specified phone number ID, such as associations, capabilities, and product type.PhoneNumberId (string) required
chime/get_phone_number_orderRetrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.PhoneNumberOrderId (string) required
chime/get_phone_number_settingsRetrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.No parameters
chime/get_retention_settingsGets 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.AccountId (string) required
chime/get_roomRetrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.AccountId (string) required
RoomId (string) required
chime/get_userRetrieves 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.AccountId (string) required
UserId (string) required
chime/get_user_settingsRetrieves settings for the specified user ID, such as any associated phone number settings.AccountId (string) required
UserId (string) required
chime/invite_usersSends 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.AccountId (string) required
UserEmailList (array) required
UserType (string)
chime/list_accountsLists 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.Name (string)
UserEmail (string)
NextToken (string)
MaxResults (integer)
chime/list_botsLists the bots associated with the administrator's Amazon Chime Enterprise account ID.AccountId (string) required
MaxResults (integer)
NextToken (string)
chime/list_phone_number_ordersLists the phone number orders for the administrator's Amazon Chime account.NextToken (string)
MaxResults (integer)
chime/list_phone_numbersLists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.Status (string)
ProductType (string)
FilterName (string)
FilterValue (string)
MaxResults (integer)
NextToken (string)
chime/list_room_membershipsLists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.AccountId (string) required
RoomId (string) required
MaxResults (integer)
NextToken (string)
chime/list_roomsLists 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.AccountId (string) required
MemberId (string)
MaxResults (integer)
NextToken (string)
chime/list_supported_phone_number_countriesLists supported phone number countries.ProductType (string) required
chime/list_usersLists 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.AccountId (string) required
UserEmail (string)
UserType (string)
MaxResults (integer)
NextToken (string)
chime/logout_userLogs out the specified user from all of the devices they are currently logged into.AccountId (string) required
UserId (string) required
chime/put_events_configurationCreates 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.AccountId (string) required
BotId (string) required
OutboundEventsHTTPSEndpoint (string)
LambdaFunctionArn (string)
chime/put_retention_settingsPuts 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 PolicieAccountId (string) required
RetentionSettings: {
. RoomRetentionSettings (object)
. ConversationRetentionSettings (object)
} (object) required
chime/redact_conversation_messageRedacts the specified message from the specified Amazon Chime conversation.AccountId (string) required
ConversationId (string) required
MessageId (string) required
chime/redact_room_messageRedacts the specified message from the specified Amazon Chime channel.AccountId (string) required
RoomId (string) required
MessageId (string) required
chime/regenerate_security_tokenRegenerates the security token for a bot.AccountId (string) required
BotId (string) required
chime/reset_personal_pinResets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.AccountId (string) required
UserId (string) required
chime/restore_phone_numberMoves a phone number from the Deletion queue back into the phone number Inventory.PhoneNumberId (string) required
chime/search_available_phone_numbersSearches 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.AreaCode (string)
City (string)
Country (string)
State (string)
TollFreePrefix (string)
PhoneNumberType (string)
MaxResults (integer)
NextToken (string)
chime/update_accountUpdates account details for the specified Amazon Chime account. Currently, only account name and default license updates are supported for this action.AccountId (string) required
Name (string)
DefaultLicense (string)
chime/update_account_settingsUpdates 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.AccountId (string) required
AccountSettings: {
. DisableRemoteControl (boolean)
. EnableDialOut (boolean)
} (object) required
chime/update_botUpdates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.AccountId (string) required
BotId (string) required
Disabled (boolean)
chime/update_global_settingsUpdates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.BusinessCalling: {
. CdrBucket (string)
} (object)
VoiceConnector: {
. CdrBucket (string)
} (object)
chime/update_phone_numberUpdates 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. PendiPhoneNumberId (string) required
ProductType (string)
CallingName (string)
chime/update_phone_number_settingsUpdates 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.CallingName (string) required
chime/update_roomUpdates room details, such as the room name, for a room in an Amazon Chime Enterprise account.AccountId (string) required
RoomId (string) required
Name (string)
chime/update_room_membershipUpdates 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.AccountId (string) required
RoomId (string) required
MemberId (string) required
Role (string)
chime/update_userUpdates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.AccountId (string) required
UserId (string) required
LicenseType (string)
UserType (string)
AlexaForBusinessMetadata: {
. IsAlexaForBusinessEnabled (boolean)
. AlexaForBusinessRoomArn (string)
} (object)
chime/update_user_settingsUpdates the settings for the specified user, such as phone number settings.AccountId (string) required
UserId (string) required
UserSettings: {
. Telephony (object)
} (object) required
cleanrooms/list_tags_for_resourceLists all of the tags that have been added to a resource.resourceArn (string) required
cleanrooms/tag_resourceTags a resource.resourceArn (string) required
tags (object) required
cleanrooms/untag_resourceRemoves a tag or list of tags from a resource.resourceArn (string) required
tagKeys (array) required
cleanrooms/create_analysis_templateCreates a new analysis template.description (string)
membershipIdentifier (string) required
name (string) required
format (string) required
source (undefined) required
tags (object)
analysisParameters (array)
schema: {
. referencedTables (array)
} (object)
errorMessageConfiguration: {
. type (string)
} (object)
syntheticDataParameters (undefined)
cleanrooms/get_analysis_templateRetrieves an analysis template.membershipIdentifier (string) required
analysisTemplateIdentifier (string) required
cleanrooms/update_analysis_templateUpdates the analysis template metadata.membershipIdentifier (string) required
analysisTemplateIdentifier (string) required
description (string)
cleanrooms/delete_analysis_templateDeletes an analysis template.membershipIdentifier (string) required
analysisTemplateIdentifier (string) required
cleanrooms/list_analysis_templatesLists analysis templates that the caller owns.membershipIdentifier (string) required
nextToken (string)
maxResults (integer)
cleanrooms/batch_get_collaboration_analysis_templateRetrieves multiple analysis templates within a collaboration by their Amazon Resource Names ARNs.collaborationIdentifier (string) required
analysisTemplateArns (array) required
cleanrooms/batch_get_schemaRetrieves multiple schemas by their identifiers.collaborationIdentifier (string) required
names (array) required
cleanrooms/batch_get_schema_analysis_ruleRetrieves multiple analysis rule schemas.collaborationIdentifier (string) required
schemaAnalysisRuleRequests (array) required
cleanrooms/create_collaboration_change_requestCreates a new change request to modify an existing collaboration. This enables post-creation modifications to collaborations through a structured API-driven approach.collaborationIdentifier (string) required
changes (array) required
cleanrooms/delete_memberRemoves the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.collaborationIdentifier (string) required
accountId (string) required
cleanrooms/get_collaboration_analysis_templateRetrieves an analysis template within a collaboration.collaborationIdentifier (string) required
analysisTemplateArn (string) required
cleanrooms/get_collaboration_change_requestRetrieves detailed information about a specific collaboration change request.collaborationIdentifier (string) required
changeRequestIdentifier (string) required
cleanrooms/get_collaboration_configured_audience_model_associationRetrieves a configured audience model association within a collaboration.collaborationIdentifier (string) required
configuredAudienceModelAssociationIdentifier (string) required
cleanrooms/get_collaboration_id_namespace_associationRetrieves an ID namespace association from a specific collaboration.collaborationIdentifier (string) required
idNamespaceAssociationIdentifier (string) required
cleanrooms/get_collaboration_privacy_budget_templateReturns details about a specified privacy budget template.collaborationIdentifier (string) required
privacyBudgetTemplateIdentifier (string) required
cleanrooms/get_schemaRetrieves the schema for a relation within a collaboration.collaborationIdentifier (string) required
name (string) required
cleanrooms/get_schema_analysis_ruleRetrieves a schema analysis rule.collaborationIdentifier (string) required
name (string) required
type (string) required
cleanrooms/list_collaboration_analysis_templatesLists analysis templates within a collaboration.collaborationIdentifier (string) required
nextToken (string)
maxResults (integer)
cleanrooms/list_collaboration_change_requestsLists all change requests for a collaboration with pagination support. Returns change requests sorted by creation time.collaborationIdentifier (string) required
status (string)
nextToken (string)
maxResults (integer)
cleanrooms/list_collaboration_configured_audience_model_associationsLists configured audience model associations within a collaboration.collaborationIdentifier (string) required
nextToken (string)
maxResults (integer)
cleanrooms/list_collaboration_id_namespace_associationsReturns a list of the ID namespace associations in a collaboration.collaborationIdentifier (string) required
nextToken (string)
maxResults (integer)
cleanrooms/list_collaboration_privacy_budgetsReturns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.collaborationIdentifier (string) required
privacyBudgetType (string) required
maxResults (integer)
nextToken (string)
accessBudgetResourceArn (string)
cleanrooms/list_collaboration_privacy_budget_templatesReturns an array that summarizes each privacy budget template in a specified collaboration.collaborationIdentifier (string) required
nextToken (string)
maxResults (integer)
cleanrooms/list_membersLists all members within a collaboration.collaborationIdentifier (string) required
nextToken (string)
maxResults (integer)
cleanrooms/list_schemasLists the schemas for relations within a collaboration.collaborationIdentifier (string) required
schemaType (string)
nextToken (string)
maxResults (integer)
cleanrooms/update_collaboration_change_requestUpdates an existing collaboration change request. This operation allows approval actions for pending change requests in collaborations APPROVE, DENY, CANCEL, COMMIT. For change requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or COMMIT a change request.collaborationIdentifier (string) required
changeRequestIdentifier (string) required
action (string) required
cleanrooms/create_collaborationCreates a new collaboration.members (array) required
name (string) required
description (string) required
creatorMemberAbilities (array) required
creatorMLMemberAbilities: {
. customMLMemberAbilities (array)
} (object)
creatorDisplayName (string) required
dataEncryptionMetadata: {
. allowCleartext (boolean)
. allowDuplicates (boolean)
. allowJoinsOnColumnsWithDifferentNames (boolean)
. preserveNulls (boolean)
} (object)
queryLogStatus (string) required
jobLogStatus (string)
tags (object)
creatorPaymentConfiguration: {
. queryCompute (object)
. machineLearning (object)
. jobCompute (object)
} (object)
analyticsEngine (string)
autoApprovedChangeRequestTypes (array)
allowedResultRegions (array)
isMetricsEnabled (boolean)
cleanrooms/get_collaborationReturns metadata about a collaboration.collaborationIdentifier (string) required
cleanrooms/update_collaborationUpdates collaboration metadata and can only be called by the collaboration owner.collaborationIdentifier (string) required
name (string)
description (string)
analyticsEngine (string)
cleanrooms/delete_collaborationDeletes a collaboration. It can only be called by the collaboration owner.collaborationIdentifier (string) required
cleanrooms/list_collaborationsLists collaborations the caller owns, is active in, or has been invited to.nextToken (string)
maxResults (integer)
memberStatus (string)
cleanrooms/create_configured_audience_model_associationProvides the details necessary to create a configured audience model association.membershipIdentifier (string) required
configuredAudienceModelArn (string) required
configuredAudienceModelAssociationName (string) required
manageResourcePolicies (boolean) required
tags (object)
description (string)
cleanrooms/get_configured_audience_model_associationReturns information about a configured audience model association.configuredAudienceModelAssociationIdentifier (string) required
membershipIdentifier (string) required
cleanrooms/update_configured_audience_model_associationProvides the details necessary to update a configured audience model association.configuredAudienceModelAssociationIdentifier (string) required
membershipIdentifier (string) required
description (string)
name (string)
cleanrooms/delete_configured_audience_model_associationProvides the information necessary to delete a configured audience model association.configuredAudienceModelAssociationIdentifier (string) required
membershipIdentifier (string) required
cleanrooms/list_configured_audience_model_associationsLists information about requested configured audience model associations.membershipIdentifier (string) required
nextToken (string)
maxResults (integer)
cleanrooms/create_configured_table_association_analysis_ruleCreates a new analysis rule for an associated configured table.membershipIdentifier (string) required
configuredTableAssociationIdentifier (string) required
analysisRuleType (string) required
analysisRulePolicy (undefined) required
cleanrooms/delete_configured_table_association_analysis_ruleDeletes an analysis rule for a configured table association.membershipIdentifier (string) required
configuredTableAssociationIdentifier (string) required
analysisRuleType (string) required
cleanrooms/get_configured_table_association_analysis_ruleRetrieves the analysis rule for a configured table association.membershipIdentifier (string) required
configuredTableAssociationIdentifier (string) required
analysisRuleType (string) required
cleanrooms/update_configured_table_association_analysis_ruleUpdates the analysis rule for a configured table association.membershipIdentifier (string) required
configuredTableAssociationIdentifier (string) required
analysisRuleType (string) required
analysisRulePolicy (undefined) required
cleanrooms/create_configured_table_associationCreates a configured table association. A configured table association links a configured table with a collaboration.name (string) required
description (string)
membershipIdentifier (string) required
configuredTableIdentifier (string) required
roleArn (string) required
tags (object)
cleanrooms/get_configured_table_associationRetrieves a configured table association.configuredTableAssociationIdentifier (string) required
membershipIdentifier (string) required
cleanrooms/update_configured_table_associationUpdates a configured table association.configuredTableAssociationIdentifier (string) required
membershipIdentifier (string) required
description (string)
roleArn (string)
cleanrooms/delete_configured_table_associationDeletes a configured table association.configuredTableAssociationIdentifier (string) required
membershipIdentifier (string) required
cleanrooms/list_configured_table_associationsLists configured table associations for a membership.membershipIdentifier (string) required
nextToken (string)
maxResults (integer)
cleanrooms/create_configured_table_analysis_ruleCreates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.configuredTableIdentifier (string) required
analysisRuleType (string) required
analysisRulePolicy (undefined) required
cleanrooms/delete_configured_table_analysis_ruleDeletes a configured table analysis rule.configuredTableIdentifier (string) required
analysisRuleType (string) required
cleanrooms/get_configured_table_analysis_ruleRetrieves a configured table analysis rule.configuredTableIdentifier (string) required
analysisRuleType (string) required
cleanrooms/update_configured_table_analysis_ruleUpdates a configured table analysis rule.configuredTableIdentifier (string) required
analysisRuleType (string) required
analysisRulePolicy (undefined) required
cleanrooms/create_configured_tableCreates a new configured table resource.name (string) required
description (string)
tableReference (undefined) required
allowedColumns (array) required
analysisMethod (string) required
selectedAnalysisMethods (array)
tags (object)
cleanrooms/get_configured_tableRetrieves a configured table.configuredTableIdentifier (string) required
cleanrooms/update_configured_tableUpdates a configured table.configuredTableIdentifier (string) required
name (string)
description (string)
tableReference (undefined)
allowedColumns (array)
analysisMethod (string)
selectedAnalysisMethods (array)
cleanrooms/delete_configured_tableDeletes a configured table.configuredTableIdentifier (string) required
cleanrooms/list_configured_tablesLists configured tables.nextToken (string)
maxResults (integer)
cleanrooms/populate_id_mapping_tableDefines the information that's necessary to populate an ID mapping table.idMappingTableIdentifier (string) required
membershipIdentifier (string) required
jobType (string)
cleanrooms/create_id_mapping_tableCreates an ID mapping table.membershipIdentifier (string) required
name (string) required
description (string)
inputReferenceConfig: {
. inputReferenceArn (string)
. manageResourcePolicies (boolean)
} (object) required
tags (object)
kmsKeyArn (string)
cleanrooms/get_id_mapping_tableRetrieves an ID mapping table.idMappingTableIdentifier (string) required
membershipIdentifier (string) required
cleanrooms/update_id_mapping_tableProvides the details that are necessary to update an ID mapping table.idMappingTableIdentifier (string) required
membershipIdentifier (string) required
description (string)
kmsKeyArn (string)
cleanrooms/delete_id_mapping_tableDeletes an ID mapping table.idMappingTableIdentifier (string) required
membershipIdentifier (string) required
cleanrooms/list_id_mapping_tablesReturns a list of ID mapping tables.membershipIdentifier (string) required
nextToken (string)
maxResults (integer)
cleanrooms/create_id_namespace_associationCreates an ID namespace association.membershipIdentifier (string) required
inputReferenceConfig: {
. inputReferenceArn (string)
. manageResourcePolicies (boolean)
} (object) required
tags (object)
name (string) required
description (string)
idMappingConfig: {
. allowUseAsDimensionColumn (boolean)
} (object)
cleanrooms/get_id_namespace_associationRetrieves an ID namespace association.idNamespaceAssociationIdentifier (string) required
membershipIdentifier (string) required
cleanrooms/update_id_namespace_associationProvides the details that are necessary to update an ID namespace association.idNamespaceAssociationIdentifier (string) required
membershipIdentifier (string) required
name (string)
description (string)
idMappingConfig: {
. allowUseAsDimensionColumn (boolean)
} (object)
cleanrooms/delete_id_namespace_associationDeletes an ID namespace association.idNamespaceAssociationIdentifier (string) required
membershipIdentifier (string) required
cleanrooms/list_id_namespace_associationsReturns a list of ID namespace associations.membershipIdentifier (string) required
nextToken (string)
maxResults (integer)
cleanrooms/get_protected_jobReturns job processing metadata.membershipIdentifier (string) required
protectedJobIdentifier (string) required
cleanrooms/get_protected_queryReturns query processing metadata.membershipIdentifier (string) required
protectedQueryIdentifier (string) required
cleanrooms/list_privacy_budgetsReturns detailed information about the privacy budgets in a specified membership.membershipIdentifier (string) required
privacyBudgetType (string) required
nextToken (string)
maxResults (integer)
accessBudgetResourceArn (string)
cleanrooms/list_protected_jobsLists protected jobs, sorted by most recent job.membershipIdentifier (string) required
status (string)
nextToken (string)
maxResults (integer)
cleanrooms/list_protected_queriesLists protected queries, sorted by the most recent query.membershipIdentifier (string) required
status (string)
nextToken (string)
maxResults (integer)
cleanrooms/preview_privacy_impactAn estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.membershipIdentifier (string) required
parameters (undefined) required
cleanrooms/start_protected_jobCreates a protected job that is started by Clean Rooms.type (string) required
membershipIdentifier (string) required
jobParameters: {
. analysisTemplateArn (string)
. parameters (object)
} (object) required
resultConfiguration: {
. outputConfiguration
} (object)
computeConfiguration (undefined)
cleanrooms/start_protected_queryCreates a protected query that is started by Clean Rooms.type (string) required
membershipIdentifier (string) required
sqlParameters: {
. queryString (string)
. analysisTemplateArn (string)
. parameters (object)
} (object) required
resultConfiguration: {
. outputConfiguration
} (object)
computeConfiguration (undefined)
cleanrooms/update_protected_jobUpdates the processing of a currently running job.membershipIdentifier (string) required
protectedJobIdentifier (string) required
targetStatus (string) required
cleanrooms/update_protected_queryUpdates the processing of a currently running query.membershipIdentifier (string) required
protectedQueryIdentifier (string) required
targetStatus (string) required
cleanrooms/create_membershipCreates a membership for a specific collaboration identifier and joins the collaboration.collaborationIdentifier (string) required
queryLogStatus (string) required
jobLogStatus (string)
tags (object)
defaultResultConfiguration: {
. outputConfiguration
. roleArn (string)
} (object)
defaultJobResultConfiguration: {
. outputConfiguration
. roleArn (string)
} (object)
paymentConfiguration: {
. queryCompute (object)
. machineLearning (object)
. jobCompute (object)
} (object)
isMetricsEnabled (boolean)
cleanrooms/get_membershipRetrieves a specified membership for an identifier.membershipIdentifier (string) required
cleanrooms/update_membershipUpdates a membership.membershipIdentifier (string) required
queryLogStatus (string)
jobLogStatus (string)
defaultResultConfiguration: {
. outputConfiguration
. roleArn (string)
} (object)
defaultJobResultConfiguration: {
. outputConfiguration
. roleArn (string)
} (object)
cleanrooms/delete_membershipDeletes a specified membership. All resources under a membership must be deleted.membershipIdentifier (string) required
cleanrooms/list_membershipsLists all memberships resources within the caller's account.nextToken (string)
maxResults (integer)
status (string)
cleanrooms/create_privacy_budget_templateCreates a privacy budget template for a specified collaboration. Each collaboration can have only one privacy budget template. If you need to change the privacy budget template, use the UpdatePrivacyBudgetTemplate operation.membershipIdentifier (string) required
autoRefresh (string)
privacyBudgetType (string) required
parameters (undefined) required
tags (object)
cleanrooms/get_privacy_budget_templateReturns details for a specified privacy budget template.membershipIdentifier (string) required
privacyBudgetTemplateIdentifier (string) required
cleanrooms/update_privacy_budget_templateUpdates the privacy budget template for the specified collaboration.membershipIdentifier (string) required
privacyBudgetTemplateIdentifier (string) required
privacyBudgetType (string) required
parameters (undefined)
cleanrooms/delete_privacy_budget_templateDeletes a privacy budget template for a specified collaboration.membershipIdentifier (string) required
privacyBudgetTemplateIdentifier (string) required
cleanrooms/list_privacy_budget_templatesReturns detailed information about the privacy budget templates in a specified membership.membershipIdentifier (string) required
nextToken (string)
maxResults (integer)
cleanroomsml/list_collaboration_configured_model_algorithm_associationsReturns a list of the configured model algorithm associations in a collaboration.nextToken (string)
maxResults (integer)
collaborationIdentifier (string) required
cleanroomsml/list_collaboration_mlinput_channelsReturns a list of the ML input channels in a collaboration.nextToken (string)
maxResults (integer)
collaborationIdentifier (string) required
cleanroomsml/list_collaboration_trained_model_export_jobsReturns a list of the export jobs for a trained model in a collaboration.nextToken (string)
maxResults (integer)
collaborationIdentifier (string) required
trainedModelArn (string) required
trainedModelVersionIdentifier (string)
cleanroomsml/list_collaboration_trained_model_inference_jobsReturns a list of trained model inference jobs in a specified collaboration.nextToken (string)
maxResults (integer)
collaborationIdentifier (string) required
trainedModelArn (string)
trainedModelVersionIdentifier (string)
cleanroomsml/list_collaboration_trained_modelsReturns a list of the trained models in a collaboration.nextToken (string)
maxResults (integer)
collaborationIdentifier (string) required
cleanroomsml/list_tags_for_resourceReturns a list of tags for a provided resource.resourceArn (string) required
cleanroomsml/tag_resourceAdds metadata tags to a specified resource.resourceArn (string) required
tags (object) required
cleanroomsml/untag_resourceRemoves metadata tags from a specified resource.resourceArn (string) required
tagKeys (array) required
cleanroomsml/start_audience_export_jobExport an audience of a specified size after you have generated an audience.name (string) required
audienceGenerationJobArn (string) required
audienceSize: {
. type (string)
. value (integer)
} (object) required
description (string)
cleanroomsml/list_audience_export_jobsReturns a list of the audience export jobs.nextToken (string)
maxResults (integer)
audienceGenerationJobArn (string)
cleanroomsml/start_audience_generation_jobInformation necessary to start the audience generation job.name (string) required
configuredAudienceModelArn (string) required
seedAudience: {
. dataSource (object)
. roleArn (string)
. sqlParameters (object)
. sqlComputeConfiguration
} (object) required
includeSeedInOutput (boolean)
collaborationId (string)
description (string)
tags (object)
cleanroomsml/get_audience_generation_jobReturns information about an audience generation job.audienceGenerationJobArn (string) required
cleanroomsml/delete_audience_generation_jobDeletes the specified audience generation job, and removes all data associated with the job.audienceGenerationJobArn (string) required
cleanroomsml/list_audience_generation_jobsReturns a list of audience generation jobs.nextToken (string)
maxResults (integer)
configuredAudienceModelArn (string)
collaborationId (string)
cleanroomsml/create_audience_modelDefines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.trainingDataStartTime (string)
trainingDataEndTime (string)
name (string) required
trainingDatasetArn (string) required
kmsKeyArn (string)
tags (object)
description (string)
cleanroomsml/get_audience_modelReturns information about an audience modelaudienceModelArn (string) required
cleanroomsml/delete_audience_modelSpecifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.audienceModelArn (string) required
cleanroomsml/list_audience_modelsReturns a list of audience models.nextToken (string)
maxResults (integer)
cleanroomsml/create_configured_audience_modelDefines the information necessary to create a configured audience model.name (string) required
audienceModelArn (string) required
outputConfig: {
. destination (object)
. roleArn (string)
} (object) required
description (string)
sharedAudienceMetrics (array) required
minMatchingSeedSize (integer)
audienceSizeConfig: {
. audienceSizeType (string)
. audienceSizeBins (array)
} (object)
tags (object)
childResourceTagOnCreatePolicy (string)
cleanroomsml/get_configured_audience_modelReturns information about a specified configured audience model.configuredAudienceModelArn (string) required
cleanroomsml/update_configured_audience_modelProvides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.configuredAudienceModelArn (string) required
outputConfig: {
. destination (object)
. roleArn (string)
} (object)
audienceModelArn (string)
sharedAudienceMetrics (array)
minMatchingSeedSize (integer)
audienceSizeConfig: {
. audienceSizeType (string)
. audienceSizeBins (array)
} (object)
description (string)
cleanroomsml/delete_configured_audience_modelDeletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.configuredAudienceModelArn (string) required
cleanroomsml/list_configured_audience_modelsReturns a list of the configured audience models.nextToken (string)
maxResults (integer)
cleanroomsml/get_configured_audience_model_policyReturns information about a configured audience model policy.configuredAudienceModelArn (string) required
cleanroomsml/delete_configured_audience_model_policyDeletes the specified configured audience model policy.configuredAudienceModelArn (string) required
cleanroomsml/put_configured_audience_model_policyCreate or update the resource policy for a configured audience model.configuredAudienceModelArn (string) required
configuredAudienceModelPolicy (string) required
previousPolicyHash (string)
policyExistenceCondition (string)
cleanroomsml/create_configured_model_algorithmCreates a configured model algorithm using a container image stored in an ECR repository.name (string) required
description (string)
roleArn (string) required
trainingContainerConfig: {
. imageUri (string)
. entrypoint (array)
. arguments (array)
. metricDefinitions (array)
} (object)
inferenceContainerConfig: {
. imageUri (string)
} (object)
tags (object)
kmsKeyArn (string)
cleanroomsml/get_configured_model_algorithmReturns information about a configured model algorithm.configuredModelAlgorithmArn (string) required
cleanroomsml/delete_configured_model_algorithmDeletes a configured model algorithm.configuredModelAlgorithmArn (string) required
cleanroomsml/list_configured_model_algorithmsReturns a list of configured model algorithms.nextToken (string)
maxResults (integer)
cleanroomsml/get_collaboration_configured_model_algorithm_associationReturns information about the configured model algorithm association in a collaboration.configuredModelAlgorithmAssociationArn (string) required
collaborationIdentifier (string) required
cleanroomsml/create_configured_model_algorithm_associationAssociates a configured model algorithm to a collaboration for use by any member of the collaboration.membershipIdentifier (string) required
configuredModelAlgorithmArn (string) required
name (string) required
description (string)
privacyConfiguration: {
. policies (object)
} (object)
tags (object)
cleanroomsml/get_configured_model_algorithm_associationReturns information about a configured model algorithm association.configuredModelAlgorithmAssociationArn (string) required
membershipIdentifier (string) required
cleanroomsml/delete_configured_model_algorithm_associationDeletes a configured model algorithm association.configuredModelAlgorithmAssociationArn (string) required
membershipIdentifier (string) required
cleanroomsml/list_configured_model_algorithm_associationsReturns a list of configured model algorithm associations.nextToken (string)
maxResults (integer)
membershipIdentifier (string) required
cleanroomsml/get_mlconfigurationReturns information about a specific ML configuration.membershipIdentifier (string) required
cleanroomsml/delete_mlconfigurationDeletes a ML modeling configuration.membershipIdentifier (string) required
cleanroomsml/put_mlconfigurationAssigns information about an ML configuration.membershipIdentifier (string) required
defaultOutputLocation: {
. destination (object)
. roleArn (string)
} (object) required
cleanroomsml/get_collaboration_mlinput_channelReturns information about a specific ML input channel in a collaboration.mlInputChannelArn (string) required
collaborationIdentifier (string) required
cleanroomsml/create_mlinput_channelProvides the information to create an ML input channel. An ML input channel is the result of a query that can be used for ML modeling.membershipIdentifier (string) required
configuredModelAlgorithmAssociations (array) required
inputChannel: {
. dataSource
. roleArn (string)
} (object) required
name (string) required
retentionInDays (integer) required
description (string)
kmsKeyArn (string)
tags (object)
cleanroomsml/get_mlinput_channelReturns information about an ML input channel.mlInputChannelArn (string) required
membershipIdentifier (string) required
cleanroomsml/delete_mlinput_channel_dataProvides the information necessary to delete an ML input channel.mlInputChannelArn (string) required
membershipIdentifier (string) required
cleanroomsml/list_mlinput_channelsReturns a list of ML input channels.nextToken (string)
maxResults (integer)
membershipIdentifier (string) required
cleanroomsml/cancel_trained_modelSubmits a request to cancel the trained model job.membershipIdentifier (string) required
trainedModelArn (string) required
versionIdentifier (string)
cleanroomsml/get_collaboration_trained_modelReturns information about a trained model in a collaboration.trainedModelArn (string) required
collaborationIdentifier (string) required
versionIdentifier (string)
cleanroomsml/list_trained_model_versionsReturns a list of trained model versions for a specified trained model. This operation allows you to view all versions of a trained model, including information about their status and creation details. You can use this to track the evolution of your trained models and select specific versions for inference or further training.nextToken (string)
maxResults (integer)
membershipIdentifier (string) required
trainedModelArn (string) required
status (string)
cleanroomsml/create_trained_modelCreates a trained model from an associated configured model algorithm using data from any member of the collaboration.membershipIdentifier (string) required
name (string) required
configuredModelAlgorithmAssociationArn (string) required
hyperparameters (object)
environment (object)
resourceConfig: {
. instanceCount (integer)
. instanceType (string)
. volumeSizeInGB (integer)
} (object) required
stoppingCondition: {
. maxRuntimeInSeconds (integer)
} (object)
incrementalTrainingDataChannels (array)
dataChannels (array) required
trainingInputMode (string)
description (string)
kmsKeyArn (string)
tags (object)
cleanroomsml/get_trained_modelReturns information about a trained model.trainedModelArn (string) required
membershipIdentifier (string) required
versionIdentifier (string)
cleanroomsml/delete_trained_model_outputDeletes the model artifacts stored by the service.trainedModelArn (string) required
membershipIdentifier (string) required
versionIdentifier (string)
cleanroomsml/list_trained_modelsReturns a list of trained models.nextToken (string)
maxResults (integer)
membershipIdentifier (string) required
cleanroomsml/start_trained_model_export_jobProvides the information necessary to start a trained model export job.name (string) required
trainedModelArn (string) required
trainedModelVersionIdentifier (string)
membershipIdentifier (string) required
outputConfiguration: {
. members (array)
} (object) required
description (string)
cleanroomsml/cancel_trained_model_inference_jobSubmits a request to cancel a trained model inference job.membershipIdentifier (string) required
trainedModelInferenceJobArn (string) required
cleanroomsml/start_trained_model_inference_jobDefines the information necessary to begin a trained model inference job.membershipIdentifier (string) required
name (string) required
trainedModelArn (string) required
trainedModelVersionIdentifier (string)
configuredModelAlgorithmAssociationArn (string)
resourceConfig: {
. instanceType (string)
. instanceCount (integer)
} (object) required
outputConfiguration: {
. accept (string)
. members (array)
} (object) required
dataSource: {
. mlInputChannelArn (string)
} (object) required
description (string)
containerExecutionParameters: {
. maxPayloadInMB (integer)
} (object)
environment (object)
kmsKeyArn (string)
tags (object)
cleanroomsml/get_trained_model_inference_jobReturns information about a trained model inference job.membershipIdentifier (string) required
trainedModelInferenceJobArn (string) required
cleanroomsml/list_trained_model_inference_jobsReturns a list of trained model inference jobs that match the request parameters.nextToken (string)
maxResults (integer)
membershipIdentifier (string) required
trainedModelArn (string)
trainedModelVersionIdentifier (string)
cleanroomsml/create_training_datasetDefines the information necessary to create a training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.name (string) required
roleArn (string) required
trainingData (array) required
tags (object)
description (string)
cleanroomsml/get_training_datasetReturns information about a training dataset.trainingDatasetArn (string) required
cleanroomsml/delete_training_datasetSpecifies a training dataset that you want to delete. You can't delete a training dataset if there are any audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation. This action deletes the metadata.trainingDatasetArn (string) required
cleanroomsml/list_training_datasetsReturns a list of training datasets.nextToken (string)
maxResults (integer)
cloud9/create_environment_ec2Creates an Cloud9 development environment, launches an Amazon Elastic Compute Cloud Amazon EC2 instance, and then connects from the instance to the environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more'name (string) required
description (string)
clientRequestToken (string)
instanceType (string) required
subnetId (string)
imageId (string) required
automaticStopTimeMinutes (integer)
ownerArn (string)
tags (array)
connectionType (string)
dryRun (boolean)
cloud9/create_environment_membershipAdds an environment member to an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more'environmentId (string) required
userArn (string) required
permissions (string) required
cloud9/delete_environmentDeletes an Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more'environmentId (string) required
cloud9/delete_environment_membershipDeletes an environment member from a development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more'environmentId (string) required
userArn (string) required
cloud9/describe_environment_membershipsGets information about environment members for an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more'userArn (string)
environmentId (string)
permissions (array)
nextToken (string)
maxResults (integer)
cloud9/describe_environmentsGets information about Cloud9 development environments. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more'environmentIds (array) required
cloud9/describe_environment_statusGets status information for an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more'environmentId (string) required
cloud9/list_environmentsGets a list of Cloud9 development environment identifiers. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more' Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more'nextToken (string)
maxResults (integer)
cloud9/list_tags_for_resourceGets a list of the tags associated with an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more'ResourceARN (string) required
cloud9/tag_resourceAdds tags to an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more' Tags that you add to an Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.ResourceARN (string) required
Tags (array) required
cloud9/untag_resourceRemoves tags from an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more'ResourceARN (string) required
TagKeys (array) required
cloud9/update_environmentChanges the settings of an existing Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more'environmentId (string) required
name (string)
description (string)
managedCredentialsAction (string)
cloud9/update_environment_membershipChanges the settings of an existing environment member for an Cloud9 development environment. Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more'environmentId (string) required
userArn (string) required
permissions (string) required
cloudcontrol/cancel_resource_requestCancels 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.RequestToken (string) required
cloudcontrol/create_resourceCreates 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.TypeName (string) required
TypeVersionId (string)
RoleArn (string)
ClientToken (string)
DesiredState (string) required
cloudcontrol/delete_resourceDeletes 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.TypeName (string) required
TypeVersionId (string)
RoleArn (string)
ClientToken (string)
Identifier (string) required
cloudcontrol/get_resourceReturns 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.TypeName (string) required
TypeVersionId (string)
RoleArn (string)
Identifier (string) required
cloudcontrol/get_resource_request_statusReturns 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.RequestToken (string) required
cloudcontrol/list_resource_requestsReturns 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.MaxResults (integer)
NextToken (string)
ResourceRequestStatusFilter: {
. Operations (array)
. OperationStatuses (array)
} (object)
cloudcontrol/list_resourcesReturns 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.TypeName (string) required
TypeVersionId (string)
RoleArn (string)
NextToken (string)
MaxResults (integer)
ResourceModel (string)
cloudcontrol/update_resourceUpdates 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 calTypeName (string) required
TypeVersionId (string)
RoleArn (string)
ClientToken (string)
Identifier (string) required
PatchDocument (string) required
clouddirectory/add_facet_to_objectAdds a new Facet to an object. An object can have more than one facet applied on it.DirectoryArn (string) required
SchemaFacet: {
. SchemaArn (string)
. FacetName (string)
} (object) required
ObjectAttributeList (array)
ObjectReference: {
. Selector (string)
} (object) required
clouddirectory/apply_schemaCopies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.PublishedSchemaArn (string) required
DirectoryArn (string) required
clouddirectory/attach_objectAttaches an existing object to another object. An object can be accessed in two ways: Using the path Using ObjectIdentifierDirectoryArn (string) required
ParentReference: {
. Selector (string)
} (object) required
ChildReference: {
. Selector (string)
} (object) required
LinkName (string) required
clouddirectory/attach_policyAttaches a policy object to a regular object. An object can have a limited number of attached policies.DirectoryArn (string) required
PolicyReference: {
. Selector (string)
} (object) required
ObjectReference: {
. Selector (string)
} (object) required
clouddirectory/attach_to_indexAttaches the specified object to the specified index.DirectoryArn (string) required
IndexReference: {
. Selector (string)
} (object) required
TargetReference: {
. Selector (string)
} (object) required
clouddirectory/attach_typed_linkAttaches a typed link to a specified source and target object. For more information, see Typed Links.DirectoryArn (string) required
SourceObjectReference: {
. Selector (string)
} (object) required
TargetObjectReference: {
. Selector (string)
} (object) required
TypedLinkFacet: {
. SchemaArn (string)
. TypedLinkName (string)
} (object) required
Attributes (array) required
clouddirectory/batch_readPerforms all the read operations in a batch.DirectoryArn (string) required
Operations (array) required
ConsistencyLevel (string)
clouddirectory/batch_writePerforms all the write operations in a batch. Either all the operations succeed or none.DirectoryArn (string) required
Operations (array) required
clouddirectory/create_directoryCreates 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.Name (string) required
SchemaArn (string) required
clouddirectory/create_facetCreates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.SchemaArn (string) required
Name (string) required
Attributes (array)
ObjectType (string)
FacetStyle (string)
clouddirectory/create_indexCreates an index object. See Indexing and search for more information.DirectoryArn (string) required
OrderedIndexedAttributeList (array) required
IsUnique (boolean) required
ParentReference: {
. Selector (string)
} (object)
LinkName (string)
clouddirectory/create_objectCreates 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.DirectoryArn (string) required
SchemaFacets (array) required
ObjectAttributeList (array)
ParentReference: {
. Selector (string)
} (object)
LinkName (string)
clouddirectory/create_schemaCreates 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 publishName (string) required
clouddirectory/create_typed_link_facetCreates a TypedLinkFacet. For more information, see Typed Links.SchemaArn (string) required
Facet: {
. Name (string)
. Attributes (array)
. IdentityAttributeOrder (array)
} (object) required
clouddirectory/delete_directoryDeletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.DirectoryArn (string) required
clouddirectory/delete_facetDeletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.SchemaArn (string) required
Name (string) required
clouddirectory/delete_objectDeletes 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.DirectoryArn (string) required
ObjectReference: {
. Selector (string)
} (object) required
clouddirectory/delete_schemaDeletes a given schema. Schemas in a development and published state can only be deleted.SchemaArn (string) required
clouddirectory/delete_typed_link_facetDeletes a TypedLinkFacet. For more information, see Typed Links.SchemaArn (string) required
Name (string) required
clouddirectory/detach_from_indexDetaches the specified object from the specified index.DirectoryArn (string) required
IndexReference: {
. Selector (string)
} (object) required
TargetReference: {
. Selector (string)
} (object) required
clouddirectory/detach_objectDetaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.DirectoryArn (string) required
ParentReference: {
. Selector (string)
} (object) required
LinkName (string) required
clouddirectory/detach_policyDetaches a policy from an object.DirectoryArn (string) required
PolicyReference: {
. Selector (string)
} (object) required
ObjectReference: {
. Selector (string)
} (object) required
clouddirectory/detach_typed_linkDetaches a typed link from a specified source and target object. For more information, see Typed Links.DirectoryArn (string) required
TypedLinkSpecifier: {
. TypedLinkFacet (object)
. SourceObjectReference (object)
. TargetObjectReference (object)
. IdentityAttributeValues (array)
} (object) required
clouddirectory/disable_directoryDisables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.DirectoryArn (string) required
clouddirectory/enable_directoryEnables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.DirectoryArn (string) required
clouddirectory/get_applied_schema_versionReturns current applied schema version ARN, including the minor version in use.SchemaArn (string) required
clouddirectory/get_directoryRetrieves metadata about a directory.DirectoryArn (string) required
clouddirectory/get_facetGets 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.SchemaArn (string) required
Name (string) required
clouddirectory/get_link_attributesRetrieves attributes that are associated with a typed link.DirectoryArn (string) required
TypedLinkSpecifier: {
. TypedLinkFacet (object)
. SourceObjectReference (object)
. TargetObjectReference (object)
. IdentityAttributeValues (array)
} (object) required
AttributeNames (array) required
ConsistencyLevel (string)
clouddirectory/get_object_attributesRetrieves attributes within a facet that are associated with an object.DirectoryArn (string) required
ObjectReference: {
. Selector (string)
} (object) required
ConsistencyLevel (string)
SchemaFacet: {
. SchemaArn (string)
. FacetName (string)
} (object) required
AttributeNames (array) required
clouddirectory/get_object_informationRetrieves metadata about an object.DirectoryArn (string) required
ObjectReference: {
. Selector (string)
} (object) required
ConsistencyLevel (string)
clouddirectory/get_schema_as_jsonRetrieves a JSON representation of the schema. See JSON Schema Format for more information.SchemaArn (string) required
clouddirectory/get_typed_link_facet_informationReturns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.SchemaArn (string) required
Name (string) required
clouddirectory/list_applied_schema_arnsLists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.DirectoryArn (string) required
SchemaArn (string)
NextToken (string)
MaxResults (integer)
clouddirectory/list_attached_indicesLists indices attached to the specified object.DirectoryArn (string) required
TargetReference: {
. Selector (string)
} (object) required
NextToken (string)
MaxResults (integer)
ConsistencyLevel (string)
clouddirectory/list_development_schema_arnsRetrieves each Amazon Resource Name ARN of schemas in the development state.NextToken (string)
MaxResults (integer)
clouddirectory/list_directoriesLists directories created within an account.NextToken (string)
MaxResults (integer)
state (string)
clouddirectory/list_facet_attributesRetrieves attributes attached to the facet.SchemaArn (string) required
Name (string) required
NextToken (string)
MaxResults (integer)
clouddirectory/list_facet_namesRetrieves the names of facets that exist in a schema.SchemaArn (string) required
NextToken (string)
MaxResults (integer)
clouddirectory/list_incoming_typed_linksReturns 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.DirectoryArn (string) required
ObjectReference: {
. Selector (string)
} (object) required
FilterAttributeRanges (array)
FilterTypedLink: {
. SchemaArn (string)
. TypedLinkName (string)
} (object)
NextToken (string)
MaxResults (integer)
ConsistencyLevel (string)
clouddirectory/list_indexLists objects attached to the specified index.DirectoryArn (string) required
RangesOnIndexedValues (array)
IndexReference: {
. Selector (string)
} (object) required
MaxResults (integer)
NextToken (string)
ConsistencyLevel (string)
clouddirectory/list_managed_schema_arnsLists 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.SchemaArn (string)
NextToken (string)
MaxResults (integer)
clouddirectory/list_object_attributesLists all attributes that are associated with an object.DirectoryArn (string) required
ObjectReference: {
. Selector (string)
} (object) required
NextToken (string)
MaxResults (integer)
ConsistencyLevel (string)
FacetFilter: {
. SchemaArn (string)
. FacetName (string)
} (object)
clouddirectory/list_object_childrenReturns a paginated list of child objects that are associated with a given object.DirectoryArn (string) required
ObjectReference: {
. Selector (string)
} (object) required
NextToken (string)
MaxResults (integer)
ConsistencyLevel (string)
clouddirectory/list_object_parent_pathsRetrieves 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 amongDirectoryArn (string) required
ObjectReference: {
. Selector (string)
} (object) required
NextToken (string)
MaxResults (integer)
clouddirectory/list_object_parentsLists parent objects that are associated with a given object in pagination fashion.DirectoryArn (string) required
ObjectReference: {
. Selector (string)
} (object) required
NextToken (string)
MaxResults (integer)
ConsistencyLevel (string)
IncludeAllLinksToEachParent (boolean)
clouddirectory/list_object_policiesReturns policies attached to an object in pagination fashion.DirectoryArn (string) required
ObjectReference: {
. Selector (string)
} (object) required
NextToken (string)
MaxResults (integer)
ConsistencyLevel (string)
clouddirectory/list_outgoing_typed_linksReturns 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.DirectoryArn (string) required
ObjectReference: {
. Selector (string)
} (object) required
FilterAttributeRanges (array)
FilterTypedLink: {
. SchemaArn (string)
. TypedLinkName (string)
} (object)
NextToken (string)
MaxResults (integer)
ConsistencyLevel (string)
clouddirectory/list_policy_attachmentsReturns all of the ObjectIdentifiers to which a given policy is attached.DirectoryArn (string) required
PolicyReference: {
. Selector (string)
} (object) required
NextToken (string)
MaxResults (integer)
ConsistencyLevel (string)
clouddirectory/list_published_schema_arnsLists 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.SchemaArn (string)
NextToken (string)
MaxResults (integer)
clouddirectory/list_tags_for_resourceReturns 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.ResourceArn (string) required
NextToken (string)
MaxResults (integer)
clouddirectory/list_typed_link_facet_attributesReturns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.SchemaArn (string) required
Name (string) required
NextToken (string)
MaxResults (integer)
clouddirectory/list_typed_link_facet_namesReturns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed Links.SchemaArn (string) required
NextToken (string)
MaxResults (integer)
clouddirectory/lookup_policyLists 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.DirectoryArn (string) required
ObjectReference: {
. Selector (string)
} (object) required
NextToken (string)
MaxResults (integer)
clouddirectory/publish_schemaPublishes a development schema with a major version and a recommended minor version.DevelopmentSchemaArn (string) required
Version (string) required
MinorVersion (string)
Name (string)
clouddirectory/put_schema_from_jsonAllows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.SchemaArn (string) required
Document (string) required
clouddirectory/remove_facet_from_objectRemoves the specified facet from the specified object.DirectoryArn (string) required
SchemaFacet: {
. SchemaArn (string)
. FacetName (string)
} (object) required
ObjectReference: {
. Selector (string)
} (object) required
clouddirectory/tag_resourceAn API operation for adding tags to a resource.ResourceArn (string) required
Tags (array) required
clouddirectory/untag_resourceAn API operation for removing tags from a resource.ResourceArn (string) required
TagKeys (array) required
clouddirectory/update_facetDoes the following: Adds new Attributes, Rules, or ObjectTypes. Updates existing Attributes, Rules, or ObjectTypes. Deletes existing Attributes, Rules, or ObjectTypes.SchemaArn (string) required
Name (string) required
AttributeUpdates (array)
ObjectType (string)
clouddirectory/update_link_attributesUpdates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder.DirectoryArn (string) required
TypedLinkSpecifier: {
. TypedLinkFacet (object)
. SourceObjectReference (object)
. TargetObjectReference (object)
. IdentityAttributeValues (array)
} (object) required
AttributeUpdates (array) required
clouddirectory/update_object_attributesUpdates a given object's attributes.DirectoryArn (string) required
ObjectReference: {
. Selector (string)
} (object) required
AttributeUpdates (array) required
clouddirectory/update_schemaUpdates the schema name with a new name. Only development schema names can be updated.SchemaArn (string) required
Name (string) required
clouddirectory/update_typed_link_facetUpdates a TypedLinkFacet. For more information, see Typed Links.SchemaArn (string) required
Name (string) required
AttributeUpdates (array) required
IdentityAttributeOrder (array) required
clouddirectory/upgrade_applied_schemaUpgrades 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.PublishedSchemaArn (string) required
DirectoryArn (string) required
DryRun (boolean)
clouddirectory/upgrade_published_schemaUpgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.DevelopmentSchemaArn (string) required
PublishedSchemaArn (string) required
MinorVersion (string) required
DryRun (boolean)
cloudformation/activate_organizations_accessActivate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.No parameters
cloudformation/activate_typeActivates a public third-party extension, such as a resource or module, to make it available for use in stack templates in your current account and Region. It can also create CloudFormation Hooks, which allow you to evaluate resource configurations before CloudFormation provisions them. Hooks integrate with both CloudFormation and Cloud Control API operations. After you activate an extension, you can use SetTypeConfiguration to set specific properties for the extension. To see which extensions hType (string)
PublicTypeArn (string)
PublisherId (string)
TypeName (string)
TypeNameAlias (string)
AutoUpdate (boolean)
LoggingConfig: {
. LogRoleArn (string)
. LogGroupName (string)
} (object)
ExecutionRoleArn (string)
VersionBump (string)
MajorVersion (integer)
cloudformation/batch_describe_type_configurationsReturns configuration data for the specified CloudFormation extensions, from the CloudFormation registry in your current account and Region. For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.TypeConfigurationIdentifiers (array) required
cloudformation/cancel_update_stackCancels 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.StackName (string) required
ClientRequestToken (string)
cloudformation/continue_update_rollbackContinues rolling back a stack from UPDATE_ROLLBACK_FAILED to 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 enters the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after a failed stack update. For example, this might occur when aStackName (string) required
RoleARN (string)
ResourcesToSkip (array)
ClientRequestToken (string)
cloudformation/create_change_setCreates 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 diStackName (string) required
TemplateBody (string)
TemplateURL (string)
UsePreviousTemplate (boolean)
Parameters (array)
Capabilities (array)
ResourceTypes (array)
RoleARN (string)
RollbackConfiguration: {
. RollbackTriggers (array)
. MonitoringTimeInMinutes (integer)
} (object)
NotificationARNs (array)
Tags (array)
ChangeSetName (string) required
ClientToken (string)
Description (string)
ChangeSetType (string)
ResourcesToImport (array)
IncludeNestedStacks (boolean)
OnStackFailure (string)
ImportExistingResources (boolean)
DeploymentMode (string)
cloudformation/create_generated_templateCreates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the DescribeGeneratedTemplate API action.Resources (array)
GeneratedTemplateName (string) required
StackName (string)
TemplateConfiguration: {
. DeletionPolicy (string)
. UpdateReplacePolicy (string)
} (object)
cloudformation/create_stackCreates 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 DescribeStacks operation. For more information about creating a stack and monitoring stack progress, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.StackName (string) required
TemplateBody (string)
TemplateURL (string)
Parameters (array)
DisableRollback (boolean)
RollbackConfiguration: {
. RollbackTriggers (array)
. MonitoringTimeInMinutes (integer)
} (object)
TimeoutInMinutes (integer)
NotificationARNs (array)
Capabilities (array)
ResourceTypes (array)
RoleARN (string)
OnFailure (string)
StackPolicyBody (string)
StackPolicyURL (string)
Tags (array)
ClientRequestToken (string)
EnableTerminationProtection (boolean)
RetainExceptOnCreate (boolean)
cloudformation/create_stack_instancesCreates 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. The maximum number of organizational unit OUs supported by a CreateStackInstances operation is 50. If you need more than 50, consider the following options: Batch processing: If you don't want to exStackSetName (string) required
Accounts (array)
DeploymentTargets: {
. Accounts (array)
. AccountsUrl (string)
. OrganizationalUnitIds (array)
. AccountFilterType (string)
} (object)
Regions (array) required
ParameterOverrides (array)
OperationPreferences: {
. RegionConcurrencyType (string)
. RegionOrder (array)
. FailureToleranceCount (integer)
. FailureTolerancePercentage (integer)
. MaxConcurrentCount (integer)
. MaxConcurrentPercentage (integer)
. ConcurrencyMode (string)
} (object)
OperationId (string)
CallAs (string)
cloudformation/create_stack_refactorCreates a refactor across multiple stacks, with the list of stacks and resources that are affected.Description (string)
EnableStackCreation (boolean)
ResourceMappings (array)
StackDefinitions (array) required
cloudformation/create_stack_setCreates a StackSet.StackSetName (string) required
Description (string)
TemplateBody (string)
TemplateURL (string)
StackId (string)
Parameters (array)
Capabilities (array)
Tags (array)
AdministrationRoleARN (string)
ExecutionRoleName (string)
PermissionModel (string)
AutoDeployment: {
. Enabled (boolean)
. RetainStacksOnAccountRemoval (boolean)
. DependsOn (array)
} (object)
CallAs (string)
ClientRequestToken (string)
ManagedExecution: {
. Active (boolean)
} (object)
cloudformation/deactivate_organizations_accessDeactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.No parameters
cloudformation/deactivate_typeDeactivates a public third-party extension, such as a resource or module, or a CloudFormation Hook when you no longer use it. Deactivating an extension deletes the configuration details that are associated with it. To temporarily disable a CloudFormation Hook instead, you can use SetTypeConfiguration. 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 madTypeName (string)
Type (string)
Arn (string)
cloudformation/delete_change_setDeletes 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.ChangeSetName (string) required
StackName (string)
cloudformation/delete_generated_templateDeleted a generated template.GeneratedTemplateName (string) required
cloudformation/delete_stackDeletes 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. For more information about deleting a stack, see Delete a stack from the CloudFormation console in the CloudFormation User Guide.StackName (string) required
RetainResources (array)
RoleARN (string)
ClientRequestToken (string)
DeletionMode (string)
cloudformation/delete_stack_instancesDeletes stack instances for the specified accounts, in the specified Amazon Web Services Regions. The maximum number of organizational unit OUs supported by a DeleteStackInstances operation is 50. If you need more than 50, consider the following options: Batch processing: If you don't want to expose your OU hierarchy, split up the operations into multiple calls with less than 50 OUs each. Parent OU strategy: If you don't mind exposing the OU hierarchy, target a parent OU that contains all desireStackSetName (string) required
Accounts (array)
DeploymentTargets: {
. Accounts (array)
. AccountsUrl (string)
. OrganizationalUnitIds (array)
. AccountFilterType (string)
} (object)
Regions (array) required
OperationPreferences: {
. RegionConcurrencyType (string)
. RegionOrder (array)
. FailureToleranceCount (integer)
. FailureTolerancePercentage (integer)
. MaxConcurrentCount (integer)
. MaxConcurrentPercentage (integer)
. ConcurrencyMode (string)
} (object)
RetainStacks (boolean) required
OperationId (string)
CallAs (string)
cloudformation/delete_stack_setDeletes a StackSet. Before you can delete a StackSet, all its member stack instances must be deleted. For more information about how to complete this, see DeleteStackInstances.StackSetName (string) required
CallAs (string)
cloudformation/deregister_typeMarks 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 deregisteArn (string)
Type (string)
TypeName (string)
VersionId (string)
cloudformation/describe_account_limitsRetrieves 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 Understand CloudFormation quotas in the CloudFormation User Guide.NextToken (string)
cloudformation/describe_change_setReturns 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 Update CloudFormation stacks using change sets in the CloudFormation User Guide.ChangeSetName (string) required
StackName (string)
NextToken (string)
IncludePropertyValues (boolean)
cloudformation/describe_change_set_hooksReturns Hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.ChangeSetName (string) required
StackName (string)
NextToken (string)
LogicalResourceId (string)
cloudformation/describe_eventsReturns CloudFormation events based on flexible query criteria. Groups events by operation ID, enabling you to focus on individual stack operations during deployment. An operation is any action performed on a stack, including stack lifecycle actions Create, Update, Delete, Rollback, change set creation, nested stack creation, and automatic rollbacks triggered by failures. Each operation has a unique identifier Operation ID and represents a discrete change attempt on the stack. Returns differentStackName (string)
ChangeSetName (string)
OperationId (string)
Filters: {
. FailedEvents (boolean)
} (object)
NextToken (string)
cloudformation/describe_generated_templateDescribes a generated template. The output includes details about the progress of the creation of a generated template started by a CreateGeneratedTemplate API action or the update of a generated template started with an UpdateGeneratedTemplate API action.GeneratedTemplateName (string) required
cloudformation/describe_organizations_accessRetrieves information about the account's OrganizationAccess status. This API can be called either by the management account or the delegated administrator by using the CallAs parameter. This API can also be called without the CallAs parameter by the management account.CallAs (string)
cloudformation/describe_publisherReturns 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 Command Line Interface CLI User GuidePublisherId (string)
cloudformation/describe_resource_scanDescribes details of a resource scan.ResourceScanId (string) required
cloudformation/describe_stack_drift_detection_statusReturns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from its 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 Detect unmanaged configuration changes to stacks and resources with drift detStackDriftDetectionId (string) required
cloudformation/describe_stack_eventsReturns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see Understand CloudFormation stack creation events 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.StackName (string) required
NextToken (string)
cloudformation/describe_stack_instanceReturns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region. For a list of stack instances that are associated with a specific StackSet, use ListStackInstances.StackSetName (string) required
StackInstanceAccount (string) required
StackInstanceRegion (string) required
CallAs (string)
cloudformation/describe_stack_refactorDescribes the stack refactor status.StackRefactorId (string) required
cloudformation/describe_stack_resourceReturns 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.StackName (string) required
LogicalResourceId (string) required
cloudformation/describe_stack_resource_driftsReturns 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 liStackName (string) required
StackResourceDriftStatusFilters (array)
NextToken (string)
MaxResults (integer)
cloudformation/describe_stack_resourcesReturns 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 informatioStackName (string)
LogicalResourceId (string)
PhysicalResourceId (string)
cloudformation/describe_stacksReturns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide. If the stack doesn't exist, a ValidationError is returned.StackName (string)
NextToken (string)
cloudformation/describe_stack_setReturns the description of the specified StackSet. This API provides strongly consistent reads meaning it will always return the most up-to-date data.StackSetName (string) required
CallAs (string)
cloudformation/describe_stack_set_operationReturns the description of the specified StackSet operation. This API provides strongly consistent reads meaning it will always return the most up-to-date data.StackSetName (string) required
OperationId (string) required
CallAs (string)
cloudformation/describe_typeReturns detailed information about an extension from the CloudFormation registry in your current account and Region. If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version. For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide.Type (string)
TypeName (string)
Arn (string)
VersionId (string)
PublisherId (string)
PublicVersionNumber (string)
cloudformation/describe_type_registrationReturns 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.RegistrationToken (string) required
cloudformation/detect_stack_driftDetects whether a stack's actual configuration differs, or has drifted, from its 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 ofStackName (string) required
LogicalResourceIds (array)
cloudformation/detect_stack_resource_driftReturns information about whether a resource's actual configuration differs, or has drifted, from its 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 Detect unmanaged configurationStackName (string) required
LogicalResourceId (string) required
cloudformation/detect_stack_set_driftDetect drift on a StackSet. When CloudFormation performs drift detection on a StackSet, it performs drift detection on the stack associated with each stack instance in the StackSet. For more information, see Performing drift detection on CloudFormation StackSets. DetectStackSetDrift returns the OperationId of the StackSet drift detection operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the drift detection operation. The drift detection operation may takeStackSetName (string) required
OperationPreferences: {
. RegionConcurrencyType (string)
. RegionOrder (array)
. FailureToleranceCount (integer)
. FailureTolerancePercentage (integer)
. MaxConcurrentCount (integer)
. MaxConcurrentPercentage (integer)
. ConcurrencyMode (string)
} (object)
OperationId (string)
CallAs (string)
cloudformation/estimate_template_costReturns 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.TemplateBody (string)
TemplateURL (string)
Parameters (array)
cloudformation/execute_change_setUpdates 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 updatChangeSetName (string) required
StackName (string)
ClientRequestToken (string)
DisableRollback (boolean)
RetainExceptOnCreate (boolean)
cloudformation/execute_stack_refactorExecutes the stack refactor operation.StackRefactorId (string) required
cloudformation/get_generated_templateRetrieves a generated template. If the template is in an InProgress or Pending status then the template returned will be the template when the template was last in a Complete status. If the template has not yet been in a Complete status then an empty template will be returned.Format (string)
GeneratedTemplateName (string) required
cloudformation/get_hook_resultRetrieves detailed information and remediation guidance for a Hook invocation result. If the Hook uses a KMS key to encrypt annotations, callers of the GetHookResult operation must have kms:Decrypt permissions. For more information, see KMS key policy and permissions for encrypting CloudFormation Hooks results at rest in the CloudFormation Hooks User Guide.HookResultId (string)
cloudformation/get_stack_policyReturns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.StackName (string) required
cloudformation/get_templateReturns 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.StackName (string)
ChangeSetName (string)
TemplateStage (string)
cloudformation/get_template_summaryReturns 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 StackSet. You can use the GetTemplateSummary action when you submit a template, or you can get template information for a StackSet, or a running or deleted stack. For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has beenTemplateBody (string)
TemplateURL (string)
StackName (string)
StackSetName (string)
CallAs (string)
TemplateSummaryConfig: {
. TreatUnrecognizedResourceTypesAsWarnings (boolean)
} (object)
cloudformation/import_stacks_to_stack_setImport existing stacks into a new StackSets. Use the stack import operation to import up to 10 stacks into a new StackSet 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.StackSetName (string) required
StackIds (array)
StackIdsUrl (string)
OrganizationalUnitIds (array)
OperationPreferences: {
. RegionConcurrencyType (string)
. RegionOrder (array)
. FailureToleranceCount (integer)
. FailureTolerancePercentage (integer)
. MaxConcurrentCount (integer)
. MaxConcurrentPercentage (integer)
. ConcurrencyMode (string)
} (object)
OperationId (string)
CallAs (string)
cloudformation/list_change_setsReturns 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.StackName (string) required
NextToken (string)
cloudformation/list_exportsLists 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 Get exported outputs from a deployed CloudFormation stack.NextToken (string)
cloudformation/list_generated_templatesLists your generated templates in this Region.NextToken (string)
MaxResults (integer)
cloudformation/list_hook_resultsReturns summaries of invoked Hooks. For more information, see View invocation summaries for CloudFormation Hooks in the CloudFormation Hooks User Guide. This operation supports the following parameter combinations: No parameters: Returns all Hook invocation summaries. TypeArn only: Returns summaries for a specific Hook. TypeArn and Status: Returns summaries for a specific Hook filtered by status. TargetId and TargetType: Returns summaries for a specific Hook invocation target.TargetType (string)
TargetId (string)
TypeArn (string)
Status (string)
NextToken (string)
cloudformation/list_importsLists 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.ExportName (string) required
NextToken (string)
cloudformation/list_resource_scan_related_resourcesLists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.ResourceScanId (string) required
Resources (array) required
NextToken (string)
MaxResults (integer)
cloudformation/list_resource_scan_resourcesLists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.ResourceScanId (string) required
ResourceIdentifier (string)
ResourceTypePrefix (string)
TagKey (string)
TagValue (string)
NextToken (string)
MaxResults (integer)
cloudformation/list_resource_scansList the resource scans from newest to oldest. By default it will return up to 10 resource scans.NextToken (string)
MaxResults (integer)
ScanTypeFilter (string)
cloudformation/list_stack_instance_resource_driftsReturns drift information for resources in a stack instance. ListStackInstanceResourceDrifts returns drift information for the most recent drift detection operation. If an operation is in progress, it may only return partial results.StackSetName (string) required
NextToken (string)
MaxResults (integer)
StackInstanceResourceDriftStatuses (array)
StackInstanceAccount (string) required
StackInstanceRegion (string) required
OperationId (string) required
CallAs (string)
cloudformation/list_stack_instancesReturns summary information about stack instances that are associated with the specified StackSet. 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.StackSetName (string) required
NextToken (string)
MaxResults (integer)
Filters (array)
StackInstanceAccount (string)
StackInstanceRegion (string)
CallAs (string)
cloudformation/list_stack_refactor_actionsLists the stack refactor actions that will be taken after calling the ExecuteStackRefactor action.StackRefactorId (string) required
NextToken (string)
MaxResults (integer)
cloudformation/list_stack_refactorsLists all account stack refactor operations and their statuses.ExecutionStatusFilter (array)
NextToken (string)
MaxResults (integer)
cloudformation/list_stack_resourcesReturns 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.StackName (string) required
NextToken (string)
cloudformation/list_stacksReturns 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.NextToken (string)
StackStatusFilter (array)
cloudformation/list_stack_set_auto_deployment_targetsReturns summary information about deployment targets for a StackSet.StackSetName (string) required
NextToken (string)
MaxResults (integer)
CallAs (string)
cloudformation/list_stack_set_operation_resultsReturns summary information about the results of a StackSet operation. This API provides eventually consistent reads meaning it may take some time but will eventually return the most up-to-date data.StackSetName (string) required
OperationId (string) required
NextToken (string)
MaxResults (integer)
CallAs (string)
Filters (array)
cloudformation/list_stack_set_operationsReturns summary information about operations performed on a StackSet. This API provides eventually consistent reads meaning it may take some time but will eventually return the most up-to-date data.StackSetName (string) required
NextToken (string)
MaxResults (integer)
CallAs (string)
cloudformation/list_stack_setsReturns summary information about StackSets that are associated with the user. This API provides strongly consistent reads meaning it will always return the most up-to-date data. 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 StackSets in your Amazon Web Services account. Service-managed permissions If you set the CallAs parameter to SELF while signed in to the organization's managementNextToken (string)
MaxResults (integer)
Status (string)
CallAs (string)
cloudformation/list_type_registrationsReturns a list of registration tokens for the specified extensions.Type (string)
TypeName (string)
TypeArn (string)
RegistrationStatusFilter (string)
MaxResults (integer)
NextToken (string)
cloudformation/list_typesReturns summary information about all extensions, including your private resource types, modules, and Hooks as well as all public extensions from Amazon Web Services and third-party publishers.Visibility (string)
ProvisioningType (string)
DeprecatedStatus (string)
Type (string)
Filters: {
. Category (string)
. PublisherId (string)
. TypeNamePrefix (string)
} (object)
MaxResults (integer)
NextToken (string)
cloudformation/list_type_versionsReturns summary information about the versions of an extension.Type (string)
TypeName (string)
Arn (string)
MaxResults (integer)
NextToken (string)
DeprecatedStatus (string)
PublisherId (string)
cloudformation/publish_typePublishes 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 Command Line Interface CLI User Guide. To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.Type (string)
Arn (string)
TypeName (string)
PublicVersionNumber (string)
cloudformation/record_handler_progressReports progress of a resource handler to CloudFormation. Reserved for use by the CloudFormation CLI. Don't use this API in your code.BearerToken (string) required
OperationStatus (string) required
CurrentOperationStatus (string)
StatusMessage (string)
ErrorCode (string)
ResourceModel (string)
ClientRequestToken (string)
cloudformation/register_publisherRegisters 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 Prerequisite: Registering your account to publish CloudFormation extensions in the CloudFormation Command Line Interface CLI User Guide.AcceptTermsAndConditions (boolean)
ConnectionArn (string)
cloudformation/register_typeRegisters 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 types using the CloudFormation CLI in theType (string)
TypeName (string) required
SchemaHandlerPackage (string) required
LoggingConfig: {
. LogRoleArn (string)
. LogGroupName (string)
} (object)
ExecutionRoleArn (string)
ClientRequestToken (string)
cloudformation/rollback_stackWhen 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. CREATStackName (string) required
RoleARN (string)
ClientRequestToken (string)
RetainExceptOnCreate (boolean)
cloudformation/set_stack_policySets a stack policy for a specified stack.StackName (string) required
StackPolicyBody (string)
StackPolicyURL (string)
cloudformation/set_type_configurationSpecifies the configuration data for a CloudFormation extension, such as a resource or Hook, in the given account and Region. For more information, see Edit configuration data for extensions in your account in the CloudFormation User Guide. To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType. It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. ForTypeArn (string)
Configuration (string) required
ConfigurationAlias (string)
TypeName (string)
Type (string)
cloudformation/set_type_default_versionSpecify the default version of an extension. The default version of an extension will be used in CloudFormation operations.Arn (string)
Type (string)
TypeName (string)
VersionId (string)
cloudformation/signal_resourceSends 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.StackName (string) required
LogicalResourceId (string) required
UniqueId (string) required
Status (string) required
cloudformation/start_resource_scanStarts a scan of the resources in this account in this Region. You can the status of a scan using the ListResourceScans API action.ClientRequestToken (string)
ScanFilters (array)
cloudformation/stop_stack_set_operationStops an in-progress operation on a StackSet and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.StackSetName (string) required
OperationId (string) required
CallAs (string)
cloudformation/test_typeTests 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 before publishing in the CloudFormation Command Line Interface CLI User Guide. If you don't specify a version, CloudFormation uses theArn (string)
Type (string)
TypeName (string)
VersionId (string)
LogDeliveryBucket (string)
cloudformation/update_generated_templateUpdates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of the update to the generated template using the DescribeGeneratedTemplate API action.GeneratedTemplateName (string) required
NewGeneratedTemplateName (string)
AddResources (array)
RemoveResources (array)
RefreshAllResources (boolean)
TemplateConfiguration: {
. DeletionPolicy (string)
. UpdateReplacePolicy (string)
} (object)
cloudformation/update_stackUpdates 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 updating a stack and monitoring the progress of the update, see Managing Amazon Web Services resources as a single unit with CloudFormation stacks in the CloudFormation User Guide.StackName (string) required
TemplateBody (string)
TemplateURL (string)
UsePreviousTemplate (boolean)
StackPolicyDuringUpdateBody (string)
StackPolicyDuringUpdateURL (string)
Parameters (array)
Capabilities (array)
ResourceTypes (array)
RoleARN (string)
RollbackConfiguration: {
. RollbackTriggers (array)
. MonitoringTimeInMinutes (integer)
} (object)
StackPolicyBody (string)
StackPolicyURL (string)
NotificationARNs (array)
Tags (array)
DisableRollback (boolean)
ClientRequestToken (string)
RetainExceptOnCreate (boolean)
cloudformation/update_stack_instancesUpdates 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 StackSet updates, any parameters overridden for a stack instance aren't updated, but retain their overridden value. You can onlStackSetName (string) required
Accounts (array)
DeploymentTargets: {
. Accounts (array)
. AccountsUrl (string)
. OrganizationalUnitIds (array)
. AccountFilterType (string)
} (object)
Regions (array) required
ParameterOverrides (array)
OperationPreferences: {
. RegionConcurrencyType (string)
. RegionOrder (array)
. FailureToleranceCount (integer)
. FailureTolerancePercentage (integer)
. MaxConcurrentCount (integer)
. MaxConcurrentPercentage (integer)
. ConcurrencyMode (string)
} (object)
OperationId (string)
CallAs (string)
cloudformation/update_stack_setUpdates the StackSet and associated stack instances in the specified accounts and Amazon Web Services Regions. Even if the StackSet operation created by updating the StackSet fails completely or partially, below or above a specified failure tolerance, the StackSet is updated with your changes. Subsequent CreateStackInstances calls on the specified StackSet use the updated StackSet. The maximum number of organizational unit OUs supported by a UpdateStackSet operation is 50. If you need more thanStackSetName (string) required
Description (string)
TemplateBody (string)
TemplateURL (string)
UsePreviousTemplate (boolean)
Parameters (array)
Capabilities (array)
Tags (array)
OperationPreferences: {
. RegionConcurrencyType (string)
. RegionOrder (array)
. FailureToleranceCount (integer)
. FailureTolerancePercentage (integer)
. MaxConcurrentCount (integer)
. MaxConcurrentPercentage (integer)
. ConcurrencyMode (string)
} (object)
AdministrationRoleARN (string)
ExecutionRoleName (string)
DeploymentTargets: {
. Accounts (array)
. AccountsUrl (string)
. OrganizationalUnitIds (array)
. AccountFilterType (string)
} (object)
PermissionModel (string)
AutoDeployment: {
. Enabled (boolean)
. RetainStacksOnAccountRemoval (boolean)
. DependsOn (array)
} (object)
OperationId (string)
Accounts (array)
Regions (array)
CallAs (string)
ManagedExecution: {
. Active (boolean)
} (object)
cloudformation/update_termination_protectionUpdates 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 Protect a CloudFormation 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.EnableTerminationProtection (boolean) required
StackName (string) required
cloudformation/validate_templateValidates 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.TemplateBody (string)
TemplateURL (string)
cloudfront_keyvaluestore/delete_keyDeletes the key value pair specified by the key.KvsARN (string) required
Key (string) required
IfMatch (string) required
cloudfront_keyvaluestore/describe_key_value_storeReturns metadata information about Key Value Store.KvsARN (string) required
cloudfront_keyvaluestore/get_keyReturns a key value pair.KvsARN (string) required
Key (string) required
cloudfront_keyvaluestore/list_keysReturns a list of key value pairs.KvsARN (string) required
NextToken (string)
MaxResults (integer)
cloudfront_keyvaluestore/put_keyCreates a new key value pair or replaces the value of an existing key.Key (string) required
Value (string) required
KvsARN (string) required
IfMatch (string) required
cloudfront_keyvaluestore/update_keysPuts or Deletes multiple key value pairs in a single, all-or-nothing operation.KvsARN (string) required
IfMatch (string) required
Puts (array)
Deletes (array)
cloudfront/associate_aliasThe AssociateAlias API operation only supports standard distributions. To move domains between distribution tenants and/or standard distributions, we recommend that you use the UpdateDomainAssociation API operation instead. Associates an alias with a CloudFront standard distribution. An alias is commonly known as a custom domain or vanity domain. It can also be called a CNAME or alternate domain name. With this operation, you can move an alias that's already used for a standard distribution to aTargetDistributionId (string) required
Alias (string) required
cloudfront/associate_distribution_tenant_web_aclAssociates the WAF web ACL with a distribution tenant.Id (string) required
WebACLArn (string) required
IfMatch (string)
cloudfront/associate_distribution_web_aclAssociates the WAF web ACL with a distribution.Id (string) required
WebACLArn (string) required
IfMatch (string)
cloudfront/copy_distributionCreates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution called the primary distribution that you can use in a continuous deployment workflow. After you create a staging distribution, you can use UpdateDistribution to modify the staging distribution's configuration. Then you can use CreateContinuousDeploymentPolicy to incrementally move traffic to the staging distribution. This API operation requiresPrimaryDistributionId (string) required
Staging (boolean)
IfMatch (string)
CallerReference (string) required
Enabled (boolean)
cloudfront/create_anycast_ip_listCreates an Anycast static IP list.Name (string) required
IpCount (integer) required
Tags: {
. Items (array)
} (object)
IpAddressType (string)
IpamCidrConfigs (array)
cloudfront/create_cache_policyCreates 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 inCachePolicyConfig: {
. Comment (string)
. Name (string)
. DefaultTTL (integer)
. MaxTTL (integer)
. MinTTL (integer)
. ParametersInCacheKeyAndForwardedToOrigin (object)
} (object) required
cloudfront/create_cloud_front_origin_access_identityCreates 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.CloudFrontOriginAccessIdentityConfig: {
. CallerReference (string)
. Comment (string)
} (object) required
cloudfront/create_connection_functionCreates a connection function.Name (string) required
ConnectionFunctionConfig: {
. Comment (string)
. Runtime (string)
. KeyValueStoreAssociations (object)
} (object) required
ConnectionFunctionCode (string) required
Tags: {
. Items (array)
} (object)
cloudfront/create_connection_groupCreates a connection group.Name (string) required
Ipv6Enabled (boolean)
Tags: {
. Items (array)
} (object)
AnycastIpListId (string)
Enabled (boolean)
cloudfront/create_continuous_deployment_policyCreates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions. To use a continuous deployment policy, first use CopyDistribution to create a staging distribution, then use UpdateDistribution to modify the staging distribution's configuration. After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to testContinuousDeploymentPolicyConfig: {
. StagingDistributionDnsNames (object)
. Enabled (boolean)
. TrafficConfig (object)
} (object) required
cloudfront/create_distributionCreates a CloudFront distribution.DistributionConfig: {
. CallerReference (string)
. Aliases (object)
. DefaultRootObject (string)
. Origins (object)
. OriginGroups (object)
. DefaultCacheBehavior (object)
. CacheBehaviors (object)
. CustomErrorResponses (object)
. Comment (string)
. Logging (object)
. PriceClass (string)
. Enabled (boolean)
. ViewerCertificate (object)
. Restrictions (object)
. WebACLId (string)
. HttpVersion (string)
. IsIPV6Enabled (boolean)
. ContinuousDeploymentPolicyId (string)
. Staging (boolean)
. AnycastIpListId (string)
. TenantConfig (object)
. ConnectionMode (string)
. ViewerMtlsConfig (object)
. ConnectionFunctionAssociation (object)
} (object) required
cloudfront/create_distribution_tenantCreates a distribution tenant.DistributionId (string) required
Name (string) required
Domains (array) required
Tags: {
. Items (array)
} (object)
Customizations: {
. WebAcl (object)
. Certificate (object)
. GeoRestrictions (object)
} (object)
Parameters (array)
ConnectionGroupId (string)
ManagedCertificateRequest: {
. ValidationTokenHost (string)
. PrimaryDomainName (string)
. CertificateTransparencyLoggingPreference (string)
} (object)
Enabled (boolean)
cloudfront/create_distribution_with_tagsCreate a new distribution with tags. This API operation requires the following IAM permissions: CreateDistribution TagResourceDistributionConfigWithTags: {
. DistributionConfig (object)
. Tags (object)
} (object) required
cloudfront/create_field_level_encryption_configCreate a new field-level encryption configuration.FieldLevelEncryptionConfig: {
. CallerReference (string)
. Comment (string)
. QueryArgProfileConfig (object)
. ContentTypeProfileConfig (object)
} (object) required
cloudfront/create_field_level_encryption_profileCreate a field-level encryption profile.FieldLevelEncryptionProfileConfig: {
. Name (string)
. CallerReference (string)
. Comment (string)
. EncryptionEntities (object)
} (object) required
cloudfront/create_functionCreates 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 thName (string) required
FunctionConfig: {
. Comment (string)
. Runtime (string)
. KeyValueStoreAssociations (object)
} (object) required
FunctionCode (string) required
cloudfront/create_invalidationCreate a new invalidation. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.DistributionId (string) required
InvalidationBatch: {
. Paths (object)
. CallerReference (string)
} (object) required
cloudfront/create_invalidation_for_distribution_tenantCreates an invalidation for a distribution tenant. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.Id (string) required
InvalidationBatch: {
. Paths (object)
. CallerReference (string)
} (object) required
cloudfront/create_key_groupCreates 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 keKeyGroupConfig: {
. Name (string)
. Items (array)
. Comment (string)
} (object) required
cloudfront/create_key_value_storeSpecifies the key value store resource to add to your account. In your account, the key value store names must be unique. You can also import key value store data in JSON format from an S3 bucket by providing a valid ImportSource that you own.Name (string) required
Comment (string)
ImportSource: {
. SourceType (string)
. SourceARN (string)
} (object)
cloudfront/create_monitoring_subscriptionEnables or disables additional Amazon 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.DistributionId (string) required
MonitoringSubscription: {
. RealtimeMetricsSubscriptionConfig (object)
} (object) required
cloudfront/create_origin_access_controlCreates 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. This makes it possible to block public access to the origin, allowing viewers users to access the origin's content only through CloudFront. For more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services origin in the AmazonOriginAccessControlConfig: {
. Name (string)
. Description (string)
. SigningProtocol (string)
. SigningBehavior (string)
. OriginAccessControlOriginType (string)
} (object) required
cloudfront/create_origin_request_policyCreates 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 oriOriginRequestPolicyConfig: {
. Comment (string)
. Name (string)
. HeadersConfig (object)
. CookiesConfig (object)
. QueryStringsConfig (object)
} (object) required
cloudfront/create_public_keyUploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.PublicKeyConfig: {
. CallerReference (string)
. Name (string)
. EncodedKey (string)
. Comment (string)
} (object) required
cloudfront/create_realtime_log_configCreates 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.EndPoints (array) required
Fields (array) required
Name (string) required
SamplingRate (integer) required
cloudfront/create_response_headers_policyCreates a response headers policy. A response headers policy contains information about a set of HTTP headers. To create a response headers policy, you provide some metadata about the policy and a set of configurations that specify the 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, the response headers policy affects the HTTP headers that CloudFront includesResponseHeadersPolicyConfig: {
. Comment (string)
. Name (string)
. CorsConfig (object)
. SecurityHeadersConfig (object)
. ServerTimingHeadersConfig (object)
. CustomHeadersConfig (object)
. RemoveHeadersConfig (object)
} (object) required
cloudfront/create_streaming_distributionThis 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.StreamingDistributionConfig: {
. CallerReference (string)
. S3Origin (object)
. Aliases (object)
. Comment (string)
. Logging (object)
. TrustedSigners (object)
. PriceClass (string)
. Enabled (boolean)
} (object) required
cloudfront/create_streaming_distribution_with_tagsThis 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.StreamingDistributionConfigWithTags: {
. StreamingDistributionConfig (object)
. Tags (object)
} (object) required
cloudfront/create_trust_storeCreates a trust store.Name (string) required
CaCertificatesBundleSource (undefined) required
Tags: {
. Items (array)
} (object)
cloudfront/create_vpc_originCreate an Amazon CloudFront VPC origin.VpcOriginEndpointConfig: {
. Name (string)
. Arn (string)
. HTTPPort (integer)
. HTTPSPort (integer)
. OriginProtocolPolicy (string)
. OriginSslProtocols (object)
} (object) required
Tags: {
. Items (array)
} (object)
cloudfront/delete_anycast_ip_listDeletes an Anycast static IP list.Id (string) required
IfMatch (string) required
cloudfront/delete_cache_policyDeletes 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.Id (string) required
IfMatch (string)
cloudfront/delete_cloud_front_origin_access_identityDelete an origin access identity.Id (string) required
IfMatch (string)
cloudfront/delete_connection_functionDeletes a connection function.Id (string) required
IfMatch (string) required
cloudfront/delete_connection_groupDeletes a connection group.Id (string) required
IfMatch (string) required
cloudfront/delete_continuous_deployment_policyDeletes a continuous deployment policy. You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy.Id (string) required
IfMatch (string)
cloudfront/delete_distributionDelete a distribution. Before you can delete a distribution, you must disable it, which requires permission to update the distribution. Once deleted, a distribution cannot be recovered.Id (string) required
IfMatch (string)
cloudfront/delete_distribution_tenantDeletes a distribution tenant. If you use this API operation to delete a distribution tenant that is currently enabled, the request will fail. To delete a distribution tenant, you must first disable the distribution tenant by using the UpdateDistributionTenant API operation.Id (string) required
IfMatch (string) required
cloudfront/delete_field_level_encryption_configRemove a field-level encryption configuration.Id (string) required
IfMatch (string)
cloudfront/delete_field_level_encryption_profileRemove a field-level encryption profile.Id (string) required
IfMatch (string)
cloudfront/delete_functionDeletes 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.Name (string) required
IfMatch (string) required
cloudfront/delete_key_groupDeletes 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.Id (string) required
IfMatch (string)
cloudfront/delete_key_value_storeSpecifies the key value store to delete.Name (string) required
IfMatch (string) required
cloudfront/delete_monitoring_subscriptionDisables additional CloudWatch metrics for the specified CloudFront distribution.DistributionId (string) required
cloudfront/delete_origin_access_controlDeletes 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.Id (string) required
IfMatch (string)
cloudfront/delete_origin_request_policyDeletes 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.Id (string) required
IfMatch (string)
cloudfront/delete_public_keyRemove a public key you previously added to CloudFront.Id (string) required
IfMatch (string)
cloudfront/delete_realtime_log_configDeletes 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 configurName (string)
ARN (string)
cloudfront/delete_resource_policyDeletes the resource policy attached to the CloudFront resource.ResourceArn (string) required
cloudfront/delete_response_headers_policyDeletes 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.Id (string) required
IfMatch (string)
cloudfront/delete_streaming_distributionDelete 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 StreaId (string) required
IfMatch (string)
cloudfront/delete_trust_storeDeletes a trust store.Id (string) required
IfMatch (string) required
cloudfront/delete_vpc_originDelete an Amazon CloudFront VPC origin.Id (string) required
IfMatch (string) required
cloudfront/describe_connection_functionDescribes a connection function.Identifier (string) required
Stage (string)
cloudfront/describe_functionGets 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.Name (string) required
Stage (string)
cloudfront/describe_key_value_storeSpecifies the key value store and its configuration.Name (string) required
cloudfront/disassociate_distribution_tenant_web_aclDisassociates a distribution tenant from the WAF web ACL.Id (string) required
IfMatch (string)
cloudfront/disassociate_distribution_web_aclDisassociates a distribution from the WAF web ACL.Id (string) required
IfMatch (string)
cloudfront/get_anycast_ip_listGets an Anycast static IP list.Id (string) required
cloudfront/get_cache_policyGets 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.Id (string) required
cloudfront/get_cache_policy_configGets 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.Id (string) required
cloudfront/get_cloud_front_origin_access_identityGet the information about an origin access identity.Id (string) required
cloudfront/get_cloud_front_origin_access_identity_configGet the configuration information about an origin access identity.Id (string) required
cloudfront/get_connection_functionGets a connection function.Identifier (string) required
Stage (string)
cloudfront/get_connection_groupGets information about a connection group.Identifier (string) required
cloudfront/get_connection_group_by_routing_endpointGets information about a connection group by using the endpoint that you specify.RoutingEndpoint (string) required
cloudfront/get_continuous_deployment_policyGets a continuous deployment policy, including metadata the policy's identifier and the date and time when the policy was last modified.Id (string) required
cloudfront/get_continuous_deployment_policy_configGets configuration information about a continuous deployment policy.Id (string) required
cloudfront/get_distributionGet the information about a distribution.Id (string) required
cloudfront/get_distribution_configGet the configuration information about a distribution.Id (string) required
cloudfront/get_distribution_tenantGets information about a distribution tenant.Identifier (string) required
cloudfront/get_distribution_tenant_by_domainGets information about a distribution tenant by the associated domain.Domain (string) required
cloudfront/get_field_level_encryptionGet the field-level encryption configuration information.Id (string) required
cloudfront/get_field_level_encryption_configGet the field-level encryption configuration information.Id (string) required
cloudfront/get_field_level_encryption_profileGet the field-level encryption profile information.Id (string) required
cloudfront/get_field_level_encryption_profile_configGet the field-level encryption profile configuration information.Id (string) required
cloudfront/get_functionGets 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.Name (string) required
Stage (string)
cloudfront/get_invalidationGet the information about an invalidation.DistributionId (string) required
Id (string) required
cloudfront/get_invalidation_for_distribution_tenantGets information about a specific invalidation for a distribution tenant.DistributionTenantId (string) required
Id (string) required
cloudfront/get_key_groupGets 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.Id (string) required
cloudfront/get_key_group_configGets 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.Id (string) required
cloudfront/get_managed_certificate_detailsGets details about the CloudFront managed ACM certificate.Identifier (string) required
cloudfront/get_monitoring_subscriptionGets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.DistributionId (string) required
cloudfront/get_origin_access_controlGets a CloudFront origin access control, including its unique identifier.Id (string) required
cloudfront/get_origin_access_control_configGets a CloudFront origin access control configuration.Id (string) required
cloudfront/get_origin_request_policyGets 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.Id (string) required
cloudfront/get_origin_request_policy_configGets 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.Id (string) required
cloudfront/get_public_keyGets a public key.Id (string) required
cloudfront/get_public_key_configGets a public key configuration.Id (string) required
cloudfront/get_realtime_log_configGets 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.Name (string)
ARN (string)
cloudfront/get_resource_policyRetrieves the resource policy for the specified CloudFront resource that you own and have shared.ResourceArn (string) required
cloudfront/get_response_headers_policyGets 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.Id (string) required
cloudfront/get_response_headers_policy_configGets 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.Id (string) required
cloudfront/get_streaming_distributionGets information about a specified RTMP distribution, including the distribution configuration.Id (string) required
cloudfront/get_streaming_distribution_configGet the configuration information about a streaming distribution.Id (string) required
cloudfront/get_trust_storeGets a trust store.Identifier (string) required
cloudfront/get_vpc_originGet the details of an Amazon CloudFront VPC origin.Id (string) required
cloudfront/list_anycast_ip_listsLists your Anycast static IP lists.Marker (string)
MaxItems (integer)
cloudfront/list_cache_policiesGets 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 NextMType (string)
Marker (string)
MaxItems (integer)
cloudfront/list_cloud_front_origin_access_identitiesLists origin access identities.Marker (string)
MaxItems (integer)
cloudfront/list_conflicting_aliasesThe ListConflictingAliases API operation only supports standard distributions. To list domain conflicts for both standard distributions and distribution tenants, we recommend that you use the ListDomainConflicts API operation instead. Gets a list of aliases that conflict or overlap with the provided alias, and the associated CloudFront standard distribution and Amazon Web Services accounts for each conflicting alias. An alias is commonly known as a custom domain or vanity domain. It can also beDistributionId (string) required
Alias (string) required
Marker (string)
MaxItems (integer)
cloudfront/list_connection_functionsLists connection functions.Marker (string)
MaxItems (integer)
Stage (string)
cloudfront/list_connection_groupsLists the connection groups in your Amazon Web Services account.AssociationFilter: {
. AnycastIpListId (string)
} (object)
Marker (string)
MaxItems (integer)
cloudfront/list_continuous_deployment_policiesGets a list of the continuous deployment policies 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.Marker (string)
MaxItems (integer)
cloudfront/list_distributionsList CloudFront distributions.Marker (string)
MaxItems (integer)
cloudfront/list_distributions_by_anycast_ip_list_idLists the distributions in your account that are associated with the specified AnycastIpListId.Marker (string)
MaxItems (integer)
AnycastIpListId (string) required
cloudfront/list_distributions_by_cache_policy_idGets 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 reMarker (string)
MaxItems (integer)
CachePolicyId (string) required
cloudfront/list_distributions_by_connection_functionLists distributions by connection function.Marker (string)
MaxItems (integer)
ConnectionFunctionIdentifier (string) required
cloudfront/list_distributions_by_connection_modeLists the distributions by the connection mode that you specify.Marker (string)
MaxItems (integer)
ConnectionMode (string) required
cloudfront/list_distributions_by_key_groupGets 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.Marker (string)
MaxItems (integer)
KeyGroupId (string) required
cloudfront/list_distributions_by_origin_request_policy_idGets 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 subsMarker (string)
MaxItems (integer)
OriginRequestPolicyId (string) required
cloudfront/list_distributions_by_owned_resourceLists the CloudFront distributions that are associated with the specified resource that you own.ResourceArn (string) required
Marker (string)
MaxItems (integer)
cloudfront/list_distributions_by_realtime_log_configGets 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 mMarker (string)
MaxItems (integer)
RealtimeLogConfigName (string)
RealtimeLogConfigArn (string)
cloudfront/list_distributions_by_response_headers_policy_idGets 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 suMarker (string)
MaxItems (integer)
ResponseHeadersPolicyId (string) required
cloudfront/list_distributions_by_trust_storeLists distributions by trust store.TrustStoreIdentifier (string) required
Marker (string)
MaxItems (integer)
cloudfront/list_distributions_by_vpc_origin_idList CloudFront distributions by their VPC origin ID.Marker (string)
MaxItems (integer)
VpcOriginId (string) required
cloudfront/list_distributions_by_web_aclidList the distributions that are associated with a specified WAF web ACL.Marker (string)
MaxItems (integer)
WebACLId (string) required
cloudfront/list_distribution_tenantsLists the distribution tenants in your Amazon Web Services account.AssociationFilter: {
. DistributionId (string)
. ConnectionGroupId (string)
} (object)
Marker (string)
MaxItems (integer)
cloudfront/list_distribution_tenants_by_customizationLists distribution tenants by the customization that you specify. You must specify either the CertificateArn parameter or WebACLArn parameter, but not both in the same request.WebACLArn (string)
CertificateArn (string)
Marker (string)
MaxItems (integer)
cloudfront/list_domain_conflictsWe recommend that you use the ListDomainConflicts API operation to check for domain conflicts, as it supports both standard distributions and distribution tenants. ListConflictingAliases performs similar checks but only supports standard distributions. Lists existing domain associations that conflict with the domain that you specify. You can use this API operation to identify potential domain conflicts when moving domains between standard distributions and/or distribution tenants. Domain conflicDomain (string) required
DomainControlValidationResource: {
. DistributionId (string)
. DistributionTenantId (string)
} (object) required
MaxItems (integer)
Marker (string)
cloudfront/list_field_level_encryption_configsList all field-level encryption configurations that have been created in CloudFront for this account.Marker (string)
MaxItems (integer)
cloudfront/list_field_level_encryption_profilesRequest a list of field-level encryption profiles that have been created in CloudFront for this account.Marker (string)
MaxItems (integer)
cloudfront/list_functionsGets 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 NextMarkerMarker (string)
MaxItems (integer)
Stage (string)
cloudfront/list_invalidationsLists invalidation batches.DistributionId (string) required
Marker (string)
MaxItems (integer)
cloudfront/list_invalidations_for_distribution_tenantLists the invalidations for a distribution tenant.Id (string) required
Marker (string)
MaxItems (integer)
cloudfront/list_key_groupsGets 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.Marker (string)
MaxItems (integer)
cloudfront/list_key_value_storesSpecifies the key value stores to list.Marker (string)
MaxItems (integer)
Status (string)
cloudfront/list_origin_access_controlsGets the list of CloudFront origin access controls OACs 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. If you're not using origin access contrMarker (string)
MaxItems (integer)
cloudfront/list_origin_request_policiesGets 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 specifiesType (string)
Marker (string)
MaxItems (integer)
cloudfront/list_public_keysList all public keys that have been added to CloudFront for this account.Marker (string)
MaxItems (integer)
cloudfront/list_realtime_log_configsGets 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.MaxItems (integer)
Marker (string)
cloudfront/list_response_headers_policiesGets 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 tType (string)
Marker (string)
MaxItems (integer)
cloudfront/list_streaming_distributionsList streaming distributions.Marker (string)
MaxItems (integer)
cloudfront/list_tags_for_resourceList tags for a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.Resource (string) required
cloudfront/list_trust_storesLists trust stores.Marker (string)
MaxItems (integer)
cloudfront/list_vpc_originsList the CloudFront VPC origins in your account.Marker (string)
MaxItems (integer)
cloudfront/publish_connection_functionPublishes a connection function.Id (string) required
IfMatch (string) required
cloudfront/publish_functionPublishes 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 useName (string) required
IfMatch (string) required
cloudfront/put_resource_policyCreates a resource control policy for a given CloudFront resource.ResourceArn (string) required
PolicyDocument (string) required
cloudfront/tag_resourceAdd tags to a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.Resource (string) required
Tags: {
. Items (array)
} (object) required
cloudfront/test_connection_functionTests a connection function.Id (string) required
IfMatch (string) required
Stage (string)
ConnectionObject (string) required
cloudfront/test_functionTests 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 CloudName (string) required
IfMatch (string) required
Stage (string)
EventObject (string) required
cloudfront/untag_resourceRemove tags from a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.Resource (string) required
TagKeys: {
. Items (array)
} (object) required
cloudfront/update_anycast_ip_listUpdates an Anycast static IP list.Id (string) required
IpAddressType (string)
IfMatch (string) required
cloudfront/update_cache_policyUpdates 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 modifiCachePolicyConfig: {
. Comment (string)
. Name (string)
. DefaultTTL (integer)
. MaxTTL (integer)
. MinTTL (integer)
. ParametersInCacheKeyAndForwardedToOrigin (object)
} (object) required
Id (string) required
IfMatch (string)
cloudfront/update_cloud_front_origin_access_identityUpdate an origin access identity.CloudFrontOriginAccessIdentityConfig: {
. CallerReference (string)
. Comment (string)
} (object) required
Id (string) required
IfMatch (string)
cloudfront/update_connection_functionUpdates a connection function.Id (string) required
IfMatch (string) required
ConnectionFunctionConfig: {
. Comment (string)
. Runtime (string)
. KeyValueStoreAssociations (object)
} (object) required
ConnectionFunctionCode (string) required
cloudfront/update_connection_groupUpdates a connection group.Id (string) required
Ipv6Enabled (boolean)
IfMatch (string) required
AnycastIpListId (string)
Enabled (boolean)
cloudfront/update_continuous_deployment_policyUpdates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to. When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configurationContinuousDeploymentPolicyConfig: {
. StagingDistributionDnsNames (object)
. Enabled (boolean)
. TrafficConfig (object)
} (object) required
Id (string) required
IfMatch (string)
cloudfront/update_distributionUpdates the configuration for a CloudFront distribution. The update process includes getting the current distribution configuration, updating it to make your changes, and then submitting an UpdateDistribution request to make the updates. To update a web distribution using the CloudFront API Use GetDistributionConfig to get the current configuration, including the version identifier ETag. Update the distribution configuration that was returned in the response. Note the following important requireDistributionConfig: {
. CallerReference (string)
. Aliases (object)
. DefaultRootObject (string)
. Origins (object)
. OriginGroups (object)
. DefaultCacheBehavior (object)
. CacheBehaviors (object)
. CustomErrorResponses (object)
. Comment (string)
. Logging (object)
. PriceClass (string)
. Enabled (boolean)
. ViewerCertificate (object)
. Restrictions (object)
. WebACLId (string)
. HttpVersion (string)
. IsIPV6Enabled (boolean)
. ContinuousDeploymentPolicyId (string)
. Staging (boolean)
. AnycastIpListId (string)
. TenantConfig (object)
. ConnectionMode (string)
. ViewerMtlsConfig (object)
. ConnectionFunctionAssociation (object)
} (object) required
Id (string) required
IfMatch (string)
cloudfront/update_distribution_tenantUpdates a distribution tenant.Id (string) required
DistributionId (string)
Domains (array)
Customizations: {
. WebAcl (object)
. Certificate (object)
. GeoRestrictions (object)
} (object)
Parameters (array)
ConnectionGroupId (string)
IfMatch (string) required
ManagedCertificateRequest: {
. ValidationTokenHost (string)
. PrimaryDomainName (string)
. CertificateTransparencyLoggingPreference (string)
} (object)
Enabled (boolean)
cloudfront/update_distribution_with_staging_configCopies the staging distribution's configuration to its corresponding primary distribution. The primary distribution retains its Aliases also known as alternate domain names or CNAMEs and ContinuousDeploymentPolicyId value, but otherwise its configuration is overwritten to match the staging distribution. You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portioId (string) required
StagingDistributionId (string)
IfMatch (string)
cloudfront/update_domain_associationWe recommend that you use the UpdateDomainAssociation API operation to move a domain association, as it supports both standard distributions and distribution tenants. AssociateAlias performs similar checks but only supports standard distributions. Moves a domain from its current standard distribution or distribution tenant to another one. You must first disable the source distribution standard distribution or distribution tenant and then separately call this operation to move the domain to anothDomain (string) required
TargetResource: {
. DistributionId (string)
. DistributionTenantId (string)
} (object) required
IfMatch (string)
cloudfront/update_field_level_encryption_configUpdate a field-level encryption configuration.FieldLevelEncryptionConfig: {
. CallerReference (string)
. Comment (string)
. QueryArgProfileConfig (object)
. ContentTypeProfileConfig (object)
} (object) required
Id (string) required
IfMatch (string)
cloudfront/update_field_level_encryption_profileUpdate a field-level encryption profile.FieldLevelEncryptionProfileConfig: {
. Name (string)
. CallerReference (string)
. Comment (string)
. EncryptionEntities (object)
} (object) required
Id (string) required
IfMatch (string)
cloudfront/update_functionUpdates 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.Name (string) required
IfMatch (string) required
FunctionConfig: {
. Comment (string)
. Runtime (string)
. KeyValueStoreAssociations (object)
} (object) required
FunctionCode (string) required
cloudfront/update_key_groupUpdates 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.KeyGroupConfig: {
. Name (string)
. Items (array)
. Comment (string)
} (object) required
Id (string) required
IfMatch (string)
cloudfront/update_key_value_storeSpecifies the key value store to update.Name (string) required
Comment (string) required
IfMatch (string) required
cloudfront/update_origin_access_controlUpdates a CloudFront origin access control.OriginAccessControlConfig: {
. Name (string)
. Description (string)
. SigningProtocol (string)
. SigningBehavior (string)
. OriginAccessControlOriginType (string)
} (object) required
Id (string) required
IfMatch (string)
cloudfront/update_origin_request_policyUpdates 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 reOriginRequestPolicyConfig: {
. Comment (string)
. Name (string)
. HeadersConfig (object)
. CookiesConfig (object)
. QueryStringsConfig (object)
} (object) required
Id (string) required
IfMatch (string)
cloudfront/update_public_keyUpdate public key information. Note that the only value you can change is the comment.PublicKeyConfig: {
. CallerReference (string)
. Name (string)
. EncodedKey (string)
. Comment (string)
} (object) required
Id (string) required
IfMatch (string)
cloudfront/update_realtime_log_configUpdates 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 confEndPoints (array)
Fields (array)
Name (string)
ARN (string)
SamplingRate (integer)
cloudfront/update_response_headers_policyUpdates 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 fieldsResponseHeadersPolicyConfig: {
. Comment (string)
. Name (string)
. CorsConfig (object)
. SecurityHeadersConfig (object)
. ServerTimingHeadersConfig (object)
. CustomHeadersConfig (object)
. RemoveHeadersConfig (object)
} (object) required
Id (string) required
IfMatch (string)
cloudfront/update_streaming_distributionUpdate a streaming distribution.StreamingDistributionConfig: {
. CallerReference (string)
. S3Origin (object)
. Aliases (object)
. Comment (string)
. Logging (object)
. TrustedSigners (object)
. PriceClass (string)
. Enabled (boolean)
} (object) required
Id (string) required
IfMatch (string)
cloudfront/update_trust_storeUpdates a trust store.Id (string) required
CaCertificatesBundleSource (undefined) required
IfMatch (string) required
cloudfront/update_vpc_originUpdate an Amazon CloudFront VPC origin in your account.VpcOriginEndpointConfig: {
. Name (string)
. Arn (string)
. HTTPPort (integer)
. HTTPSPort (integer)
. OriginProtocolPolicy (string)
. OriginSslProtocols (object)
} (object) required
Id (string) required
IfMatch (string) required
cloudfront/verify_dns_configurationVerify the DNS configuration for your domain names. This API operation checks whether your domain name points to the correct routing endpoint of the connection group, such as d111111abcdef8.cloudfront.net. You can use this API operation to troubleshoot and resolve DNS configuration issues.Domain (string)
Identifier (string) required
cloudhsm_v2/copy_backup_to_regionCopy an CloudHSM cluster backup to a different region. Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.DestinationRegion (string) required
BackupId (string) required
TagList (array)
cloudhsm_v2/create_clusterCreates a new CloudHSM cluster. Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup ARN in the value of the SourceBackupId parameter.BackupRetentionPolicy: {
. Type (string)
. Value (string)
} (object)
HsmType (string) required
SourceBackupId (string)
SubnetIds (array) required
NetworkType (string)
TagList (array)
Mode (string)
cloudhsm_v2/create_hsmCreates a new hardware security module HSM in the specified CloudHSM cluster. Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.ClusterId (string) required
AvailabilityZone (string) required
IpAddress (string)
cloudhsm_v2/delete_backupDeletes a specified 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. Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.BackupId (string) required
cloudhsm_v2/delete_clusterDeletes the specified 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. Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.ClusterId (string) required
cloudhsm_v2/delete_hsmDeletes 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. Cross-account use: No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.ClusterId (string) required
HsmId (string)
EniId (string)
EniIp (string)
cloudhsm_v2/delete_resource_policyDeletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that backup. Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.ResourceArn (string)
cloudhsm_v2/describe_backupsGets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true. 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, thatNextToken (string)
MaxResults (integer)
Filters (object)
Shared (boolean)
SortAscending (boolean)
cloudhsm_v2/describe_clustersGets information about 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. Cross-account use: No. You cannot perform this operation on CloudFilters (object)
NextToken (string)
MaxResults (integer)
cloudhsm_v2/get_resource_policyRetrieves the resource policy document attached to a given resource. Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.ResourceArn (string)
cloudhsm_v2/initialize_clusterClaims an 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. Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.ClusterId (string) required
SignedCert (string) required
TrustAnchor (string) required
cloudhsm_v2/list_tagsGets a list of tags for the specified 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. Cross-account use: No. You cannot perform this operation on an CloudHSM resResourceId (string) required
NextToken (string)
MaxResults (integer)
cloudhsm_v2/modify_backup_attributesModifies attributes for CloudHSM backup. Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.BackupId (string) required
NeverExpires (boolean) required
cloudhsm_v2/modify_clusterModifies CloudHSM cluster. Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.HsmType (string)
BackupRetentionPolicy: {
. Type (string)
. Value (string)
} (object)
ClusterId (string) required
cloudhsm_v2/put_resource_policyCreates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity for example, an Amazon Web Services account that can manage your CloudHSM resources. The following resources support CloudHSM resource policies: Backup - The resource policy allows you to describe the backup and restore a cluster from the backup in another Amazon Web Services account. In order to share a backup, it must be in a 'READY' state and you must own it. While you can share a backup usingResourceArn (string)
Policy (string)
cloudhsm_v2/restore_backupRestores a specified CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup. Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.BackupId (string) required
cloudhsm_v2/tag_resourceAdds or overwrites one or more tags for the specified CloudHSM cluster. Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.ResourceId (string) required
TagList (array) required
cloudhsm_v2/untag_resourceRemoves the specified tag or tags from the specified CloudHSM cluster. Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.ResourceId (string) required
TagKeyList (array) required
cloudhsm/add_tags_to_resourceThis 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.ResourceArn (string) required
TagList (array) required
cloudhsm/create_hapgThis 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.Label (string) required
cloudhsm/create_hsmThis 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 HSMSubnetId (string) required
SshKey (string) required
EniIp (string)
IamRoleArn (string) required
ExternalId (string)
SubscriptionType (string) required
ClientToken (string)
SyslogIp (string)
cloudhsm/create_luna_clientThis 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.Label (string)
Certificate (string) required
cloudhsm/delete_hapgThis 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.HapgArn (string) required
cloudhsm/delete_hsmThis 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.HsmArn (string) required
cloudhsm/delete_luna_clientThis 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.ClientArn (string) required
cloudhsm/describe_hapgThis 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.HapgArn (string) required
cloudhsm/describe_hsmThis 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.HsmArn (string)
HsmSerialNumber (string)
cloudhsm/describe_luna_clientThis 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.ClientArn (string)
CertificateFingerprint (string)
cloudhsm/get_configThis 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.ClientArn (string) required
ClientVersion (string) required
HapgList (array) required
cloudhsm/list_available_zonesThis 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.No parameters
cloudhsm/list_hapgsThis 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 NextToNextToken (string)
cloudhsm/list_hsmsThis 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 areNextToken (string)
cloudhsm/list_luna_clientsThis 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 containsNextToken (string)
cloudhsm/list_tags_for_resourceThis 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.ResourceArn (string) required
cloudhsm/modify_hapgThis 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.HapgArn (string) required
Label (string)
PartitionSerialList (array)
cloudhsm/modify_hsmThis 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,HsmArn (string) required
SubnetId (string)
EniIp (string)
IamRoleArn (string)
ExternalId (string)
SyslogIp (string)
cloudhsm/modify_luna_clientThis 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.ClientArn (string) required
Certificate (string) required
cloudhsm/remove_tags_from_resourceThis 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 tagResourceArn (string) required
TagKeyList (array) required
cloudsearch_domain/searchRetrieves 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 searcursor (string)
expr (string)
facet (string)
filterQuery (string)
highlight (string)
partial (boolean)
query (string) required
queryOptions (string)
queryParser (string)
return (string)
size (integer)
sort (string)
start (integer)
stats (string)
cloudsearch_domain/suggestRetrieves 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 aboutquery (string) required
suggester (string) required
size (integer)
cloudsearch_domain/upload_documentsPosts 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. Indivdocuments (string) required
contentType (string) required
cloudsearch/build_suggestersIndexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.DomainName (string) required
cloudsearch/create_domainCreates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.DomainName (string) required
cloudsearch/define_analysis_schemeConfigures 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.DomainName (string) required
AnalysisScheme: {
. AnalysisSchemeName (string)
. AnalysisSchemeLanguage (string)
. AnalysisOptions (object)
} (object) required
cloudsearch/define_expressionConfigures 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.DomainName (string) required
Expression: {
. ExpressionName (string)
. ExpressionValue (string)
} (object) required
cloudsearch/define_index_fieldConfigures 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 inDomainName (string) required
IndexField: {
. IndexFieldName (string)
. IndexFieldType (string)
. IntOptions (object)
. DoubleOptions (object)
. LiteralOptions (object)
. TextOptions (object)
. DateOptions (object)
. LatLonOptions (object)
. IntArrayOptions (object)
. DoubleArrayOptions (object)
. LiteralArrayOptions (object)
. TextArrayOptions (object)
. DateArrayOptions (object)
} (object) required
cloudsearch/define_suggesterConfigures 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.DomainName (string) required
Suggester: {
. SuggesterName (string)
. DocumentSuggesterOptions (object)
} (object) required
cloudsearch/delete_analysis_schemeDeletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.DomainName (string) required
AnalysisSchemeName (string) required
cloudsearch/delete_domainPermanently 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.DomainName (string) required
cloudsearch/delete_expressionRemoves an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.DomainName (string) required
ExpressionName (string) required
cloudsearch/delete_index_fieldRemoves an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.DomainName (string) required
IndexFieldName (string) required
cloudsearch/delete_suggesterDeletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.DomainName (string) required
SuggesterName (string) required
cloudsearch/describe_analysis_schemesGets 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.DomainName (string) required
AnalysisSchemeNames (array)
Deployed (boolean)
cloudsearch/describe_availability_optionsGets 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.DomainName (string) required
Deployed (boolean)
cloudsearch/describe_domain_endpoint_optionsReturns 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.DomainName (string) required
Deployed (boolean)
cloudsearch/describe_domainsGets 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 and q.parser=structured and size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.DomainNames (array)
cloudsearch/describe_expressionsGets 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.DomainName (string) required
ExpressionNames (array)
Deployed (boolean)
cloudsearch/describe_index_fieldsGets 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.DomainName (string) required
FieldNames (array)
Deployed (boolean)
cloudsearch/describe_scaling_parametersGets 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.DomainName (string) required
cloudsearch/describe_service_access_policiesGets 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.DomainName (string) required
Deployed (boolean)
cloudsearch/describe_suggestersGets 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.DomainName (string) required
SuggesterNames (array)
Deployed (boolean)
cloudsearch/index_documentsTells 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.DomainName (string) required
cloudsearch/list_domain_namesLists all search domains owned by an account.No parameters
cloudsearch/update_availability_optionsConfigures 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.DomainName (string) required
MultiAZ (boolean) required
cloudsearch/update_domain_endpoint_optionsUpdates 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.DomainName (string) required
DomainEndpointOptions: {
. EnforceHTTPS (boolean)
. TLSSecurityPolicy (string)
} (object) required
cloudsearch/update_scaling_parametersConfigures 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.DomainName (string) required
ScalingParameters: {
. DesiredInstanceType (string)
. DesiredReplicationCount (integer)
. DesiredPartitionCount (integer)
} (object) required
cloudsearch/update_service_access_policiesConfigures 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.DomainName (string) required
AccessPolicies (string) required
cloudtrail_data/put_audit_eventsIngests your application events into CloudTrail Lake. A required parameter, auditEvents, accepts the JSON records also called payload of events that you want CloudTrail to ingest. You can add up to 100 of these events or up to 1 MB per PutAuditEvents request.auditEvents (array) required
channelArn (string) required
externalId (string)
cloudtrail/add_tagsAdds one or more tags to a trail, event data store, dashboard, or channel, 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; 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 inResourceId (string) required
TagsList (array) required
cloudtrail/cancel_queryCancels 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.EventDataStore (string)
QueryId (string) required
EventDataStoreOwnerAccountId (string)
cloudtrail/create_channelCreates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.Name (string) required
Source (string) required
Destinations (array) required
Tags (array)
cloudtrail/create_dashboardCreates a custom dashboard or the Highlights dashboard. Custom dashboards - Custom dashboards allow you to query events in any event data store type. You can add up to 10 widgets to a custom dashboard. You can manually refresh a custom dashboard, or you can set a refresh schedule. Highlights dashboard - You can create the Highlights dashboard to see a summary of key user activities and API usage across all your event data stores. CloudTrail Lake manages the Highlights dashboard and refreshes theName (string) required
RefreshSchedule: {
. Frequency (object)
. Status (string)
. TimeOfDay (string)
} (object)
TagsList (array)
TerminationProtectionEnabled (boolean)
Widgets (array)
cloudtrail/create_event_data_storeCreates a new event data store.Name (string) required
AdvancedEventSelectors (array)
MultiRegionEnabled (boolean)
OrganizationEnabled (boolean)
RetentionPeriod (integer)
TerminationProtectionEnabled (boolean)
TagsList (array)
KmsKeyId (string)
StartIngestion (boolean)
BillingMode (string)
cloudtrail/create_trailCreates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.Name (string) required
S3BucketName (string) required
S3KeyPrefix (string)
SnsTopicName (string)
IncludeGlobalServiceEvents (boolean)
IsMultiRegionTrail (boolean)
EnableLogFileValidation (boolean)
CloudWatchLogsLogGroupArn (string)
CloudWatchLogsRoleArn (string)
KmsKeyId (string)
IsOrganizationTrail (boolean)
TagsList (array)
cloudtrail/delete_channelDeletes a channel.Channel (string) required
cloudtrail/delete_dashboardDeletes the specified dashboard. You cannot delete a dashboard that has termination protection enabled.DashboardId (string) required
cloudtrail/delete_event_data_storeDisables 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 and the FederationStatus must be DISABLED. You cannot delete an event data store if TerminationProtectionEnabled is True or the FederationStatus is ENABLED. After you run DelEventDataStore (string) required
cloudtrail/delete_resource_policyDeletes the resource-based policy attached to the CloudTrail event data store, dashboard, or channel.ResourceArn (string) required
cloudtrail/delete_trailDeletes 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. While deleting a CloudTrail trail is an irreversible action, CloudTrail does not delete log files in the Amazon S3 bucket for that trail, the Amazon S3 bucket itself, or the CloudWatchlog group to which the trail delivers events. Deleting a multi-Region trail will stop loggingName (string) required
cloudtrail/deregister_organization_delegated_adminRemoves CloudTrail delegated administrator permissions from a member account in an organization.DelegatedAdminAccountId (string) required
cloudtrail/describe_queryReturns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status. You must specify either QueryId or QueryAlias. Specifying the QueryAlias parameter returns information about the last query run for the alias. You can provide RefreshId along with QueryAlias to view the query results of a dashboard query for the specifieEventDataStore (string)
QueryId (string)
QueryAlias (string)
RefreshId (string)
EventDataStoreOwnerAccountId (string)
cloudtrail/describe_trailsRetrieves settings for one or more trails associated with the current Region for your account.trailNameList (array)
includeShadowTrails (boolean)
cloudtrail/disable_federationDisables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables the integration with Glue, Lake Formation, and Amazon Athena. After disabling Lake query federation, you can no longer query your event data in Amazon Athena. No CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake.EventDataStore (string) required
cloudtrail/enable_federationEnables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue Data Catalog and run SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query. When you enable Lake query federation, CloudTrail creates a managed database named aws:cloudtrail ifEventDataStore (string) required
FederationRoleArn (string) required
cloudtrail/generate_queryGenerates a query from a natural language prompt. This operation uses generative artificial intelligence generative AI to produce a ready-to-use SQL query from the prompt. The prompt can be a question or a statement about the event data in your event data store. For example, you can enter prompts like 'What are my top errors in the past month?' and “Give me a list of users that used SNS.” The prompt must be in English. For information about limitations, permissions, and supported Regions, see CrEventDataStores (array) required
Prompt (string) required
cloudtrail/get_channelReturns information about a specific channel.Channel (string) required
cloudtrail/get_dashboardReturns the specified dashboard.DashboardId (string) required
cloudtrail/get_event_configurationRetrieves the current event configuration settings for the specified event data store or trail. The response includes maximum event size configuration, the context key selectors configured for the event data store, and any aggregation settings configured for the trail.TrailName (string)
EventDataStore (string)
cloudtrail/get_event_data_storeReturns information about an event data store specified as either an ARN or the ID portion of the ARN.EventDataStore (string) required
cloudtrail/get_event_selectorsDescribes 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 management events, data events, and network activity events. If your event selector includes management events. If your event selector includes network activity events, the event sources for which you are logging network activity events. If yoTrailName (string) required
cloudtrail/get_importReturns information about a specific import.ImportId (string) required
cloudtrail/get_insight_selectorsDescribes the settings for the Insights event selectors that you configured for your trail or event data store. GetInsightSelectors shows if CloudTrail Insights logging is enabled and which Insights types are configured with corresponding event categories. If you run GetInsightSelectors on a trail or event data store that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException Specify either the EventDataStore parameter to get Insights event selectorsTrailName (string)
EventDataStore (string)
cloudtrail/get_query_resultsGets event data results of a query. You must specify the QueryID value returned by the StartQuery operation.EventDataStore (string)
QueryId (string) required
NextToken (string)
MaxQueryResults (integer)
EventDataStoreOwnerAccountId (string)
cloudtrail/get_resource_policyRetrieves the JSON text of the resource-based policy document attached to the CloudTrail event data store, dashboard, or channel.ResourceArn (string) required
cloudtrail/get_trailReturns settings information for a specified trail.Name (string) required
cloudtrail/get_trail_statusReturns 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.Name (string) required
cloudtrail/list_channelsLists the channels in the current account, and their source names.MaxResults (integer)
NextToken (string)
cloudtrail/list_dashboardsReturns information about all dashboards in the account, in the current Region.NamePrefix (string)
Type (string)
NextToken (string)
MaxResults (integer)
cloudtrail/list_event_data_storesReturns information about all event data stores in the account, in the current Region.NextToken (string)
MaxResults (integer)
cloudtrail/list_import_failuresReturns a list of failures for the specified import.ImportId (string) required
MaxResults (integer)
NextToken (string)
cloudtrail/list_importsReturns information on all imports, or a select set of imports by ImportStatus or Destination.MaxResults (integer)
Destination (string)
ImportStatus (string)
NextToken (string)
cloudtrail/list_insights_dataReturns Insights events generated on a trail that logs data events. You can list Insights events that occurred in a Region within the last 90 days. ListInsightsData supports the following Dimensions for Insights events: Event ID Event name Event source All dimensions 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 ListInsightsData requests is limited to two per sInsightSource (string) required
DataType (string) required
Dimensions (object)
StartTime (string)
EndTime (string)
MaxResults (integer)
NextToken (string)
cloudtrail/list_insights_metric_dataReturns Insights metrics data for trails that have enabled Insights. The request must include the EventSource, EventName, and InsightType parameters. If the InsightType is set to ApiErrorRateInsight, the request must also include the ErrorCode parameter. The following are the available time periods for ListInsightsMetricData. Each cutoff is inclusive. 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 63TrailName (string)
EventSource (string) required
EventName (string) required
InsightType (string) required
ErrorCode (string)
StartTime (string)
EndTime (string)
Period (integer)
DataType (string)
MaxResults (integer)
NextToken (string)
cloudtrail/list_public_keysReturns 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.StartTime (string)
EndTime (string)
NextToken (string)
cloudtrail/list_queriesReturns 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.EventDataStore (string) required
NextToken (string)
MaxResults (integer)
StartTime (string)
EndTime (string)
QueryStatus (string)
cloudtrail/list_tagsLists the tags for the specified trails, event data stores, dashboards, or channels in the current Region.ResourceIdList (array) required
NextToken (string)
cloudtrail/list_trailsLists trails that are in the current account.NextToken (string)
cloudtrail/lookup_eventsLooks 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. LookupEvents returns recent Insights events for trails that enable Insights. To view Insights events for an event data store, you can run queries on your Insights event data store, and you can also view the Lake dashboard for Insights. Lookup supports the following attributes for management events: Amazon Web Services access key EventLookupAttributes (array)
StartTime (string)
EndTime (string)
EventCategory (string)
MaxResults (integer)
NextToken (string)
cloudtrail/put_event_configurationUpdates the event configuration settings for the specified event data store or trail. This operation supports updating the maximum event size, adding or modifying context key selectors for event data store, and configuring aggregation settings for the trail.TrailName (string)
EventDataStore (string)
MaxEventSize (string)
ContextKeySelectors (array)
AggregationConfigurations (array)
cloudtrail/put_event_selectorsConfigures event selectors also referred to as basic event selectors or advanced event selectors for your trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. You can use AdvancedEventSelectors to log management events, data events for all resource types, and network activity events. You can use EventSelectors to log management events and data events for the following resourcTrailName (string) required
EventSelectors (array)
AdvancedEventSelectors (array)
cloudtrail/put_insight_selectorsLets you enable Insights event logging on specific event categories by specifying the Insights selectors that you want to enable on an existing trail or event data store. You also use PutInsightSelectors to turn off Insights event logging, by passing an empty list of Insights types. The valid Insights event types are ApiErrorRateInsight and ApiCallRateInsight, and valid EventCategories are Management and Data. Insights on data events are not supported on event data stores. For event data stores,TrailName (string)
InsightSelectors (array) required
EventDataStore (string)
InsightsDestination (string)
cloudtrail/put_resource_policyAttaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.ResourceArn (string) required
ResourcePolicy (string) required
cloudtrail/register_organization_delegated_adminRegisters an organization’s member account as the CloudTrail delegated administrator.MemberAccountId (string) required
cloudtrail/remove_tagsRemoves the specified tags from a trail, event data store, dashboard, or channel.ResourceId (string) required
TagsList (array) required
cloudtrail/restore_event_data_storeRestores 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.EventDataStore (string) required
cloudtrail/search_sample_queriesSearches sample queries and returns a list of sample queries that are sorted by relevance. To search for sample queries, provide a natural language SearchPhrase in English.SearchPhrase (string) required
MaxResults (integer)
NextToken (string)
cloudtrail/start_dashboard_refreshStarts a refresh of the specified dashboard. Each time a dashboard is refreshed, CloudTrail runs queries to populate the dashboard's widgets. CloudTrail must be granted permissions to run the StartQuery operation on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to each event data store. For more information, see Example: Allow CloudTrail to run queries to populate a dashboard in the CloudTrail User Guide.DashboardId (string) required
QueryParameterValues (object)
cloudtrail/start_event_data_store_ingestionStarts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store Status must be STOPPED_INGESTION and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.EventDataStore (string) required
cloudtrail/start_importStarts an import of logged trail events from a source S3 bucket to a destination event data store. By default, CloudTrail only imports events contained in the S3 bucket's CloudTrail prefix and the prefixes inside the CloudTrail prefix, and does not check prefixes for other Amazon Web Services services. If you want to import CloudTrail events contained in another prefix, you must include the prefix in the S3LocationUri. For more considerations about importing trail events, see Considerations forDestinations (array)
ImportSource: {
. S3 (object)
} (object)
StartEventTime (string)
EndEventTime (string)
ImportId (string)
cloudtrail/start_loggingStarts 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.Name (string) required
cloudtrail/start_queryStarts a CloudTrail Lake query. Use the QueryStatement parameter to provide your SQL query, enclosed in single quotation marks. Use the optional DeliveryS3Uri parameter to deliver the query results to an S3 bucket. StartQuery requires you specify either the QueryStatement parameter, or a QueryAlias and any QueryParameters. In the current release, the QueryAlias and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake dashboards.QueryStatement (string)
DeliveryS3Uri (string)
QueryAlias (string)
QueryParameters (array)
EventDataStoreOwnerAccountId (string)
cloudtrail/stop_event_data_store_ingestionStops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store Status must be ENABLED and the eventCategory must be Management, Data, NetworkActivity, or ConfigurationItem.EventDataStore (string) required
cloudtrail/stop_importStops a specified import.ImportId (string) required
cloudtrail/stop_loggingSuspends 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 otheName (string) required
cloudtrail/update_channelUpdates a channel specified by a required channel ARN or UUID.Channel (string) required
Destinations (array)
Name (string)
cloudtrail/update_dashboardUpdates the specified dashboard. To set a refresh schedule, CloudTrail must be granted permissions to run the StartDashboardRefresh operation to refresh the dashboard on your behalf. To provide permissions, run the PutResourcePolicy operation to attach a resource-based policy to the dashboard. For more information, see Resource-based policy example for a dashboard in the CloudTrail User Guide. CloudTrail runs queries to populate the dashboard's widgets during a manual or scheduled refresh. CloudDashboardId (string) required
Widgets (array)
RefreshSchedule: {
. Frequency (object)
. Status (string)
. TimeOfDay (string)
} (object)
TerminationProtectionEnabled (boolean)
cloudtrail/update_event_data_storeUpdates 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 7 and 3653 if the BillingMode is set to EXTENDABLE_RETENTION_PRICING, or between 7 and 2557 if BillingMode is set to FIXED_RETENTION_PRICING. By default, TerminationProtection is enabled. For event data stores forEventDataStore (string) required
Name (string)
AdvancedEventSelectors (array)
MultiRegionEnabled (boolean)
OrganizationEnabled (boolean)
RetentionPeriod (integer)
TerminationProtectionEnabled (boolean)
KmsKeyId (string)
BillingMode (string)
cloudtrail/update_trailUpdates 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.Name (string) required
S3BucketName (string)
S3KeyPrefix (string)
SnsTopicName (string)
IncludeGlobalServiceEvents (boolean)
IsMultiRegionTrail (boolean)
EnableLogFileValidation (boolean)
CloudWatchLogsLogGroupArn (string)
CloudWatchLogsRoleArn (string)
KmsKeyId (string)
IsOrganizationTrail (boolean)
cloudwatch_events/activate_event_sourceActivates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.Name (string) required
cloudwatch_events/cancel_replayCancels the specified replay.ReplayName (string) required
cloudwatch_events/create_api_destinationCreates an API destination, which is an HTTP invocation endpoint configured as a target for events.Name (string) required
Description (string)
ConnectionArn (string) required
InvocationEndpoint (string) required
HttpMethod (string) required
InvocationRateLimitPerSecond (integer)
cloudwatch_events/create_archiveCreates 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.ArchiveName (string) required
EventSourceArn (string) required
Description (string)
EventPattern (string)
RetentionDays (integer)
cloudwatch_events/create_connectionCreates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.Name (string) required
Description (string)
AuthorizationType (string) required
AuthParameters: {
. BasicAuthParameters (object)
. OAuthParameters (object)
. ApiKeyAuthParameters (object)
. InvocationHttpParameters (object)
} (object) required
cloudwatch_events/create_event_busCreates 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.Name (string) required
EventSourceName (string)
Tags (array)
cloudwatch_events/create_partner_event_sourceCalled 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 applicName (string) required
Account (string) required
cloudwatch_events/deactivate_event_sourceYou 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.Name (string) required
cloudwatch_events/deauthorize_connectionRemoves 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.Name (string) required
cloudwatch_events/delete_api_destinationDeletes the specified API destination.Name (string) required
cloudwatch_events/delete_archiveDeletes the specified archive.ArchiveName (string) required
cloudwatch_events/delete_connectionDeletes a connection.Name (string) required
cloudwatch_events/delete_event_busDeletes 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.Name (string) required
cloudwatch_events/delete_partner_event_sourceThis 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.Name (string) required
Account (string) required
cloudwatch_events/delete_ruleDeletes 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 WebName (string) required
EventBusName (string)
Force (boolean)
cloudwatch_events/describe_api_destinationRetrieves details about an API destination.Name (string) required
cloudwatch_events/describe_archiveRetrieves details about an archive.ArchiveName (string) required
cloudwatch_events/describe_connectionRetrieves details about a connection.Name (string) required
cloudwatch_events/describe_event_busDisplays 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.Name (string)
cloudwatch_events/describe_event_sourceThis operation lists details about a partner event source that is shared with your account.Name (string) required
cloudwatch_events/describe_partner_event_sourceAn 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.Name (string) required
cloudwatch_events/describe_replayRetrieves 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 progreReplayName (string) required
cloudwatch_events/describe_ruleDescribes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.Name (string) required
EventBusName (string)
cloudwatch_events/disable_ruleDisables 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.Name (string) required
EventBusName (string)
cloudwatch_events/enable_ruleEnables 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.Name (string) required
EventBusName (string)
cloudwatch_events/list_api_destinationsRetrieves a list of API destination in the account in the current Region.NamePrefix (string)
ConnectionArn (string)
NextToken (string)
Limit (integer)
cloudwatch_events/list_archivesLists 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.NamePrefix (string)
EventSourceArn (string)
State (string)
NextToken (string)
Limit (integer)
cloudwatch_events/list_connectionsRetrieves a list of connections from the account.NamePrefix (string)
ConnectionState (string)
NextToken (string)
Limit (integer)
cloudwatch_events/list_event_busesLists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.NamePrefix (string)
NextToken (string)
Limit (integer)
cloudwatch_events/list_event_sourcesYou 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.NamePrefix (string)
NextToken (string)
Limit (integer)
cloudwatch_events/list_partner_event_source_accountsAn 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.EventSourceName (string) required
NextToken (string)
Limit (integer)
cloudwatch_events/list_partner_event_sourcesAn 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.NamePrefix (string) required
NextToken (string)
Limit (integer)
cloudwatch_events/list_replaysLists 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.NamePrefix (string)
State (string)
EventSourceArn (string)
NextToken (string)
Limit (integer)
cloudwatch_events/list_rule_names_by_targetLists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.TargetArn (string) required
EventBusName (string)
NextToken (string)
Limit (integer)
cloudwatch_events/list_rulesLists 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.NamePrefix (string)
EventBusName (string)
NextToken (string)
Limit (integer)
cloudwatch_events/list_tags_for_resourceDisplays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.ResourceARN (string) required
cloudwatch_events/list_targets_by_ruleLists the targets assigned to the specified rule.Rule (string) required
EventBusName (string)
NextToken (string)
Limit (integer)
cloudwatch_events/put_eventsSends custom events to Amazon EventBridge so that they can be matched to rules.Entries (array) required
cloudwatch_events/put_partner_eventsThis is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.Entries (array) required
cloudwatch_events/put_permissionRunning 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 evEventBusName (string)
Action (string)
Principal (string)
StatementId (string)
Condition: {
. Type (string)
. Key (string)
. Value (string)
} (object)
Policy (string)
cloudwatch_events/put_ruleCreates 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 orName (string) required
ScheduleExpression (string)
EventPattern (string)
State (string)
Description (string)
RoleArn (string)
Tags (array)
EventBusName (string)
cloudwatch_events/put_targetsAdds 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 TerminRule (string) required
EventBusName (string)
Targets (array) required
cloudwatch_events/remove_permissionRevokes 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.StatementId (string)
RemoveAllPermissions (boolean)
EventBusName (string)
cloudwatch_events/remove_targetsRemoves 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 andRule (string) required
EventBusName (string)
Ids (array) required
Force (boolean)
cloudwatch_events/start_replayStarts 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 theReplayName (string) required
Description (string)
EventSourceArn (string) required
EventStartTime (string) required
EventEndTime (string) required
Destination: {
. Arn (string)
. FilterArns (array)
} (object) required
cloudwatch_events/tag_resourceAssigns 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 thatResourceARN (string) required
Tags (array) required
cloudwatch_events/test_event_patternTests 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.EventPattern (string) required
Event (string) required
cloudwatch_events/untag_resourceRemoves one or more tags from the specified EventBridge resource. In Amazon EventBridge CloudWatch Events, rules and event buses can be tagged.ResourceARN (string) required
TagKeys (array) required
cloudwatch_events/update_api_destinationUpdates an API destination.Name (string) required
Description (string)
ConnectionArn (string)
InvocationEndpoint (string)
HttpMethod (string)
InvocationRateLimitPerSecond (integer)
cloudwatch_events/update_archiveUpdates the specified archive.ArchiveName (string) required
Description (string)
EventPattern (string)
RetentionDays (integer)
cloudwatch_events/update_connectionUpdates settings for a connection.Name (string) required
Description (string)
AuthorizationType (string)
AuthParameters: {
. BasicAuthParameters (object)
. OAuthParameters (object)
. ApiKeyAuthParameters (object)
. InvocationHttpParameters (object)
} (object)
cloudwatch_logs/associate_kms_keyAssociates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account. When you use AssociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation. Specify the logGroupName parameter to cause log events ingested into that log group to be encrypted with that key. Only the log events ingested after the key is associatedlogGroupName (string)
kmsKeyId (string) required
resourceIdentifier (string)
cloudwatch_logs/associate_source_to_s3table_integrationAssociates a data source with an S3 Table Integration for query access in the 'logs' namespace. This enables querying log data using analytics engines that support Iceberg such as Amazon Athena, Amazon Redshift, and Apache Spark.integrationArn (string) required
dataSource: {
. name (string)
. type (string)
} (object) required
cloudwatch_logs/cancel_export_taskCancels the specified export task. The task must be in the PENDING or RUNNING state.taskId (string) required
cloudwatch_logs/cancel_import_taskCancels an active import task and stops importing data from the CloudTrail Lake Event Data Store.importId (string) required
cloudwatch_logs/create_deliveryCreates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created. Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported V2 Permissions in the table at Enabling logging from Amazon Web Services services. A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, a delivery stream in Firehose, ordeliverySourceName (string) required
deliveryDestinationArn (string) required
recordFields (array)
fieldDelimiter (string)
s3DeliveryConfiguration: {
. suffixPath (string)
. enableHiveCompatiblePath (boolean)
} (object)
tags (object)
cloudwatch_logs/create_export_taskCreates an export task so that you can 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 S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported. Exporting to S3 buckets that are encrypted with AEStaskName (string)
logGroupName (string) required
logStreamNamePrefix (string)
from (integer) required
to (integer) required
destination (string) required
destinationPrefix (string)
cloudwatch_logs/create_import_taskStarts an import from a data source to CloudWatch Log and creates a managed log group as the destination for the imported data. Currently, CloudTrail Event Data Store is the only supported data source. The import task must satisfy the following constraints: The specified source must be in an ACTIVE state. The API caller must have permissions to access the data in the provided source and to perform iam:PassRole on the provided import role which has the same permissions, as described below. The primportSourceArn (string) required
importRoleArn (string) required
importFilter: {
. startEventTime (integer)
. endEventTime (integer)
} (object)
cloudwatch_logs/create_log_anomaly_detectorCreates an anomaly detector that regularly scans one or more log groups and look for patterns and anomalies in the logs. An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic. An anomaly detector uses machine learning algorithms to scan log events and find patterns. A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for analyzing large sets of logs because a large number of log events can ologGroupArnList (array) required
detectorName (string)
evaluationFrequency (string)
filterPattern (string)
kmsKeyId (string)
anomalyVisibilityTime (integer)
tags (object)
cloudwatch_logs/create_log_groupCreates a log group with the specified name. You can create up to 1,000,000 log groups per Region 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 Log group names can't start with the slogGroupName (string) required
kmsKeyId (string)
tags (object)
logGroupClass (string)
deletionProtectionEnabled (boolean)
cloudwatch_logs/create_log_streamCreates 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. LlogGroupName (string) required
logStreamName (string) required
cloudwatch_logs/create_scheduled_queryCreates a scheduled query that runs CloudWatch Logs Insights queries at regular intervals. Scheduled queries enable proactive monitoring by automatically executing queries to detect patterns and anomalies in your log data. Query results can be delivered to Amazon S3 for analysis or further processing.name (string) required
description (string)
queryLanguage (string) required
queryString (string) required
logGroupIdentifiers (array)
scheduleExpression (string) required
timezone (string)
startTimeOffset (integer)
destinationConfiguration: {
. s3Configuration (object)
} (object)
scheduleStartTime (integer)
scheduleEndTime (integer)
executionRoleArn (string) required
state (string)
tags (object)
cloudwatch_logs/delete_account_policyDeletes a CloudWatch Logs account policy. This stops the account-wide policy from applying to log groups or data sources in the account. If you delete a data protection policy or subscription filter policy, any log-group level policies of those types remain in effect. This operation supports deletion of data source-based field index policies, including facet configurations, in addition to log group-based policies. To use this operation, you must be signed on with the correct permissions dependinpolicyName (string) required
policyType (string) required
cloudwatch_logs/delete_data_protection_policyDeletes the data protection policy from the specified log group. For more information about data protection policies, see PutDataProtectionPolicy.logGroupIdentifier (string) required
cloudwatch_logs/delete_deliveryDeletes a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.id (string) required
cloudwatch_logs/delete_delivery_destinationDeletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination. You can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the deliveryDestinationArn field in the results.name (string) required
cloudwatch_logs/delete_delivery_destination_policyDeletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.deliveryDestinationName (string) required
cloudwatch_logs/delete_delivery_sourceDeletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery destination. You can't delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the deliverySourceName field in the results.name (string) required
cloudwatch_logs/delete_destinationDeletes 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.destinationName (string) required
cloudwatch_logs/delete_index_policyDeletes a log-group level field index policy that was applied to a single log group. The indexing of the log events that happened before you delete the policy will still be used for as many as 30 days to improve CloudWatch Logs Insights queries. If the deleted policy included facet configurations, those facets will no longer be available for interactive exploration in the CloudWatch Logs Insights console for this log group. However, facet data is retained for up to 30 days. You can't use this oplogGroupIdentifier (string) required
cloudwatch_logs/delete_integrationDeletes the integration between CloudWatch Logs and OpenSearch Service. If your integration has active vended logs dashboards, you must specify true for the force parameter, otherwise the operation will fail. If you delete the integration by setting force to true, all your vended logs dashboards powered by OpenSearch Service will be deleted and the data that was on them will no longer be accessible.integrationName (string) required
force (boolean)
cloudwatch_logs/delete_log_anomaly_detectorDeletes the specified CloudWatch Logs anomaly detector.anomalyDetectorArn (string) required
cloudwatch_logs/delete_log_groupDeletes the specified log group and permanently deletes all the archived log events associated with the log group.logGroupName (string) required
cloudwatch_logs/delete_log_streamDeletes the specified log stream and permanently deletes all the archived log events associated with the log stream.logGroupName (string) required
logStreamName (string) required
cloudwatch_logs/delete_metric_filterDeletes the specified metric filter.logGroupName (string) required
filterName (string) required
cloudwatch_logs/delete_query_definitionDeletes 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.queryDefinitionId (string) required
cloudwatch_logs/delete_resource_policyDeletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.policyName (string)
resourceArn (string)
expectedRevisionId (string)
cloudwatch_logs/delete_retention_policyDeletes the specified retention policy. Log events do not expire if they belong to log groups without a retention policy.logGroupName (string) required
cloudwatch_logs/delete_scheduled_queryDeletes a scheduled query and stops all future executions. This operation also removes any configured actions and associated resources.identifier (string) required
cloudwatch_logs/delete_subscription_filterDeletes the specified subscription filter.logGroupName (string) required
filterName (string) required
cloudwatch_logs/delete_transformerDeletes the log transformer for the specified log group. As soon as you do this, the transformation of incoming log events according to that transformer stops. If this account has an account-level transformer that applies to this log group, the log group begins using that account-level transformer when this log-group level transformer is deleted. After you delete a transformer, be sure to edit any metric filters or subscription filters that relied on the transformed versions of the log events.logGroupIdentifier (string) required
cloudwatch_logs/describe_account_policiesReturns a list of all CloudWatch Logs account policies in the account. To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are retrieving information for. To see data protection policies, you must have the logs:GetDataProtectionPolicy and logs:DescribeAccountPolicies permissions. To see subscription filter policies, you must have the logs:DescribeSubscriptionFilters and logs:DescribeAccountPolicies permissions. To see transformer polpolicyType (string) required
policyName (string)
accountIdentifiers (array)
nextToken (string)
cloudwatch_logs/describe_configuration_templatesUse this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries. For more information about deliveries, see CreateDelivery.service (string)
logTypes (array)
resourceTypes (array)
deliveryDestinationTypes (array)
nextToken (string)
limit (integer)
cloudwatch_logs/describe_deliveriesRetrieves a list of the deliveries that have been created in the account. A delivery is a connection between a delivery source and a delivery destination . A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.nextToken (string)
limit (integer)
cloudwatch_logs/describe_delivery_destinationsRetrieves a list of the delivery destinations that have been created in the account.nextToken (string)
limit (integer)
cloudwatch_logs/describe_delivery_sourcesRetrieves a list of the delivery sources that have been created in the account.nextToken (string)
limit (integer)
cloudwatch_logs/describe_destinationsLists all your destinations. The results are ASCII-sorted by destination name.DestinationNamePrefix (string)
nextToken (string)
limit (integer)
cloudwatch_logs/describe_export_tasksLists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.taskId (string)
statusCode (string)
nextToken (string)
limit (integer)
cloudwatch_logs/describe_field_indexesReturns a list of custom and default field indexes which are discovered in log data. For more information about field index policies, see PutIndexPolicy.logGroupIdentifiers (array) required
nextToken (string)
cloudwatch_logs/describe_import_task_batchesGets detailed information about the individual batches within an import task, including their status and any error messages. For CloudTrail Event Data Store sources, a batch refers to a subset of stored events grouped by their eventTime.importId (string) required
batchImportStatus (array)
limit (integer)
nextToken (string)
cloudwatch_logs/describe_import_tasksLists and describes import tasks, with optional filtering by import status and source ARN.importId (string)
importStatus (string)
importSourceArn (string)
limit (integer)
nextToken (string)
cloudwatch_logs/describe_index_policiesReturns the field index policies of the specified log group. For more information about field index policies, see PutIndexPolicy. If a specified log group has a log-group level index policy, that policy is returned by this operation. If a specified log group doesn't have a log-group level index policy, but an account-wide index policy applies to it, that account-wide policy is returned by this operation. To find information about only account-level policies, use DescribeAccountPolicies instead.logGroupIdentifiers (array) required
nextToken (string)
cloudwatch_logs/describe_log_groupsReturns information about log groups, including data sources that ingest into each log group. You can return 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 aboutaccountIdentifiers (array)
logGroupNamePrefix (string)
logGroupNamePattern (string)
nextToken (string)
limit (integer)
includeLinkedAccounts (boolean)
logGroupClass (string)
logGroupIdentifiers (array)
cloudwatch_logs/describe_log_streamsLists 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. You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both. This operation has a limit of 25 transactions per second, after which transactions are throttled. If you are using CloudWatch cross-account observability, you can uselogGroupName (string)
logGroupIdentifier (string)
logStreamNamePrefix (string)
orderBy (string)
descending (boolean)
nextToken (string)
limit (integer)
cloudwatch_logs/describe_metric_filtersLists 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.logGroupName (string)
filterNamePrefix (string)
nextToken (string)
limit (integer)
metricName (string)
metricNamespace (string)
cloudwatch_logs/describe_queriesReturns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run 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. This operation includes both interactive queries started directly by users and automated queries executed by scheduled query configurations. Scheduled query executions appear in the results alongside manually initiated queries, providing visibility into all query actilogGroupName (string)
status (string)
maxResults (integer)
nextToken (string)
queryLanguage (string)
cloudwatch_logs/describe_query_definitionsThis operation returns a paginated list of your saved CloudWatch Logs Insights query definitions. You can retrieve query definitions from the current account or from a source account that is linked to the current account. You can use the queryDefinitionNamePrefix parameter to limit the results to only the query definitions that have names that start with a certain string.queryLanguage (string)
queryDefinitionNamePrefix (string)
maxResults (integer)
nextToken (string)
cloudwatch_logs/describe_resource_policiesLists the resource policies in this account.nextToken (string)
limit (integer)
resourceArn (string)
policyScope (string)
cloudwatch_logs/describe_subscription_filtersLists 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.logGroupName (string) required
filterNamePrefix (string)
nextToken (string)
limit (integer)
cloudwatch_logs/disassociate_kms_keyDisassociates the specified KMS key from the specified log group or from all CloudWatch Logs Insights query results in the account. When you use DisassociateKmsKey, you specify either the logGroupName parameter or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation. Specify the logGroupName parameter to stop using the KMS key to encrypt future log events ingested and stored in the log group. Instead, they will be encrypted with the default CloudWatclogGroupName (string)
resourceIdentifier (string)
cloudwatch_logs/disassociate_source_from_s3table_integrationDisassociates a data source from an S3 Table Integration, removing query access and deleting all associated data from the integration.identifier (string) required
cloudwatch_logs/filter_log_eventsLists log events from the specified log group. You can list all the log events or filter the results using one or more of the following: A filter pattern A time range The log stream name, or a log stream name prefix that matches multiple log streams You must have the logs:FilterLogEvents permission to perform this operation. You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both. FilterLlogGroupName (string)
logGroupIdentifier (string)
logStreamNames (array)
logStreamNamePrefix (string)
startTime (integer)
endTime (integer)
filterPattern (string)
nextToken (string)
limit (integer)
interleaved (boolean)
unmask (boolean)
cloudwatch_logs/get_data_protection_policyReturns information about a log group data protection policy.logGroupIdentifier (string) required
cloudwatch_logs/get_deliveryReturns complete information about one logical delivery. A delivery is a connection between a delivery source and a delivery destination . A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services. You need to specify thid (string) required
cloudwatch_logs/get_delivery_destinationRetrieves complete information about one delivery destination.name (string) required
cloudwatch_logs/get_delivery_destination_policyRetrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.deliveryDestinationName (string) required
cloudwatch_logs/get_delivery_sourceRetrieves complete information about one delivery source.name (string) required
cloudwatch_logs/get_integrationReturns information about one integration between CloudWatch Logs and OpenSearch Service.integrationName (string) required
cloudwatch_logs/get_log_anomaly_detectorRetrieves information about the log anomaly detector that you specify. The KMS key ARN detected is valid.anomalyDetectorArn (string) required
cloudwatch_logs/get_log_eventsLists log events from the specified log stream. You can list all of the log events or filter using a time range. GetLogEvents is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty. For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB. Partially full or empty pages don't necessalogGroupName (string)
logGroupIdentifier (string)
logStreamName (string) required
startTime (integer)
endTime (integer)
nextToken (string)
limit (integer)
startFromHead (boolean)
unmask (boolean)
cloudwatch_logs/get_log_fieldsDiscovers available fields for a specific data source and type. The response includes any field modifications introduced through pipelines, such as new fields or changed field types.dataSourceName (string) required
dataSourceType (string) required
cloudwatch_logs/get_log_group_fieldsReturns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify. This operation is used for discovering fields within log group events. For discovering fields across data sources, use the GetLogFields operation. You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must specify one of these parameters, but you calogGroupName (string)
time (integer)
logGroupIdentifier (string)
cloudwatch_logs/get_log_objectRetrieves a large logging object LLO and streams it back. This API is used to fetch the content of large portions of log events that have been ingested through the PutOpenTelemetryLogs API. When log events contain fields that would cause the total event size to exceed 1MB, CloudWatch Logs automatically processes up to 10 fields, starting with the largest fields. Each field is truncated as needed to keep the total event size as close to 1MB as possible. The excess portions are stored as Large Logunmask (boolean)
logObjectPointer (string) required
cloudwatch_logs/get_log_recordRetrieves 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.logRecordPointer (string) required
unmask (boolean)
cloudwatch_logs/get_query_resultsReturns 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 running a query. To run a query, use StartQuery. For more information about how long results of previous queries are available, see CloudWatch Logs quotas. If the value of the Status field in the output is Running,queryId (string) required
cloudwatch_logs/get_scheduled_queryRetrieves details about a specific scheduled query, including its configuration, execution status, and metadata.identifier (string) required
cloudwatch_logs/get_scheduled_query_historyRetrieves the execution history of a scheduled query within a specified time range, including query results and destination processing status.identifier (string) required
startTime (integer) required
endTime (integer) required
executionStatuses (array)
maxResults (integer)
nextToken (string)
cloudwatch_logs/get_transformerReturns the information about the log transformer associated with this log group. This operation returns data only for transformers created at the log group level. To get information for an account-level transformer, use DescribeAccountPolicies.logGroupIdentifier (string) required
cloudwatch_logs/list_aggregate_log_group_summariesReturns an aggregate summary of all log groups in the Region grouped by specified data source characteristics. Supports optional filtering by log group class, name patterns, and data sources. If you perform this action in a monitoring account, you can also return aggregated summaries of log groups from source accounts that are linked to the monitoring account. For more information about using cross-account observability to set up monitoring accounts and source accounts, see CloudWatch cross-accoaccountIdentifiers (array)
includeLinkedAccounts (boolean)
logGroupClass (string)
logGroupNamePattern (string)
dataSources (array)
groupBy (string) required
nextToken (string)
limit (integer)
cloudwatch_logs/list_anomaliesReturns a list of anomalies that log anomaly detectors have found. For details about the structure format of each anomaly object that is returned, see the example in this section.anomalyDetectorArn (string)
suppressionState (string)
limit (integer)
nextToken (string)
cloudwatch_logs/list_integrationsReturns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one integration can be created in an account, and this integration must be with OpenSearch Service.integrationNamePrefix (string)
integrationType (string)
integrationStatus (string)
cloudwatch_logs/list_log_anomaly_detectorsRetrieves a list of the log anomaly detectors in the account.filterLogGroupArn (string)
limit (integer)
nextToken (string)
cloudwatch_logs/list_log_groupsReturns a list of log groups in the Region in your account. If you are performing this action in a monitoring account, you can choose to also return log groups from source accounts that are linked to the monitoring account. For more information about using cross-account observability to set up monitoring accounts and source accounts, see CloudWatch cross-account observability. You can optionally filter the list by log group class, by using regular expressions in your request to match strings inlogGroupNamePattern (string)
logGroupClass (string)
includeLinkedAccounts (boolean)
accountIdentifiers (array)
nextToken (string)
limit (integer)
dataSources (array)
fieldIndexNames (array)
cloudwatch_logs/list_log_groups_for_queryReturns a list of the log groups that were analyzed during a single CloudWatch Logs Insights query. This can be useful for queries that use log group name prefixes or the filterIndex command, because the log groups are dynamically selected in these cases. For more information about field indexes, see Create field indexes to improve query performance and reduce costs.queryId (string) required
nextToken (string)
maxResults (integer)
cloudwatch_logs/list_scheduled_queriesLists all scheduled queries in your account and region. You can filter results by state to show only enabled or disabled queries.maxResults (integer)
nextToken (string)
state (string)
cloudwatch_logs/list_sources_for_s3table_integrationReturns a list of data source associations for a specified S3 Table Integration, showing which data sources are currently associated for query access.integrationArn (string) required
maxResults (integer)
nextToken (string)
cloudwatch_logs/list_tags_for_resourceDisplays the tags associated with a CloudWatch Logs resource. Currently, log groups and destinations support tagging.resourceArn (string) required
cloudwatch_logs/list_tags_log_groupThe ListTagsLogGroup operation is on the path to deprecation. We recommend that you use ListTagsForResource instead. Lists the tags for the specified log group.logGroupName (string) required
cloudwatch_logs/put_account_policyCreates an account-level data protection policy, subscription filter policy, field index policy, transformer policy, or metric extraction policy that applies to all log groups, a subset of log groups, or a data source name and type combination in the account. For field index policies, you can configure indexed fields as facets to enable interactive exploration of your logs. Facets provide value distributions and counts for indexed fields in the CloudWatch Logs Insights console without requiringpolicyName (string) required
policyDocument (string) required
policyType (string) required
scope (string)
selectionCriteria (string)
cloudwatch_logs/put_data_protection_policyCreates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. Sensitive data is detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested into the log group before that time are not masked. By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterilogGroupIdentifier (string) required
policyDocument (string) required
cloudwatch_logs/put_delivery_destinationCreates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations and X-Ray as the trace delivery destination. To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following: Create a delivery source, which is a logical object that representsname (string) required
outputFormat (string)
deliveryDestinationConfiguration: {
. destinationResourceArn (string)
} (object)
deliveryDestinationType (string)
tags (object)
cloudwatch_logs/put_delivery_destination_policyCreates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, you must do the following: Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource. Create a deliverydeliveryDestinationName (string) required
deliveryDestinationPolicy (string) required
cloudwatch_logs/put_delivery_sourceCreates or updates a logical delivery source. A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray for sending traces. To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following: Use PutDeliverySource to create a delivery source, which is a logical object that represents thname (string) required
resourceArn (string) required
logType (string) required
tags (object)
cloudwatch_logs/put_destinationCreates 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. With a destination, you can 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-adestinationName (string) required
targetArn (string) required
roleArn (string) required
tags (object)
cloudwatch_logs/put_destination_policyCreates 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.destinationName (string) required
accessPolicy (string) required
forceUpdate (boolean)
cloudwatch_logs/put_index_policyCreates or updates a field index policy for the specified log group. Only log groups in the Standard log class support field index policies. For more information about log classes, see Log classes. You can use field index policies to create field indexes on fields found in log events in the log group. Creating field indexes speeds up and lowers the costs for CloudWatch Logs Insights queries that reference those field indexes, because these queries attempt to skip the processing of log events thalogGroupIdentifier (string) required
policyDocument (string) required
cloudwatch_logs/put_integrationCreates an integration between CloudWatch Logs and another service in this account. Currently, only integrations with OpenSearch Service are supported, and currently you can have only one integration in your account. Integrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered by OpenSearch Service analytics. For more information, see Vended log dashboards powered by Amazon OpenSearch Service. You can use this operation only to create a new inteintegrationName (string) required
resourceConfig (undefined) required
integrationType (string) required
cloudwatch_logs/put_log_eventsUploads a batch of log events to the specified log stream. The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions are always accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid. You can use parallel PutLogEvents actions on the same log stream. 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 messlogGroupName (string) required
logStreamName (string) required
logEvents (array) required
sequenceToken (string)
entity: {
. keyAttributes (object)
. attributes (object)
} (object)
cloudwatch_logs/put_log_group_deletion_protectionEnables or disables deletion protection for the specified log group. When enabled on a log group, deletion protection blocks all deletion operations until it is explicitly disabled. For information about the parameters that are common to all actions, see Common Parameters.logGroupIdentifier (string) required
deletionProtectionEnabled (boolean) required
cloudwatch_logs/put_metric_filterCreates or updates a metric filter and associates it with the specified log group. With metric filters, you can 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. Using regular expressions in filter patterns is supported. For these filters, there is a quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterlogGroupName (string) required
filterName (string) required
filterPattern (string) required
metricTransformations (array) required
applyOnTransformedLogs (boolean)
fieldSelectionCriteria (string)
emitSystemFieldDimensions (array)
cloudwatch_logs/put_query_definitionCreates 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, imagine updating a current query definition that includes log groups. If you donqueryLanguage (string)
name (string) required
queryDefinitionId (string)
logGroupNames (array)
queryString (string) required
clientToken (string)
cloudwatch_logs/put_resource_policyCreates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. This API has the following restrictions: Supported actions - Policy only supports logs:PutLogEvents and logs:CreateLogStream actions Supported principals - Policy only applies when operations are invoked by Amazon Web Services service principals not IAM users, roles, or cross-account principals Policy limits - An account can have a maximum of 10 policies wipolicyName (string)
policyDocument (string)
resourceArn (string)
expectedRevisionId (string)
cloudwatch_logs/put_retention_policySets the retention of the specified log group. With a retention policy, you can configure the number of days for which to retain log events in the specified log group. CloudWatch Logs doesn't immediately delete log events when they reach their retention setting. It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer. To illustrate, imagine that you change a log group to have a longer retention setting when it contains log events thatlogGroupName (string) required
retentionInDays (integer) required
cloudwatch_logs/put_subscription_filterCreates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can 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 data stream belonging to the same account as the sublogGroupName (string) required
filterName (string) required
filterPattern (string) required
destinationArn (string) required
roleArn (string)
distribution (string)
applyOnTransformedLogs (boolean)
fieldSelectionCriteria (string)
emitSystemFields (array)
cloudwatch_logs/put_transformerCreates or updates a log transformer for a single log group. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contains relevant, source-specific information. After you have created a transformer, CloudWatch Logs performs the transformations at the time of log ingestion. You can then refer to the transformed versions of the logs during operalogGroupIdentifier (string) required
transformerConfig (array) required
cloudwatch_logs/start_live_tailStarts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see Use Live Tail to view logs in near real time. The response to this operation is a response stream, over which the server sends live log events and the client receives them. The following objects are sent over the stream: A single LiveTailSessionStart object is sent at the start of the session. Every seconlogGroupIdentifiers (array) required
logStreamNames (array)
logStreamNamePrefixes (array)
logEventFilterPattern (string)
cloudwatch_logs/start_queryStarts a query of one or more log groups or data sources using CloudWatch Logs Insights. You specify the log groups or data sources and time range to query and the query string to use. You can query up to 10 data sources in a single query. For more information, see CloudWatch Logs Insights Query Syntax. After you run a query using StartQuery, the query results are stored by CloudWatch Logs. You can use GetQueryResults to retrieve the results of a query, using the queryId that StartQuery returns.queryLanguage (string)
logGroupName (string)
logGroupNames (array)
logGroupIdentifiers (array)
startTime (integer) required
endTime (integer) required
queryString (string) required
limit (integer)
cloudwatch_logs/stop_queryStops 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. This operation can be used to cancel both interactive queries and individual scheduled query executions. When used with scheduled queries, StopQuery cancels only the specific execution identified by the query ID, not the scheduled query configuration itself.queryId (string) required
cloudwatch_logs/tag_log_groupThe TagLogGroup operation is on the path to deprecation. We recommend that you use TagResource instead. Adds or updates the specified tags for the specified log group. To list the tags for a log group, use ListTagsForResource. To remove tags, use UntagResource. 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 thelogGroupName (string) required
tags (object) required
cloudwatch_logs/tag_resourceAssigns one or more tags key-value pairs to the specified CloudWatch Logs resource. Currently, the only CloudWatch Logs resources that can be tagged are log groups and destinations. 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 canresourceArn (string) required
tags (object) required
cloudwatch_logs/test_metric_filterTests 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.filterPattern (string) required
logEventMessages (array) required
cloudwatch_logs/test_transformerUse this operation to test a log transformer. You enter the transformer configuration and a set of log events to test with. The operation responds with an array that includes the original log events and the transformed versions.transformerConfig (array) required
logEventMessages (array) required
cloudwatch_logs/untag_log_groupThe UntagLogGroup operation is on the path to deprecation. We recommend that you use UntagResource instead. Removes the specified tags from the specified log group. To list the tags for a log group, use ListTagsForResource. To add tags, use TagResource. When using IAM policies to control tag management for CloudWatch Logs log groups, the condition keys aws:Resource/key-name and aws:TagKeys cannot be used to restrict which tags users can assign.logGroupName (string) required
tags (array) required
cloudwatch_logs/untag_resourceRemoves one or more tags from the specified resource.resourceArn (string) required
tagKeys (array) required
cloudwatch_logs/update_anomalyUse this operation to suppress anomaly detection for a specified anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won't report new occurrences of that anomaly and won't update that anomaly with new data. If you suppress a pattern, CloudWatch Logs won't report any anomalies related to that pattern. You must specify either anomalyId or patternId, but you can't specify both parameters in the same operation. If you have previously used this operation to suppress detection of a patternanomalyId (string)
patternId (string)
anomalyDetectorArn (string) required
suppressionType (string)
suppressionPeriod: {
. value (integer)
. suppressionUnit (string)
} (object)
baseline (boolean)
cloudwatch_logs/update_delivery_configurationUse this operation to update the configuration of a delivery to change either the S3 path pattern or the format of the delivered logs. You can't use this operation to change the source or destination of the delivery.id (string) required
recordFields (array)
fieldDelimiter (string)
s3DeliveryConfiguration: {
. suffixPath (string)
. enableHiveCompatiblePath (boolean)
} (object)
cloudwatch_logs/update_log_anomaly_detectorUpdates an existing log anomaly detector.anomalyDetectorArn (string) required
evaluationFrequency (string)
filterPattern (string)
anomalyVisibilityTime (integer)
enabled (boolean) required
cloudwatch_logs/update_scheduled_queryUpdates an existing scheduled query with new configuration. This operation uses PUT semantics, allowing modification of query parameters, schedule, and destinations.identifier (string) required
description (string)
queryLanguage (string) required
queryString (string) required
logGroupIdentifiers (array)
scheduleExpression (string) required
timezone (string)
startTimeOffset (integer)
destinationConfiguration: {
. s3Configuration (object)
} (object)
scheduleStartTime (integer)
scheduleEndTime (integer)
executionRoleArn (string) required
state (string)
cloudwatch/delete_alarmsDeletes 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. If you specify any incorrect alarm names, the alarms you specify with correct names are still deleted. Other syntax errors might result in no alarms being deleted. To confirm that alarms were deletedAlarmNames (array) required
cloudwatch/delete_anomaly_detectorDeletes 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.Namespace (string)
MetricName (string)
Dimensions (array)
Stat (string)
SingleMetricAnomalyDetector: {
. AccountId (string)
. Namespace (string)
. MetricName (string)
. Dimensions (array)
. Stat (string)
} (object)
MetricMathAnomalyDetector: {
. MetricDataQueries (array)
} (object)
cloudwatch/delete_dashboardsDeletes 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.DashboardNames (array) required
cloudwatch/delete_insight_rulesPermanently 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.RuleNames (array) required
cloudwatch/delete_metric_streamPermanently deletes the metric stream that you specify.Name (string) required
cloudwatch/describe_alarm_contributorsReturns the information of the current alarm contributors that are in ALARM state. This operation returns details about the individual time series that contribute to the alarm's state.AlarmName (string) required
NextToken (string)
cloudwatch/describe_alarm_historyRetrieves 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 compositeAlarmName (string)
AlarmContributorId (string)
AlarmTypes (array)
HistoryItemType (string)
StartDate (string)
EndDate (string)
MaxRecords (integer)
NextToken (string)
ScanBy (string)
cloudwatch/describe_alarmsRetrieves 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.AlarmNames (array)
AlarmNamePrefix (string)
AlarmTypes (array)
ChildrenOfAlarmName (string)
ParentsOfAlarmName (string)
StateValue (string)
ActionPrefix (string)
MaxRecords (integer)
NextToken (string)
cloudwatch/describe_alarms_for_metricRetrieves 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.MetricName (string) required
Namespace (string) required
Statistic (string)
ExtendedStatistic (string)
Dimensions (array)
Period (integer)
Unit (string)
cloudwatch/describe_anomaly_detectorsLists 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.NextToken (string)
MaxResults (integer)
Namespace (string)
MetricName (string)
Dimensions (array)
AnomalyDetectorTypes (array)
cloudwatch/describe_insight_rulesReturns 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.NextToken (string)
MaxResults (integer)
cloudwatch/disable_alarm_actionsDisables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.AlarmNames (array) required
cloudwatch/disable_insight_rulesDisables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.RuleNames (array) required
cloudwatch/enable_alarm_actionsEnables the actions for the specified alarms.AlarmNames (array) required
cloudwatch/enable_insight_rulesEnables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.RuleNames (array) required
cloudwatch/get_dashboardDisplays 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.DashboardName (string) required
cloudwatch/get_insight_rule_reportThis 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 changeRuleName (string) required
StartTime (string) required
EndTime (string) required
Period (integer) required
MaxContributorCount (integer)
Metrics (array)
OrderBy (string)
cloudwatch/get_metric_dataYou 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 insightMetricDataQueries (array) required
StartTime (string) required
EndTime (string) required
NextToken (string)
ScanBy (string)
MaxDatapoints (integer)
LabelOptions: {
. Timezone (string)
} (object)
cloudwatch/get_metric_statisticsGets 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.Namespace (string) required
MetricName (string) required
Dimensions (array)
StartTime (string) required
EndTime (string) required
Period (integer) required
Statistics (array)
ExtendedStatistics (array)
Unit (string)
cloudwatch/get_metric_streamReturns information about the metric stream that you specify.Name (string) required
cloudwatch/get_metric_widget_imageYou 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 ofMetricWidget (string) required
OutputFormat (string)
cloudwatch/list_dashboardsReturns 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.DashboardNamePrefix (string)
NextToken (string)
cloudwatch/list_managed_insight_rulesReturns a list that contains the number of managed Contributor Insights rules in your account.ResourceARN (string) required
NextToken (string)
MaxResults (integer)
cloudwatch/list_metricsList the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to get 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 for the metric to appear. To see metric statistics sooner, use GetMetricData or GetMetricStatistics. If you are using CloudWatch cross-account observability, you can use this operation in a monitNamespace (string)
MetricName (string)
Dimensions (array)
NextToken (string)
RecentlyActive (string)
IncludeLinkedAccounts (boolean)
OwningAccount (string)
cloudwatch/list_metric_streamsReturns a list of metric streams in this account.NextToken (string)
MaxResults (integer)
cloudwatch/list_tags_for_resourceDisplays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.ResourceARN (string) required
cloudwatch/put_anomaly_detectorCreates 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. If you have enabled unified cross-account observability, and this account is a monitoring account, the metric can be in the same account or a source account. You can specify the account ID in the object you specify in the SingleMetricAnomalyDetector parameter. For more information, see CloudWatch Anomaly Detection.Namespace (string)
MetricName (string)
Dimensions (array)
Stat (string)
Configuration: {
. ExcludedTimeRanges (array)
. MetricTimezone (string)
} (object)
MetricCharacteristics: {
. PeriodicSpikes (boolean)
} (object)
SingleMetricAnomalyDetector: {
. AccountId (string)
. Namespace (string)
. MetricName (string)
. Dimensions (array)
. Stat (string)
} (object)
MetricMathAnomalyDetector: {
. MetricDataQueries (array)
} (object)
cloudwatch/put_composite_alarmCreates 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 alarmActionsEnabled (boolean)
AlarmActions (array)
AlarmDescription (string)
AlarmName (string) required
AlarmRule (string) required
InsufficientDataActions (array)
OKActions (array)
Tags (array)
ActionsSuppressor (string)
ActionsSuppressorWaitPeriod (integer)
ActionsSuppressorExtensionPeriod (integer)
cloudwatch/put_dashboardCreates 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 dasDashboardName (string) required
DashboardBody (string) required
cloudwatch/put_insight_ruleCreates 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.RuleName (string) required
RuleState (string)
RuleDefinition (string) required
Tags (array)
ApplyOnTransformedLogs (boolean)
cloudwatch/put_managed_insight_rulesCreates 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 ListManagedRules (array) required
cloudwatch/put_metric_alarmCreates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query. For more information about using a Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries. 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 appropriatelyAlarmName (string) required
AlarmDescription (string)
ActionsEnabled (boolean)
OKActions (array)
AlarmActions (array)
InsufficientDataActions (array)
MetricName (string)
Namespace (string)
Statistic (string)
ExtendedStatistic (string)
Dimensions (array)
Period (integer)
Unit (string)
EvaluationPeriods (integer) required
DatapointsToAlarm (integer)
Threshold (number)
ComparisonOperator (string) required
TreatMissingData (string)
EvaluateLowSampleCountPercentile (string)
Metrics (array)
Tags (array)
ThresholdMetricId (string)
cloudwatch/put_metric_dataPublishes metric data to Amazon CloudWatch. CloudWatch associates the data 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 metrics with associated entity data so that related telemetry can be found and viewed together, or publish metric data by itself. To send entity data with your metrics, use the EntityMetricDataNamespace (string) required
MetricData (array)
EntityMetricData (array)
StrictEntityValidation (boolean)
cloudwatch/put_metric_streamCreates 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 signed in 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:Name (string) required
IncludeFilters (array)
ExcludeFilters (array)
FirehoseArn (string) required
RoleArn (string) required
OutputFormat (string) required
Tags (array)
StatisticsConfigurations (array)
IncludeLinkedAccountsMetrics (boolean)
cloudwatch/set_alarm_stateTemporarily 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 visibAlarmName (string) required
StateValue (string) required
StateReason (string) required
StateReasonData (string)
cloudwatch/start_metric_streamsStarts the streaming of metrics for one or more of your metric streams.Names (array) required
cloudwatch/stop_metric_streamsStops the streaming of metrics for one or more of your metric streams.Names (array) required
cloudwatch/tag_resourceAssigns 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 canResourceARN (string) required
Tags (array) required
cloudwatch/untag_resourceRemoves one or more tags from the specified resource.ResourceARN (string) required
TagKeys (array) required
codeartifact/associate_external_connectionAdds 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.domain (string) required
domainOwner (string)
repository (string) required
externalConnection (string) required
codeartifact/copy_package_versionsCopies package versions from one repository to another repository in the same domain. You must specify versions or versionRevisions. You cannot specify both.domain (string) required
domainOwner (string)
sourceRepository (string) required
destinationRepository (string) required
format (string) required
namespace (string)
package (string) required
versions (array)
versionRevisions (object)
allowOverwrite (boolean)
includeFromUpstream (boolean)
codeartifact/create_domainCreates 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 sdomain (string) required
encryptionKey (string)
tags (array)
codeartifact/create_package_groupCreates a package group. For more information about creating package groups, including example CLI commands, see Create a package group in the CodeArtifact User Guide.domain (string) required
domainOwner (string)
packageGroup (string) required
contactInfo (string)
description (string)
tags (array)
codeartifact/create_repositoryCreates a repository.domain (string) required
domainOwner (string)
repository (string) required
description (string)
upstreams (array)
tags (array)
codeartifact/delete_domainDeletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.domain (string) required
domainOwner (string)
codeartifact/delete_domain_permissions_policyDeletes the resource policy set on a domain.domain (string) required
domainOwner (string)
policyRevision (string)
codeartifact/delete_packageDeletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions API.domain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
codeartifact/delete_package_groupDeletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group's direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.domain (string) required
domainOwner (string)
packageGroup (string) required
codeartifact/delete_package_versionsDeletes 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, ListPackageVersions, but you can restore them using UpdatePackageVersionsStatus.domain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
versions (array) required
expectedStatus (string)
codeartifact/delete_repositoryDeletes a repository.domain (string) required
domainOwner (string)
repository (string) required
codeartifact/delete_repository_permissions_policyDeletes 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.domain (string) required
domainOwner (string)
repository (string) required
policyRevision (string)
codeartifact/describe_domainReturns a DomainDescription object that contains information about the requested domain.domain (string) required
domainOwner (string)
codeartifact/describe_packageReturns a PackageDescription object that contains information about the requested package.domain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
codeartifact/describe_package_groupReturns a PackageGroupDescription object that contains information about the requested package group.domain (string) required
domainOwner (string)
packageGroup (string) required
codeartifact/describe_package_versionReturns a PackageVersionDescription object that contains information about the requested package version.domain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
packageVersion (string) required
codeartifact/describe_repositoryReturns a RepositoryDescription object that contains detailed information about the requested repository.domain (string) required
domainOwner (string)
repository (string) required
codeartifact/disassociate_external_connectionRemoves an existing external connection from a repository.domain (string) required
domainOwner (string)
repository (string) required
externalConnection (string) required
codeartifact/dispose_package_versionsDeletes 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.domain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
versions (array) required
versionRevisions (object)
expectedStatus (string)
codeartifact/get_associated_package_groupReturns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such, GetAssociatedPackageGroup can be used to see which package group's origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them. For information package group association and matching, see Package group definition syntax and matcdomain (string) required
domainOwner (string)
format (string) required
namespace (string)
package (string) required
codeartifact/get_authorization_tokenGenerates 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 GetAuthorizatiodomain (string) required
domainOwner (string)
durationSeconds (integer)
codeartifact/get_domain_permissions_policyReturns 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.domain (string) required
domainOwner (string)
codeartifact/get_package_version_assetReturns 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.domain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
packageVersion (string) required
asset (string) required
packageVersionRevision (string)
codeartifact/get_package_version_readmeGets the readme file or descriptive text for a package version. The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.domain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
packageVersion (string) required
codeartifact/get_repository_endpointReturns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format: cargo generic maven npm nuget pypi ruby swiftdomain (string) required
domainOwner (string)
repository (string) required
format (string) required
endpointType (string)
codeartifact/get_repository_permissions_policyReturns the resource policy that is set on a repository.domain (string) required
domainOwner (string)
repository (string) required
codeartifact/list_allowed_repositories_for_groupLists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls in the CodeArtifact User Guide.domain (string) required
domainOwner (string)
packageGroup (string) required
originRestrictionType (string) required
maxResults (integer)
nextToken (string)
codeartifact/list_associated_packagesReturns a list of packages associated with the requested package group. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.domain (string) required
domainOwner (string)
packageGroup (string) required
maxResults (integer)
nextToken (string)
preview (boolean)
codeartifact/list_domainsReturns 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.maxResults (integer)
nextToken (string)
codeartifact/list_package_groupsReturns a list of package groups in the requested domain.domain (string) required
domainOwner (string)
maxResults (integer)
nextToken (string)
prefix (string)
codeartifact/list_packagesReturns a list of PackageSummary objects for packages in a repository that match the request parameters.domain (string) required
domainOwner (string)
repository (string) required
format (string)
namespace (string)
packagePrefix (string)
maxResults (integer)
nextToken (string)
publish (string)
upstream (string)
codeartifact/list_package_version_assetsReturns a list of AssetSummary objects for assets in a package version.domain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
packageVersion (string) required
maxResults (integer)
nextToken (string)
codeartifact/list_package_version_dependenciesReturns 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.domain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
packageVersion (string) required
nextToken (string)
codeartifact/list_package_versionsReturns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters. Package versions of all statuses will be returned by default when calling list-package-versions with no --status parameter.domain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
status (string)
sortBy (string)
maxResults (integer)
nextToken (string)
originType (string)
codeartifact/list_repositoriesReturns 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.repositoryPrefix (string)
maxResults (integer)
nextToken (string)
codeartifact/list_repositories_in_domainReturns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.domain (string) required
domainOwner (string)
administratorAccount (string)
repositoryPrefix (string)
maxResults (integer)
nextToken (string)
codeartifact/list_sub_package_groupsReturns a list of direct children of the specified package group. For information package group hierarchy, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.domain (string) required
domainOwner (string)
packageGroup (string) required
maxResults (integer)
nextToken (string)
codeartifact/list_tags_for_resourceGets information about Amazon Web Services tags for a specified Amazon Resource Name ARN in CodeArtifact.resourceArn (string) required
codeartifact/publish_package_versionCreates a new package version containing one or more assets or files. The unfinished flag can be used to keep the package version in the Unfinished state until all of its assets have been uploaded see Package version status in the CodeArtifact user guide. To set the package version’s status to Published, omit the unfinished flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set to Published, it cannot change back to Unfinisdomain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
packageVersion (string) required
assetContent (string) required
assetName (string) required
assetSHA256 (string) required
unfinished (boolean)
codeartifact/put_domain_permissions_policySets 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.domain (string) required
domainOwner (string)
policyRevision (string)
policyDocument (string) required
codeartifact/put_package_origin_configurationSets 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 caldomain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
restrictions: {
. publish (string)
. upstream (string)
} (object) required
codeartifact/put_repository_permissions_policySets 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.domain (string) required
domainOwner (string)
repository (string) required
policyRevision (string)
policyDocument (string) required
codeartifact/tag_resourceAdds or updates tags for a resource in CodeArtifact.resourceArn (string) required
tags (array) required
codeartifact/untag_resourceRemoves tags from a resource in CodeArtifact.resourceArn (string) required
tagKeys (array) required
codeartifact/update_package_groupUpdates a package group. This API cannot be used to update a package group's origin configuration or pattern. To update a package group's origin configuration, use UpdatePackageGroupOriginConfiguration.domain (string) required
domainOwner (string)
packageGroup (string) required
contactInfo (string)
description (string)
codeartifact/update_package_group_origin_configurationUpdates the package origin configuration for a package group. 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 group origin controls and configuration, see Package group origin controls in the CodeArtifact User Guide.domain (string) required
domainOwner (string)
packageGroup (string) required
restrictions (object)
addAllowedRepositories (array)
removeAllowedRepositories (array)
codeartifact/update_package_versions_statusUpdates 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.domain (string) required
domainOwner (string)
repository (string) required
format (string) required
namespace (string)
package (string) required
versions (array) required
versionRevisions (object)
expectedStatus (string)
targetStatus (string) required
codeartifact/update_repositoryUpdate the properties of a repository.domain (string) required
domainOwner (string)
repository (string) required
description (string)
upstreams (array)
codebuild/batch_delete_buildsDeletes one or more builds.ids (array) required
codebuild/batch_get_build_batchesRetrieves information about one or more batch builds.ids (array) required
codebuild/batch_get_buildsGets information about one or more builds.ids (array) required
codebuild/batch_get_command_executionsGets information about the command executions.sandboxId (string) required
commandExecutionIds (array) required
codebuild/batch_get_fleetsGets information about one or more compute fleets.names (array) required
codebuild/batch_get_projectsGets information about one or more build projects.names (array) required
codebuild/batch_get_report_groupsReturns an array of report groups.reportGroupArns (array) required
codebuild/batch_get_reportsReturns an array of reports.reportArns (array) required
codebuild/batch_get_sandboxesGets information about the sandbox status.ids (array) required
codebuild/create_fleetCreates a compute fleet.name (string) required
baseCapacity (integer) required
environmentType (string) required
computeType (string) required
computeConfiguration: {
. vCpu (integer)
. memory (integer)
. disk (integer)
. machineType (string)
. instanceType (string)
} (object)
scalingConfiguration: {
. scalingType (string)
. targetTrackingScalingConfigs (array)
. maxCapacity (integer)
} (object)
overflowBehavior (string)
vpcConfig: {
. vpcId (string)
. subnets (array)
. securityGroupIds (array)
} (object)
proxyConfiguration: {
. defaultBehavior (string)
. orderedProxyRules (array)
} (object)
imageId (string)
fleetServiceRole (string)
tags (array)
codebuild/create_projectCreates a build project.name (string) required
description (string)
source: {
. type (string)
. location (string)
. gitCloneDepth (integer)
. gitSubmodulesConfig (object)
. buildspec (string)
. auth (object)
. reportBuildStatus (boolean)
. buildStatusConfig (object)
. insecureSsl (boolean)
. sourceIdentifier (string)
} (object) required
secondarySources (array)
sourceVersion (string)
secondarySourceVersions (array)
artifacts: {
. type (string)
. location (string)
. path (string)
. namespaceType (string)
. name (string)
. packaging (string)
. overrideArtifactName (boolean)
. encryptionDisabled (boolean)
. artifactIdentifier (string)
. bucketOwnerAccess (string)
} (object) required
secondaryArtifacts (array)
cache: {
. type (string)
. location (string)
. modes (array)
. cacheNamespace (string)
} (object)
environment: {
. type (string)
. image (string)
. computeType (string)
. computeConfiguration (object)
. fleet (object)
. environmentVariables (array)
. privilegedMode (boolean)
. certificate (string)
. registryCredential (object)
. imagePullCredentialsType (string)
. dockerServer (object)
} (object) required
serviceRole (string) required
timeoutInMinutes (integer)
queuedTimeoutInMinutes (integer)
encryptionKey (string)
tags (array)
vpcConfig: {
. vpcId (string)
. subnets (array)
. securityGroupIds (array)
} (object)
badgeEnabled (boolean)
logsConfig: {
. cloudWatchLogs (object)
. s3Logs (object)
} (object)
fileSystemLocations (array)
buildBatchConfig: {
. serviceRole (string)
. combineArtifacts (boolean)
. restrictions (object)
. timeoutInMins (integer)
. batchReportMode (string)
} (object)
concurrentBuildLimit (integer)
autoRetryLimit (integer)
codebuild/create_report_groupCreates a report group. A report group contains a collection of reports.name (string) required
type (string) required
exportConfig: {
. exportConfigType (string)
. s3Destination (object)
} (object) required
tags (array)
codebuild/create_webhookFor 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 biprojectName (string) required
branchFilter (string)
filterGroups (array)
buildType (string)
manualCreation (boolean)
scopeConfiguration: {
. name (string)
. domain (string)
. scope (string)
} (object)
pullRequestBuildPolicy: {
. requiresCommentApproval (string)
. approverRoles (array)
} (object)
codebuild/delete_build_batchDeletes a batch build.id (string) required
codebuild/delete_fleetDeletes a compute fleet. When you delete a compute fleet, its builds are not deleted.arn (string) required
codebuild/delete_projectDeletes a build project. When you delete a project, its builds are not deleted.name (string) required
codebuild/delete_reportDeletes a report.arn (string) required
codebuild/delete_report_groupDeletes a report group. Before you delete a report group, you must delete its reports.arn (string) required
deleteReports (boolean)
codebuild/delete_resource_policyDeletes a resource policy that is identified by its resource ARN.resourceArn (string) required
codebuild/delete_source_credentialsDeletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.arn (string) required
codebuild/delete_webhookFor 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.projectName (string) required
codebuild/describe_code_coveragesRetrieves one or more code coverage reports.reportArn (string) required
nextToken (string)
maxResults (integer)
sortOrder (string)
sortBy (string)
minLineCoveragePercentage (number)
maxLineCoveragePercentage (number)
codebuild/describe_test_casesReturns a list of details about test cases for a report.reportArn (string) required
nextToken (string)
maxResults (integer)
filter: {
. status (string)
. keyword (string)
} (object)
codebuild/get_report_group_trendAnalyzes and accumulates test report values for the specified test reports.reportGroupArn (string) required
numOfReports (integer)
trendField (string) required
codebuild/get_resource_policyGets a resource policy that is identified by its resource ARN.resourceArn (string) required
codebuild/import_source_credentialsImports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository.username (string)
token (string) required
serverType (string) required
authType (string) required
shouldOverwrite (boolean)
codebuild/invalidate_project_cacheResets the cache for a project.projectName (string) required
codebuild/list_build_batchesRetrieves the identifiers of your build batches in the current region.filter: {
. status (string)
} (object)
maxResults (integer)
sortOrder (string)
nextToken (string)
codebuild/list_build_batches_for_projectRetrieves the identifiers of the build batches for a specific project.projectName (string)
filter: {
. status (string)
} (object)
maxResults (integer)
sortOrder (string)
nextToken (string)
codebuild/list_buildsGets a list of build IDs, with each build ID representing a single build.sortOrder (string)
nextToken (string)
codebuild/list_builds_for_projectGets a list of build identifiers for the specified build project, with each build identifier representing a single build.projectName (string) required
sortOrder (string)
nextToken (string)
codebuild/list_command_executions_for_sandboxGets a list of command executions for a sandbox.sandboxId (string) required
maxResults (integer)
sortOrder (string)
nextToken (string)
codebuild/list_curated_environment_imagesGets information about Docker images that are managed by CodeBuild.No parameters
codebuild/list_fleetsGets a list of compute fleet names with each compute fleet name representing a single compute fleet.nextToken (string)
maxResults (integer)
sortOrder (string)
sortBy (string)
codebuild/list_projectsGets a list of build project names, with each build project name representing a single build project.sortBy (string)
sortOrder (string)
nextToken (string)
codebuild/list_report_groupsGets a list ARNs for the report groups in the current Amazon Web Services account.sortOrder (string)
sortBy (string)
nextToken (string)
maxResults (integer)
codebuild/list_reportsReturns a list of ARNs for the reports in the current Amazon Web Services account.sortOrder (string)
nextToken (string)
maxResults (integer)
filter: {
. status (string)
} (object)
codebuild/list_reports_for_report_groupReturns a list of ARNs for the reports that belong to a ReportGroup.reportGroupArn (string) required
nextToken (string)
sortOrder (string)
maxResults (integer)
filter: {
. status (string)
} (object)
codebuild/list_sandboxesGets a list of sandboxes.maxResults (integer)
sortOrder (string)
nextToken (string)
codebuild/list_sandboxes_for_projectGets a list of sandboxes for a given project.projectName (string) required
maxResults (integer)
sortOrder (string)
nextToken (string)
codebuild/list_shared_projectsGets a list of projects that are shared with other Amazon Web Services accounts or users.sortBy (string)
sortOrder (string)
maxResults (integer)
nextToken (string)
codebuild/list_shared_report_groupsGets a list of report groups that are shared with other Amazon Web Services accounts or users.sortOrder (string)
sortBy (string)
nextToken (string)
maxResults (integer)
codebuild/list_source_credentialsReturns a list of SourceCredentialsInfo objects.No parameters
codebuild/put_resource_policyStores a resource policy for the ARN of a Project or ReportGroup object.policy (string) required
resourceArn (string) required
codebuild/retry_buildRestarts a build.id (string)
idempotencyToken (string)
codebuild/retry_build_batchRestarts a failed batch build. Only batch builds that have failed can be retried.id (string)
idempotencyToken (string)
retryType (string)
codebuild/start_buildStarts running a build with the settings defined in the project. These setting include: how to run a build, where to get the source code, which build environment to use, which build commands to run, and where to store the build output. You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that specific start build request. The settings in the project are unaltered.projectName (string) required
secondarySourcesOverride (array)
secondarySourcesVersionOverride (array)
sourceVersion (string)
artifactsOverride: {
. type (string)
. location (string)
. path (string)
. namespaceType (string)
. name (string)
. packaging (string)
. overrideArtifactName (boolean)
. encryptionDisabled (boolean)
. artifactIdentifier (string)
. bucketOwnerAccess (string)
} (object)
secondaryArtifactsOverride (array)
environmentVariablesOverride (array)
sourceTypeOverride (string)
sourceLocationOverride (string)
sourceAuthOverride: {
. type (string)
. resource (string)
} (object)
gitCloneDepthOverride (integer)
gitSubmodulesConfigOverride: {
. fetchSubmodules (boolean)
} (object)
buildspecOverride (string)
insecureSslOverride (boolean)
reportBuildStatusOverride (boolean)
buildStatusConfigOverride: {
. context (string)
. targetUrl (string)
} (object)
environmentTypeOverride (string)
imageOverride (string)
computeTypeOverride (string)
certificateOverride (string)
cacheOverride: {
. type (string)
. location (string)
. modes (array)
. cacheNamespace (string)
} (object)
serviceRoleOverride (string)
privilegedModeOverride (boolean)
timeoutInMinutesOverride (integer)
queuedTimeoutInMinutesOverride (integer)
encryptionKeyOverride (string)
idempotencyToken (string)
logsConfigOverride: {
. cloudWatchLogs (object)
. s3Logs (object)
} (object)
registryCredentialOverride: {
. credential (string)
. credentialProvider (string)
} (object)
imagePullCredentialsTypeOverride (string)
debugSessionEnabled (boolean)
fleetOverride: {
. fleetArn (string)
} (object)
autoRetryLimitOverride (integer)
codebuild/start_build_batchStarts a batch build for a project.projectName (string) required
secondarySourcesOverride (array)
secondarySourcesVersionOverride (array)
sourceVersion (string)
artifactsOverride: {
. type (string)
. location (string)
. path (string)
. namespaceType (string)
. name (string)
. packaging (string)
. overrideArtifactName (boolean)
. encryptionDisabled (boolean)
. artifactIdentifier (string)
. bucketOwnerAccess (string)
} (object)
secondaryArtifactsOverride (array)
environmentVariablesOverride (array)
sourceTypeOverride (string)
sourceLocationOverride (string)
sourceAuthOverride: {
. type (string)
. resource (string)
} (object)
gitCloneDepthOverride (integer)
gitSubmodulesConfigOverride: {
. fetchSubmodules (boolean)
} (object)
buildspecOverride (string)
insecureSslOverride (boolean)
reportBuildBatchStatusOverride (boolean)
environmentTypeOverride (string)
imageOverride (string)
computeTypeOverride (string)
certificateOverride (string)
cacheOverride: {
. type (string)
. location (string)
. modes (array)
. cacheNamespace (string)
} (object)
serviceRoleOverride (string)
privilegedModeOverride (boolean)
buildTimeoutInMinutesOverride (integer)
queuedTimeoutInMinutesOverride (integer)
encryptionKeyOverride (string)
idempotencyToken (string)
logsConfigOverride: {
. cloudWatchLogs (object)
. s3Logs (object)
} (object)
registryCredentialOverride: {
. credential (string)
. credentialProvider (string)
} (object)
imagePullCredentialsTypeOverride (string)
buildBatchConfigOverride: {
. serviceRole (string)
. combineArtifacts (boolean)
. restrictions (object)
. timeoutInMins (integer)
. batchReportMode (string)
} (object)
debugSessionEnabled (boolean)
codebuild/start_command_executionStarts a command execution.sandboxId (string) required
command (string) required
type (string)
codebuild/start_sandboxStarts a sandbox.projectName (string)
idempotencyToken (string)
codebuild/start_sandbox_connectionStarts a sandbox connection.sandboxId (string) required
codebuild/stop_buildAttempts to stop running a build.id (string) required
codebuild/stop_build_batchStops a running batch build.id (string) required
codebuild/stop_sandboxStops a sandbox.id (string) required
codebuild/update_fleetUpdates a compute fleet.arn (string) required
baseCapacity (integer)
environmentType (string)
computeType (string)
computeConfiguration: {
. vCpu (integer)
. memory (integer)
. disk (integer)
. machineType (string)
. instanceType (string)
} (object)
scalingConfiguration: {
. scalingType (string)
. targetTrackingScalingConfigs (array)
. maxCapacity (integer)
} (object)
overflowBehavior (string)
vpcConfig: {
. vpcId (string)
. subnets (array)
. securityGroupIds (array)
} (object)
proxyConfiguration: {
. defaultBehavior (string)
. orderedProxyRules (array)
} (object)
imageId (string)
fleetServiceRole (string)
tags (array)
codebuild/update_projectChanges the settings of a build project.name (string) required
description (string)
source: {
. type (string)
. location (string)
. gitCloneDepth (integer)
. gitSubmodulesConfig (object)
. buildspec (string)
. auth (object)
. reportBuildStatus (boolean)
. buildStatusConfig (object)
. insecureSsl (boolean)
. sourceIdentifier (string)
} (object)
secondarySources (array)
sourceVersion (string)
secondarySourceVersions (array)
artifacts: {
. type (string)
. location (string)
. path (string)
. namespaceType (string)
. name (string)
. packaging (string)
. overrideArtifactName (boolean)
. encryptionDisabled (boolean)
. artifactIdentifier (string)
. bucketOwnerAccess (string)
} (object)
secondaryArtifacts (array)
cache: {
. type (string)
. location (string)
. modes (array)
. cacheNamespace (string)
} (object)
environment: {
. type (string)
. image (string)
. computeType (string)
. computeConfiguration (object)
. fleet (object)
. environmentVariables (array)
. privilegedMode (boolean)
. certificate (string)
. registryCredential (object)
. imagePullCredentialsType (string)
. dockerServer (object)
} (object)
serviceRole (string)
timeoutInMinutes (integer)
queuedTimeoutInMinutes (integer)
encryptionKey (string)
tags (array)
vpcConfig: {
. vpcId (string)
. subnets (array)
. securityGroupIds (array)
} (object)
badgeEnabled (boolean)
logsConfig: {
. cloudWatchLogs (object)
. s3Logs (object)
} (object)
fileSystemLocations (array)
buildBatchConfig: {
. serviceRole (string)
. combineArtifacts (boolean)
. restrictions (object)
. timeoutInMins (integer)
. batchReportMode (string)
} (object)
concurrentBuildLimit (integer)
autoRetryLimit (integer)
codebuild/update_project_visibilityChanges 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. EnvironmenprojectArn (string) required
projectVisibility (string) required
resourceAccessRole (string)
codebuild/update_report_groupUpdates a report group.arn (string) required
exportConfig: {
. exportConfigType (string)
. s3Destination (object)
} (object)
tags (array)
codebuild/update_webhookUpdates the webhook associated with an CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored.projectName (string) required
branchFilter (string)
rotateSecret (boolean)
filterGroups (array)
buildType (string)
pullRequestBuildPolicy: {
. requiresCommentApproval (string)
. approverRoles (array)
} (object)
codecatalyst/get_user_detailsReturns information about a user.id (string)
userName (string)
codecatalyst/verify_sessionVerifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.No parameters
codecatalyst/create_access_tokenCreates a personal access token PAT for the current user. A personal access token PAT is similar to a password. It is associated with your user identity for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst from resources that include integrated development environments IDEs and Git-based source repositories. PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see Managing personal access tokenname (string) required
expiresTime (string)
codecatalyst/delete_access_tokenDeletes a specified personal access token PAT. A personal access token can only be deleted by the user who created it.id (string) required
codecatalyst/list_access_tokensLists all personal access tokens PATs associated with the user who calls the API. You can only list PATs associated with your Amazon Web Services Builder ID.maxResults (integer)
nextToken (string)
codecatalyst/list_dev_environmentsRetrieves a list of Dev Environments in a project.spaceName (string) required
projectName (string)
filters (array)
nextToken (string)
maxResults (integer)
codecatalyst/get_spaceReturns information about an space.name (string) required
codecatalyst/update_spaceChanges one or more values for a space.name (string) required
description (string)
codecatalyst/delete_spaceDeletes a space. Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.name (string) required
codecatalyst/list_spacesRetrieves a list of spaces.nextToken (string)
codecatalyst/list_event_logsRetrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more information, see Monitoring in the Amazon CodeCatalyst User Guide. ListEventLogs guarantees events for the last 30 days in a given space. You can also view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst in the CloudTrail console by viewing Event history, or by creating a trail to create and maintain a rspaceName (string) required
startTime (string) required
endTime (string) required
eventName (string)
nextToken (string)
maxResults (integer)
codecatalyst/create_projectCreates a project in a specified space.spaceName (string) required
displayName (string) required
description (string)
codecatalyst/get_projectReturns information about a project.spaceName (string) required
name (string) required
codecatalyst/update_projectChanges one or more values for a project.spaceName (string) required
name (string) required
description (string)
codecatalyst/delete_projectDeletes a project in a space.spaceName (string) required
name (string) required
codecatalyst/list_projectsRetrieves a list of projects.spaceName (string) required
nextToken (string)
maxResults (integer)
filters (array)
codecatalyst/list_dev_environment_sessionsRetrieves a list of active sessions for a Dev Environment in a project.spaceName (string) required
projectName (string) required
devEnvironmentId (string) required
nextToken (string)
maxResults (integer)
codecatalyst/start_dev_environmentStarts a specified Dev Environment and puts it into an active state.spaceName (string) required
projectName (string) required
id (string) required
ides (array)
instanceType (string)
inactivityTimeoutMinutes (integer)
codecatalyst/start_dev_environment_sessionStarts a session for a specified Dev Environment.spaceName (string) required
projectName (string) required
id (string) required
sessionConfiguration: {
. sessionType (string)
. executeCommandSessionConfiguration (object)
} (object) required
codecatalyst/stop_dev_environmentPauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.spaceName (string) required
projectName (string) required
id (string) required
codecatalyst/stop_dev_environment_sessionStops a session for a specified Dev Environment.spaceName (string) required
projectName (string) required
id (string) required
sessionId (string) required
codecatalyst/create_dev_environmentCreates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project. When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these defaults apply to a Dev Environment created programmatically.spaceName (string) required
projectName (string) required
repositories (array)
clientToken (string)
alias (string)
ides (array)
instanceType (string) required
inactivityTimeoutMinutes (integer)
persistentStorage: {
. sizeInGiB (integer)
} (object) required
vpcConnectionName (string)
codecatalyst/get_dev_environmentReturns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.spaceName (string) required
projectName (string) required
id (string) required
codecatalyst/update_dev_environmentChanges one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.spaceName (string) required
projectName (string) required
id (string) required
alias (string)
ides (array)
instanceType (string)
inactivityTimeoutMinutes (integer)
clientToken (string)
codecatalyst/delete_dev_environmentDeletes a Dev Environment.spaceName (string) required
projectName (string) required
id (string) required
codecatalyst/get_source_repository_clone_urlsReturns information about the URLs that can be used with a Git client to clone a source repository.spaceName (string) required
projectName (string) required
sourceRepositoryName (string) required
codecatalyst/get_source_repositoryReturns information about a source repository.spaceName (string) required
projectName (string) required
name (string) required
codecatalyst/delete_source_repositoryDeletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst source repository.spaceName (string) required
projectName (string) required
name (string) required
codecatalyst/list_source_repositoriesRetrieves a list of source repositories in a project.spaceName (string) required
projectName (string) required
nextToken (string)
maxResults (integer)
codecatalyst/create_source_repositoryCreates an empty Git-based source repository in a specified project. The repository is created with an initial empty commit with a default branch named main.spaceName (string) required
projectName (string) required
name (string) required
description (string)
codecatalyst/list_source_repository_branchesRetrieves a list of branches in a specified source repository.spaceName (string) required
projectName (string) required
sourceRepositoryName (string) required
nextToken (string)
maxResults (integer)
codecatalyst/create_source_repository_branchCreates a branch in a specified source repository in Amazon CodeCatalyst. This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.spaceName (string) required
projectName (string) required
sourceRepositoryName (string) required
name (string) required
headCommitId (string)
codecatalyst/get_workflowReturns information about a workflow.spaceName (string) required
id (string) required
projectName (string) required
codecatalyst/list_workflowsRetrieves a list of workflows in a specified project.spaceName (string) required
projectName (string) required
nextToken (string)
maxResults (integer)
sortBy (array)
codecatalyst/start_workflow_runBegins a run of a specified workflow.spaceName (string) required
projectName (string) required
workflowId (string) required
clientToken (string)
codecatalyst/get_workflow_runReturns information about a specified run of a workflow.spaceName (string) required
id (string) required
projectName (string) required
codecatalyst/list_workflow_runsRetrieves a list of workflow runs of a specified workflow.spaceName (string) required
workflowId (string)
projectName (string) required
nextToken (string)
maxResults (integer)
sortBy (array)
codecatalyst/get_subscriptionReturns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.spaceName (string) required
codecommit/associate_approval_rule_template_with_repositoryCreates 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 requeapprovalRuleTemplateName (string) required
repositoryName (string) required
codecommit/batch_associate_approval_rule_template_with_repositoriesCreates an association between an approval rule template and one or more specified repositories.approvalRuleTemplateName (string) required
repositoryNames (array) required
codecommit/batch_describe_merge_conflictsReturns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy.repositoryName (string) required
destinationCommitSpecifier (string) required
sourceCommitSpecifier (string) required
mergeOption (string) required
maxMergeHunks (integer)
maxConflictFiles (integer)
filePaths (array)
conflictDetailLevel (string)
conflictResolutionStrategy (string)
nextToken (string)
codecommit/batch_disassociate_approval_rule_template_from_repositoriesRemoves the association between an approval rule template and one or more specified repositories.approvalRuleTemplateName (string) required
repositoryNames (array) required
codecommit/batch_get_commitsReturns information about the contents of one or more commits in a repository.commitIds (array) required
repositoryName (string) required
codecommit/batch_get_repositoriesReturns 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.repositoryNames (array) required
codecommit/create_approval_rule_templateCreates a template for approval rules that can then be associated with one or more repositories in your Amazon Web Services account. When you associate a template with a repository, 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.approvalRuleTemplateName (string) required
approvalRuleTemplateContent (string) required
approvalRuleTemplateDescription (string)
codecommit/create_branchCreates 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.repositoryName (string) required
branchName (string) required
commitId (string) required
codecommit/create_commitCreates a commit for a repository on the tip of a specified branch.repositoryName (string) required
branchName (string) required
parentCommitId (string)
authorName (string)
email (string)
commitMessage (string)
keepEmptyFolders (boolean)
putFiles (array)
deleteFiles (array)
setFileModes (array)
codecommit/create_pull_requestCreates a pull request in the specified repository.title (string) required
description (string)
targets (array) required
clientRequestToken (string)
codecommit/create_pull_request_approval_ruleCreates an approval rule for a pull request.pullRequestId (string) required
approvalRuleName (string) required
approvalRuleContent (string) required
codecommit/create_repositoryCreates a new, empty repository.repositoryName (string) required
repositoryDescription (string)
tags (object)
kmsKeyId (string)
codecommit/create_unreferenced_merge_commitCreates 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.repositoryName (string) required
sourceCommitSpecifier (string) required
destinationCommitSpecifier (string) required
mergeOption (string) required
conflictDetailLevel (string)
conflictResolutionStrategy (string)
authorName (string)
email (string)
commitMessage (string)
keepEmptyFolders (boolean)
conflictResolution: {
. replaceContents (array)
. deleteFiles (array)
. setFileModes (array)
} (object)
codecommit/delete_approval_rule_templateDeletes a specified approval rule template. Deleting a template does not remove approval rules on pull requests already created with the template.approvalRuleTemplateName (string) required
codecommit/delete_branchDeletes a branch from a repository, unless that branch is the default branch for the repository.repositoryName (string) required
branchName (string) required
codecommit/delete_comment_contentDeletes the content of a comment made on a change, file, or commit in a repository.commentId (string) required
codecommit/delete_fileDeletes 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.repositoryName (string) required
branchName (string) required
filePath (string) required
parentCommitId (string) required
keepEmptyFolders (boolean)
commitMessage (string)
name (string)
email (string)
codecommit/delete_pull_request_approval_ruleDeletes 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.pullRequestId (string) required
approvalRuleName (string) required
codecommit/delete_repositoryDeletes 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.repositoryName (string) required
codecommit/describe_merge_conflictsReturns 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.repositoryName (string) required
destinationCommitSpecifier (string) required
sourceCommitSpecifier (string) required
mergeOption (string) required
maxMergeHunks (integer)
filePath (string) required
conflictDetailLevel (string)
conflictResolutionStrategy (string)
nextToken (string)
codecommit/describe_pull_request_eventsReturns information about one or more pull request events.pullRequestId (string) required
pullRequestEventType (string)
actorArn (string)
nextToken (string)
maxResults (integer)
codecommit/disassociate_approval_rule_template_from_repositoryRemoves 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.approvalRuleTemplateName (string) required
repositoryName (string) required
codecommit/evaluate_pull_request_approval_rulesEvaluates whether a pull request has met all the conditions specified in its associated approval rules.pullRequestId (string) required
revisionId (string) required
codecommit/get_approval_rule_templateReturns information about a specified approval rule template.approvalRuleTemplateName (string) required
codecommit/get_blobReturns the base-64 encoded content of an individual blob in a repository.repositoryName (string) required
blobId (string) required
codecommit/get_branchReturns information about a repository branch, including its name and the last commit ID.repositoryName (string)
branchName (string)
codecommit/get_commentReturns 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.commentId (string) required
codecommit/get_comment_reactionsReturns information about reactions to a specified comment ID. Reactions from users who have been deleted will not be included in the count.commentId (string) required
reactionUserArn (string)
nextToken (string)
maxResults (integer)
codecommit/get_comments_for_compared_commitReturns 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.repositoryName (string) required
beforeCommitId (string)
afterCommitId (string) required
nextToken (string)
maxResults (integer)
codecommit/get_comments_for_pull_requestReturns 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.pullRequestId (string) required
repositoryName (string)
beforeCommitId (string)
afterCommitId (string)
nextToken (string)
maxResults (integer)
codecommit/get_commitReturns information about a commit, including commit message and committer information.repositoryName (string) required
commitId (string) required
codecommit/get_differencesReturns 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.repositoryName (string) required
beforeCommitSpecifier (string)
afterCommitSpecifier (string) required
beforePath (string)
afterPath (string)
MaxResults (integer)
NextToken (string)
codecommit/get_fileReturns the base-64 encoded contents of a specified file and its metadata.repositoryName (string) required
commitSpecifier (string)
filePath (string) required
codecommit/get_folderReturns the contents of a specified folder in a repository.repositoryName (string) required
commitSpecifier (string)
folderPath (string) required
codecommit/get_merge_commitReturns information about a specified merge commit.repositoryName (string) required
sourceCommitSpecifier (string) required
destinationCommitSpecifier (string) required
conflictDetailLevel (string)
conflictResolutionStrategy (string)
codecommit/get_merge_conflictsReturns information about merge conflicts between the before and after commit IDs for a pull request in a repository.repositoryName (string) required
destinationCommitSpecifier (string) required
sourceCommitSpecifier (string) required
mergeOption (string) required
conflictDetailLevel (string)
maxConflictFiles (integer)
conflictResolutionStrategy (string)
nextToken (string)
codecommit/get_merge_optionsReturns 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.repositoryName (string) required
sourceCommitSpecifier (string) required
destinationCommitSpecifier (string) required
conflictDetailLevel (string)
conflictResolutionStrategy (string)
codecommit/get_pull_requestGets information about a pull request in a specified repository.pullRequestId (string) required
codecommit/get_pull_request_approval_statesGets 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.pullRequestId (string) required
revisionId (string) required
codecommit/get_pull_request_override_stateReturns 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.pullRequestId (string) required
revisionId (string) required
codecommit/get_repositoryReturns 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.repositoryName (string) required
codecommit/get_repository_triggersGets information about triggers configured for a repository.repositoryName (string) required
codecommit/list_approval_rule_templatesLists all approval rule templates in the specified Amazon Web Services Region in your Amazon Web Services account. If an Amazon Web Services Region is not specified, the Amazon Web Services Region where you are signed in is used.nextToken (string)
maxResults (integer)
codecommit/list_associated_approval_rule_templates_for_repositoryLists all approval rule templates that are associated with a specified repository.repositoryName (string) required
nextToken (string)
maxResults (integer)
codecommit/list_branchesGets information about one or more branches in a repository.repositoryName (string) required
nextToken (string)
codecommit/list_file_commit_historyRetrieves a list of commits and changes to a specified file.repositoryName (string) required
commitSpecifier (string)
filePath (string) required
maxResults (integer)
nextToken (string)
codecommit/list_pull_requestsReturns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author ARN.repositoryName (string) required
authorArn (string)
pullRequestStatus (string)
nextToken (string)
maxResults (integer)
codecommit/list_repositoriesGets information about one or more repositories.nextToken (string)
sortBy (string)
order (string)
codecommit/list_repositories_for_approval_rule_templateLists all repositories associated with the specified approval rule template.approvalRuleTemplateName (string) required
nextToken (string)
maxResults (integer)
codecommit/list_tags_for_resourceGets information about Amazon Web Servicestags for a specified Amazon Resource Name ARN in CodeCommit. For a list of valid resources in CodeCommit, see CodeCommit Resources and Operations in the CodeCommit User Guide.resourceArn (string) required
nextToken (string)
codecommit/merge_branches_by_fast_forwardMerges two branches using the fast-forward merge strategy.repositoryName (string) required
sourceCommitSpecifier (string) required
destinationCommitSpecifier (string) required
targetBranch (string)
codecommit/merge_branches_by_squashMerges two branches using the squash merge strategy.repositoryName (string) required
sourceCommitSpecifier (string) required
destinationCommitSpecifier (string) required
targetBranch (string)
conflictDetailLevel (string)
conflictResolutionStrategy (string)
authorName (string)
email (string)
commitMessage (string)
keepEmptyFolders (boolean)
conflictResolution: {
. replaceContents (array)
. deleteFiles (array)
. setFileModes (array)
} (object)
codecommit/merge_branches_by_three_wayMerges two specified branches using the three-way merge strategy.repositoryName (string) required
sourceCommitSpecifier (string) required
destinationCommitSpecifier (string) required
targetBranch (string)
conflictDetailLevel (string)
conflictResolutionStrategy (string)
authorName (string)
email (string)
commitMessage (string)
keepEmptyFolders (boolean)
conflictResolution: {
. replaceContents (array)
. deleteFiles (array)
. setFileModes (array)
} (object)
codecommit/merge_pull_request_by_fast_forwardAttempts 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.pullRequestId (string) required
repositoryName (string) required
sourceCommitId (string)
codecommit/merge_pull_request_by_squashAttempts 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.pullRequestId (string) required
repositoryName (string) required
sourceCommitId (string)
conflictDetailLevel (string)
conflictResolutionStrategy (string)
commitMessage (string)
authorName (string)
email (string)
keepEmptyFolders (boolean)
conflictResolution: {
. replaceContents (array)
. deleteFiles (array)
. setFileModes (array)
} (object)
codecommit/merge_pull_request_by_three_wayAttempts 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.pullRequestId (string) required
repositoryName (string) required
sourceCommitId (string)
conflictDetailLevel (string)
conflictResolutionStrategy (string)
commitMessage (string)
authorName (string)
email (string)
keepEmptyFolders (boolean)
conflictResolution: {
. replaceContents (array)
. deleteFiles (array)
. setFileModes (array)
} (object)
codecommit/override_pull_request_approval_rulesSets aside overrides all approval rule requirements for a specified pull request.pullRequestId (string) required
revisionId (string) required
overrideStatus (string) required
codecommit/post_comment_for_compared_commitPosts a comment on the comparison between two commits.repositoryName (string) required
beforeCommitId (string)
afterCommitId (string) required
location: {
. filePath (string)
. filePosition (integer)
. relativeFileVersion (string)
} (object)
content (string) required
clientRequestToken (string)
codecommit/post_comment_for_pull_requestPosts a comment on a pull request.pullRequestId (string) required
repositoryName (string) required
beforeCommitId (string) required
afterCommitId (string) required
location: {
. filePath (string)
. filePosition (integer)
. relativeFileVersion (string)
} (object)
content (string) required
clientRequestToken (string)
codecommit/post_comment_replyPosts a comment in reply to an existing comment on a comparison between commits or a pull request.inReplyTo (string) required
clientRequestToken (string)
content (string) required
codecommit/put_comment_reactionAdds 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.commentId (string) required
reactionValue (string) required
codecommit/put_fileAdds or updates a file in a branch in an CodeCommit repository, and generates a commit for the addition in the specified branch.repositoryName (string) required
branchName (string) required
fileContent (string) required
filePath (string) required
fileMode (string)
parentCommitId (string)
commitMessage (string)
name (string)
email (string)
codecommit/put_repository_triggersReplaces all triggers for a repository. Used to create or delete triggers.repositoryName (string) required
triggers (array) required
codecommit/tag_resourceAdds or updates tags for a resource in CodeCommit. For a list of valid resources in CodeCommit, see CodeCommit Resources and Operations in the CodeCommit User Guide.resourceArn (string) required
tags (object) required
codecommit/test_repository_triggersTests 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.repositoryName (string) required
triggers (array) required
codecommit/untag_resourceRemoves tags for a resource in CodeCommit. For a list of valid resources in CodeCommit, see CodeCommit Resources and Operations in the CodeCommit User Guide.resourceArn (string) required
tagKeys (array) required
codecommit/update_approval_rule_template_contentUpdates 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.approvalRuleTemplateName (string) required
newRuleContent (string) required
existingRuleContentSha256 (string)
codecommit/update_approval_rule_template_descriptionUpdates the description for a specified approval rule template.approvalRuleTemplateName (string) required
approvalRuleTemplateDescription (string) required
codecommit/update_approval_rule_template_nameUpdates the name of a specified approval rule template.oldApprovalRuleTemplateName (string) required
newApprovalRuleTemplateName (string) required
codecommit/update_commentReplaces the contents of a comment.commentId (string) required
content (string) required
codecommit/update_default_branchSets 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.repositoryName (string) required
defaultBranchName (string) required
codecommit/update_pull_request_approval_rule_contentUpdates 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.pullRequestId (string) required
approvalRuleName (string) required
existingRuleContentSha256 (string)
newRuleContent (string) required
codecommit/update_pull_request_approval_stateUpdates 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.pullRequestId (string) required
revisionId (string) required
approvalState (string) required
codecommit/update_pull_request_descriptionReplaces the contents of the description of a pull request.pullRequestId (string) required
description (string) required
codecommit/update_pull_request_statusUpdates the status of a pull request.pullRequestId (string) required
pullRequestStatus (string) required
codecommit/update_pull_request_titleReplaces the title of a pull request.pullRequestId (string) required
title (string) required
codecommit/update_repository_descriptionSets 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.repositoryName (string) required
repositoryDescription (string)
codecommit/update_repository_encryption_keyUpdates the Key Management Service encryption key used to encrypt and decrypt a CodeCommit repository.repositoryName (string) required
kmsKeyId (string) required
codecommit/update_repository_nameRenames a repository. The repository name must be unique across the calling Amazon Web Services 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 Quotas in the CodeCommit User Guide.oldName (string) required
newName (string) required
codeconnections/create_connectionCreates a connection that can then be given to other Amazon Web Services 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.ProviderType (string)
ConnectionName (string) required
Tags (array)
HostArn (string)
codeconnections/create_hostCreates 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.Name (string) required
ProviderType (string) required
ProviderEndpoint (string) required
VpcConfiguration: {
. VpcId (string)
. SubnetIds (array)
. SecurityGroupIds (array)
. TlsCertificate (string)
} (object)
Tags (array)
codeconnections/create_repository_linkCreates a link to a specified external Git repository. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.ConnectionArn (string) required
OwnerId (string) required
RepositoryName (string) required
EncryptionKeyArn (string)
Tags (array)
codeconnections/create_sync_configurationCreates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource. Parameters for the sync configuration are determined by the sync type.Branch (string) required
ConfigFile (string) required
RepositoryLinkId (string) required
ResourceName (string) required
RoleArn (string) required
SyncType (string) required
PublishDeploymentStatus (string)
TriggerResourceUpdateOn (string)
PullRequestComment (string)
codeconnections/delete_connectionThe connection to be deleted.ConnectionArn (string) required
codeconnections/delete_hostThe 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.HostArn (string) required
codeconnections/delete_repository_linkDeletes the association between your connection and a specified external Git repository.RepositoryLinkId (string) required
codeconnections/delete_sync_configurationDeletes the sync configuration for a specified repository and connection.SyncType (string) required
ResourceName (string) required
codeconnections/get_connectionReturns the connection ARN and details such as status, owner, and provider type.ConnectionArn (string) required
codeconnections/get_hostReturns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.HostArn (string) required
codeconnections/get_repository_linkReturns details about a repository link. A repository link allows Git sync to monitor and sync changes from files in a specified Git repository.RepositoryLinkId (string) required
codeconnections/get_repository_sync_statusReturns details about the sync status for a repository. A repository sync uses Git sync to push and pull changes from your remote repository.Branch (string) required
RepositoryLinkId (string) required
SyncType (string) required
codeconnections/get_resource_sync_statusReturns the status of the sync with the Git repository for a specific Amazon Web Services resource.ResourceName (string) required
SyncType (string) required
codeconnections/get_sync_blocker_summaryReturns a list of the most recent sync blockers.SyncType (string) required
ResourceName (string) required
codeconnections/get_sync_configurationReturns details about a sync configuration, including the sync type and resource name. A sync configuration allows the configuration to sync push and pull changes from the remote repository for a specified branch in a Git repository.SyncType (string) required
ResourceName (string) required
codeconnections/list_connectionsLists the connections associated with your account.ProviderTypeFilter (string)
HostArnFilter (string)
MaxResults (integer)
NextToken (string)
codeconnections/list_hostsLists the hosts associated with your account.MaxResults (integer)
NextToken (string)
codeconnections/list_repository_linksLists the repository links created for connections in your account.MaxResults (integer)
NextToken (string)
codeconnections/list_repository_sync_definitionsLists the repository sync definitions for repository links in your account.RepositoryLinkId (string) required
SyncType (string) required
codeconnections/list_sync_configurationsReturns a list of sync configurations for a specified repository.MaxResults (integer)
NextToken (string)
RepositoryLinkId (string) required
SyncType (string) required
codeconnections/list_tags_for_resourceGets the set of key-value pairs metadata that are used to manage the resource.ResourceArn (string) required
codeconnections/tag_resourceAdds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.ResourceArn (string) required
Tags (array) required
codeconnections/untag_resourceRemoves tags from an Amazon Web Services resource.ResourceArn (string) required
TagKeys (array) required
codeconnections/update_hostUpdates a specified host with the provided configurations.HostArn (string) required
ProviderEndpoint (string)
VpcConfiguration: {
. VpcId (string)
. SubnetIds (array)
. SecurityGroupIds (array)
. TlsCertificate (string)
} (object)
codeconnections/update_repository_linkUpdates the association between your connection and a specified external Git repository. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.ConnectionArn (string)
EncryptionKeyArn (string)
RepositoryLinkId (string) required
codeconnections/update_sync_blockerAllows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.Id (string) required
SyncType (string) required
ResourceName (string) required
ResolvedReason (string) required
codeconnections/update_sync_configurationUpdates the sync configuration for your connection and a specified external Git repository.Branch (string)
ConfigFile (string)
RepositoryLinkId (string)
ResourceName (string) required
RoleArn (string)
SyncType (string) required
PublishDeploymentStatus (string)
TriggerResourceUpdateOn (string)
PullRequestComment (string)
codedeploy/add_tags_to_on_premises_instancesAdds tags to on-premises instances.tags (array) required
instanceNames (array) required
codedeploy/batch_get_application_revisionsGets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.applicationName (string) required
revisions (array) required
codedeploy/batch_get_applicationsGets information about one or more applications. The maximum number of applications that can be returned is 100.applicationNames (array) required
codedeploy/batch_get_deployment_groupsGets information about one or more deployment groups.applicationName (string) required
deploymentGroupNames (array) required
codedeploy/batch_get_deployment_instancesThis 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.deploymentId (string) required
instanceIds (array) required
codedeploy/batch_get_deploymentsGets information about one or more deployments. The maximum number of deployments that can be returned is 25.deploymentIds (array) required
codedeploy/batch_get_deployment_targetsReturns 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 servdeploymentId (string) required
targetIds (array) required
codedeploy/batch_get_on_premises_instancesGets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.instanceNames (array) required
codedeploy/continue_deploymentFor 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.deploymentId (string)
deploymentWaitType (string)
codedeploy/create_applicationCreates an application.applicationName (string) required
computePlatform (string)
tags (array)
codedeploy/create_deploymentDeploys an application revision through the specified deployment group.applicationName (string) required
deploymentGroupName (string)
revision: {
. revisionType (string)
. s3Location (object)
. gitHubLocation (object)
. string (object)
. appSpecContent (object)
} (object)
deploymentConfigName (string)
description (string)
ignoreApplicationStopFailures (boolean)
targetInstances: {
. tagFilters (array)
. autoScalingGroups (array)
. ec2TagSet (object)
} (object)
autoRollbackConfiguration: {
. enabled (boolean)
. events (array)
} (object)
updateOutdatedInstancesOnly (boolean)
fileExistsBehavior (string)
overrideAlarmConfiguration: {
. enabled (boolean)
. ignorePollAlarmFailure (boolean)
. alarms (array)
} (object)
codedeploy/create_deployment_configCreates a deployment configuration.deploymentConfigName (string) required
minimumHealthyHosts: {
. type (string)
. value (integer)
} (object)
trafficRoutingConfig: {
. type (string)
. timeBasedCanary (object)
. timeBasedLinear (object)
} (object)
computePlatform (string)
zonalConfig: {
. firstZoneMonitorDurationInSeconds (integer)
. monitorDurationInSeconds (integer)
. minimumHealthyHostsPerZone (object)
} (object)
codedeploy/create_deployment_groupCreates a deployment group to which application revisions are deployed.applicationName (string) required
deploymentGroupName (string) required
deploymentConfigName (string)
ec2TagFilters (array)
onPremisesInstanceTagFilters (array)
autoScalingGroups (array)
serviceRoleArn (string) required
triggerConfigurations (array)
alarmConfiguration: {
. enabled (boolean)
. ignorePollAlarmFailure (boolean)
. alarms (array)
} (object)
autoRollbackConfiguration: {
. enabled (boolean)
. events (array)
} (object)
outdatedInstancesStrategy (string)
deploymentStyle: {
. deploymentType (string)
. deploymentOption (string)
} (object)
blueGreenDeploymentConfiguration: {
. terminateBlueInstancesOnDeploymentSuccess (object)
. deploymentReadyOption (object)
. greenFleetProvisioningOption (object)
} (object)
loadBalancerInfo: {
. elbInfoList (array)
. targetGroupInfoList (array)
. targetGroupPairInfoList (array)
} (object)
ec2TagSet: {
. ec2TagSetList (array)
} (object)
ecsServices (array)
onPremisesTagSet: {
. onPremisesTagSetList (array)
} (object)
tags (array)
terminationHookEnabled (boolean)
codedeploy/delete_applicationDeletes an application.applicationName (string) required
codedeploy/delete_deployment_configDeletes a deployment configuration. A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.deploymentConfigName (string) required
codedeploy/delete_deployment_groupDeletes a deployment group.applicationName (string) required
deploymentGroupName (string) required
codedeploy/delete_git_hub_account_tokenDeletes a GitHub account connection.tokenName (string)
codedeploy/delete_resources_by_external_idDeletes resources linked to an external ID. This action only applies if you have configured blue/green deployments through CloudFormation. It is not necessary to call this action directly. CloudFormation calls it on your behalf when it needs to delete stack resources. This action is offered publicly in case you need to delete resources to comply with General Data Protection Regulation GDPR requirements.externalId (string)
codedeploy/deregister_on_premises_instanceDeregisters an on-premises instance.instanceName (string) required
codedeploy/get_applicationGets information about an application.applicationName (string) required
codedeploy/get_application_revisionGets information about an application revision.applicationName (string) required
revision: {
. revisionType (string)
. s3Location (object)
. gitHubLocation (object)
. string (object)
. appSpecContent (object)
} (object) required
codedeploy/get_deploymentGets 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.deploymentId (string) required
codedeploy/get_deployment_configGets information about a deployment configuration.deploymentConfigName (string) required
codedeploy/get_deployment_groupGets information about a deployment group.applicationName (string) required
deploymentGroupName (string) required
codedeploy/get_deployment_instanceGets information about an instance as part of a deployment.deploymentId (string) required
instanceId (string) required
codedeploy/get_deployment_targetReturns information about a deployment target.deploymentId (string) required
targetId (string) required
codedeploy/get_on_premises_instanceGets information about an on-premises instance.instanceName (string) required
codedeploy/list_application_revisionsLists information about revisions for an application.applicationName (string) required
sortBy (string)
sortOrder (string)
s3Bucket (string)
s3KeyPrefix (string)
deployed (string)
nextToken (string)
codedeploy/list_applicationsLists the applications registered with the user or Amazon Web Services account.nextToken (string)
codedeploy/list_deployment_configsLists the deployment configurations with the user or Amazon Web Services account.nextToken (string)
codedeploy/list_deployment_groupsLists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.applicationName (string) required
nextToken (string)
codedeploy/list_deployment_instancesThe 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 user or Amazon Web Services account.deploymentId (string) required
nextToken (string)
instanceStatusFilter (array)
instanceTypeFilter (array)
codedeploy/list_deploymentsLists the deployments in a deployment group for an application registered with the user or Amazon Web Services account.applicationName (string)
deploymentGroupName (string)
externalId (string)
includeOnlyStatuses (array)
createTimeRange: {
. start (string)
. end (string)
} (object)
nextToken (string)
codedeploy/list_deployment_targetsReturns an array of target IDs that are associated a deployment.deploymentId (string) required
nextToken (string)
targetFilters (object)
codedeploy/list_git_hub_account_token_namesLists the names of stored connections to GitHub accounts.nextToken (string)
codedeploy/list_on_premises_instancesGets 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.registrationStatus (string)
tagFilters (array)
nextToken (string)
codedeploy/list_tags_for_resourceReturns 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.ResourceArn (string) required
NextToken (string)
codedeploy/put_lifecycle_event_hook_execution_statusSets 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, seedeploymentId (string)
lifecycleEventHookExecutionId (string)
status (string)
codedeploy/register_application_revisionRegisters with CodeDeploy a revision for the specified application.applicationName (string) required
description (string)
revision: {
. revisionType (string)
. s3Location (object)
. gitHubLocation (object)
. string (object)
. appSpecContent (object)
} (object) required
codedeploy/register_on_premises_instanceRegisters 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.instanceName (string) required
iamSessionArn (string)
iamUserArn (string)
codedeploy/remove_tags_from_on_premises_instancesRemoves one or more tags from one or more on-premises instances.tags (array) required
instanceNames (array) required
codedeploy/skip_wait_time_for_instance_terminationIn a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.deploymentId (string)
codedeploy/stop_deploymentAttempts to stop an ongoing deployment.deploymentId (string) required
autoRollbackEnabled (boolean)
codedeploy/tag_resourceAssociates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.ResourceArn (string) required
Tags (array) required
codedeploy/untag_resourceDisassociates 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.ResourceArn (string) required
TagKeys (array) required
codedeploy/update_applicationChanges the name of an application.applicationName (string)
newApplicationName (string)
codedeploy/update_deployment_groupChanges information about a deployment group.applicationName (string) required
currentDeploymentGroupName (string) required
newDeploymentGroupName (string)
deploymentConfigName (string)
ec2TagFilters (array)
onPremisesInstanceTagFilters (array)
autoScalingGroups (array)
serviceRoleArn (string)
triggerConfigurations (array)
alarmConfiguration: {
. enabled (boolean)
. ignorePollAlarmFailure (boolean)
. alarms (array)
} (object)
autoRollbackConfiguration: {
. enabled (boolean)
. events (array)
} (object)
outdatedInstancesStrategy (string)
deploymentStyle: {
. deploymentType (string)
. deploymentOption (string)
} (object)
blueGreenDeploymentConfiguration: {
. terminateBlueInstancesOnDeploymentSuccess (object)
. deploymentReadyOption (object)
. greenFleetProvisioningOption (object)
} (object)
loadBalancerInfo: {
. elbInfoList (array)
. targetGroupInfoList (array)
. targetGroupPairInfoList (array)
} (object)
ec2TagSet: {
. ec2TagSetList (array)
} (object)
ecsServices (array)
onPremisesTagSet: {
. onPremisesTagSetList (array)
} (object)
terminationHookEnabled (boolean)
codeguru_reviewer/associate_repositoryUse 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 youRepository: {
. CodeCommit (object)
. Bitbucket (object)
. GitHubEnterpriseServer (object)
. S3Bucket (object)
} (object) required
ClientRequestToken (string)
Tags (object)
KMSKeyDetails: {
. KMSKeyId (string)
. EncryptionOption (string)
} (object)
codeguru_reviewer/create_code_reviewUse 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.Name (string) required
RepositoryAssociationArn (string) required
Type: {
. RepositoryAnalysis (object)
. AnalysisTypes (array)
} (object) required
ClientRequestToken (string)
codeguru_reviewer/describe_code_reviewReturns the metadata associated with the code review along with its status.CodeReviewArn (string) required
codeguru_reviewer/describe_recommendation_feedbackDescribes the customer feedback for a CodeGuru Reviewer recommendation.CodeReviewArn (string) required
RecommendationId (string) required
UserId (string)
codeguru_reviewer/describe_repository_associationReturns a RepositoryAssociation object that contains information about the requested repository association.AssociationArn (string) required
codeguru_reviewer/disassociate_repositoryRemoves the association between Amazon CodeGuru Reviewer and a repository.AssociationArn (string) required
codeguru_reviewer/list_code_reviewsLists all the code reviews that the customer has created in the past 90 days.ProviderTypes (array)
States (array)
RepositoryNames (array)
Type (string) required
MaxResults (integer)
NextToken (string)
codeguru_reviewer/list_recommendation_feedbackReturns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.NextToken (string)
MaxResults (integer)
CodeReviewArn (string) required
UserIds (array)
RecommendationIds (array)
codeguru_reviewer/list_recommendationsReturns the list of all recommendations for a completed code review.NextToken (string)
MaxResults (integer)
CodeReviewArn (string) required
codeguru_reviewer/list_repository_associationsReturns 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.ProviderTypes (array)
States (array)
Names (array)
Owners (array)
MaxResults (integer)
NextToken (string)
codeguru_reviewer/list_tags_for_resourceReturns the list of tags associated with an associated repository resource.resourceArn (string) required
codeguru_reviewer/put_recommendation_feedbackStores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.CodeReviewArn (string) required
RecommendationId (string) required
Reactions (array) required
codeguru_reviewer/tag_resourceAdds one or more tags to an associated repository.resourceArn (string) required
Tags (object) required
codeguru_reviewer/untag_resourceRemoves a tag from an associated repository.resourceArn (string) required
TagKeys (array) required
codeguru_security/batch_get_findingsReturns a list of requested findings from standard scans.findingIdentifiers (array) required
codeguru_security/create_scanUse to create a scan using code uploaded to an Amazon S3 bucket.clientToken (string)
resourceId (undefined) required
scanName (string) required
scanType (string)
analysisType (string)
tags (object)
codeguru_security/create_upload_urlGenerates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource. You can upload your code resource to the URL with the request headers using any HTTP client.scanName (string) required
codeguru_security/get_account_configurationUse to get the encryption configuration for an account.No parameters
codeguru_security/get_findingsReturns a list of all findings generated by a particular scan.scanName (string) required
nextToken (string)
maxResults (integer)
status (string)
codeguru_security/get_metrics_summaryReturns a summary of metrics for an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.date (string) required
codeguru_security/get_scanReturns details about a scan, including whether or not a scan has completed.scanName (string) required
runId (string)
codeguru_security/list_findings_metricsReturns metrics about all findings in an account within a specified time range.nextToken (string)
maxResults (integer)
startDate (string) required
endDate (string) required
codeguru_security/list_scansReturns a list of all scans in an account. Does not return EXPRESS scans.nextToken (string)
maxResults (integer)
codeguru_security/list_tags_for_resourceReturns a list of all tags associated with a scan.resourceArn (string) required
codeguru_security/tag_resourceUse to add one or more tags to an existing scan.resourceArn (string) required
tags (object) required
codeguru_security/untag_resourceUse to remove one or more tags from an existing scan.resourceArn (string) required
tagKeys (array) required
codeguru_security/update_account_configurationUse to update the encryption configuration for an account.encryptionConfig: {
. kmsKeyArn (string)
} (object) required
codeguruprofiler/get_findings_report_account_summaryReturns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.nextToken (string)
maxResults (integer)
dailyReportsOnly (boolean)
codeguruprofiler/list_tags_for_resourceReturns a list of the tags that are assigned to a specified resource.resourceArn (string) required
codeguruprofiler/tag_resourceUse to assign one or more tags to a resource.resourceArn (string) required
tags (object) required
codeguruprofiler/untag_resourceUse to remove one or more tags from a resource.resourceArn (string) required
tagKeys (array) required
codeguruprofiler/add_notification_channelsAdd up to 2 anomaly notifications channels for a profiling group.profilingGroupName (string) required
channels (array) required
codeguruprofiler/batch_get_frame_metric_dataReturns the time series of values for a requested list of frame metrics from a time period.profilingGroupName (string) required
startTime (string)
endTime (string)
period (string)
targetResolution (string)
frameMetrics (array)
codeguruprofiler/configure_agentUsed 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.profilingGroupName (string) required
fleetInstanceId (string)
metadata (object)
codeguruprofiler/get_notification_configurationGet the current configuration for anomaly notifications for a profiling group.profilingGroupName (string) required
codeguruprofiler/get_policyReturns the JSON-formatted resource-based policy on a profiling group.profilingGroupName (string) required
codeguruprofiler/get_profileGets 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. Because aggregated profiles expire over time GetProfile is not idempotent. Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: startTime, endTime, period. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specifyprofilingGroupName (string) required
startTime (string)
period (string)
endTime (string)
maxDepth (integer)
accept (string)
codeguruprofiler/get_recommendationsReturns 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.profilingGroupName (string) required
startTime (string) required
endTime (string) required
locale (string)
codeguruprofiler/list_findings_reportsList the available reports for a given profiling group and time range.profilingGroupName (string) required
startTime (string) required
endTime (string) required
nextToken (string)
maxResults (integer)
dailyReportsOnly (boolean)
codeguruprofiler/list_profile_timesLists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.profilingGroupName (string) required
startTime (string) required
endTime (string) required
period (string) required
orderBy (string)
maxResults (integer)
nextToken (string)
codeguruprofiler/post_agent_profileSubmits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use GetProfile .profilingGroupName (string) required
agentProfile (string) required
profileToken (string)
contentType (string) required
codeguruprofiler/put_permissionAdds 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. The one supported action group that can be added is agentPermission which grants ConfigureAgent and PostAgent permissions. For more information, see Resource-based policies in CodeGuru Profiler in the Amazon CodeGuru ProfprofilingGroupName (string) required
actionGroup (string) required
principals (array) required
revisionId (string)
codeguruprofiler/remove_notification_channelRemove one anomaly notifications channel for a profiling group.profilingGroupName (string) required
channelId (string) required
codeguruprofiler/remove_permissionRemoves 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 .profilingGroupName (string) required
actionGroup (string) required
revisionId (string) required
codeguruprofiler/submit_feedbackSends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.profilingGroupName (string) required
anomalyInstanceId (string) required
type (string) required
comment (string)
codeguruprofiler/describe_profiling_groupReturns a ProfilingGroupDescription object that contains information about the requested profiling group.profilingGroupName (string) required
codeguruprofiler/update_profiling_groupUpdates a profiling group.profilingGroupName (string) required
agentOrchestrationConfig: {
. profilingEnabled (boolean)
} (object) required
codeguruprofiler/delete_profiling_groupDeletes a profiling group.profilingGroupName (string) required
codeguruprofiler/list_profiling_groupsReturns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.nextToken (string)
maxResults (integer)
includeDescription (boolean)
codeguruprofiler/create_profiling_groupCreates a profiling group.profilingGroupName (string) required
computePlatform (string)
clientToken (string) required
agentOrchestrationConfig: {
. profilingEnabled (boolean)
} (object)
tags (object)
codepipeline/acknowledge_jobReturns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.jobId (string) required
nonce (string) required
codepipeline/acknowledge_third_party_jobConfirms a job worker has received the specified job. Used for partner actions only.jobId (string) required
nonce (string) required
clientToken (string) required
codepipeline/create_custom_action_typeCreates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.category (string) required
provider (string) required
version (string) required
settings: {
. thirdPartyConfigurationUrl (string)
. entityUrlTemplate (string)
. executionUrlTemplate (string)
. revisionUrlTemplate (string)
} (object)
configurationProperties (array)
inputArtifactDetails: {
. minimumCount (integer)
. maximumCount (integer)
} (object) required
outputArtifactDetails: {
. minimumCount (integer)
. maximumCount (integer)
} (object) required
tags (array)
codepipeline/create_pipelineCreates 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.pipeline: {
. name (string)
. roleArn (string)
. artifactStore (object)
. artifactStores (object)
. stages (array)
. version (integer)
. executionMode (string)
. pipelineType (string)
. variables (array)
. triggers (array)
} (object) required
tags (array)
codepipeline/delete_custom_action_typeMarks 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.category (string) required
provider (string) required
version (string) required
codepipeline/delete_pipelineDeletes the specified pipeline.name (string) required
codepipeline/delete_webhookDeletes a previously created webhook by name. Deleting the webhook stops 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.name (string) required
codepipeline/deregister_webhook_with_third_partyRemoves 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.webhookName (string)
codepipeline/disable_stage_transitionPrevents artifacts in a pipeline from transitioning to the next stage in the pipeline.pipelineName (string) required
stageName (string) required
transitionType (string) required
reason (string) required
codepipeline/enable_stage_transitionEnables artifacts in a pipeline to transition to a stage in a pipeline.pipelineName (string) required
stageName (string) required
transitionType (string) required
codepipeline/get_action_typeReturns 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.category (string) required
owner (string) required
provider (string) required
version (string) required
codepipeline/get_job_detailsReturns information about a job. Used for custom actions only. When this API is called, 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.jobId (string) required
codepipeline/get_pipelineReturns 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.name (string) required
version (integer)
codepipeline/get_pipeline_executionReturns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.pipelineName (string) required
pipelineExecutionId (string) required
codepipeline/get_pipeline_stateReturns 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.name (string) required
codepipeline/get_third_party_job_detailsRequests the details of a job for a third party action. Used for partner actions only. When this API is called, 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.jobId (string) required
clientToken (string) required
codepipeline/list_action_executionsLists the action executions that have occurred in a pipeline.pipelineName (string) required
filter: {
. pipelineExecutionId (string)
. latestInPipelineExecution (object)
} (object)
maxResults (integer)
nextToken (string)
codepipeline/list_action_typesGets a summary of all CodePipeline action types associated with your account.actionOwnerFilter (string)
nextToken (string)
regionFilter (string)
codepipeline/list_deploy_action_execution_targetsLists the targets for the deploy action.pipelineName (string)
actionExecutionId (string) required
filters (array)
maxResults (integer)
nextToken (string)
codepipeline/list_pipeline_executionsGets a summary of the most recent executions for a pipeline. When applying the filter for pipeline executions that have succeeded in the stage, the operation returns all executions in the current pipeline version beginning on February 1, 2024.pipelineName (string) required
maxResults (integer)
filter: {
. succeededInStage (object)
} (object)
nextToken (string)
codepipeline/list_pipelinesGets a summary of all of the pipelines associated with your account.nextToken (string)
maxResults (integer)
codepipeline/list_rule_executionsLists the rule executions that have occurred in a pipeline configured for conditions with rules.pipelineName (string) required
filter: {
. pipelineExecutionId (string)
. latestInPipelineExecution (object)
} (object)
maxResults (integer)
nextToken (string)
codepipeline/list_rule_typesLists the rules for the condition. For more information about conditions, see Stage conditions and How do stage conditions work?.For more information about rules, see the CodePipeline rule reference.ruleOwnerFilter (string)
regionFilter (string)
codepipeline/list_tags_for_resourceGets the set of key-value pairs metadata that are used to manage the resource.resourceArn (string) required
nextToken (string)
maxResults (integer)
codepipeline/list_webhooksGets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook. If a secret token was provided, it will be redacted in the response.NextToken (string)
MaxResults (integer)
codepipeline/override_stage_conditionUsed to override a stage condition. For more information about conditions, see Stage conditions and How do stage conditions work?.pipelineName (string) required
stageName (string) required
pipelineExecutionId (string) required
conditionType (string) required
codepipeline/poll_for_jobsReturns information about any jobs for 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, 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 defineactionTypeId: {
. category (string)
. owner (string)
. provider (string)
. version (string)
} (object) required
maxBatchSize (integer)
queryParam (object)
codepipeline/poll_for_third_party_jobsDetermines whether there are any third party jobs for a job worker to act on. Used for partner actions only. When this API is called, 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.actionTypeId: {
. category (string)
. owner (string)
. provider (string)
. version (string)
} (object) required
maxBatchSize (integer)
codepipeline/put_action_revisionProvides information to CodePipeline about new revisions to a source.pipelineName (string) required
stageName (string) required
actionName (string) required
actionRevision: {
. revisionId (string)
. revisionChangeId (string)
. created (string)
} (object) required
codepipeline/put_approval_resultProvides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.pipelineName (string) required
stageName (string) required
actionName (string) required
result: {
. summary (string)
. status (string)
} (object) required
token (string) required
codepipeline/put_job_failure_resultRepresents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.jobId (string) required
failureDetails: {
. type (string)
. message (string)
. externalExecutionId (string)
} (object) required
codepipeline/put_job_success_resultRepresents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.jobId (string) required
currentRevision: {
. revision (string)
. changeIdentifier (string)
. created (string)
. revisionSummary (string)
} (object)
continuationToken (string)
executionDetails: {
. summary (string)
. externalExecutionId (string)
. percentComplete (integer)
} (object)
outputVariables (object)
codepipeline/put_third_party_job_failure_resultRepresents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.jobId (string) required
clientToken (string) required
failureDetails: {
. type (string)
. message (string)
. externalExecutionId (string)
} (object) required
codepipeline/put_third_party_job_success_resultRepresents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.jobId (string) required
clientToken (string) required
currentRevision: {
. revision (string)
. changeIdentifier (string)
. created (string)
. revisionSummary (string)
} (object)
continuationToken (string)
executionDetails: {
. summary (string)
. externalExecutionId (string)
. percentComplete (integer)
} (object)
codepipeline/put_webhookDefines 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 automatwebhook: {
. name (string)
. targetPipeline (string)
. targetAction (string)
. filters (array)
. authentication (string)
. authenticationConfiguration (object)
} (object) required
tags (array)
codepipeline/register_webhook_with_third_partyConfigures a connection between the webhook that was created and the external tool with events to be detected.webhookName (string)
codepipeline/retry_stage_executionYou can retry a stage that has failed without having to run a pipeline again from the beginning. You do this by either retrying the failed actions in a stage or by retrying all actions in the stage starting from the first action in the stage. When you retry the failed actions in a stage, all actions that are still in progress continue working, and failed actions are triggered again. When you retry a failed stage from the first action in the stage, the stage cannot have any actions in progress. BpipelineName (string) required
stageName (string) required
pipelineExecutionId (string) required
retryMode (string) required
codepipeline/rollback_stageRolls back a stage execution.pipelineName (string) required
stageName (string) required
targetPipelineExecutionId (string) required
codepipeline/start_pipeline_executionStarts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.name (string) required
variables (array)
clientRequestToken (string)
sourceRevisions (array)
codepipeline/stop_pipeline_executionStops 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.pipelineName (string) required
pipelineExecutionId (string) required
abandon (boolean)
reason (string)
codepipeline/tag_resourceAdds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.resourceArn (string) required
tags (array) required
codepipeline/untag_resourceRemoves tags from an Amazon Web Services resource.resourceArn (string) required
tagKeys (array) required
codepipeline/update_action_typeUpdates 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.actionType: {
. description (string)
. executor (object)
. id (object)
. inputArtifactDetails (object)
. outputArtifactDetails (object)
. permissions (object)
. properties (array)
. urls (object)
} (object) required
codepipeline/update_pipelineUpdates 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.pipeline: {
. name (string)
. roleArn (string)
. artifactStore (object)
. artifactStores (object)
. stages (array)
. version (integer)
. executionMode (string)
. pipelineType (string)
. variables (array)
. triggers (array)
} (object) required
codestar_connections/create_connectionCreates a connection that can then be given to other Amazon Web Services 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.ProviderType (string)
ConnectionName (string) required
Tags (array)
HostArn (string)
codestar_connections/create_hostCreates 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.Name (string) required
ProviderType (string) required
ProviderEndpoint (string) required
VpcConfiguration: {
. VpcId (string)
. SubnetIds (array)
. SecurityGroupIds (array)
. TlsCertificate (string)
} (object)
Tags (array)
codestar_connections/create_repository_linkCreates a link to a specified external Git repository. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.ConnectionArn (string) required
OwnerId (string) required
RepositoryName (string) required
EncryptionKeyArn (string)
Tags (array)
codestar_connections/create_sync_configurationCreates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource. Parameters for the sync configuration are determined by the sync type.Branch (string) required
ConfigFile (string) required
RepositoryLinkId (string) required
ResourceName (string) required
RoleArn (string) required
SyncType (string) required
PublishDeploymentStatus (string)
TriggerResourceUpdateOn (string)
codestar_connections/delete_connectionThe connection to be deleted.ConnectionArn (string) required
codestar_connections/delete_hostThe 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.HostArn (string) required
codestar_connections/delete_repository_linkDeletes the association between your connection and a specified external Git repository.RepositoryLinkId (string) required
codestar_connections/delete_sync_configurationDeletes the sync configuration for a specified repository and connection.SyncType (string) required
ResourceName (string) required
codestar_connections/get_connectionReturns the connection ARN and details such as status, owner, and provider type.ConnectionArn (string) required
codestar_connections/get_hostReturns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.HostArn (string) required
codestar_connections/get_repository_linkReturns details about a repository link. A repository link allows Git sync to monitor and sync changes from files in a specified Git repository.RepositoryLinkId (string) required
codestar_connections/get_repository_sync_statusReturns details about the sync status for a repository. A repository sync uses Git sync to push and pull changes from your remote repository.Branch (string) required
RepositoryLinkId (string) required
SyncType (string) required
codestar_connections/get_resource_sync_statusReturns the status of the sync with the Git repository for a specific Amazon Web Services resource.ResourceName (string) required
SyncType (string) required
codestar_connections/get_sync_blocker_summaryReturns a list of the most recent sync blockers.SyncType (string) required
ResourceName (string) required
codestar_connections/get_sync_configurationReturns details about a sync configuration, including the sync type and resource name. A sync configuration allows the configuration to sync push and pull changes from the remote repository for a specified branch in a Git repository.SyncType (string) required
ResourceName (string) required
codestar_connections/list_connectionsLists the connections associated with your account.ProviderTypeFilter (string)
HostArnFilter (string)
MaxResults (integer)
NextToken (string)
codestar_connections/list_hostsLists the hosts associated with your account.MaxResults (integer)
NextToken (string)
codestar_connections/list_repository_linksLists the repository links created for connections in your account.MaxResults (integer)
NextToken (string)
codestar_connections/list_repository_sync_definitionsLists the repository sync definitions for repository links in your account.RepositoryLinkId (string) required
SyncType (string) required
codestar_connections/list_sync_configurationsReturns a list of sync configurations for a specified repository.MaxResults (integer)
NextToken (string)
RepositoryLinkId (string) required
SyncType (string) required
codestar_connections/list_tags_for_resourceGets the set of key-value pairs metadata that are used to manage the resource.ResourceArn (string) required
codestar_connections/tag_resourceAdds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.ResourceArn (string) required
Tags (array) required
codestar_connections/untag_resourceRemoves tags from an Amazon Web Services resource.ResourceArn (string) required
TagKeys (array) required
codestar_connections/update_hostUpdates a specified host with the provided configurations.HostArn (string) required
ProviderEndpoint (string)
VpcConfiguration: {
. VpcId (string)
. SubnetIds (array)
. SecurityGroupIds (array)
. TlsCertificate (string)
} (object)
codestar_connections/update_repository_linkUpdates the association between your connection and a specified external Git repository. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.ConnectionArn (string)
EncryptionKeyArn (string)
RepositoryLinkId (string) required
codestar_connections/update_sync_blockerAllows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.Id (string) required
SyncType (string) required
ResourceName (string) required
ResolvedReason (string) required
codestar_connections/update_sync_configurationUpdates the sync configuration for your connection and a specified external Git repository.Branch (string)
ConfigFile (string)
RepositoryLinkId (string)
ResourceName (string) required
RoleArn (string)
SyncType (string) required
PublishDeploymentStatus (string)
TriggerResourceUpdateOn (string)
codestar_notifications/create_notification_ruleCreates a notification rule for a resource. The rule specifies the events you want notifications about and the targets such as Amazon Q Developer in chat applications topics or Amazon Q Developer in chat applications clients configured for Slack where you want to receive them.Name (string) required
EventTypeIds (array) required
Resource (string) required
Targets (array) required
DetailType (string) required
ClientRequestToken (string)
Tags (object)
Status (string)
codestar_notifications/delete_notification_ruleDeletes a notification rule for a resource.Arn (string) required
codestar_notifications/delete_targetDeletes a specified target for notifications.TargetAddress (string) required
ForceUnsubscribeAll (boolean)
codestar_notifications/describe_notification_ruleReturns information about a specified notification rule.Arn (string) required
codestar_notifications/list_event_typesReturns information about the event types available for configuring notifications.Filters (array)
NextToken (string)
MaxResults (integer)
codestar_notifications/list_notification_rulesReturns a list of the notification rules for an Amazon Web Services account.Filters (array)
NextToken (string)
MaxResults (integer)
codestar_notifications/list_tags_for_resourceReturns a list of the tags associated with a notification rule.Arn (string) required
codestar_notifications/list_targetsReturns a list of the notification rule targets for an Amazon Web Services account.Filters (array)
NextToken (string)
MaxResults (integer)
codestar_notifications/subscribeCreates an association between a notification rule and an Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client so that the associated target can receive notifications when the events described in the rule are triggered.Arn (string) required
Target: {
. TargetType (string)
. TargetAddress (string)
} (object) required
ClientRequestToken (string)
codestar_notifications/tag_resourceAssociates a set of provided tags with a notification rule.Arn (string) required
Tags (object) required
codestar_notifications/unsubscribeRemoves an association between a notification rule and an Amazon Q Developer in chat applications topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.Arn (string) required
TargetAddress (string) required
codestar_notifications/untag_resourceRemoves the association between one or more provided tags and a notification rule.Arn (string) required
TagKeys (array) required
codestar_notifications/update_notification_ruleUpdates 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.Arn (string) required
Name (string)
Status (string)
EventTypeIds (array)
Targets (array)
DetailType (string)
cognito_identity_provider/add_custom_attributesAdds additional user attributes to the user pool schema. Custom attributes can be mutable or immutable and have a custom: or dev: prefix. For more information, see Custom attributes. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the AmazUserPoolId (string) required
CustomAttributes (array) required
cognito_identity_provider/admin_add_user_to_groupAdds a user to a group. A user who is in a group can present a preferred-role claim to an identity pool, and populates a cognito:groups claim to their access and identity tokens. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon CUserPoolId (string) required
Username (string) required
GroupName (string) required
cognito_identity_provider/admin_confirm_sign_upConfirms user sign-up as an administrator. This request sets a user account active in a user pool that requires confirmation of new user accounts before they can sign in. You can configure your user pool to not send confirmation codes to new users and instead confirm them with this API operation on the back end. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you mUserPoolId (string) required
Username (string) required
ClientMetadata (object)
cognito_identity_provider/admin_create_userCreates 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 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,UserPoolId (string) required
Username (string) required
UserAttributes (array)
ValidationData (array)
TemporaryPassword (string)
ForceAliasCreation (boolean)
MessageAction (string)
DesiredDeliveryMediums (array)
ClientMetadata (object)
cognito_identity_provider/admin_delete_userDeletes a user profile in your user pool. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpointsUserPoolId (string) required
Username (string) required
cognito_identity_provider/admin_delete_user_attributesDeletes attribute values from a user. This operation doesn't affect tokens for existing user sessions. The next ID token that the user receives will no longer have the deleted attributes. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using theUserPoolId (string) required
Username (string) required
UserAttributeNames (array) required
cognito_identity_provider/admin_disable_provider_for_userPrevents 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 createUserPoolId (string) required
User: {
. ProviderName (string)
. ProviderAttributeName (string)
. ProviderAttributeValue (string)
} (object) required
cognito_identity_provider/admin_disable_userDeactivates a user profile and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to ListUsers API requests. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito userUserPoolId (string) required
Username (string) required
cognito_identity_provider/admin_enable_userActivates sign-in for a user profile that previously had sign-in access disabled. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpointsUserPoolId (string) required
Username (string) required
cognito_identity_provider/admin_forget_deviceForgets, or deletes, a remembered device from a user's profile. After you forget the device, the user can no longer complete device authentication with that device and when applicable, must submit MFA codes again. For more information, see Working with devices. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permissionUserPoolId (string) required
Username (string) required
DeviceKey (string) required
cognito_identity_provider/admin_get_deviceGiven the device key, returns details for a user's device. For more information, see Working with devices. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpointsDeviceKey (string) required
UserPoolId (string) required
Username (string) required
cognito_identity_provider/admin_get_userGiven a username, returns details about a user profile in a user pool. You can specify alias attributes in the Username request parameter. This operation contributes to your monthly active user MAU count for the purpose of billing. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more SigninUserPoolId (string) required
Username (string) required
cognito_identity_provider/admin_initiate_authStarts sign-in for applications with a server-side component, for example a traditional web application. This operation specifies the authentication flow that you'd like to begin. The authentication flow that you specify must be supported in your app client configuration. For more information about authentication flows, see Authentication flows. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before yoUserPoolId (string) required
ClientId (string) required
AuthFlow (string) required
AuthParameters (object)
ClientMetadata (object)
AnalyticsMetadata: {
. AnalyticsEndpointId (string)
} (object)
ContextData: {
. IpAddress (string)
. ServerName (string)
. ServerPath (string)
. HttpHeaders (array)
. EncodedData (string)
} (object)
Session (string)
cognito_identity_provider/admin_link_provider_for_userLinks an existing user account in a user pool, or DestinationUser, to an identity from an external IdP, or SourceUser, based on a specified attribute name and value from the external IdP. This operation connects a local user profile with a user identity who hasn't yet signed in from their third-party IdP. When the user signs in with their IdP, they get access-control configuration from the local user profile. Linked local users can also sign in with SDK-based API operations like InitiateAuth aftUserPoolId (string) required
DestinationUser: {
. ProviderName (string)
. ProviderAttributeName (string)
. ProviderAttributeValue (string)
} (object) required
SourceUser: {
. ProviderName (string)
. ProviderAttributeName (string)
. ProviderAttributeValue (string)
} (object) required
cognito_identity_provider/admin_list_devicesLists a user's registered devices. Remembered devices are used in authentication services where you offer a 'Remember me' option for users who you want to permit to sign in without MFA from a trusted device. Users can bypass MFA while your application performs device SRP authentication on the back end. For more information, see Working with devices. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credenUserPoolId (string) required
Username (string) required
Limit (integer)
PaginationToken (string)
cognito_identity_provider/admin_list_groups_for_userLists the groups that a user belongs to. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in aUsername (string) required
UserPoolId (string) required
Limit (integer)
NextToken (string)
cognito_identity_provider/admin_list_user_auth_eventsRequests a history of user activity and any risks detected as part of Amazon Cognito threat protection. For more information, see Viewing user event history. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools APIUserPoolId (string) required
Username (string) required
MaxResults (integer)
NextToken (string)
cognito_identity_provider/admin_remove_user_from_groupGiven a username and a group name, removes them from the group. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the correspondUserPoolId (string) required
Username (string) required
GroupName (string) required
cognito_identity_provider/admin_reset_user_passwordBegins the password reset process. Sets the requested user’s account into a RESET_REQUIRED status, and sends them a password-reset code. Your user pool also sends the user a notification with a reset code and the information that their password has been reset. At sign-in, your application or the managed login session receives a challenge to complete the reset by confirming the code and setting a new password. To use this API operation, your user pool must have self-service account recovery confiUserPoolId (string) required
Username (string) required
ClientMetadata (object)
cognito_identity_provider/admin_respond_to_auth_challengeSome API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge. An AdminRespondToAuthChallenge API request provides the answer to that challenge, like a code or a secure remote password SRP. The parameters of a response to an authentication challenge vary with the type of challenge. For more information about custom authentication challenges, see Custom authentication challenge Lambda tUserPoolId (string) required
ClientId (string) required
ChallengeName (string) required
ChallengeResponses (object)
Session (string)
AnalyticsMetadata: {
. AnalyticsEndpointId (string)
} (object)
ContextData: {
. IpAddress (string)
. ServerName (string)
. ServerPath (string)
. HttpHeaders (array)
. EncodedData (string)
} (object)
ClientMetadata (object)
cognito_identity_provider/admin_set_user_mfapreferenceSets 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. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation.SMSMfaSettings: {
. Enabled (boolean)
. PreferredMfa (boolean)
} (object)
SoftwareTokenMfaSettings: {
. Enabled (boolean)
. PreferredMfa (boolean)
} (object)
EmailMfaSettings: {
. Enabled (boolean)
. PreferredMfa (boolean)
} (object)
Username (string) required
UserPoolId (string) required
cognito_identity_provider/admin_set_user_passwordSets the specified user's password in a user pool. This operation administratively sets a temporary or permanent password for a user. With this operation, you can bypass self-service password changes and permit immediate sign-in with the password that you set. To do this, set Permanent to true. You can also set a new temporary password in this request, send it to a user, and require them to choose a new password on their next sign-in. To do this, set Permanent to false. If the password is temporUserPoolId (string) required
Username (string) required
Password (string) required
Permanent (boolean)
cognito_identity_provider/admin_set_user_settingsThis 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. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user poolsUserPoolId (string) required
Username (string) required
MFAOptions (array) required
cognito_identity_provider/admin_update_auth_event_feedbackProvides the feedback for an authentication event generated by threat protection features. Your response indicates that you think that the event either was from a valid user or was an unwanted authentication attempt. This feedback improves the risk evaluation decision for the user pool as part of Amazon Cognito threat protection. To activate this setting, your user pool must be on the Plus tier. To train the threat-protection model to recognize trusted and untrusted sign-in characteristics, confUserPoolId (string) required
Username (string) required
EventId (string) required
FeedbackValue (string) required
cognito_identity_provider/admin_update_device_statusUpdates the status of a user's device so that it is marked as remembered or not remembered for the purpose of device authentication. Device authentication is a 'remember me' mechanism that silently completes sign-in from trusted devices with a device key instead of a user-provided MFA code. This operation changes the status of a device without deleting it, so you can enable it again later. For more information about device authentication, see Working with devices. Amazon Cognito evaluates IdentiUserPoolId (string) required
Username (string) required
DeviceKey (string) required
DeviceRememberedStatus (string)
cognito_identity_provider/admin_update_user_attributesUpdates the specified user's attributes. To delete an attribute from your user, submit the attribute in your API request with a blank value. For custom attributes, you must add a custom: prefix to the attribute name, for example custom:department. This operation can set a user's email address or phone number as verified and permit immediate sign-in in user pools that require verification of these attributes. To do this, set the email_verified or phone_number_verified attribute to true. Amazon CoUserPoolId (string) required
Username (string) required
UserAttributes (array) required
ClientMetadata (object)
cognito_identity_provider/admin_user_global_sign_outInvalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation with your administrative credentials when your user signs out of your app. This results in the following behavior. Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints. Amazon Cognito returns an Access Token has been revoked erUserPoolId (string) required
Username (string) required
cognito_identity_provider/associate_software_tokenBegins 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 doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't uAccessToken (string)
Session (string)
cognito_identity_provider/change_passwordChanges the password for the currently signed-in user. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon CognitPreviousPassword (string)
ProposedPassword (string) required
AccessToken (string) required
cognito_identity_provider/complete_web_authn_registrationCompletes registration of a passkey authenticator for the currently signed-in user. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.AccessToken (string) required
Credential (undefined) required
cognito_identity_provider/confirm_deviceConfirms a device that a user wants to remember. A remembered device is a 'Remember me on this device' option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate IdentAccessToken (string) required
DeviceKey (string) required
DeviceSecretVerifierConfig: {
. PasswordVerifier (string)
. Salt (string)
} (object)
DeviceName (string)
cognito_identity_provider/confirm_forgot_passwordThis public API operation accepts a confirmation code that Amazon Cognito sent to a user and accepts a new password for that user. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.ClientId (string) required
SecretHash (string)
Username (string) required
ConfirmationCode (string) required
Password (string) required
AnalyticsMetadata: {
. AnalyticsEndpointId (string)
} (object)
UserContextData: {
. IpAddress (string)
. EncodedData (string)
} (object)
ClientMetadata (object)
cognito_identity_provider/confirm_sign_upConfirms the account of a new user. This public API operation submits a code that Amazon Cognito sent to your user when they signed up in your user pool. After your user enters their code, they confirm ownership of the email address or phone number that they provided, and their user account becomes active. Depending on your user pool configuration, your users will receive their confirmation code in an email or SMS message. Local users who signed up in your user pool are the only type of user whoClientId (string) required
SecretHash (string)
Username (string) required
ConfirmationCode (string) required
ForceAliasCreation (boolean)
AnalyticsMetadata: {
. AnalyticsEndpointId (string)
} (object)
UserContextData: {
. IpAddress (string)
. EncodedData (string)
} (object)
ClientMetadata (object)
Session (string)
cognito_identity_provider/create_groupCreates a new group in the specified user pool. For more information about user pool groups, see Adding groups to a user pool. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpointsGroupName (string) required
UserPoolId (string) required
Description (string)
RoleArn (string)
Precedence (integer)
cognito_identity_provider/create_identity_providerAdds a configuration and trust relationship between a third-party identity provider IdP and a user pool. Amazon Cognito accepts sign-in with third-party identity providers through managed login and OIDC relying-party libraries. For more information, see Third-party IdP sign-in. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the correspondinUserPoolId (string) required
ProviderName (string) required
ProviderType (string) required
ProviderDetails (object) required
AttributeMapping (object)
IdpIdentifiers (array)
cognito_identity_provider/create_managed_login_brandingCreates a new set of branding settings for a user pool style and associates it with an app client. This operation is the programmatic option for the creation of a new style in the branding editor. Provides values for UI customization in a Settings JSON object and image files in an Assets array. To send the JSON object Document type parameter in Settings, you might need to update to the most recent version of your Amazon Web Services SDK. To create a new style with default settings, set UseCognitUserPoolId (string) required
ClientId (string) required
UseCognitoProvidedValues (boolean)
Settings (undefined)
Assets (array)
cognito_identity_provider/create_resource_serverCreates a new OAuth2.0 resource server and defines custom scopes within it. Resource servers are associated with custom scopes and machine-to-machine M2M authorization. For more information, see Access control with resource servers. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more SigniUserPoolId (string) required
Identifier (string) required
Name (string) required
Scopes (array)
cognito_identity_provider/create_termsCreates terms documents for the requested app client. When Terms and conditions and Privacy policy documents are configured, the app client displays links to them in the sign-up page of managed login for the app client. You can provide URLs for terms documents in the languages that are supported by managed login localization. Amazon Cognito directs users to the terms documents for their current language, with fallback to default if no document exists for the language. Each request accepts one tyUserPoolId (string) required
ClientId (string) required
TermsName (string) required
TermsSource (string) required
Enforcement (string) required
Links (object)
cognito_identity_provider/create_user_import_jobCreates a user import job. You can import users into user pools from a comma-separated values CSV file without adding Amazon Cognito MAU costs to your Amazon Web Services bill. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon CogJobName (string) required
UserPoolId (string) required
CloudWatchLogsRoleArn (string) required
cognito_identity_provider/create_user_poolCreates a new Amazon Cognito user pool. This operation sets basic and advanced configuration options. If you don't provide a value for an attribute, Amazon Cognito sets it to its 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. AmazonPoolName (string) required
Policies: {
. PasswordPolicy (object)
. SignInPolicy (object)
} (object)
DeletionProtection (string)
LambdaConfig: {
. PreSignUp (string)
. CustomMessage (string)
. PostConfirmation (string)
. PreAuthentication (string)
. PostAuthentication (string)
. DefineAuthChallenge (string)
. CreateAuthChallenge (string)
. VerifyAuthChallengeResponse (string)
. PreTokenGeneration (string)
. UserMigration (string)
. PreTokenGenerationConfig (object)
. CustomSMSSender (object)
. CustomEmailSender (object)
. KMSKeyID (string)
. InboundFederation (object)
} (object)
AutoVerifiedAttributes (array)
AliasAttributes (array)
UsernameAttributes (array)
SmsVerificationMessage (string)
EmailVerificationMessage (string)
EmailVerificationSubject (string)
VerificationMessageTemplate: {
. SmsMessage (string)
. EmailMessage (string)
. EmailSubject (string)
. EmailMessageByLink (string)
. EmailSubjectByLink (string)
. DefaultEmailOption (string)
} (object)
SmsAuthenticationMessage (string)
MfaConfiguration (string)
UserAttributeUpdateSettings: {
. AttributesRequireVerificationBeforeUpdate (array)
} (object)
DeviceConfiguration: {
. ChallengeRequiredOnNewDevice (boolean)
. DeviceOnlyRememberedOnUserPrompt (boolean)
} (object)
EmailConfiguration: {
. SourceArn (string)
. ReplyToEmailAddress (string)
. EmailSendingAccount (string)
. From (string)
. ConfigurationSet (string)
} (object)
SmsConfiguration: {
. SnsCallerArn (string)
. ExternalId (string)
. SnsRegion (string)
} (object)
UserPoolTags (object)
AdminCreateUserConfig: {
. AllowAdminCreateUserOnly (boolean)
. UnusedAccountValidityDays (integer)
. InviteMessageTemplate (object)
} (object)
Schema (array)
UserPoolAddOns: {
. AdvancedSecurityMode (string)
. AdvancedSecurityAdditionalFlows (object)
} (object)
UsernameConfiguration: {
. CaseSensitive (boolean)
} (object)
AccountRecoverySetting: {
. RecoveryMechanisms (array)
} (object)
UserPoolTier (string)
cognito_identity_provider/create_user_pool_clientCreates an app client in a user pool. This operation sets basic and advanced configuration options. Unlike app clients created in the console, Amazon Cognito doesn't automatically assign a branding style to app clients that you configure with this API operation. Managed login and classic hosted UI pages aren't available for your client until after you apply a branding style. If you don't provide a value for an attribute, Amazon Cognito sets it to its default value. Amazon Cognito evaluates IdentUserPoolId (string) required
ClientName (string) required
GenerateSecret (boolean)
RefreshTokenValidity (integer)
AccessTokenValidity (integer)
IdTokenValidity (integer)
TokenValidityUnits: {
. AccessToken (string)
. IdToken (string)
. RefreshToken (string)
} (object)
ReadAttributes (array)
WriteAttributes (array)
ExplicitAuthFlows (array)
SupportedIdentityProviders (array)
CallbackURLs (array)
LogoutURLs (array)
DefaultRedirectURI (string)
AllowedOAuthFlows (array)
AllowedOAuthScopes (array)
AllowedOAuthFlowsUserPoolClient (boolean)
AnalyticsConfiguration: {
. ApplicationId (string)
. ApplicationArn (string)
. RoleArn (string)
. ExternalId (string)
. UserDataShared (boolean)
} (object)
PreventUserExistenceErrors (string)
EnableTokenRevocation (boolean)
EnablePropagateAdditionalUserContextData (boolean)
AuthSessionValidity (integer)
RefreshTokenRotation: {
. Feature (string)
. RetryGracePeriodSeconds (integer)
} (object)
cognito_identity_provider/create_user_pool_domainA user pool domain hosts managed login, an authorization server and web server for authentication in your application. This operation creates a new user pool prefix domain or custom domain and sets the managed login branding version. Set the branding version to 1 for hosted UI classic or 2 for managed login. When you choose a custom domain, you must provide an SSL certificate in the US East N. Virginia Amazon Web Services Region in your request. Your prefix domain might take up to one minute toDomain (string) required
UserPoolId (string) required
ManagedLoginVersion (integer)
CustomDomainConfig: {
. CertificateArn (string)
} (object)
cognito_identity_provider/delete_groupDeletes a group from the specified user pool. When you delete a group, that group no longer contributes to users' cognito:preferred_group or cognito:groups claims, and no longer influence access-control decision that are based on group membership. For more information about user pool groups, see Adding groups to a user pool. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requesGroupName (string) required
UserPoolId (string) required
cognito_identity_provider/delete_identity_providerDeletes a user pool identity provider IdP. After you delete an IdP, users can no longer sign in to your user pool through that IdP. For more information about user pool IdPs, see Third-party IdP sign-in. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API ReUserPoolId (string) required
ProviderName (string) required
cognito_identity_provider/delete_managed_login_brandingDeletes a managed login branding style. When you delete a style, you delete the branding association for an app client. When an app client doesn't have a style assigned, your managed login pages for that app client are nonfunctional until you create a new style or switch the domain branding version. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant youManagedLoginBrandingId (string) required
UserPoolId (string) required
cognito_identity_provider/delete_resource_serverDeletes a resource server. After you delete a resource server, users can no longer generate access tokens with scopes that are associate with that resource server. Resource servers are associated with custom scopes and machine-to-machine M2M authorization. For more information, see Access control with resource servers. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, anUserPoolId (string) required
Identifier (string) required
cognito_identity_provider/delete_termsDeletes the terms documents with the requested ID from your app client. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpointsTermsId (string) required
UserPoolId (string) required
cognito_identity_provider/delete_userDeletes the profile of the currently signed-in user. A deleted user profile can no longer be used to sign in and can't be restored. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more informatAccessToken (string) required
cognito_identity_provider/delete_user_attributesDeletes attributes from the currently signed-in user. For example, your application can submit a request to this operation when a user wants to remove their birthdate attribute value. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can'tUserAttributeNames (array) required
AccessToken (string) required
cognito_identity_provider/delete_user_poolDeletes a user pool. After you delete a user pool, users can no longer sign in to any associated applications. When you delete a user pool, it's no longer visible or operational in your Amazon Web Services account. Amazon Cognito retains deleted user pools in an inactive state for 14 days, then begins a cleanup process that fully removes them from Amazon Web Services systems. In case of accidental deletion, contact Amazon Web Services Support within 14 days for restoration assistance. Amazon CogUserPoolId (string) required
cognito_identity_provider/delete_user_pool_clientDeletes a user pool app client. After you delete an app client, users can no longer sign in to the associated application.UserPoolId (string) required
ClientId (string) required
cognito_identity_provider/delete_user_pool_domainGiven a user pool ID and domain identifier, deletes a user pool domain. After you delete a user pool domain, your managed login pages and authorization server are no longer available.Domain (string) required
UserPoolId (string) required
cognito_identity_provider/delete_web_authn_credentialDeletes a registered passkey, or WebAuthn, authenticator for the currently signed-in user. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in AmazonAccessToken (string) required
CredentialId (string) required
cognito_identity_provider/describe_identity_providerGiven a user pool ID and identity provider IdP name, returns details about the IdP.UserPoolId (string) required
ProviderName (string) required
cognito_identity_provider/describe_managed_login_brandingGiven the ID of a managed login branding style, returns detailed information about the style.UserPoolId (string) required
ManagedLoginBrandingId (string) required
ReturnMergedResources (boolean)
cognito_identity_provider/describe_managed_login_branding_by_clientGiven the ID of a user pool app client, returns detailed information about the style assigned to the app client.UserPoolId (string) required
ClientId (string) required
ReturnMergedResources (boolean)
cognito_identity_provider/describe_resource_serverDescribes a resource server. For more information about resource servers, see Access control with resource servers.UserPoolId (string) required
Identifier (string) required
cognito_identity_provider/describe_risk_configurationGiven an app client or user pool ID where threat protection is configured, describes the risk configuration. This operation returns details about adaptive authentication, compromised credentials, and IP-address allow- and denylists. For more information about threat protection, see Threat protection.UserPoolId (string) required
ClientId (string)
cognito_identity_provider/describe_termsReturns details for the requested terms documents ID. For more information, see Terms documents. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpointsTermsId (string) required
UserPoolId (string) required
cognito_identity_provider/describe_user_import_jobDescribes a user import job. For more information about user CSV import, see Importing users from a CSV file.UserPoolId (string) required
JobId (string) required
cognito_identity_provider/describe_user_poolGiven a user pool ID, returns configuration information. This operation is useful when you want to inspect an existing user pool and programmatically replicate the configuration to another user pool. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API RequesUserPoolId (string) required
cognito_identity_provider/describe_user_pool_clientGiven an app client ID, returns configuration information. This operation is useful when you want to inspect an existing app client and programmatically replicate the configuration to another app client. For more information about app clients, see App clients. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission iUserPoolId (string) required
ClientId (string) required
cognito_identity_provider/describe_user_pool_domainGiven a user pool domain name, returns information about the domain configuration. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpointsDomain (string) required
cognito_identity_provider/forget_deviceGiven a device key, deletes a remembered device as the currently signed-in user. For more information about device authentication, see Working with user devices in your user pool. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't granAccessToken (string)
DeviceKey (string) required
cognito_identity_provider/forgot_passwordSends a password-reset confirmation code to the email address or phone number of the requested username. The message delivery method is determined by the user's available attributes and the AccountRecoverySetting configuration of the user pool. For the Username parameter, you can use the username or an email, phone, or preferred username alias. If neither a verified phone number nor a verified email exists, Amazon Cognito responds with an InvalidParameterException error . If your app client hasClientId (string) required
SecretHash (string)
UserContextData: {
. IpAddress (string)
. EncodedData (string)
} (object)
Username (string) required
AnalyticsMetadata: {
. AnalyticsEndpointId (string)
} (object)
ClientMetadata (object)
cognito_identity_provider/get_csvheaderGiven a user pool ID, generates a comma-separated value CSV list populated with available user attributes in the user pool. This list is the header for the CSV file that determines the users in a user import job. Save the content of CSVHeader in the response as a .csv file and populate it with the usernames and attributes of users that you want to import. For more information about CSV user import, see Importing users from a CSV file. Amazon Cognito evaluates Identity and Access Management IAM pUserPoolId (string) required
cognito_identity_provider/get_deviceGiven a device key, returns information about a remembered device for the current user. For more information about device authentication, see Working with user devices in your user pool. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you canDeviceKey (string) required
AccessToken (string)
cognito_identity_provider/get_groupGiven a user pool ID and a group name, returns information about the user group. For more information about user pool groups, see Adding groups to a user pool. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools AGroupName (string) required
UserPoolId (string) required
cognito_identity_provider/get_identity_provider_by_identifierGiven the identifier of an identity provider IdP, for example examplecorp, returns information about the user pool configuration for that IdP. For more information about IdPs, see Third-party IdP sign-in.UserPoolId (string) required
IdpIdentifier (string) required
cognito_identity_provider/get_log_delivery_configurationGiven a user pool ID, returns the logging configuration. User pools can export message-delivery error and threat-protection activity logs to external Amazon Web Services services. For more information, see Exporting user pool logs. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more SigninUserPoolId (string) required
cognito_identity_provider/get_signing_certificateGiven a user pool ID, returns the signing certificate for SAML 2.0 federation. Issued certificates are valid for 10 years from the date of issue. Amazon Cognito issues and assigns a new signing certificate annually. This renewal process returns a new value in the response to GetSigningCertificate, but doesn't invalidate the original certificate. For more information, see Signing SAML requests. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operationUserPoolId (string) required
cognito_identity_provider/get_tokens_from_refresh_tokenGiven a refresh token, issues new ID, access, and optionally refresh tokens for the user who owns the submitted token. This operation issues a new refresh token and invalidates the original refresh token after an optional grace period when refresh token rotation is enabled. If refresh token rotation is disabled, issues new ID and access tokens only.RefreshToken (string) required
ClientId (string) required
ClientSecret (string)
DeviceKey (string)
ClientMetadata (object)
cognito_identity_provider/get_uicustomizationGiven a user pool ID or app client, returns information about classic hosted UI branding that you applied, if any. Returns user-pool level branding information if no app client branding is applied, or if you don't specify an app client ID. Returns an empty object if you haven't applied hosted UI branding to either the client or the user pool. For more information, see Hosted UI classic branding.UserPoolId (string) required
ClientId (string)
cognito_identity_provider/get_userGets user attributes and and MFA settings for the currently signed-in user. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see UsAccessToken (string) required
cognito_identity_provider/get_user_attribute_verification_codeGiven an attribute name, sends a user attribute verification code for the specified attribute name to the currently signed-in user. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more informatAccessToken (string) required
AttributeName (string) required
ClientMetadata (object)
cognito_identity_provider/get_user_auth_factorsLists the authentication options for the currently signed-in user. Returns the following: The user's multi-factor authentication MFA preferences. The user's options for choice-based authentication with the USER_AUTH flow. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentialsAccessToken (string) required
cognito_identity_provider/get_user_pool_mfa_configGiven a user pool ID, returns configuration for sign-in with WebAuthn authenticators and for multi-factor authentication MFA. This operation describes the following: The WebAuthn relying party RP ID and user-verification settings. The required, optional, or disabled state of MFA for all user pool users. The message templates for email and SMS MFA. The enabled or disabled state of time-based one-time password TOTP MFA. Amazon Cognito evaluates Identity and Access Management IAM policies in requesUserPoolId (string) required
cognito_identity_provider/global_sign_outInvalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation when your user signs out of your app. This results in the following behavior. Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints. Amazon Cognito returns an Access Token has been revoked error when your app attempts to authoriAccessToken (string) required
cognito_identity_provider/initiate_authDeclares an authentication flow and initiates sign-in for a user in the Amazon Cognito user directory. Amazon Cognito might respond with an additional challenge or an AuthenticationResult that contains the outcome of a successful authentication. You can't sign in a user with a federated IdP with InitiateAuth. For more information, see Authentication. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAuthFlow (string) required
AuthParameters (object)
ClientMetadata (object)
ClientId (string) required
AnalyticsMetadata: {
. AnalyticsEndpointId (string)
} (object)
UserContextData: {
. IpAddress (string)
. EncodedData (string)
} (object)
Session (string)
cognito_identity_provider/list_devicesLists the devices that Amazon Cognito has registered to the currently signed-in user. For more information about device authentication, see Working with user devices in your user pool. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can'tAccessToken (string) required
Limit (integer)
PaginationToken (string)
cognito_identity_provider/list_groupsGiven a user pool ID, returns user pool groups and their details. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpointsUserPoolId (string) required
Limit (integer)
NextToken (string)
cognito_identity_provider/list_identity_providersGiven a user pool ID, returns information about configured identity providers IdPs. For more information about IdPs, see Third-party IdP sign-in. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user poUserPoolId (string) required
MaxResults (integer)
NextToken (string)
cognito_identity_provider/list_resource_serversGiven a user pool ID, returns all resource servers and their details. For more information about resource servers, see Access control with resource servers. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools APIUserPoolId (string) required
MaxResults (integer)
NextToken (string)
cognito_identity_provider/list_tags_for_resourceLists the tags that are assigned to an Amazon Cognito user pool. For more information, see Tagging resources.ResourceArn (string) required
cognito_identity_provider/list_termsReturns details about all terms documents for the requested user pool. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpointsUserPoolId (string) required
MaxResults (integer)
NextToken (string)
cognito_identity_provider/list_user_import_jobsGiven a user pool ID, returns user import jobs and their details. Import jobs are retained in user pool configuration so that you can stage, stop, start, review, and delete them. For more information about user import, see Importing users from a CSV file. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a pUserPoolId (string) required
MaxResults (integer) required
PaginationToken (string)
cognito_identity_provider/list_user_pool_clientsGiven a user pool ID, lists app clients. App clients are sets of rules for the access that you want a user pool to grant to one application. For more information, see App clients. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the AmazonUserPoolId (string) required
MaxResults (integer)
NextToken (string)
cognito_identity_provider/list_user_poolsLists user pools and their details in the current Amazon Web Services account. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpointsNextToken (string)
MaxResults (integer) required
cognito_identity_provider/list_usersGiven a user pool ID, returns a list of users and their basic details in a user pool. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpointsUserPoolId (string) required
AttributesToGet (array)
Limit (integer)
PaginationToken (string)
Filter (string)
cognito_identity_provider/list_users_in_groupGiven a user pool ID and a group name, returns a list of users in the group. For more information about user pool groups, see Adding groups to a user pool. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API aUserPoolId (string) required
GroupName (string) required
Limit (integer)
NextToken (string)
cognito_identity_provider/list_web_authn_credentialsGenerates a list of the currently signed-in user's registered passkey, or WebAuthn, credentials. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in AAccessToken (string) required
NextToken (string)
MaxResults (integer)
cognito_identity_provider/resend_confirmation_codeResends the code that confirms a new account for a user who has signed up in your user pool. Amazon Cognito sends confirmation codes to the user attribute in the AutoVerifiedAttributes property of your user pool. When you prompt new users for the confirmation code, include a 'Resend code' option that generates a call to this API operation. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentiClientId (string) required
SecretHash (string)
UserContextData: {
. IpAddress (string)
. EncodedData (string)
} (object)
Username (string) required
AnalyticsMetadata: {
. AnalyticsEndpointId (string)
} (object)
ClientMetadata (object)
cognito_identity_provider/respond_to_auth_challengeSome API operations in a user pool generate a challenge, like a prompt for an MFA code, for device authentication that bypasses MFA, or for a custom authentication challenge. A RespondToAuthChallenge API request provides the answer to that challenge, like a code or a secure remote password SRP. The parameters of a response to an authentication challenge vary with the type of challenge. For more information about custom authentication challenges, see Custom authentication challenge Lambda triggerClientId (string) required
ChallengeName (string) required
Session (string)
ChallengeResponses (object)
AnalyticsMetadata: {
. AnalyticsEndpointId (string)
} (object)
UserContextData: {
. IpAddress (string)
. EncodedData (string)
} (object)
ClientMetadata (object)
cognito_identity_provider/revoke_tokenRevokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information abToken (string) required
ClientId (string) required
ClientSecret (string)
cognito_identity_provider/set_log_delivery_configurationSets up or modifies the logging configuration of a user pool. User pools can export user notification logs and, when threat protection is active, user-activity logs. For more information, see Exporting user pool logs.UserPoolId (string) required
LogConfigurations (array) required
cognito_identity_provider/set_risk_configurationConfigures threat protection for a user pool or app client. Sets configuration for the following. Responses to risks with adaptive authentication Responses to vulnerable passwords with compromised-credentials detection Notifications to users who have had risky activity detected IP-address denylist and allowlist To set the risk configuration for the user pool to defaults, send this request with only the UserPoolId parameter. To reset the threat protection settings of an app client to be inheritedUserPoolId (string) required
ClientId (string)
CompromisedCredentialsRiskConfiguration: {
. EventFilter (array)
. Actions (object)
} (object)
AccountTakeoverRiskConfiguration: {
. NotifyConfiguration (object)
. Actions (object)
} (object)
RiskExceptionConfiguration: {
. BlockedIPRangeList (array)
. SkippedIPRangeList (array)
} (object)
cognito_identity_provider/set_uicustomizationConfigures UI branding settings for domains with the hosted UI classic branding version. Your user pool must have a domain. Configure a domain with . Set the default configuration for all clients with a ClientId of ALL. When the ClientId value is an app client ID, the settings you pass in this request apply to that app client and override the default ALL configuration. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, youUserPoolId (string) required
ClientId (string)
CSS (string)
ImageFile (string)
cognito_identity_provider/set_user_mfapreferenceSet 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 attemptSMSMfaSettings: {
. Enabled (boolean)
. PreferredMfa (boolean)
} (object)
SoftwareTokenMfaSettings: {
. Enabled (boolean)
. PreferredMfa (boolean)
} (object)
EmailMfaSettings: {
. Enabled (boolean)
. PreferredMfa (boolean)
} (object)
AccessToken (string) required
cognito_identity_provider/set_user_pool_mfa_configSets user pool multi-factor authentication MFA and passkey configuration. For more information about user pool MFA, see Adding MFA. For more information about WebAuthn passkeys see Authentication flows. 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 PinpoinUserPoolId (string) required
SmsMfaConfiguration: {
. SmsAuthenticationMessage (string)
. SmsConfiguration (object)
} (object)
SoftwareTokenMfaConfiguration: {
. Enabled (boolean)
} (object)
EmailMfaConfiguration: {
. Message (string)
. Subject (string)
} (object)
MfaConfiguration (string)
WebAuthnConfiguration: {
. RelyingPartyId (string)
. UserVerification (string)
} (object)
cognito_identity_provider/set_user_settingsThis 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 or email MFA. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM perAccessToken (string) required
MFAOptions (array) required
cognito_identity_provider/sign_upRegisters a user with an app client and requests a user name, password, and user attributes in the user pool. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints. This action might geClientId (string) required
SecretHash (string)
Username (string) required
Password (string)
UserAttributes (array)
ValidationData (array)
AnalyticsMetadata: {
. AnalyticsEndpointId (string)
} (object)
UserContextData: {
. IpAddress (string)
. EncodedData (string)
} (object)
ClientMetadata (object)
cognito_identity_provider/start_user_import_jobInstructs your user pool to start importing users from a CSV file that contains their usernames and attributes. For more information about importing users from a CSV file, see Importing users from a CSV file.UserPoolId (string) required
JobId (string) required
cognito_identity_provider/start_web_authn_registrationRequests credential creation options from your user pool for the currently signed-in user. Returns information about the user pool, the user profile, and authentication requirements. Users must provide this information in their request to enroll your application with their passkey provider. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.AccessToken (string) required
cognito_identity_provider/stop_user_import_jobInstructs your user pool to stop a running job that's importing users from a CSV file that contains their usernames and attributes. For more information about importing users from a CSV file, see Importing users from a CSV file.UserPoolId (string) required
JobId (string) required
cognito_identity_provider/tag_resourceAssigns 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 keyResourceArn (string) required
Tags (object) required
cognito_identity_provider/untag_resourceGiven tag IDs that you previously assigned to a user pool, removes them.ResourceArn (string) required
TagKeys (array) required
cognito_identity_provider/update_auth_event_feedbackProvides the feedback for an authentication event generated by threat protection features. The user's response indicates that you think that the event either was from a valid user or was an unwanted authentication attempt. This feedback improves the risk evaluation decision for the user pool as part of Amazon Cognito threat protection. To activate this setting, your user pool must be on the Plus tier. This operation requires a FeedbackToken that Amazon Cognito generates and adds to notificationUserPoolId (string) required
Username (string) required
EventId (string) required
FeedbackToken (string) required
FeedbackValue (string) required
cognito_identity_provider/update_device_statusUpdates the status of a the currently signed-in user's device so that it is marked as remembered or not remembered for the purpose of device authentication. Device authentication is a 'remember me' mechanism that silently completes sign-in from trusted devices with a device key instead of a user-provided MFA code. This operation changes the status of a device without deleting it, so you can enable it again later. For more information about device authentication, see Working with devices. AuthoriAccessToken (string) required
DeviceKey (string) required
DeviceRememberedStatus (string)
cognito_identity_provider/update_groupGiven the name of a user pool group, updates any of the properties for precedence, IAM role, or description. For more information about user pool groups, see Adding groups to a user pool. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using theGroupName (string) required
UserPoolId (string) required
Description (string)
RoleArn (string)
Precedence (integer)
cognito_identity_provider/update_identity_providerModifies the configuration and trust relationship between a third-party identity provider IdP and a user pool. Amazon Cognito accepts sign-in with third-party identity providers through managed login and OIDC relying-party libraries. For more information, see Third-party IdP sign-in. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresUserPoolId (string) required
ProviderName (string) required
ProviderDetails (object)
AttributeMapping (object)
IdpIdentifiers (array)
cognito_identity_provider/update_managed_login_brandingConfigures the branding settings for a user pool style. This operation is the programmatic option for the configuration of a style in the branding editor. Provides values for UI customization in a Settings JSON object and image files in an Assets array. This operation has a 2-megabyte request-size limit and include the CSS settings and image assets for your app client. Your branding settings might exceed 2MB in size. Amazon Cognito doesn't require that you pass all parameters in one request andUserPoolId (string)
ManagedLoginBrandingId (string)
UseCognitoProvidedValues (boolean)
Settings (undefined)
Assets (array)
cognito_identity_provider/update_resource_serverUpdates the name and scopes of a resource server. All other fields are read-only. For more information about resource servers, see Access control with resource servers. If you don't provide a value for an attribute, it is set to the default value. Amazon Cognito evaluates Identity and Access Management IAM policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. LUserPoolId (string) required
Identifier (string) required
Name (string) required
Scopes (array)
cognito_identity_provider/update_termsModifies existing terms documents for the requested app client. When Terms and conditions and Privacy policy documents are configured, the app client displays links to them in the sign-up page of managed login for the app client. You can provide URLs for terms documents in the languages that are supported by managed login localization. Amazon Cognito directs users to the terms documents for their current language, with fallback to default if no document exists for the language. Each request acceTermsId (string) required
UserPoolId (string) required
TermsName (string)
TermsSource (string)
Enforcement (string)
Links (object)
cognito_identity_provider/update_user_attributesUpdates the currently signed-in user's attributes. To delete an attribute from the user, submit the attribute in your API request with a blank value. For custom attributes, you must add a custom: prefix to the attribute name, for example custom:department. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operaUserAttributes (array) required
AccessToken (string) required
ClientMetadata (object)
cognito_identity_provider/update_user_poolUpdates the configuration of a user pool. To avoid setting parameters to Amazon Cognito defaults, construct this API request to pass the existing configuration of your user pool, modified to include the changes that you want to make. If you don't provide a value for an attribute, Amazon Cognito sets it to its 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 messageUserPoolId (string) required
Policies: {
. PasswordPolicy (object)
. SignInPolicy (object)
} (object)
DeletionProtection (string)
LambdaConfig: {
. PreSignUp (string)
. CustomMessage (string)
. PostConfirmation (string)
. PreAuthentication (string)
. PostAuthentication (string)
. DefineAuthChallenge (string)
. CreateAuthChallenge (string)
. VerifyAuthChallengeResponse (string)
. PreTokenGeneration (string)
. UserMigration (string)
. PreTokenGenerationConfig (object)
. CustomSMSSender (object)
. CustomEmailSender (object)
. KMSKeyID (string)
. InboundFederation (object)
} (object)
AutoVerifiedAttributes (array)
SmsVerificationMessage (string)
EmailVerificationMessage (string)
EmailVerificationSubject (string)
VerificationMessageTemplate: {
. SmsMessage (string)
. EmailMessage (string)
. EmailSubject (string)
. EmailMessageByLink (string)
. EmailSubjectByLink (string)
. DefaultEmailOption (string)
} (object)
SmsAuthenticationMessage (string)
UserAttributeUpdateSettings: {
. AttributesRequireVerificationBeforeUpdate (array)
} (object)
MfaConfiguration (string)
DeviceConfiguration: {
. ChallengeRequiredOnNewDevice (boolean)
. DeviceOnlyRememberedOnUserPrompt (boolean)
} (object)
EmailConfiguration: {
. SourceArn (string)
. ReplyToEmailAddress (string)
. EmailSendingAccount (string)
. From (string)
. ConfigurationSet (string)
} (object)
SmsConfiguration: {
. SnsCallerArn (string)
. ExternalId (string)
. SnsRegion (string)
} (object)
UserPoolTags (object)
AdminCreateUserConfig: {
. AllowAdminCreateUserOnly (boolean)
. UnusedAccountValidityDays (integer)
. InviteMessageTemplate (object)
} (object)
UserPoolAddOns: {
. AdvancedSecurityMode (string)
. AdvancedSecurityAdditionalFlows (object)
} (object)
AccountRecoverySetting: {
. RecoveryMechanisms (array)
} (object)
PoolName (string)
UserPoolTier (string)
cognito_identity_provider/update_user_pool_clientGiven a user pool app client ID, updates the configuration. To avoid setting parameters to Amazon Cognito defaults, construct this API request to pass the existing configuration of your app client, modified to include the changes that you want to make. If you don't provide a value for an attribute, Amazon Cognito sets it to its default value. Unlike app clients created in the console, Amazon Cognito doesn't automatically assign a branding style to app clients that you configure with this API opeUserPoolId (string) required
ClientId (string) required
ClientName (string)
RefreshTokenValidity (integer)
AccessTokenValidity (integer)
IdTokenValidity (integer)
TokenValidityUnits: {
. AccessToken (string)
. IdToken (string)
. RefreshToken (string)
} (object)
ReadAttributes (array)
WriteAttributes (array)
ExplicitAuthFlows (array)
SupportedIdentityProviders (array)
CallbackURLs (array)
LogoutURLs (array)
DefaultRedirectURI (string)
AllowedOAuthFlows (array)
AllowedOAuthScopes (array)
AllowedOAuthFlowsUserPoolClient (boolean)
AnalyticsConfiguration: {
. ApplicationId (string)
. ApplicationArn (string)
. RoleArn (string)
. ExternalId (string)
. UserDataShared (boolean)
} (object)
PreventUserExistenceErrors (string)
EnableTokenRevocation (boolean)
EnablePropagateAdditionalUserContextData (boolean)
AuthSessionValidity (integer)
RefreshTokenRotation: {
. Feature (string)
. RetryGracePeriodSeconds (integer)
} (object)
cognito_identity_provider/update_user_pool_domainA user pool domain hosts managed login, an authorization server and web server for authentication in your application. This operation updates the branding version for user pool domains between 1 for hosted UI classic and 2 for managed login. It also updates the SSL certificate for user pool custom domains. Changes to the domain branding version take up to one minute to take effect for a prefix domain and up to five minutes for a custom domain. This operation doesn't change the name of your userDomain (string) required
UserPoolId (string) required
ManagedLoginVersion (integer)
CustomDomainConfig: {
. CertificateArn (string)
} (object)
cognito_identity_provider/verify_software_tokenRegisters the current user's time-based one-time password TOTP authenticator with a code generated in their authenticator app from a private key that's supplied by your user pool. Marks the user's software token MFA status as 'verified' if successful. The request takes an access token or a session string, but not both. Amazon Cognito doesn't evaluate Identity and Access Management IAM policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requAccessToken (string)
Session (string)
UserCode (string) required
FriendlyDeviceName (string)
cognito_identity_provider/verify_user_attributeSubmits a verification code for a signed-in user who has added or changed a value of an auto-verified attribute. When successful, the user's attribute becomes verified and the attribute email_verified or phone_number_verified becomes true. If your user pool requires verification before Amazon Cognito updates the attribute value, this operation updates the affected attribute to its pending value. Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.sigAccessToken (string) required
AttributeName (string) required
Code (string) required
cognito_identity/create_identity_poolCreates a new identity pool. The identity pool is a store of user identity information that is specific to your Amazon Web Services account. The keys for SupportedLoginProviders are as follows: Facebook: graph.facebook.com Google: accounts.google.com Sign in With Apple: appleid.apple.com Amazon: www.amazon.com Twitter: api.twitter.com Digits: www.digits.com If you don't provide a value for a parameter, Amazon Cognito sets it to its default value. You must use Amazon Web Services developer credenIdentityPoolName (string) required
AllowUnauthenticatedIdentities (boolean) required
AllowClassicFlow (boolean)
SupportedLoginProviders (object)
DeveloperProviderName (string)
OpenIdConnectProviderARNs (array)
CognitoIdentityProviders (array)
SamlProviderARNs (array)
IdentityPoolTags (object)
cognito_identity/delete_identitiesDeletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete. You must use Amazon Web Services developer credentials to call this operation.IdentityIdsToDelete (array) required
cognito_identity/delete_identity_poolDeletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool. You must use Amazon Web Services developer credentials to call this operation.IdentityPoolId (string) required
cognito_identity/describe_identityReturns metadata related to the given identity, including when the identity was created and any associated linked logins. You must use Amazon Web Services developer credentials to call this operation.IdentityId (string) required
cognito_identity/describe_identity_poolGets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users. You must use Amazon Web Services developer credentials to call this operation.IdentityPoolId (string) required
cognito_identity/get_credentials_for_identityReturns 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 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.IdentityId (string) required
Logins (object)
CustomRoleArn (string)
cognito_identity/get_idGenerates or retrieves IdentityID. Supplying multiple logins will create an implicit linked account. This is a public API. You do not need any credentials to call this API.AccountId (string)
IdentityPoolId (string) required
Logins (object)
cognito_identity/get_identity_pool_rolesGets the roles for an identity pool. You must use Amazon Web Services developer credentials to call this operation.IdentityPoolId (string) required
cognito_identity/get_open_id_tokenGets 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.IdentityId (string) required
Logins (object)
cognito_identity/get_open_id_token_for_developer_identityRegisters 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, usIdentityPoolId (string) required
IdentityId (string)
Logins (object) required
PrincipalTags (object)
TokenDuration (integer)
cognito_identity/get_principal_tag_attribute_mapUse GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.IdentityPoolId (string) required
IdentityProviderName (string) required
cognito_identity/list_identitiesLists the identities in an identity pool. You must use Amazon Web Services developer credentials to call this operation.IdentityPoolId (string) required
MaxResults (integer) required
NextToken (string)
HideDisabled (boolean)
cognito_identity/list_identity_poolsLists all of the Cognito identity pools registered for your account. You must use Amazon Web Services developer credentials to call this operation.MaxResults (integer) required
NextToken (string)
cognito_identity/list_tags_for_resourceLists 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.ResourceArn (string) required
cognito_identity/lookup_developer_identityRetrieves 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 responIdentityPoolId (string) required
IdentityId (string)
DeveloperUserIdentifier (string)
MaxResults (integer)
NextToken (string)
cognito_identity/merge_developer_identitiesMerges 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 asSourceUserIdentifier (string) required
DestinationUserIdentifier (string) required
DeveloperProviderName (string) required
IdentityPoolId (string) required
cognito_identity/set_identity_pool_rolesSets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action. You must use Amazon Web Services developer credentials to call this operation.IdentityPoolId (string) required
Roles (object) required
RoleMappings (object)
cognito_identity/set_principal_tag_attribute_mapYou can use this operation to use default username and clientID attribute or custom attribute mappings.IdentityPoolId (string) required
IdentityProviderName (string) required
UseDefaults (boolean)
PrincipalTags (object)
cognito_identity/tag_resourceAssigns 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 pResourceArn (string) required
Tags (object) required
cognito_identity/unlink_developer_identityUnlinks 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 Amazon Web Services developer credentials to call this operation.IdentityId (string) required
IdentityPoolId (string) required
DeveloperProviderName (string) required
DeveloperUserIdentifier (string) required
cognito_identity/unlink_identityUnlinks 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.IdentityId (string) required
Logins (object) required
LoginsToRemove (array) required
cognito_identity/untag_resourceRemoves the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per accountResourceArn (string) required
TagKeys (array) required
cognito_identity/update_identity_poolUpdates the configuration of an identity pool. If you don't provide a value for a parameter, Amazon Cognito sets it to its default value. You must use Amazon Web Services developer credentials to call this operation.IdentityPoolId (string) required
IdentityPoolName (string) required
AllowUnauthenticatedIdentities (boolean) required
AllowClassicFlow (boolean)
SupportedLoginProviders (object)
DeveloperProviderName (string)
OpenIdConnectProviderARNs (array)
CognitoIdentityProviders (array)
SamlProviderARNs (array)
IdentityPoolTags (object)
cognito_sync/bulk_publishInitiates 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.IdentityPoolId (string) required
cognito_sync/delete_datasetDeletes 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.IdentityPoolId (string) required
IdentityId (string) required
DatasetName (string) required
cognito_sync/describe_datasetGets 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.IdentityPoolId (string) required
IdentityId (string) required
DatasetName (string) required
cognito_sync/describe_identity_pool_usageGets 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 The following examples have been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: 8dc0e749-c8cd-48bd-8520-da6be00d528b X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.DescribeIdentityPoolIdentityPoolId (string) required
cognito_sync/describe_identity_usageGets 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 The following examples have been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: 33f9b4e4-a177-4aad-a3bb-6edb7980b283 X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.DescribeIdentityUsage HOST: cognito-sync.us-east-1IdentityPoolId (string) required
IdentityId (string) required
cognito_sync/get_bulk_publish_detailsGet 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.IdentityPoolId (string) required
cognito_sync/get_cognito_eventsGets 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.IdentityPoolId (string) required
cognito_sync/get_identity_pool_configurationGets 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 The following examples have been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: b1cfdd4b-f620-4fe4-be0f-02024a1d33da X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.GetIdentityPoolConfiguration HOST: cognito-sIdentityPoolId (string) required
cognito_sync/list_datasetsLists 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 The following examples have been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/jsIdentityPoolId (string) required
IdentityId (string) required
NextToken (string)
MaxResults (integer)
cognito_sync/list_identity_pool_usageGets 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 The following examples have been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: 9be7c425-ef05-48c0-aef3-9f0ff2fe17d3 X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.ListIdentityPoolUsage HOST: coNextToken (string)
MaxResults (integer)
cognito_sync/list_recordsGets 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 The following examples have been editeIdentityPoolId (string) required
IdentityId (string) required
DatasetName (string) required
LastSyncCount (integer)
NextToken (string)
MaxResults (integer)
SyncSessionToken (string)
cognito_sync/register_deviceRegisters 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 The following examples have been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: 368f9200-3eca-449e-93b3-7b9c08d8e185 X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.RegisterDevice HOST: cognito-sync.us-east-1.amazonaws.com X-AMZ-DIdentityPoolId (string) required
IdentityId (string) required
Platform (string) required
Token (string) required
cognito_sync/set_cognito_eventsSets 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.IdentityPoolId (string) required
Events (object) required
cognito_sync/set_identity_pool_configurationSets 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 The following examples have been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: a46db021-f5dd-45d6-af5b-7069fa4a211b X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.SetIdentityPoolConfiguration HOST: cognito-sync.uIdentityPoolId (string) required
PushSync: {
. ApplicationArns (array)
. RoleArn (string)
} (object)
CognitoStreams: {
. StreamName (string)
. RoleArn (string)
. StreamingStatus (string)
} (object)
cognito_sync/subscribe_to_datasetSubscribes 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 The following examples have been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: 8b9932b7-201d-4418-a960-0a470e11de9f X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.SubscribeToDataset HOST: cognito-sIdentityPoolId (string) required
IdentityId (string) required
DatasetName (string) required
DeviceId (string) required
cognito_sync/unsubscribe_from_datasetUnsubscribes 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 The following examples have been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZ-REQUESTSUPERTRACE: true X-AMZN-REQUESTID: 676896d6-14ca-45b1-8029-6d36b10a077e X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncSeIdentityPoolId (string) required
IdentityId (string) required
DatasetName (string) required
DeviceId (string) required
cognito_sync/update_recordsPosts 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 currentIdentityPoolId (string) required
IdentityId (string) required
DatasetName (string) required
DeviceId (string)
RecordPatches (array)
SyncSessionToken (string) required
ClientContext (string)
comprehend/batch_detect_dominant_languageDetermines 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.TextList (array) required
comprehend/batch_detect_entitiesInspects 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.TextList (array) required
LanguageCode (string) required
comprehend/batch_detect_key_phrasesDetects the key noun phrases found in a batch of documents.TextList (array) required
LanguageCode (string) required
comprehend/batch_detect_sentimentInspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.TextList (array) required
LanguageCode (string) required
comprehend/batch_detect_syntaxInspects 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.TextList (array) required
LanguageCode (string) required
comprehend/batch_detect_targeted_sentimentInspects 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 in the Amazon Comprehend Developer Guide.TextList (array) required
LanguageCode (string) required
comprehend/classify_documentCreates a classification request to analyze a single document in real-time. ClassifyDocument supports the following model types: Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document PDF, Word, or image, or Amazon Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide. Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input pText (string)
EndpointArn (string) required
Bytes (string)
DocumentReaderConfig: {
. DocumentReadAction (string)
. DocumentReadMode (string)
. FeatureTypes (array)
} (object)
comprehend/contains_pii_entitiesAnalyzes 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.Text (string) required
LanguageCode (string) required
comprehend/create_datasetCreates a dataset to upload training or test data for a model associated with a flywheel. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.FlywheelArn (string) required
DatasetName (string) required
DatasetType (string)
Description (string)
InputDataConfig: {
. AugmentedManifests (array)
. DataFormat (string)
. DocumentClassifierInputDataConfig (object)
. EntityRecognizerInputDataConfig (object)
} (object) required
ClientRequestToken (string)
Tags (array)
comprehend/create_document_classifierCreates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide.DocumentClassifierName (string) required
VersionName (string)
DataAccessRoleArn (string) required
Tags (array)
InputDataConfig: {
. DataFormat (string)
. S3Uri (string)
. TestS3Uri (string)
. LabelDelimiter (string)
. AugmentedManifests (array)
. DocumentType (string)
. Documents (object)
. DocumentReaderConfig (object)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. KmsKeyId (string)
. FlywheelStatsS3Prefix (string)
} (object)
ClientRequestToken (string)
LanguageCode (string) required
VolumeKmsKeyId (string)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
Mode (string)
ModelKmsKeyId (string)
ModelPolicy (string)
comprehend/create_endpointCreates a model-specific endpoint for synchronous inference for a previously trained custom model For information about endpoints, see Managing endpoints.EndpointName (string) required
ModelArn (string)
DesiredInferenceUnits (integer) required
ClientRequestToken (string)
Tags (array)
DataAccessRoleArn (string)
FlywheelArn (string)
comprehend/create_entity_recognizerCreates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the DescribeEntityRecognizer API.RecognizerName (string) required
VersionName (string)
DataAccessRoleArn (string) required
Tags (array)
InputDataConfig: {
. DataFormat (string)
. EntityTypes (array)
. Documents (object)
. Annotations (object)
. EntityList (object)
. AugmentedManifests (array)
} (object) required
ClientRequestToken (string)
LanguageCode (string) required
VolumeKmsKeyId (string)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
ModelKmsKeyId (string)
ModelPolicy (string)
comprehend/create_flywheelA flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification or custom entity recognition. You can create a flywheel to start with an existing trained model, or Comprehend can create and train a new model. When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training data and test data for all versions of the model. To use a flywheel with an existing trained model, you specify the activeFlywheelName (string) required
ActiveModelArn (string)
DataAccessRoleArn (string) required
TaskConfig: {
. LanguageCode (string)
. DocumentClassificationConfig (object)
. EntityRecognitionConfig (object)
} (object)
ModelType (string)
DataLakeS3Uri (string) required
DataSecurityConfig: {
. ModelKmsKeyId (string)
. VolumeKmsKeyId (string)
. DataLakeKmsKeyId (string)
. VpcConfig (object)
} (object)
ClientRequestToken (string)
Tags (array)
comprehend/delete_document_classifierDeletes 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.DocumentClassifierArn (string) required
comprehend/delete_endpointDeletes 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.EndpointArn (string) required
comprehend/delete_entity_recognizerDeletes 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.EntityRecognizerArn (string) required
comprehend/delete_flywheelDeletes a flywheel. When you delete the flywheel, Amazon Comprehend does not delete the data lake or the model associated with the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.FlywheelArn (string) required
comprehend/delete_resource_policyDeletes a resource-based policy that is attached to a custom model.ResourceArn (string) required
PolicyRevisionId (string)
comprehend/describe_datasetReturns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.DatasetArn (string) required
comprehend/describe_document_classification_jobGets the properties associated with a document classification job. Use this operation to get the status of a classification job.JobId (string) required
comprehend/describe_document_classifierGets the properties associated with a document classifier.DocumentClassifierArn (string) required
comprehend/describe_dominant_language_detection_jobGets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.JobId (string) required
comprehend/describe_endpointGets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.EndpointArn (string) required
comprehend/describe_entities_detection_jobGets the properties associated with an entities detection job. Use this operation to get the status of a detection job.JobId (string) required
comprehend/describe_entity_recognizerProvides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.EntityRecognizerArn (string) required
comprehend/describe_events_detection_jobGets the status and details of an events detection job.JobId (string) required
comprehend/describe_flywheelProvides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.FlywheelArn (string) required
comprehend/describe_flywheel_iterationRetrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.FlywheelArn (string) required
FlywheelIterationId (string) required
comprehend/describe_key_phrases_detection_jobGets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.JobId (string) required
comprehend/describe_pii_entities_detection_jobGets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.JobId (string) required
comprehend/describe_resource_policyGets the details of a resource-based policy that is attached to a custom model, including the JSON body of the policy.ResourceArn (string) required
comprehend/describe_sentiment_detection_jobGets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.JobId (string) required
comprehend/describe_targeted_sentiment_detection_jobGets the properties associated with a targeted sentiment detection job. Use this operation to get the status of the job.JobId (string) required
comprehend/describe_topics_detection_jobGets the properties associated with a topic detection job. Use this operation to get the status of a detection job.JobId (string) required
comprehend/detect_dominant_languageDetermines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.Text (string) required
comprehend/detect_entitiesDetects named entities in input text when you use the pre-trained model. Detects custom entities if you have a custom entity recognition model. When detecting named entities using the pre-trained model, use plain text as the input. For more information about named entities, see Entities in the Comprehend Developer Guide. When you use a custom entity recognition model, you can input plain text or you can upload a single-page input document text, PDF, Word, or image. If the system detects errors wText (string)
LanguageCode (string)
EndpointArn (string)
Bytes (string)
DocumentReaderConfig: {
. DocumentReadAction (string)
. DocumentReadMode (string)
. FeatureTypes (array)
} (object)
comprehend/detect_key_phrasesDetects the key noun phrases found in the text.Text (string) required
LanguageCode (string) required
comprehend/detect_pii_entitiesInspects the input text for entities that contain personally identifiable information PII and returns information about them.Text (string) required
LanguageCode (string) required
comprehend/detect_sentimentInspects text and returns an inference of the prevailing sentiment POSITIVE, NEUTRAL, MIXED, or NEGATIVE.Text (string) required
LanguageCode (string) required
comprehend/detect_syntaxInspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.Text (string) required
LanguageCode (string) required
comprehend/detect_targeted_sentimentInspects the input text and returns a sentiment analysis for each entity identified in the text. For more information about targeted sentiment, see Targeted sentiment in the Amazon Comprehend Developer Guide.Text (string) required
LanguageCode (string) required
comprehend/detect_toxic_contentPerforms toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.TextSegments (array) required
LanguageCode (string) required
comprehend/import_modelCreates a new custom model that replicates a source custom model that you import. The source model can be in your Amazon Web Services account or another one. If the source model is in another Amazon Web Services account, then it must have a resource-based policy that authorizes you to import it. The source model must be in the same Amazon Web Services Region that you're using when you import. You can't import a model that's in a different Region.SourceModelArn (string) required
ModelName (string)
VersionName (string)
ModelKmsKeyId (string)
DataAccessRoleArn (string)
Tags (array)
comprehend/list_datasetsList the datasets that you have configured in this Region. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.FlywheelArn (string)
Filter: {
. Status (string)
. DatasetType (string)
. CreationTimeAfter (string)
. CreationTimeBefore (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_document_classification_jobsGets a list of the documentation classification jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_document_classifiersGets a list of the document classifiers that you have created.Filter: {
. Status (string)
. DocumentClassifierName (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_document_classifier_summariesGets a list of summaries of the document classifiers that you have createdNextToken (string)
MaxResults (integer)
comprehend/list_dominant_language_detection_jobsGets a list of the dominant language detection jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_endpointsGets a list of all existing endpoints that you've created. For information about endpoints, see Managing endpoints.Filter: {
. ModelArn (string)
. Status (string)
. CreationTimeBefore (string)
. CreationTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_entities_detection_jobsGets a list of the entity detection jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_entity_recognizersGets 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.Filter: {
. Status (string)
. RecognizerName (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_entity_recognizer_summariesGets a list of summaries for the entity recognizers that you have created.NextToken (string)
MaxResults (integer)
comprehend/list_events_detection_jobsGets a list of the events detection jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_flywheel_iteration_historyInformation about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.FlywheelArn (string) required
Filter: {
. CreationTimeAfter (string)
. CreationTimeBefore (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_flywheelsGets a list of the flywheels that you have created.Filter: {
. Status (string)
. CreationTimeAfter (string)
. CreationTimeBefore (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_key_phrases_detection_jobsGet a list of key phrase detection jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_pii_entities_detection_jobsGets a list of the PII entity detection jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_sentiment_detection_jobsGets a list of sentiment detection jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_tags_for_resourceLists all tags associated with a given Amazon Comprehend resource.ResourceArn (string) required
comprehend/list_targeted_sentiment_detection_jobsGets a list of targeted sentiment detection jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/list_topics_detection_jobsGets a list of the topic detection jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehend/put_resource_policyAttaches a resource-based policy to a custom model. You can use this policy to authorize an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon Comprehend in their account.ResourceArn (string) required
ResourcePolicy (string) required
PolicyRevisionId (string)
comprehend/start_document_classification_jobStarts an asynchronous document classification job using a custom classification model. Use the DescribeDocumentClassificationJob operation to track the progress of the job.JobName (string)
DocumentClassifierArn (string)
InputDataConfig: {
. S3Uri (string)
. InputFormat (string)
. DocumentReaderConfig (object)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. KmsKeyId (string)
} (object) required
DataAccessRoleArn (string) required
ClientRequestToken (string)
VolumeKmsKeyId (string)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
Tags (array)
FlywheelArn (string)
comprehend/start_dominant_language_detection_jobStarts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.InputDataConfig: {
. S3Uri (string)
. InputFormat (string)
. DocumentReaderConfig (object)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. KmsKeyId (string)
} (object) required
DataAccessRoleArn (string) required
JobName (string)
ClientRequestToken (string)
VolumeKmsKeyId (string)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
Tags (array)
comprehend/start_entities_detection_jobStarts 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.InputDataConfig: {
. S3Uri (string)
. InputFormat (string)
. DocumentReaderConfig (object)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. KmsKeyId (string)
} (object) required
DataAccessRoleArn (string) required
JobName (string)
EntityRecognizerArn (string)
LanguageCode (string) required
ClientRequestToken (string)
VolumeKmsKeyId (string)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
Tags (array)
FlywheelArn (string)
comprehend/start_events_detection_jobStarts an asynchronous event detection job for a collection of documents.InputDataConfig: {
. S3Uri (string)
. InputFormat (string)
. DocumentReaderConfig (object)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. KmsKeyId (string)
} (object) required
DataAccessRoleArn (string) required
JobName (string)
LanguageCode (string) required
ClientRequestToken (string)
TargetEventTypes (array) required
Tags (array)
comprehend/start_flywheel_iterationStart the flywheel iteration.This operation uses any new datasets to train a new model version. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.FlywheelArn (string) required
ClientRequestToken (string)
comprehend/start_key_phrases_detection_jobStarts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.InputDataConfig: {
. S3Uri (string)
. InputFormat (string)
. DocumentReaderConfig (object)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. KmsKeyId (string)
} (object) required
DataAccessRoleArn (string) required
JobName (string)
LanguageCode (string) required
ClientRequestToken (string)
VolumeKmsKeyId (string)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
Tags (array)
comprehend/start_pii_entities_detection_jobStarts an asynchronous PII entity detection job for a collection of documents.InputDataConfig: {
. S3Uri (string)
. InputFormat (string)
. DocumentReaderConfig (object)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. KmsKeyId (string)
} (object) required
Mode (string) required
RedactionConfig: {
. PiiEntityTypes (array)
. MaskMode (string)
. MaskCharacter (string)
} (object)
DataAccessRoleArn (string) required
JobName (string)
LanguageCode (string) required
ClientRequestToken (string)
Tags (array)
comprehend/start_sentiment_detection_jobStarts an asynchronous sentiment detection job for a collection of documents. Use the operation to track the status of a job.InputDataConfig: {
. S3Uri (string)
. InputFormat (string)
. DocumentReaderConfig (object)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. KmsKeyId (string)
} (object) required
DataAccessRoleArn (string) required
JobName (string)
LanguageCode (string) required
ClientRequestToken (string)
VolumeKmsKeyId (string)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
Tags (array)
comprehend/start_targeted_sentiment_detection_jobStarts an asynchronous targeted sentiment detection job for a collection of documents. Use the DescribeTargetedSentimentDetectionJob operation to track the status of a job.InputDataConfig: {
. S3Uri (string)
. InputFormat (string)
. DocumentReaderConfig (object)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. KmsKeyId (string)
} (object) required
DataAccessRoleArn (string) required
JobName (string)
LanguageCode (string) required
ClientRequestToken (string)
VolumeKmsKeyId (string)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
Tags (array)
comprehend/start_topics_detection_jobStarts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.InputDataConfig: {
. S3Uri (string)
. InputFormat (string)
. DocumentReaderConfig (object)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. KmsKeyId (string)
} (object) required
DataAccessRoleArn (string) required
JobName (string)
NumberOfTopics (integer)
ClientRequestToken (string)
VolumeKmsKeyId (string)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
Tags (array)
comprehend/stop_dominant_language_detection_jobStops 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 documeJobId (string) required
comprehend/stop_entities_detection_jobStops 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 alreJobId (string) required
comprehend/stop_events_detection_jobStops an events detection job in progress.JobId (string) required
comprehend/stop_key_phrases_detection_jobStops 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 alJobId (string) required
comprehend/stop_pii_entities_detection_jobStops a PII entities detection job in progress.JobId (string) required
comprehend/stop_sentiment_detection_jobStops 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 documentsJobId (string) required
comprehend/stop_targeted_sentiment_detection_jobStops 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 dJobId (string) required
comprehend/stop_training_document_classifierStops 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.DocumentClassifierArn (string) required
comprehend/stop_training_entity_recognizerStops 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.EntityRecognizerArn (string) required
comprehend/tag_resourceAssociates 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.ResourceArn (string) required
Tags (array) required
comprehend/untag_resourceRemoves a specific tag associated with an Amazon Comprehend resource.ResourceArn (string) required
TagKeys (array) required
comprehend/update_endpointUpdates information about the specified endpoint. For information about endpoints, see Managing endpoints.EndpointArn (string) required
DesiredModelArn (string)
DesiredInferenceUnits (integer)
DesiredDataAccessRoleArn (string)
FlywheelArn (string)
comprehend/update_flywheelUpdate the configuration information for an existing flywheel.FlywheelArn (string) required
ActiveModelArn (string)
DataAccessRoleArn (string)
DataSecurityConfig: {
. ModelKmsKeyId (string)
. VolumeKmsKeyId (string)
. VpcConfig (object)
} (object)
comprehendmedical/describe_entities_detection_v2jobGets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.JobId (string) required
comprehendmedical/describe_icd10cminference_jobGets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.JobId (string) required
comprehendmedical/describe_phidetection_jobGets the properties associated with a protected health information PHI detection job. Use this operation to get the status of a detection job.JobId (string) required
comprehendmedical/describe_rx_norm_inference_jobGets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.JobId (string) required
comprehendmedical/describe_snomedctinference_jobGets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.JobId (string) required
comprehendmedical/detect_entitiesThe 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.Text (string) required
comprehendmedical/detect_entities_v2Inspects 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 shoulText (string) required
comprehendmedical/detect_phiInspects 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.Text (string) required
comprehendmedical/infer_icd10cmInferICD10CM 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.Text (string) required
comprehendmedical/infer_rx_normInferRxNorm 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.Text (string) required
comprehendmedical/infer_snomedctInferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms SNOMED-CT ontologyText (string) required
comprehendmedical/list_entities_detection_v2jobsGets a list of medical entity detection jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehendmedical/list_icd10cminference_jobsGets a list of InferICD10CM jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehendmedical/list_phidetection_jobsGets a list of protected health information PHI detection jobs you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehendmedical/list_rx_norm_inference_jobsGets a list of InferRxNorm jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehendmedical/list_snomedctinference_jobsGets a list of InferSNOMEDCT jobs a user has submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmitTimeBefore (string)
. SubmitTimeAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
comprehendmedical/start_entities_detection_v2jobStarts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.InputDataConfig: {
. S3Bucket (string)
. S3Key (string)
} (object) required
OutputDataConfig: {
. S3Bucket (string)
. S3Key (string)
} (object) required
DataAccessRoleArn (string) required
JobName (string)
ClientRequestToken (string)
KMSKey (string)
LanguageCode (string) required
comprehendmedical/start_icd10cminference_jobStarts 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.InputDataConfig: {
. S3Bucket (string)
. S3Key (string)
} (object) required
OutputDataConfig: {
. S3Bucket (string)
. S3Key (string)
} (object) required
DataAccessRoleArn (string) required
JobName (string)
ClientRequestToken (string)
KMSKey (string)
LanguageCode (string) required
comprehendmedical/start_phidetection_jobStarts an asynchronous job to detect protected health information PHI. Use the DescribePHIDetectionJob operation to track the status of a job.InputDataConfig: {
. S3Bucket (string)
. S3Key (string)
} (object) required
OutputDataConfig: {
. S3Bucket (string)
. S3Key (string)
} (object) required
DataAccessRoleArn (string) required
JobName (string)
ClientRequestToken (string)
KMSKey (string)
LanguageCode (string) required
comprehendmedical/start_rx_norm_inference_jobStarts 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.InputDataConfig: {
. S3Bucket (string)
. S3Key (string)
} (object) required
OutputDataConfig: {
. S3Bucket (string)
. S3Key (string)
} (object) required
DataAccessRoleArn (string) required
JobName (string)
ClientRequestToken (string)
KMSKey (string)
LanguageCode (string) required
comprehendmedical/start_snomedctinference_jobStarts 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.InputDataConfig: {
. S3Bucket (string)
. S3Key (string)
} (object) required
OutputDataConfig: {
. S3Bucket (string)
. S3Key (string)
} (object) required
DataAccessRoleArn (string) required
JobName (string)
ClientRequestToken (string)
KMSKey (string)
LanguageCode (string) required
comprehendmedical/stop_entities_detection_v2jobStops a medical entities detection job in progress.JobId (string) required
comprehendmedical/stop_icd10cminference_jobStops an InferICD10CM inference job in progress.JobId (string) required
comprehendmedical/stop_phidetection_jobStops a protected health information PHI detection job in progress.JobId (string) required
comprehendmedical/stop_rx_norm_inference_jobStops an InferRxNorm inference job in progress.JobId (string) required
comprehendmedical/stop_snomedctinference_jobStops an InferSNOMEDCT inference job in progress.JobId (string) required
compute_optimizer_automation/associate_accountsAssociates one or more member accounts with your organization's management account, enabling centralized implementation of optimization actions across those accounts. Once associated, the management account or a delegated administrator can apply recommended actions to the member account. When you associate a member account, its organization rule mode is automatically set to 'Any allowed,' which permits the management account to create Automation rules that automatically apply actions to that accaccountIds (array) required
clientToken (string)
compute_optimizer_automation/create_automation_ruleCreates a new automation rule to apply recommended actions to resources based on specified criteria.name (string) required
description (string)
ruleType (string) required
organizationConfiguration: {
. ruleApplyOrder (string)
. accountIds (array)
} (object)
priority (string)
recommendedActionTypes (array) required
criteria: {
. region (array)
. resourceArn (array)
. ebsVolumeType (array)
. ebsVolumeSizeInGib (array)
. estimatedMonthlySavings (array)
. resourceTag (array)
. lookBackPeriodInDays (array)
. restartNeeded (array)
} (object)
schedule: {
. scheduleExpression (string)
. scheduleExpressionTimezone (string)
. executionWindowInMinutes (integer)
} (object) required
status (string) required
tags (array)
clientToken (string)
compute_optimizer_automation/delete_automation_ruleDeletes an existing automation rule.ruleArn (string) required
ruleRevision (integer) required
clientToken (string)
compute_optimizer_automation/disassociate_accountsDisassociates member accounts from your organization's management account, removing centralized automation capabilities. Once disassociated, organization rules no longer apply to the member account, and the management account or delegated administrator cannot create Automation rules for that account. Only the management account or a delegated administrator can perform this action.accountIds (array) required
clientToken (string)
compute_optimizer_automation/get_automation_eventRetrieves details about a specific automation event.eventId (string) required
compute_optimizer_automation/get_automation_ruleRetrieves details about a specific automation rule.ruleArn (string) required
compute_optimizer_automation/get_enrollment_configurationRetrieves the current enrollment configuration for Compute Optimizer Automation.No parameters
compute_optimizer_automation/list_accountsLists the accounts in your organization that are enrolled in Compute Optimizer and whether they have enabled Automation. Only the management account or a delegated administrator can perform this action.maxResults (integer)
nextToken (string)
compute_optimizer_automation/list_automation_eventsLists automation events based on specified filters. You can retrieve events that were created within the past year.filters (array)
startTimeInclusive (string)
endTimeExclusive (string)
maxResults (integer)
nextToken (string)
compute_optimizer_automation/list_automation_event_stepsLists the steps for a specific automation event. You can only list steps for events created within the past year.eventId (string) required
maxResults (integer)
nextToken (string)
compute_optimizer_automation/list_automation_event_summariesProvides a summary of automation events based on specified filters. Only events created within the past year will be included in the summary.filters (array)
startDateInclusive (string)
endDateExclusive (string)
maxResults (integer)
nextToken (string)
compute_optimizer_automation/list_automation_rule_previewReturns a preview of the recommended actions that match your Automation rule's configuration and criteria.ruleType (string) required
organizationScope: {
. accountIds (array)
} (object)
recommendedActionTypes (array) required
criteria: {
. region (array)
. resourceArn (array)
. ebsVolumeType (array)
. ebsVolumeSizeInGib (array)
. estimatedMonthlySavings (array)
. resourceTag (array)
. lookBackPeriodInDays (array)
. restartNeeded (array)
} (object)
maxResults (integer)
nextToken (string)
compute_optimizer_automation/list_automation_rule_preview_summariesReturns a summary of the recommended actions that match your rule preview configuration and criteria.ruleType (string) required
organizationScope: {
. accountIds (array)
} (object)
recommendedActionTypes (array) required
criteria: {
. region (array)
. resourceArn (array)
. ebsVolumeType (array)
. ebsVolumeSizeInGib (array)
. estimatedMonthlySavings (array)
. resourceTag (array)
. lookBackPeriodInDays (array)
. restartNeeded (array)
} (object)
maxResults (integer)
nextToken (string)
compute_optimizer_automation/list_automation_rulesLists the automation rules that match specified filters.filters (array)
maxResults (integer)
nextToken (string)
compute_optimizer_automation/list_recommended_actionsLists the recommended actions based that match specified filters. Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using AssociateAccounts.filters (array)
maxResults (integer)
nextToken (string)
compute_optimizer_automation/list_recommended_action_summariesProvides a summary of recommended actions based on specified filters. Management accounts and delegated administrators can retrieve recommended actions that include associated member accounts. You can associate a member account using AssociateAccounts.filters (array)
maxResults (integer)
nextToken (string)
compute_optimizer_automation/list_tags_for_resourceLists the tags for a specified resource.resourceArn (string) required
compute_optimizer_automation/rollback_automation_eventInitiates a rollback for a completed automation event. Management accounts and delegated administrators can only initiate a rollback for events belonging to associated member accounts. You can associate a member account using AssociateAccounts.eventId (string) required
clientToken (string)
compute_optimizer_automation/start_automation_eventInitiates a one-time, on-demand automation for the specified recommended action. Management accounts and delegated administrators can only initiate recommended actions for associated member accounts. You can associate a member account using AssociateAccounts.recommendedActionId (string) required
clientToken (string)
compute_optimizer_automation/tag_resourceAdds tags to the specified resource.resourceArn (string) required
ruleRevision (integer) required
tags (array) required
clientToken (string)
compute_optimizer_automation/untag_resourceRemoves tags from the specified resource.resourceArn (string) required
ruleRevision (integer) required
tagKeys (array) required
clientToken (string)
compute_optimizer_automation/update_automation_ruleUpdates an existing automation rule.ruleArn (string) required
ruleRevision (integer) required
name (string)
description (string)
ruleType (string)
organizationConfiguration: {
. ruleApplyOrder (string)
. accountIds (array)
} (object)
priority (string)
recommendedActionTypes (array)
criteria: {
. region (array)
. resourceArn (array)
. ebsVolumeType (array)
. ebsVolumeSizeInGib (array)
. estimatedMonthlySavings (array)
. resourceTag (array)
. lookBackPeriodInDays (array)
. restartNeeded (array)
} (object)
schedule: {
. scheduleExpression (string)
. scheduleExpressionTimezone (string)
. executionWindowInMinutes (integer)
} (object)
status (string)
clientToken (string)
compute_optimizer_automation/update_enrollment_configurationUpdates your account’s Compute Optimizer Automation enrollment configuration.status (string) required
clientToken (string)
compute_optimizer/delete_recommendation_preferencesDeletes a recommendation preference, such as enhanced infrastructure metrics. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.resourceType (string) required
scope: {
. name (string)
. value (string)
} (object)
recommendationPreferenceNames (array) required
compute_optimizer/describe_recommendation_export_jobsDescribes 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.jobIds (array)
filters (array)
nextToken (string)
maxResults (integer)
compute_optimizer/export_auto_scaling_group_recommendationsExports optimization recommendations for Amazon EC2 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 Amazon EC2 Auto Scaling group export job in progress per Amazon Web Services Region.accountIds (array)
filters (array)
fieldsToExport (array)
s3DestinationConfig: {
. bucket (string)
. keyPrefix (string)
} (object) required
fileFormat (string)
includeMemberAccounts (boolean)
recommendationPreferences: {
. cpuVendorArchitectures (array)
} (object)
compute_optimizer/export_ebsvolume_recommendationsExports 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.accountIds (array)
filters (array)
fieldsToExport (array)
s3DestinationConfig: {
. bucket (string)
. keyPrefix (string)
} (object) required
fileFormat (string)
includeMemberAccounts (boolean)
compute_optimizer/export_ec2instance_recommendationsExports 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.accountIds (array)
filters (array)
fieldsToExport (array)
s3DestinationConfig: {
. bucket (string)
. keyPrefix (string)
} (object) required
fileFormat (string)
includeMemberAccounts (boolean)
recommendationPreferences: {
. cpuVendorArchitectures (array)
} (object)
compute_optimizer/export_ecsservice_recommendationsExports optimization recommendations for Amazon ECS services on Fargate. Recommendations are exported in a CSV file, and its metadata in a 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 only have one Amazon ECS service export job in progress per Amazon Web Services Region.accountIds (array)
filters (array)
fieldsToExport (array)
s3DestinationConfig: {
. bucket (string)
. keyPrefix (string)
} (object) required
fileFormat (string)
includeMemberAccounts (boolean)
compute_optimizer/export_idle_recommendationsExport optimization recommendations for your idle resources. Recommendations are exported in a comma-separated values CSV file, and its metadata in a JavaScript Object Notation 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 idle resource export job in progress per Amazon Web Services Region.accountIds (array)
filters (array)
fieldsToExport (array)
s3DestinationConfig: {
. bucket (string)
. keyPrefix (string)
} (object) required
fileFormat (string)
includeMemberAccounts (boolean)
compute_optimizer/export_lambda_function_recommendationsExports 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.accountIds (array)
filters (array)
fieldsToExport (array)
s3DestinationConfig: {
. bucket (string)
. keyPrefix (string)
} (object) required
fileFormat (string)
includeMemberAccounts (boolean)
compute_optimizer/export_license_recommendationsExport optimization recommendations for your licenses. Recommendations are exported in a comma-separated values CSV file, and its metadata in a JavaScript Object Notation 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 license export job in progress per Amazon Web Services Region.accountIds (array)
filters (array)
fieldsToExport (array)
s3DestinationConfig: {
. bucket (string)
. keyPrefix (string)
} (object) required
fileFormat (string)
includeMemberAccounts (boolean)
compute_optimizer/export_rdsdatabase_recommendationsExport optimization recommendations for your Amazon Aurora and Amazon Relational Database Service Amazon RDS databases. Recommendations are exported in a comma-separated values CSV file, and its metadata in a JavaScript Object Notation 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 Aurora or RDS export job in progress per Amazon Web SeraccountIds (array)
filters (array)
fieldsToExport (array)
s3DestinationConfig: {
. bucket (string)
. keyPrefix (string)
} (object) required
fileFormat (string)
includeMemberAccounts (boolean)
recommendationPreferences: {
. cpuVendorArchitectures (array)
} (object)
compute_optimizer/get_auto_scaling_group_recommendationsReturns Amazon EC2 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.accountIds (array)
autoScalingGroupArns (array)
nextToken (string)
maxResults (integer)
filters (array)
recommendationPreferences: {
. cpuVendorArchitectures (array)
} (object)
compute_optimizer/get_ebsvolume_recommendationsReturns 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.volumeArns (array)
nextToken (string)
maxResults (integer)
filters (array)
accountIds (array)
compute_optimizer/get_ec2instance_recommendationsReturns 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.instanceArns (array)
nextToken (string)
maxResults (integer)
filters (array)
accountIds (array)
recommendationPreferences: {
. cpuVendorArchitectures (array)
} (object)
compute_optimizer/get_ec2recommendation_projected_metricsReturns 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.instanceArn (string) required
stat (string) required
period (integer) required
startTime (string) required
endTime (string) required
recommendationPreferences: {
. cpuVendorArchitectures (array)
} (object)
compute_optimizer/get_ecsservice_recommendation_projected_metricsReturns the projected metrics of Amazon ECS service recommendations.serviceArn (string) required
stat (string) required
period (integer) required
startTime (string) required
endTime (string) required
compute_optimizer/get_ecsservice_recommendationsReturns Amazon ECS service recommendations. Compute Optimizer generates recommendations for Amazon ECS services on Fargate that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.serviceArns (array)
nextToken (string)
maxResults (integer)
filters (array)
accountIds (array)
compute_optimizer/get_effective_recommendation_preferencesReturns 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.resourceArn (string) required
compute_optimizer/get_enrollment_statusReturns 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.No parameters
compute_optimizer/get_enrollment_statuses_for_organizationReturns 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.filters (array)
nextToken (string)
maxResults (integer)
compute_optimizer/get_idle_recommendationsReturns idle resource recommendations. Compute Optimizer generates recommendations for idle resources that meet a specific set of requirements. For more information, see Resource requirements in the Compute Optimizer User GuideresourceArns (array)
nextToken (string)
maxResults (integer)
filters (array)
accountIds (array)
orderBy: {
. dimension (string)
. order (string)
} (object)
compute_optimizer/get_lambda_function_recommendationsReturns 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.functionArns (array)
accountIds (array)
filters (array)
nextToken (string)
maxResults (integer)
compute_optimizer/get_license_recommendationsReturns license recommendations for Amazon EC2 instances that run on a specific license. Compute Optimizer generates recommendations for licenses that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.resourceArns (array)
nextToken (string)
maxResults (integer)
filters (array)
accountIds (array)
compute_optimizer/get_rdsdatabase_recommendation_projected_metricsReturns the projected metrics of Aurora and RDS database recommendations.resourceArn (string) required
stat (string) required
period (integer) required
startTime (string) required
endTime (string) required
recommendationPreferences: {
. cpuVendorArchitectures (array)
} (object)
compute_optimizer/get_rdsdatabase_recommendationsReturns Amazon Aurora and RDS database recommendations. Compute Optimizer generates recommendations for Amazon Aurora and RDS databases that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.resourceArns (array)
nextToken (string)
maxResults (integer)
filters (array)
accountIds (array)
recommendationPreferences: {
. cpuVendorArchitectures (array)
} (object)
compute_optimizer/get_recommendation_preferencesReturns 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 Amazon EC2 Auto Scaling group Amazon Resource Name ARN. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.resourceType (string) required
scope: {
. name (string)
. value (string)
} (object)
nextToken (string)
maxResults (integer)
compute_optimizer/get_recommendation_summariesReturns the optimization findings for an account. It returns the number of: Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned, or Optimized. EC2Amazon EC2 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. Amazon ECS services in an account that are Underprovisioned, Overprovisioned, or Optimized. Commercial softwaccountIds (array)
nextToken (string)
maxResults (integer)
compute_optimizer/put_recommendation_preferencesCreates 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.resourceType (string) required
scope: {
. name (string)
. value (string)
} (object)
enhancedInfrastructureMetrics (string)
inferredWorkloadTypes (string)
externalMetricsPreference: {
. source (string)
} (object)
lookBackPeriod (string)
utilizationPreferences (array)
preferredResources (array)
savingsEstimationMode (string)
compute_optimizer/update_enrollment_statusUpdates 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 opstatus (string) required
includeMemberAccounts (boolean)
config_service/associate_resource_typesAdds all resource types specified in the ResourceTypes list to the RecordingGroup of specified configuration recorder and includes those resource types when recording. For this operation, the specified configuration recorder must use a RecordingStrategy that is either INCLUSION_BY_RESOURCE_TYPES or EXCLUSION_BY_RESOURCE_TYPES.ConfigurationRecorderArn (string) required
ResourceTypes (array) required
config_service/batch_get_aggregate_resource_configReturns 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.ConfigurationAggregatorName (string) required
ResourceIdentifiers (array) required
config_service/batch_get_resource_configReturns 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.resourceKeys (array) required
config_service/delete_aggregation_authorizationDeletes the authorization granted to the specified configuration aggregator account in a specified region.AuthorizedAccountId (string) required
AuthorizedAwsRegion (string) required
config_service/delete_config_ruleDeletes 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. Recommendation: Consider excluding the AWS::Config::ResourceCompliance resource type from recording before deletinConfigRuleName (string) required
config_service/delete_configuration_aggregatorDeletes the specified configuration aggregator and the aggregated data associated with the aggregator.ConfigurationAggregatorName (string) required
config_service/delete_configuration_recorderDeletes the customer managed configuration recorder. This operation does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory operation, but you will not be able to access this information in the Config console until you have created a new customer managed configuration recorder.ConfigurationRecorderName (string) required
config_service/delete_conformance_packDeletes 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. Recommendation: Consider excluding the AWS::Config::ResourceCompliance resource type from recording before deleting rules Deleting rules creates configuration items CIs for AWS::Config::ResourceCompliance tConformancePackName (string) required
config_service/delete_delivery_channelDeletes the delivery channel. Before you can delete the delivery channel, you must stop the customer managed configuration recorder. You can use the StopConfigurationRecorder operation to stop the customer managed configuration recorder.DeliveryChannelName (string) required
config_service/delete_evaluation_resultsDeletes 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.ConfigRuleName (string) required
config_service/delete_organization_config_ruleDeletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization. Only a management 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 staOrganizationConfigRuleName (string) required
config_service/delete_organization_conformance_packDeletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization. Only a management 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 cannoOrganizationConformancePackName (string) required
config_service/delete_pending_aggregation_requestDeletes pending authorization requests for a specified aggregator account in a specified region.RequesterAccountId (string) required
RequesterAwsRegion (string) required
config_service/delete_remediation_configurationDeletes the remediation configuration.ConfigRuleName (string) required
ResourceType (string)
config_service/delete_remediation_exceptionsDeletes 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.ConfigRuleName (string) required
ResourceKeys (array) required
config_service/delete_resource_configRecords 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.ResourceType (string) required
ResourceId (string) required
config_service/delete_retention_configurationDeletes the retention configuration.RetentionConfigurationName (string) required
config_service/delete_service_linked_configuration_recorderDeletes an existing service-linked configuration recorder. This operation does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory operation, but you will not be able to access this information in the Config console until you have created a new service-linked configuration recorder for the same service. The recording scope determines if you receive configuration items The recorServicePrincipal (string) required
config_service/delete_stored_queryDeletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.QueryName (string) required
config_service/deliver_config_snapshotSchedules 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.deliveryChannelName (string) required
config_service/describe_aggregate_compliance_by_config_rulesReturns 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.ConfigurationAggregatorName (string) required
Filters: {
. ConfigRuleName (string)
. ComplianceType (string)
. AccountId (string)
. AwsRegion (string)
} (object)
Limit (integer)
NextToken (string)
config_service/describe_aggregate_compliance_by_conformance_packsReturns a list of the existing and deleted 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.ConfigurationAggregatorName (string) required
Filters: {
. ConformancePackName (string)
. ComplianceType (string)
. AccountId (string)
. AwsRegion (string)
} (object)
Limit (integer)
NextToken (string)
config_service/describe_aggregation_authorizationsReturns a list of authorizations granted to various aggregator accounts and regions.Limit (integer)
NextToken (string)
config_service/describe_compliance_by_config_ruleIndicates whether the specified Config rules are compliant. If a rule is noncompliant, this operation 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 evaluaConfigRuleNames (array)
ComplianceTypes (array)
NextToken (string)
config_service/describe_compliance_by_resourceIndicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this operation 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 condiResourceType (string)
ResourceId (string)
ComplianceTypes (array)
Limit (integer)
NextToken (string)
config_service/describe_config_rule_evaluation_statusReturns 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.ConfigRuleNames (array)
NextToken (string)
Limit (integer)
config_service/describe_config_rulesReturns details about your Config rules.ConfigRuleNames (array)
NextToken (string)
Filters: {
. EvaluationMode (string)
} (object)
config_service/describe_configuration_aggregatorsReturns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this operation returns the details for all the configuration aggregators associated with the account.ConfigurationAggregatorNames (array)
NextToken (string)
Limit (integer)
config_service/describe_configuration_aggregator_sources_statusReturns 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.ConfigurationAggregatorName (string) required
UpdateStatus (array)
NextToken (string)
Limit (integer)
config_service/describe_configuration_recordersReturns details for the configuration recorder you specify. If a configuration recorder is not specified, this operation returns details for the customer managed configuration recorder configured for the account, if applicable. When making a request to this operation, you can only specify one configuration recorder.ConfigurationRecorderNames (array)
ServicePrincipal (string)
Arn (string)
config_service/describe_configuration_recorder_statusReturns the current status of the configuration recorder you specify as well as the status of the last recording event for the configuration recorders. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics. If a configuration recorder is not specified, this operation returns the status for the customer managed configuration recorder configured for the account, if applicable. When making a request to this operation, youConfigurationRecorderNames (array)
ServicePrincipal (string)
Arn (string)
config_service/describe_conformance_pack_complianceReturns compliance details for each rule in that conformance pack. You must provide exact rule names.ConformancePackName (string) required
Filters: {
. ConfigRuleNames (array)
. ComplianceType (string)
} (object)
Limit (integer)
NextToken (string)
config_service/describe_conformance_packsReturns a list of one or more conformance packs.ConformancePackNames (array)
Limit (integer)
NextToken (string)
config_service/describe_conformance_pack_statusProvides one or more conformance packs deployment status. If there are no conformance packs then you will see an empty result.ConformancePackNames (array)
Limit (integer)
NextToken (string)
config_service/describe_delivery_channelsReturns details about the specified delivery channel. If a delivery channel is not specified, this operation returns the details of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account.DeliveryChannelNames (array)
config_service/describe_delivery_channel_statusReturns the current status of the specified delivery channel. If a delivery channel is not specified, this operation 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.DeliveryChannelNames (array)
config_service/describe_organization_config_rulesReturns 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 organization If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rulOrganizationConfigRuleNames (array)
Limit (integer)
NextToken (string)
config_service/describe_organization_config_rule_statusesProvides 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.OrganizationConfigRuleNames (array)
Limit (integer)
NextToken (string)
config_service/describe_organization_conformance_packsReturns 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 organization If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy anOrganizationConformancePackNames (array)
Limit (integer)
NextToken (string)
config_service/describe_organization_conformance_pack_statusesProvides 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 packsOrganizationConformancePackNames (array)
Limit (integer)
NextToken (string)
config_service/describe_pending_aggregation_requestsReturns a list of all pending aggregation requests.Limit (integer)
NextToken (string)
config_service/describe_remediation_configurationsReturns the details of one or more remediation configurations.ConfigRuleNames (array) required
config_service/describe_remediation_exceptionsReturns 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. WheConfigRuleName (string) required
ResourceKeys (array)
Limit (integer)
NextToken (string)
config_service/describe_remediation_execution_statusProvides 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.ConfigRuleName (string) required
ResourceKeys (array)
Limit (integer)
NextToken (string)
config_service/describe_retention_configurationsReturns the details of one or more retention configurations. If the retention configuration name is not specified, this operation returns the details for all the retention configurations for that account. Currently, Config supports only one retention configuration per region in your account.RetentionConfigurationNames (array)
NextToken (string)
config_service/disassociate_resource_typesRemoves all resource types specified in the ResourceTypes list from the RecordingGroup of configuration recorder and excludes these resource types when recording. For this operation, the configuration recorder must use a RecordingStrategy that is either INCLUSION_BY_RESOURCE_TYPES or EXCLUSION_BY_RESOURCE_TYPES.ConfigurationRecorderArn (string) required
ResourceTypes (array) required
config_service/get_aggregate_compliance_details_by_config_ruleReturns 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.ConfigurationAggregatorName (string) required
ConfigRuleName (string) required
AccountId (string) required
AwsRegion (string) required
ComplianceType (string)
Limit (integer)
NextToken (string)
config_service/get_aggregate_config_rule_compliance_summaryReturns 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.ConfigurationAggregatorName (string) required
Filters: {
. AccountId (string)
. AwsRegion (string)
} (object)
GroupByKey (string)
Limit (integer)
NextToken (string)
config_service/get_aggregate_conformance_pack_compliance_summaryReturns 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.ConfigurationAggregatorName (string) required
Filters: {
. AccountId (string)
. AwsRegion (string)
} (object)
GroupByKey (string)
Limit (integer)
NextToken (string)
config_service/get_aggregate_discovered_resource_countsReturns 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.ConfigurationAggregatorName (string) required
Filters: {
. ResourceType (string)
. AccountId (string)
. Region (string)
} (object)
GroupByKey (string)
Limit (integer)
NextToken (string)
config_service/get_aggregate_resource_configReturns configuration item that is aggregated for your specific resource in a specific source account and region. The API does not return results for deleted resources.ConfigurationAggregatorName (string) required
ResourceIdentifier: {
. SourceAccountId (string)
. SourceRegion (string)
. ResourceId (string)
. ResourceType (string)
. ResourceName (string)
} (object) required
config_service/get_compliance_details_by_config_ruleReturns 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.ConfigRuleName (string) required
ComplianceTypes (array)
Limit (integer)
NextToken (string)
config_service/get_compliance_details_by_resourceReturns 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 invoked, and whether the resource complies with each rule.ResourceType (string)
ResourceId (string)
ComplianceTypes (array)
NextToken (string)
ResourceEvaluationId (string)
config_service/get_compliance_summary_by_config_ruleReturns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.No parameters
config_service/get_compliance_summary_by_resource_typeReturns 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.ResourceTypes (array)
config_service/get_conformance_pack_compliance_detailsReturns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.ConformancePackName (string) required
Filters: {
. ConfigRuleNames (array)
. ComplianceType (string)
. ResourceType (string)
. ResourceIds (array)
} (object)
Limit (integer)
NextToken (string)
config_service/get_conformance_pack_compliance_summaryReturns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.ConformancePackNames (array) required
Limit (integer)
NextToken (string)
config_service/get_custom_rule_policyReturns the policy definition containing the logic for your Config Custom Policy rule.ConfigRuleName (string)
config_service/get_discovered_resource_countsReturns 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, anresourceTypes (array)
limit (integer)
nextToken (string)
config_service/get_organization_config_rule_detailed_statusReturns detailed status for each member account within an organization for a given organization Config rule.OrganizationConfigRuleName (string) required
Filters: {
. AccountId (string)
. MemberAccountRuleStatus (string)
} (object)
Limit (integer)
NextToken (string)
config_service/get_organization_conformance_pack_detailed_statusReturns detailed status for each member account within an organization for a given organization conformance pack.OrganizationConformancePackName (string) required
Filters: {
. AccountId (string)
. Status (string)
} (object)
Limit (integer)
NextToken (string)
config_service/get_organization_custom_rule_policyReturns the policy definition containing the logic for your organization Config Custom Policy rule.OrganizationConfigRuleName (string) required
config_service/get_resource_config_historyFor accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type. For more information, see Recording Amazon Web Services Resources in the Config Resources Developer Guide. Returns a list of configurations items CIs for the specified resource. Contents The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your CIs between a minimum of 30 days and a maximum of 7resourceType (string) required
resourceId (string) required
laterTime (string)
earlierTime (string)
chronologicalOrder (string)
limit (integer)
nextToken (string)
config_service/get_resource_evaluation_summaryReturns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules. To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the GetComplianceDetaResourceEvaluationId (string) required
config_service/get_stored_queryReturns the details of a specific stored query.QueryName (string) required
config_service/list_aggregate_discovered_resourcesAccepts 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-ConfigurationAggregatorName (string) required
ResourceType (string) required
Filters: {
. AccountId (string)
. ResourceId (string)
. ResourceName (string)
. Region (string)
} (object)
Limit (integer)
NextToken (string)
config_service/list_configuration_recordersReturns a list of configuration recorders depending on the filters you specify.Filters (array)
MaxResults (integer)
NextToken (string)
config_service/list_conformance_pack_compliance_scoresReturns 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. You can use it to identify, investigate, and understand the level of compliance in your conformance packs. Conformance packs with no evaluatiFilters: {
. ConformancePackNames (array)
} (object)
SortOrder (string)
SortBy (string)
Limit (integer)
NextToken (string)
config_service/list_discovered_resourcesReturns a list of resource resource identifiers for the specified resource types 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 bothresourceType (string) required
resourceIds (array)
resourceName (string)
limit (integer)
includeDeletedResources (boolean)
nextToken (string)
config_service/list_resource_evaluationsReturns a list of proactive resource evaluations.Filters: {
. EvaluationMode (string)
. TimeWindow (object)
. EvaluationContextIdentifier (string)
} (object)
Limit (integer)
NextToken (string)
config_service/list_stored_queriesLists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.NextToken (string)
MaxResults (integer)
config_service/list_tags_for_resourceList the tags for Config resource.ResourceArn (string) required
Limit (integer)
NextToken (string)
config_service/put_aggregation_authorizationAuthorizes the aggregator account and region to collect data from the source account and region. Tags are added at creation and cannot be updated with this operation PutAggregationAuthorization is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, Config 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 difAuthorizedAccountId (string) required
AuthorizedAwsRegion (string) required
Tags (array)
config_service/put_config_ruleAdds 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 Managed Rules and Config Custom Rules. You can use PutConfigRule to create both Config Managed Rules and Config Custom Rules. Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rConfigRule: {
. ConfigRuleName (string)
. ConfigRuleArn (string)
. ConfigRuleId (string)
. Description (string)
. Scope (object)
. Source (object)
. InputParameters (string)
. MaximumExecutionFrequency (string)
. ConfigRuleState (string)
. CreatedBy (string)
. EvaluationModes (array)
} (object) required
Tags (array)
config_service/put_configuration_aggregatorCreates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual accounts 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 organizationConfigurationAggregatorName (string) required
AccountAggregationSources (array)
OrganizationAggregationSource: {
. RoleArn (string)
. AwsRegions (array)
. AllAwsRegions (boolean)
} (object)
Tags (array)
AggregatorFilters: {
. ResourceType (object)
. ServicePrincipal (object)
} (object)
config_service/put_configuration_recorderCreates or updates the customer managed configuration recorder. You can use this operation to create a new customer managed configuration recorder or to update the roleARN and the recordingGroup for an existing customer managed configuration recorder. To start the customer managed configuration recorder and begin recording configuration changes for the resource types you specify, use the StartConfigurationRecorder operation. For more information, see Working with the Configuration Recorder in thConfigurationRecorder: {
. arn (string)
. name (string)
. roleARN (string)
. recordingGroup (object)
. recordingMode (object)
. recordingScope (string)
. servicePrincipal (string)
} (object) required
Tags (array)
config_service/put_conformance_packCreates 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 an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide. When you use PutConformancePack to deploy conformance packs in your account, the operation can create Config rules and remediation actions without requiring config:PutConfigRule or config:PutRemediationConConformancePackName (string) required
TemplateS3Uri (string)
TemplateBody (string)
DeliveryS3Bucket (string)
DeliveryS3KeyPrefix (string)
ConformancePackInputParameters (array)
TemplateSSMDocumentDetails: {
. DocumentName (string)
. DocumentVersion (string)
} (object)
Tags (array)
config_service/put_delivery_channelCreates or updates a delivery channel to deliver configuration information and other compliance information. You can use this operation to create a new delivery channel or to update the Amazon S3 bucket and the Amazon SNS topic of an existing delivery channel. For more information, see Working with the Delivery Channel in the Config Developer Guide. One delivery channel per account per Region You can have only one delivery channel for each account for each Amazon Web Services Region.DeliveryChannel: {
. name (string)
. s3BucketName (string)
. s3KeyPrefix (string)
. s3KmsKeyArn (string)
. snsTopicARN (string)
. configSnapshotDeliveryProperties (object)
} (object) required
config_service/put_evaluationsUsed by an Lambda function to deliver evaluation results to Config. This operation is required in every Lambda function that is invoked by an Config rule.Evaluations (array)
ResultToken (string) required
TestMode (boolean)
config_service/put_external_evaluationAdd 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.ConfigRuleName (string) required
ExternalEvaluation: {
. ComplianceResourceType (string)
. ComplianceResourceId (string)
. ComplianceType (string)
. Annotation (string)
. OrderingTimestamp (string)
} (object) required
config_service/put_organization_config_ruleAdds 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 management 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 peOrganizationConfigRuleName (string) required
OrganizationManagedRuleMetadata: {
. Description (string)
. RuleIdentifier (string)
. InputParameters (string)
. MaximumExecutionFrequency (string)
. ResourceTypesScope (array)
. ResourceIdScope (string)
. TagKeyScope (string)
. TagValueScope (string)
} (object)
OrganizationCustomRuleMetadata: {
. Description (string)
. LambdaFunctionArn (string)
. OrganizationConfigRuleTriggerTypes (array)
. InputParameters (string)
. MaximumExecutionFrequency (string)
. ResourceTypesScope (array)
. ResourceIdScope (string)
. TagKeyScope (string)
. TagValueScope (string)
} (object)
ExcludedAccounts (array)
OrganizationCustomPolicyRuleMetadata: {
. Description (string)
. OrganizationConfigRuleTriggerTypes (array)
. InputParameters (string)
. MaximumExecutionFrequency (string)
. ResourceTypesScope (array)
. ResourceIdScope (string)
. TagKeyScope (string)
. TagValueScope (string)
. PolicyRuntime (string)
. PolicyText (string)
. DebugLogDeliveryAccounts (array)
} (object)
config_service/put_organization_conformance_packDeploys 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 management 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 delegateOrganizationConformancePackName (string) required
TemplateS3Uri (string)
TemplateBody (string)
DeliveryS3Bucket (string)
DeliveryS3KeyPrefix (string)
ConformancePackInputParameters (array)
ExcludedAccounts (array)
config_service/put_remediation_configurationsAdds 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. Be aware of backward incompatible changes If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can ruRemediationConfigurations (array) required
config_service/put_remediation_exceptionsA remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule. Exceptions block auto remediation Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared. Manual remediation is recommended when placing an exConfigRuleName (string) required
ResourceKeys (array) required
Message (string)
ExpirationTime (string)
config_service/put_resource_configRecords 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 configuResourceType (string) required
SchemaVersionId (string) required
ResourceId (string) required
ResourceName (string)
Configuration (string) required
Tags (object)
config_service/put_retention_configurationCreates 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.RetentionPeriodInDays (integer) required
config_service/put_service_linked_configuration_recorderCreates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the ServicePrincipal you specify. The configuration recorder's name, recordingGroup, recordingMode, and recordingScope is set by the service that is linked to the configuration recorder. For more information and a list of supported services/service principals, see Working with the Configuration Recorder in the Config Developer Guide. This API creates a service-linked role AWSServiceRServicePrincipal (string) required
Tags (array)
config_service/put_stored_querySaves 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. Tags are added at creation and cannot be updated PutStoredQuery is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different tags values, ConfStoredQuery: {
. QueryId (string)
. QueryArn (string)
. QueryName (string)
. Description (string)
. Expression (string)
} (object) required
Tags (array)
config_service/select_aggregate_resource_configAccepts 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,Expression (string) required
ConfigurationAggregatorName (string) required
Limit (integer)
MaxResults (integer)
NextToken (string)
config_service/select_resource_configAccepts 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.Expression (string) required
Limit (integer)
NextToken (string)
config_service/start_config_rules_evaluationRuns 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 speciConfigRuleNames (array)
config_service/start_configuration_recorderStarts the customer managed configuration recorder. The customer managed configuration recorder will begin recording configuration changes for the resource types you specify. You must have created a delivery channel to successfully start the customer managed configuration recorder. You can use the PutDeliveryChannel operation to create a delivery channel.ConfigurationRecorderName (string) required
config_service/start_remediation_executionRuns 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.ConfigRuleName (string) required
ResourceKeys (array) required
config_service/start_resource_evaluationRuns an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type. Ensure you have the cloudformation:DescribeType role setup to validate the resource type schema. You can findResourceDetails: {
. ResourceId (string)
. ResourceType (string)
. ResourceConfiguration (string)
. ResourceConfigurationSchemaType (string)
} (object) required
EvaluationContext: {
. EvaluationContextIdentifier (string)
} (object)
EvaluationMode (string) required
EvaluationTimeout (integer)
ClientToken (string)
config_service/stop_configuration_recorderStops the customer managed configuration recorder. The customer managed configuration recorder will stop recording configuration changes for the resource types you have specified.ConfigurationRecorderName (string) required
config_service/tag_resourceAssociates 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. If existing tags are specified, however, then their values will be updated. When a resource is deleted, the tags associated with that resource are deleted as well.ResourceArn (string) required
Tags (array) required
config_service/untag_resourceDeletes specified tags from a resource.ResourceArn (string) required
TagKeys (array) required
connect_contact_lens/list_realtime_contact_analysis_segmentsProvides a list of analysis segments for a real-time analysis session.InstanceId (string) required
ContactId (string) required
MaxResults (integer)
NextToken (string)
connect/activate_evaluation_formActivates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form.InstanceId (string) required
EvaluationFormId (string) required
EvaluationFormVersion (integer) required
connect/associate_analytics_data_setAssociates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.InstanceId (string) required
DataSetId (string) required
TargetAccountId (string)
connect/associate_approved_originThis API is in preview release for Amazon Connect and is subject to change. Associates an approved origin to an Amazon Connect instance.InstanceId (string) required
Origin (string) required
ClientToken (string)
connect/associate_botThis 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.InstanceId (string) required
LexBot: {
. Name (string)
. LexRegion (string)
} (object)
LexV2Bot: {
. AliasArn (string)
} (object)
ClientToken (string)
connect/associate_contact_with_userAssociates a queued contact with an agent. Use cases Following are common uses cases for this API: Programmatically assign queued contacts to available users. Leverage the IAM context key connect:PreferredUserArn to restrict contact association to specific preferred user. Important things to know Use this API with chat, email, and task contacts. It does not support voice contacts. Use it to associate contacts with users regardless of their current state, including custom states. Ensure your applInstanceId (string) required
ContactId (string) required
UserId (string) required
connect/associate_default_vocabularyAssociates 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.InstanceId (string) required
LanguageCode (string) required
VocabularyId (string)
connect/associate_email_address_aliasAssociates an email address alias with an existing email address in an Amazon Connect instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address. Use cases Following are common uses cases for this API: Unified customer support: Create multiple entry points for example, support@example.com, help@example.com, customercare@example.com that all forward to a single agent queue for streamlined management. DeparEmailAddressId (string) required
InstanceId (string) required
AliasConfiguration: {
. EmailAddressId (string)
} (object) required
ClientToken (string)
connect/associate_flowAssociates a connect resource to a flow.InstanceId (string) required
ResourceId (string) required
FlowId (string) required
ResourceType (string) required
connect/associate_hours_of_operationsAssociates a set of hours of operations with another hours of operation. Refer to Administrator Guide here for more information on inheriting overrides from parent hours of operations.InstanceId (string) required
HoursOfOperationId (string) required
ParentHoursOfOperationConfigs (array) required
connect/associate_instance_storage_configThis 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 bucInstanceId (string) required
ResourceType (string) required
StorageConfig: {
. AssociationId (string)
. StorageType (string)
. S3Config (object)
. KinesisVideoStreamConfig (object)
. KinesisStreamConfig (object)
. KinesisFirehoseConfig (object)
} (object) required
ClientToken (string)
connect/associate_lambda_functionThis 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.InstanceId (string) required
FunctionArn (string) required
ClientToken (string)
connect/associate_lex_botThis 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 V1 bot. This API only supports the association of Amazon Lex V1 bots.InstanceId (string) required
LexBot: {
. Name (string)
. LexRegion (string)
} (object) required
ClientToken (string)
connect/associate_phone_number_contact_flowAssociates a flow with a phone number claimed to your Amazon Connect instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternatePhoneNumberId (string) required
InstanceId (string) required
ContactFlowId (string) required
connect/associate_queue_quick_connectsAssociates a set of quick connects with a queue.InstanceId (string) required
QueueId (string) required
QuickConnectIds (array) required
connect/associate_routing_profile_queuesAssociates a set of queues with a routing profile.InstanceId (string) required
RoutingProfileId (string) required
QueueConfigs (array)
ManualAssignmentQueueConfigs (array)
connect/associate_security_keyThis API is in preview release for Amazon Connect and is subject to change. Associates a security key to the instance.InstanceId (string) required
Key (string) required
ClientToken (string)
connect/associate_security_profilesAssociate security profiles with an Entity in an Amazon Connect instance.InstanceId (string) required
SecurityProfiles (array) required
EntityType (string) required
EntityArn (string) required
connect/associate_traffic_distribution_group_userAssociates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.TrafficDistributionGroupId (string) required
UserId (string) required
InstanceId (string) required
connect/associate_user_proficienciesAssociates a set of proficiencies with a user.InstanceId (string) required
UserId (string) required
UserProficiencies (array) required
connect/associate_workspaceAssociates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.InstanceId (string) required
WorkspaceId (string) required
ResourceArns (array) required
connect/batch_associate_analytics_data_setAssociates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.InstanceId (string) required
DataSetIds (array) required
TargetAccountId (string)
connect/batch_create_data_table_valueCreates values for attributes in a data table. The value may be a default or it may be associated with a primary value. The value must pass all customer defined validation as well as the default validation for the value type. The operation must conform to Batch Operation API Standards. Although the standard specifies that successful and failed entities are listed separately in the response, authorization fails if any primary values or attributes are unauthorized. The combination of primary valueInstanceId (string) required
DataTableId (string) required
Values (array) required
connect/batch_delete_data_table_valueDeletes multiple values from a data table. API users may delete values at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the attribute and its values were accessed. System managed values are not deletable by customers.InstanceId (string) required
DataTableId (string) required
Values (array) required
connect/batch_describe_data_table_valueRetrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and modification timestamps. 'Describe' is a deprecated term but is allowed to maintain consistency with existing operations.InstanceId (string) required
DataTableId (string) required
Values (array) required
connect/batch_disassociate_analytics_data_setRemoves a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.InstanceId (string) required
DataSetIds (array) required
TargetAccountId (string)
connect/batch_get_attached_file_metadataAllows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.FileIds (array) required
InstanceId (string) required
AssociatedResourceArn (string) required
connect/batch_get_flow_associationRetrieve the flow associations for the given resources.InstanceId (string) required
ResourceIds (array) required
ResourceType (string)
connect/batch_put_contactOnly the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API. Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId thClientToken (string)
InstanceId (string) required
ContactDataRequestList (array) required
connect/batch_update_data_table_valueUpdates multiple data table values using all properties from BatchCreateDataTableValue. System managed values are not modifiable by customers. The operation requires proper lock versions to prevent concurrent modification conflicts.InstanceId (string) required
DataTableId (string) required
Values (array) required
connect/claim_phone_numberClaims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide. You can call the SearchAvailablePhoneNumbers API for available phoneTargetArn (string)
InstanceId (string)
PhoneNumber (string) required
PhoneNumberDescription (string)
Tags (object)
ClientToken (string)
connect/complete_attached_file_uploadAllows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.InstanceId (string) required
FileId (string) required
AssociatedResourceArn (string) required
connect/create_agent_statusCreates an agent status for the specified Amazon Connect instance.InstanceId (string) required
Name (string) required
Description (string)
State (string) required
DisplayOrder (integer)
Tags (object)
connect/create_contactOnly the VOICE, EMAIL, and TASK channels are supported. For VOICE: The supported initiation method is TRANSFER. The contacts created with this initiation method have a subtype connect:ExternalAudio. For EMAIL: The supported initiation methods are OUTBOUND, AGENT_REPLY, and FLOW. For TASK: The supported initiation method is API. Contacts created with this API have a sub-type of connect:ExternalTask. Creates a new VOICE, EMAIL, or TASK contact. After a contact is created, you can move it to the deInstanceId (string) required
ClientToken (string)
RelatedContactId (string)
Attributes (object)
References (object)
Channel (string) required
InitiationMethod (string) required
ExpiryDurationInMinutes (integer)
UserInfo: {
. UserId (string)
} (object)
InitiateAs (string)
Name (string)
Description (string)
SegmentAttributes (object)
PreviousContactId (string)
connect/create_contact_flowCreates a flow for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language.InstanceId (string) required
Name (string) required
Type (string) required
Description (string)
Content (string) required
Status (string)
Tags (object)
connect/create_contact_flow_moduleCreates a flow module for the specified Amazon Connect instance.InstanceId (string) required
Name (string) required
Description (string)
Content (string) required
Tags (object)
ClientToken (string)
Settings (string)
ExternalInvocationConfiguration: {
. Enabled (boolean)
} (object)
connect/create_contact_flow_module_aliasCreates a named alias that points to a specific version of a contact flow module.InstanceId (string) required
Description (string)
ContactFlowModuleId (string) required
ContactFlowModuleVersion (integer) required
AliasName (string) required
connect/create_contact_flow_module_versionCreates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities.InstanceId (string) required
Description (string)
ContactFlowModuleId (string) required
FlowModuleContentSha256 (string)
connect/create_contact_flow_versionPublishes a new version of the flow provided. Versions are immutable and monotonically increasing. If the FlowContentSha256 provided is different from the FlowContentSha256 of the $LATEST published flow content, then an error is returned. This API only supports creating versions for flows of type Campaign.InstanceId (string) required
Description (string)
ContactFlowId (string) required
FlowContentSha256 (string)
ContactFlowVersion (integer)
LastModifiedTime (string)
LastModifiedRegion (string)
connect/create_data_tableCreates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables per instance is limited to 100 per instance. Customers can request an increase by using Amazon Web Services Service Quotas.InstanceId (string) required
Name (string) required
Description (string)
TimeZone (string) required
ValueLockLevel (string) required
Status (string) required
Tags (object)
connect/create_data_table_attributeAdds an attribute to an existing data table. Creating a new primary attribute uses the empty value for the specified value type for all existing records. This should not affect uniqueness of published data tables since the existing primary values will already be unique. Creating attributes does not create any values. System managed tables may not allow customers to create new attributes.InstanceId (string) required
DataTableId (string) required
Name (string) required
ValueType (string) required
Description (string)
Primary (boolean)
Validation: {
. MinLength (integer)
. MaxLength (integer)
. MinValues (integer)
. MaxValues (integer)
. IgnoreCase (boolean)
. Minimum (number)
. Maximum (number)
. ExclusiveMinimum (number)
. ExclusiveMaximum (number)
. MultipleOf (number)
. Enum (object)
} (object)
connect/create_email_addressCreate new email address in the specified Amazon Connect instance. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.Description (string)
InstanceId (string) required
EmailAddress (string) required
DisplayName (string)
Tags (object)
ClientToken (string)
connect/create_evaluation_formCreates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.InstanceId (string) required
Title (string) required
Description (string)
Items (array) required
ScoringStrategy: {
. Mode (string)
. Status (string)
} (object)
AutoEvaluationConfiguration: {
. Enabled (boolean)
} (object)
ClientToken (string)
AsDraft (boolean)
Tags (object)
ReviewConfiguration: {
. ReviewNotificationRecipients (array)
. EligibilityDays (integer)
} (object)
TargetConfiguration: {
. ContactInteractionType (string)
} (object)
LanguageConfiguration: {
. FormLanguage (string)
} (object)
connect/create_hours_of_operationCreates hours of operation.InstanceId (string) required
Name (string) required
Description (string)
TimeZone (string) required
Config (array) required
ParentHoursOfOperationConfigs (array)
Tags (object)
connect/create_hours_of_operation_overrideCreates an hours of operation override in an Amazon Connect hours of operation resource.InstanceId (string) required
HoursOfOperationId (string) required
Name (string) required
Description (string)
Config (array) required
EffectiveFrom (string) required
EffectiveTill (string) required
RecurrenceConfig: {
. RecurrencePattern (object)
} (object)
OverrideType (string)
connect/create_instanceThis 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. For more information, see Create an Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the totalClientToken (string)
IdentityManagementType (string) required
InstanceAlias (string)
DirectoryId (string)
InboundCallsEnabled (boolean) required
OutboundCallsEnabled (boolean) required
Tags (object)
connect/create_integration_associationCreates an Amazon Web Services resource association with an Amazon Connect instance.InstanceId (string) required
IntegrationType (string) required
IntegrationArn (string) required
SourceApplicationUrl (string)
SourceApplicationName (string)
SourceType (string)
Tags (object)
connect/create_notificationCreates a new notification to be delivered to specified recipients. Notifications can include localized content with embedded links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.InstanceId (string) required
ExpiresAt (string)
Recipients (array) required
Priority (string)
Content (object) required
Tags (object)
PredefinedNotificationId (string)
ClientToken (string)
connect/create_participantAdds a new participant into an on-going chat contact or webRTC call. For more information, see Customize chat flow experiences by integrating custom participants or Enable multi-user web, in-app, and video calling.InstanceId (string) required
ContactId (string) required
ClientToken (string)
ParticipantDetails: {
. ParticipantRole (string)
. DisplayName (string)
. ParticipantCapabilities (object)
} (object) required
connect/create_persistent_contact_associationEnables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.InstanceId (string) required
InitialContactId (string) required
RehydrationType (string) required
SourceContactId (string) required
ClientToken (string)
connect/create_predefined_attributeCreates a new predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. For the predefined attributes per instance quota, see Amazon Connect quotas. Use cases Following are common uses cases for this API: Create an attribute for routing proficiency for example, agent certification that has predefined values for example, a list of possible certifications. For more information, see Create predefined attributes for routing contacts to aInstanceId (string) required
Name (string) required
Values (undefined)
Purposes (array)
AttributeConfiguration: {
. EnableValueValidationOnAssociation (boolean)
} (object)
connect/create_promptCreates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.InstanceId (string) required
Name (string) required
Description (string)
S3Uri (string) required
Tags (object)
connect/create_push_notification_registrationCreates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Amazon Connect for mobile chat in the Amazon Connect Administrator Guide.InstanceId (string) required
ClientToken (string)
PinpointAppArn (string) required
DeviceToken (string) required
DeviceType (string) required
ContactConfiguration: {
. ContactId (string)
. ParticipantRole (string)
. IncludeRawMessage (boolean)
} (object) required
connect/create_queueCreates a new queue for the specified Amazon Connect instance. If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associaInstanceId (string) required
Name (string) required
Description (string)
OutboundCallerConfig: {
. OutboundCallerIdName (string)
. OutboundCallerIdNumberId (string)
. OutboundFlowId (string)
} (object)
OutboundEmailConfig: {
. OutboundEmailAddressId (string)
} (object)
HoursOfOperationId (string) required
MaxContacts (integer)
QuickConnectIds (array)
Tags (object)
connect/create_quick_connectCreates a quick connect for the specified Amazon Connect instance.InstanceId (string) required
Name (string) required
Description (string)
QuickConnectConfig: {
. QuickConnectType (string)
. UserConfig (object)
. QueueConfig (object)
. PhoneConfig (object)
. FlowConfig (object)
} (object) required
Tags (object)
connect/create_routing_profileCreates a new routing profile.InstanceId (string) required
Name (string) required
Description (string) required
DefaultOutboundQueueId (string) required
QueueConfigs (array)
ManualAssignmentQueueConfigs (array)
MediaConcurrencies (array) required
Tags (object)
AgentAvailabilityTimer (string)
connect/create_ruleCreates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule.InstanceId (string) required
Name (string) required
TriggerEventSource: {
. EventSourceName (string)
. IntegrationAssociationId (string)
} (object) required
Function (string) required
Actions (array) required
PublishStatus (string) required
ClientToken (string)
connect/create_security_profileCreates a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.SecurityProfileName (string) required
Description (string)
Permissions (array)
InstanceId (string) required
Tags (object)
AllowedAccessControlTags (object)
TagRestrictedResources (array)
Applications (array)
HierarchyRestrictedResources (array)
AllowedAccessControlHierarchyGroupId (string)
AllowedFlowModules (array)
GranularAccessControlConfiguration: {
. DataTableAccessControlConfiguration (object)
} (object)
connect/create_task_templateCreates a new task template in the specified Amazon Connect instance.InstanceId (string) required
Name (string) required
Description (string)
ContactFlowId (string)
SelfAssignFlowId (string)
Constraints: {
. RequiredFields (array)
. ReadOnlyFields (array)
. InvisibleFields (array)
} (object)
Defaults: {
. DefaultFieldValues (array)
} (object)
Status (string)
Fields (array) required
ClientToken (string)
connect/create_test_caseCreates a test case with its content and metadata for the specified Amazon Connect instance.InstanceId (string) required
Name (string) required
Description (string)
Content (string) required
EntryPoint: {
. Type (string)
. VoiceCallEntryPointParameters (object)
} (object)
InitializationData (string)
Status (string)
TestCaseId (string)
Tags (object)
LastModifiedTime (string)
LastModifiedRegion (string)
connect/create_traffic_distribution_groupCreates a traffic distribution group given an Amazon Connect instance that has been replicated. The SignInConfig distribution is available only on a default TrafficDistributionGroup see the IsDefault parameter in the TrafficDistributionGroup data type. If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned. For more information about creating traffic distribution groups, see Set up traffic distributionName (string) required
Description (string)
InstanceId (string) required
ClientToken (string)
Tags (object)
connect/create_use_caseCreates a use case for an integration association.InstanceId (string) required
IntegrationAssociationId (string) required
UseCaseType (string) required
Tags (object)
connect/create_userCreates a user account for the specified Amazon Connect instance. Certain UserIdentityInfo parameters are required in some situations. For example, Email, FirstName and LastName are required if you are using Amazon Connect or SAML for identity management. Fields in PhoneConfig cannot be set simultaneously with their corresponding channel-specific configuration parameters. Specifically: PhoneConfig.AutoAccept conflicts with AutoAcceptConfigs PhoneConfig.AfterContactWorkTimeLimit conflicts with AfUsername (string) required
Password (string)
IdentityInfo: {
. FirstName (string)
. LastName (string)
. Email (string)
. SecondaryEmail (string)
. Mobile (string)
} (object)
PhoneConfig: {
. PhoneType (string)
. AutoAccept (boolean)
. AfterContactWorkTimeLimit (integer)
. DeskPhoneNumber (string)
. PersistentConnection (boolean)
} (object)
DirectoryUserId (string)
SecurityProfileIds (array) required
RoutingProfileId (string) required
HierarchyGroupId (string)
InstanceId (string) required
AutoAcceptConfigs (array)
AfterContactWorkConfigs (array)
PhoneNumberConfigs (array)
PersistentConnectionConfigs (array)
VoiceEnhancementConfigs (array)
Tags (object)
connect/create_user_hierarchy_groupCreates a new user hierarchy group.Name (string) required
ParentGroupId (string)
InstanceId (string) required
Tags (object)
connect/create_viewCreates a new view with the possible status of SAVED or PUBLISHED. The views will have a unique name for each connect instance. It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.InstanceId (string) required
ClientToken (string)
Status (string) required
Content: {
. Template (string)
. Actions (array)
} (object) required
Description (string)
Name (string) required
Tags (object)
connect/create_view_versionPublishes a new version of the view identifier. Versions are immutable and monotonically increasing. It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.InstanceId (string) required
ViewId (string) required
VersionDescription (string)
ViewContentSha256 (string)
connect/create_vocabularyCreates 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.ClientToken (string)
InstanceId (string) required
VocabularyName (string) required
LanguageCode (string) required
Content (string) required
Tags (object)
connect/create_workspaceCreates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.InstanceId (string) required
Name (string) required
Description (string)
Theme: {
. Light (object)
. Dark (object)
} (object)
Title (string)
Tags (object)
connect/create_workspace_pageAssociates a view with a page in a workspace, defining what users see when they navigate to that page.InstanceId (string) required
WorkspaceId (string) required
ResourceArn (string) required
Page (string) required
Slug (string)
InputData (string)
connect/deactivate_evaluation_formDeactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.InstanceId (string) required
EvaluationFormId (string) required
EvaluationFormVersion (integer) required
connect/delete_attached_fileDeletes an attached file along with the underlying S3 Object. The attached file is permanently deleted if S3 bucket versioning is not enabled.InstanceId (string) required
FileId (string) required
AssociatedResourceArn (string) required
connect/delete_contact_evaluationDeletes a contact evaluation in the specified Amazon Connect instance.InstanceId (string) required
EvaluationId (string) required
connect/delete_contact_flowDeletes a flow for the specified Amazon Connect instance.InstanceId (string) required
ContactFlowId (string) required
connect/delete_contact_flow_moduleDeletes the specified flow module.InstanceId (string) required
ContactFlowModuleId (string) required
connect/delete_contact_flow_module_aliasRemoves an alias reference, breaking the named connection to the underlying module version without affecting the version itself.InstanceId (string) required
ContactFlowModuleId (string) required
AliasId (string) required
connect/delete_contact_flow_module_versionRemoves a specific version of a contact flow module.InstanceId (string) required
ContactFlowModuleId (string) required
ContactFlowModuleVersion (integer) required
connect/delete_contact_flow_versionDeletes the particular version specified in flow version identifier.InstanceId (string) required
ContactFlowId (string) required
ContactFlowVersion (integer) required
connect/delete_data_tableDeletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed.InstanceId (string) required
DataTableId (string) required
connect/delete_data_table_attributeDeletes an attribute and all its values from a data table.InstanceId (string) required
DataTableId (string) required
AttributeName (string) required
connect/delete_email_addressDeletes email address from the specified Amazon Connect instance.InstanceId (string) required
EmailAddressId (string) required
connect/delete_evaluation_formDeletes an evaluation form in the specified Amazon Connect instance. If the version property is provided, only the specified version of the evaluation form is deleted. If no version is provided, then the full form all versions is deleted.InstanceId (string) required
EvaluationFormId (string) required
EvaluationFormVersion (integer)
connect/delete_hours_of_operationDeletes an hours of operation.InstanceId (string) required
HoursOfOperationId (string) required
connect/delete_hours_of_operation_overrideDeletes an hours of operation override in an Amazon Connect hours of operation resource.InstanceId (string) required
HoursOfOperationId (string) required
HoursOfOperationOverrideId (string) required
connect/delete_instanceThis API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide. 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 befoInstanceId (string) required
ClientToken (string)
connect/delete_integration_associationDeletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.InstanceId (string) required
IntegrationAssociationId (string) required
connect/delete_notificationDeletes a notification. Once deleted, the notification is no longer visible to all users and cannot be managed through the Admin Website or APIs.InstanceId (string) required
NotificationId (string) required
connect/delete_predefined_attributeDeletes a predefined attribute from the specified Amazon Connect instance.InstanceId (string) required
Name (string) required
connect/delete_promptDeletes a prompt.InstanceId (string) required
PromptId (string) required
connect/delete_push_notification_registrationDeletes registration for a device token and a chat contact.InstanceId (string) required
RegistrationId (string) required
ContactId (string) required
connect/delete_queueDeletes a queue.InstanceId (string) required
QueueId (string) required
connect/delete_quick_connectDeletes a quick connect. After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas. Remove deleted users so they don't appear to agents as transfer options. Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.InstanceId (string) required
QuickConnectId (string) required
connect/delete_routing_profileDeletes a routing profile.InstanceId (string) required
RoutingProfileId (string) required
connect/delete_ruleDeletes a rule for the specified Amazon Connect instance.InstanceId (string) required
RuleId (string) required
connect/delete_security_profileDeletes a security profile.InstanceId (string) required
SecurityProfileId (string) required
connect/delete_task_templateDeletes the task template.InstanceId (string) required
TaskTemplateId (string) required
connect/delete_test_caseDeletes the test case that has already been created for the specified Amazon Connect instance.InstanceId (string) required
TestCaseId (string) required
connect/delete_traffic_distribution_groupDeletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.TrafficDistributionGroupId (string) required
connect/delete_use_caseDeletes a use case from an integration association.InstanceId (string) required
IntegrationAssociationId (string) required
UseCaseId (string) required
connect/delete_userDeletes 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. After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas. Remove deleted users so they don't appear to agents as transfer options. AvoInstanceId (string) required
UserId (string) required
connect/delete_user_hierarchy_groupDeletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.HierarchyGroupId (string) required
InstanceId (string) required
connect/delete_viewDeletes the view entirely. It deletes the view and all associated qualifiers versions and aliases.InstanceId (string) required
ViewId (string) required
connect/delete_view_versionDeletes the particular version specified in ViewVersion identifier.InstanceId (string) required
ViewId (string) required
ViewVersion (integer) required
connect/delete_vocabularyDeletes the vocabulary that has the given identifier.InstanceId (string) required
VocabularyId (string) required
connect/delete_workspaceDeletes a workspace and removes all associated view and resource assignments.InstanceId (string) required
WorkspaceId (string) required
connect/delete_workspace_mediaDeletes a media asset such as a logo from a workspace.InstanceId (string) required
WorkspaceId (string) required
MediaType (string) required
connect/delete_workspace_pageRemoves the association between a view and a page in a workspace. The page will display the default view after deletion.InstanceId (string) required
WorkspaceId (string) required
Page (string) required
connect/describe_agent_statusDescribes an agent status.InstanceId (string) required
AgentStatusId (string) required
connect/describe_authentication_profileThis API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Describes the target authentication profile.AuthenticationProfileId (string) required
InstanceId (string) required
connect/describe_contactThis API is in preview release for Amazon Connect and is subject to change. Describes the specified contact. Use cases Following are common uses cases for this API: Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions. Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detecInstanceId (string) required
ContactId (string) required
connect/describe_contact_evaluationDescribes a contact evaluation in the specified Amazon Connect instance.InstanceId (string) required
EvaluationId (string) required
connect/describe_contact_flowDescribes the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/id:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published. Use arn:aws:.../contact-flow/id:version to retrieve the content of a specific flow version. In the response, Status indicates the flow status as either SAVED orInstanceId (string) required
ContactFlowId (string) required
connect/describe_contact_flow_moduleDescribes the specified flow module. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/id:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.InstanceId (string) required
ContactFlowModuleId (string) required
connect/describe_contact_flow_module_aliasRetrieves detailed information about a specific alias, including which version it currently points to and its metadata.InstanceId (string) required
ContactFlowModuleId (string) required
AliasId (string) required
connect/describe_data_tableReturns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. 'Describe' is a deprecated term but is allowed to maintain consistency with existing operations.InstanceId (string) required
DataTableId (string) required
connect/describe_data_table_attributeReturns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. 'Describe' is a deprecated term but is allowed to maintain consistency with existing operations.InstanceId (string) required
DataTableId (string) required
AttributeName (string) required
connect/describe_email_addressDescribe email address form the specified Amazon Connect instance.InstanceId (string) required
EmailAddressId (string) required
connect/describe_evaluation_formDescribes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.InstanceId (string) required
EvaluationFormId (string) required
EvaluationFormVersion (integer)
connect/describe_hours_of_operationDescribes the hours of operation.InstanceId (string) required
HoursOfOperationId (string) required
connect/describe_hours_of_operation_overrideDescribes the hours of operation override.InstanceId (string) required
HoursOfOperationId (string) required
HoursOfOperationOverrideId (string) required
connect/describe_instanceThis 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.InstanceId (string) required
connect/describe_instance_attributeThis API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute.InstanceId (string) required
AttributeType (string) required
connect/describe_instance_storage_configThis 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.InstanceId (string) required
AssociationId (string) required
ResourceType (string) required
connect/describe_notificationRetrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.InstanceId (string) required
NotificationId (string) required
connect/describe_phone_numberGets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group. If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon WePhoneNumberId (string) required
connect/describe_predefined_attributeDescribes a predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for: Routing proficiency for example, agent certification that has predefined values for example, a list of possible certifications. For more information, see Create predefined attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such as the name of the business unit handlingInstanceId (string) required
Name (string) required
connect/describe_promptDescribes the prompt.InstanceId (string) required
PromptId (string) required
connect/describe_queueDescribes the specified queue.InstanceId (string) required
QueueId (string) required
connect/describe_quick_connectDescribes the quick connect.InstanceId (string) required
QuickConnectId (string) required
connect/describe_routing_profileDescribes the specified routing profile. DescribeRoutingProfile does not populate AssociatedQueueIds in its response. The example Response Syntax shown on this page is incorrect; we are working to update it. SearchRoutingProfiles does include AssociatedQueueIds.InstanceId (string) required
RoutingProfileId (string) required
connect/describe_ruleDescribes a rule for the specified Amazon Connect instance.InstanceId (string) required
RuleId (string) required
connect/describe_security_profileGets basic information about the security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.SecurityProfileId (string) required
InstanceId (string) required
connect/describe_test_caseDescribes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.InstanceId (string) required
TestCaseId (string) required
Status (string)
connect/describe_traffic_distribution_groupGets details and status of a traffic distribution group.TrafficDistributionGroupId (string) required
connect/describe_userDescribes the specified user. You can find the instance ID in the Amazon Connect 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.UserId (string) required
InstanceId (string) required
connect/describe_user_hierarchy_groupDescribes the specified hierarchy group.HierarchyGroupId (string) required
InstanceId (string) required
connect/describe_user_hierarchy_structureDescribes the hierarchy structure of the specified Amazon Connect instance.InstanceId (string) required
connect/describe_viewRetrieves the view for the specified Amazon Connect instance and view identifier. The view identifier can be supplied as a ViewId or ARN. $SAVED needs to be supplied if a view is unpublished. The view identifier can contain an optional qualifier, for example, :$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content aInstanceId (string) required
ViewId (string) required
connect/describe_vocabularyDescribes the specified vocabulary.InstanceId (string) required
VocabularyId (string) required
connect/describe_workspaceRetrieves details about a workspace, including its configuration and metadata.InstanceId (string) required
WorkspaceId (string) required
connect/disassociate_analytics_data_setRemoves the dataset ID associated with a given Amazon Connect instance.InstanceId (string) required
DataSetId (string) required
TargetAccountId (string)
connect/disassociate_approved_originThis API is in preview release for Amazon Connect and is subject to change. Revokes access to integrated applications from Amazon Connect.InstanceId (string) required
Origin (string) required
ClientToken (string)
connect/disassociate_botThis 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.InstanceId (string) required
LexBot: {
. Name (string)
. LexRegion (string)
} (object)
LexV2Bot: {
. AliasArn (string)
} (object)
ClientToken (string)
connect/disassociate_email_address_aliasRemoves the alias association between two email addresses in an Amazon Connect instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly. Use cases Following are common uses cases for this API: Department separation: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues. EmailEmailAddressId (string) required
InstanceId (string) required
AliasConfiguration: {
. EmailAddressId (string)
} (object) required
ClientToken (string)
connect/disassociate_flowDisassociates a connect resource from a flow.InstanceId (string) required
ResourceId (string) required
ResourceType (string) required
connect/disassociate_hours_of_operationsDisassociates a set of hours of operations with another hours of operation. Refer to Administrator Guide here for more information on inheriting overrides from parent hours of operations.InstanceId (string) required
HoursOfOperationId (string) required
ParentHoursOfOperationIds (array) required
connect/disassociate_instance_storage_configThis 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.InstanceId (string) required
AssociationId (string) required
ResourceType (string) required
ClientToken (string)
connect/disassociate_lambda_functionThis 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.InstanceId (string) required
FunctionArn (string) required
ClientToken (string)
connect/disassociate_lex_botThis 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.InstanceId (string) required
BotName (string) required
LexRegion (string) required
ClientToken (string)
connect/disassociate_phone_number_contact_flowRemoves the flow association from a phone number claimed to your Amazon Connect instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in thePhoneNumberId (string) required
InstanceId (string) required
connect/disassociate_queue_quick_connectsDisassociates a set of quick connects from a queue.InstanceId (string) required
QueueId (string) required
QuickConnectIds (array) required
connect/disassociate_routing_profile_queuesDisassociates a set of queues from a routing profile. Up to 10 queue references can be disassociated in a single API call. More than 10 queue references results in a single call results in an InvalidParameterException.InstanceId (string) required
RoutingProfileId (string) required
QueueReferences (array)
ManualAssignmentQueueReferences (array)
connect/disassociate_security_keyThis API is in preview release for Amazon Connect and is subject to change. Deletes the specified security key.InstanceId (string) required
AssociationId (string) required
ClientToken (string)
connect/disassociate_security_profilesDisassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance.InstanceId (string) required
SecurityProfiles (array) required
EntityType (string) required
EntityArn (string) required
connect/disassociate_traffic_distribution_group_userDisassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.TrafficDistributionGroupId (string) required
UserId (string) required
InstanceId (string) required
connect/disassociate_user_proficienciesDisassociates a set of proficiencies from a user.InstanceId (string) required
UserId (string) required
UserProficiencies (array) required
connect/disassociate_workspaceRemoves the association between a workspace and one or more users or routing profiles.InstanceId (string) required
WorkspaceId (string) required
ResourceArns (array) required
connect/dismiss_user_contactDismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.UserId (string) required
InstanceId (string) required
ContactId (string) required
connect/evaluate_data_table_valuesEvaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term 'Batch' is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: Amazon Web Services APIInstanceId (string) required
DataTableId (string) required
Values (array) required
TimeZone (string)
NextToken (string)
MaxResults (integer)
connect/get_attached_fileProvides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.InstanceId (string) required
FileId (string) required
UrlExpiryInSeconds (integer)
AssociatedResourceArn (string) required
connect/get_contact_attributesRetrieves the contact attributes for the specified contact.InstanceId (string) required
InitialContactId (string) required
connect/get_contact_metricsRetrieves contact metric data for a specified contact. Use cases Following are common use cases for position in queue and estimated wait time: Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience. Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold. Queue Routing Decisions - Route incoming contacts to less conInstanceId (string) required
ContactId (string) required
Metrics (array) required
connect/get_current_metric_dataGets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide. When you make a successful API request, you can expect the following metric values in the response: Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data Metric value is a number including 0 of defined type: The number provided is the calculation result MetricResult list is emInstanceId (string) required
Filters: {
. Queues (array)
. Channels (array)
. RoutingProfiles (array)
. RoutingStepExpressions (array)
. AgentStatuses (array)
. Subtypes (array)
. ValidationTestTypes (array)
} (object) required
Groupings (array)
CurrentMetrics (array) required
NextToken (string)
MaxResults (integer)
SortCriteria (array)
connect/get_current_user_dataGets the real-time active user data from the specified Amazon Connect instance.InstanceId (string) required
Filters: {
. Queues (array)
. ContactFilter (object)
. RoutingProfiles (array)
. Agents (array)
. UserHierarchyGroups (array)
} (object) required
NextToken (string)
MaxResults (integer)
connect/get_effective_hours_of_operationsGet the hours of operations with the effective override applied.InstanceId (string) required
HoursOfOperationId (string) required
FromDate (string) required
ToDate (string) required
connect/get_federation_tokenSupports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide. This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following oneInstanceId (string) required
connect/get_flow_associationRetrieves the flow associated for a given resource.InstanceId (string) required
ResourceId (string) required
ResourceType (string) required
connect/get_metric_dataGets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Metrics definitions in the Amazon Connect Administrator Guide. We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historicaInstanceId (string) required
StartTime (string) required
EndTime (string) required
Filters: {
. Queues (array)
. Channels (array)
. RoutingProfiles (array)
. RoutingStepExpressions (array)
. AgentStatuses (array)
. Subtypes (array)
. ValidationTestTypes (array)
} (object) required
Groupings (array)
HistoricalMetrics (array) required
NextToken (string)
MaxResults (integer)
connect/get_metric_data_v2Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues. For a description of the historical metrics that are suppoResourceArn (string) required
StartTime (string) required
EndTime (string) required
Interval: {
. TimeZone (string)
. IntervalPeriod (string)
} (object)
Filters (array) required
Groupings (array)
Metrics (array) required
NextToken (string)
MaxResults (integer)
connect/get_prompt_fileGets the prompt file.InstanceId (string) required
PromptId (string) required
connect/get_task_templateGets details about a specific task template in the specified Amazon Connect instance.InstanceId (string) required
TaskTemplateId (string) required
SnapshotVersion (string)
connect/get_test_case_execution_summaryRetrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary.InstanceId (string) required
TestCaseId (string) required
TestCaseExecutionId (string) required
connect/get_traffic_distributionRetrieves the current traffic distribution for a given traffic distribution group.Id (string) required
connect/import_phone_numberImports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created. Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation. If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you willInstanceId (string) required
SourcePhoneNumberArn (string) required
PhoneNumberDescription (string)
Tags (object)
ClientToken (string)
connect/import_workspace_mediaImports a media asset such as a logo for use in a workspace.InstanceId (string) required
WorkspaceId (string) required
MediaType (string) required
MediaSource (string) required
connect/list_agent_statusesLists agent statuses.InstanceId (string) required
NextToken (string)
MaxResults (integer)
AgentStatusTypes (array)
connect/list_analytics_data_associationsLists the association status of requested dataset ID for a given Amazon Connect instance.InstanceId (string) required
DataSetId (string)
NextToken (string)
MaxResults (integer)
connect/list_analytics_data_lake_data_setsLists the data lake datasets available to associate with for a given Amazon Connect instance.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_approved_originsThis 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.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_associated_contactsProvides information about contact tree, a list of associated contacts with a unique identifier.InstanceId (string) required
ContactId (string) required
MaxResults (integer)
NextToken (string)
connect/list_authentication_profilesThis API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Provides summary information about the authentication profiles in a specified Amazon Connect instance.InstanceId (string) required
MaxResults (integer)
NextToken (string)
connect/list_botsThis 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 return both Amazon Lex V1 and V2 bots.InstanceId (string) required
NextToken (string)
MaxResults (integer)
LexVersion (string) required
connect/list_child_hours_of_operationsProvides information about the child hours of operations for the specified parent hours of operation. For more information about child hours of operations, see Link overrides from different hours of operation in the Administrator Guide.InstanceId (string) required
HoursOfOperationId (string) required
NextToken (string)
MaxResults (integer)
connect/list_contact_evaluationsLists contact evaluations in the specified Amazon Connect instance.InstanceId (string) required
ContactId (string) required
NextToken (string)
connect/list_contact_flow_module_aliasesLists all aliases associated with a contact flow module, showing their current version mappings and metadata.InstanceId (string) required
ContactFlowModuleId (string) required
NextToken (string)
MaxResults (integer)
connect/list_contact_flow_modulesProvides information about the flow modules for the specified Amazon Connect instance.InstanceId (string) required
NextToken (string)
MaxResults (integer)
ContactFlowModuleState (string)
connect/list_contact_flow_module_versionsRetrieves a paginated list of all versions for a specific contact flow module.InstanceId (string) required
ContactFlowModuleId (string) required
NextToken (string)
MaxResults (integer)
connect/list_contact_flowsProvides 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.InstanceId (string) required
ContactFlowTypes (array)
NextToken (string)
MaxResults (integer)
connect/list_contact_flow_versionsReturns all the available versions for the specified Amazon Connect instance and flow identifier.InstanceId (string) required
ContactFlowId (string) required
NextToken (string)
MaxResults (integer)
connect/list_contact_referencesThis 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. References are links to documents that are related to a contact, such as emails, attachments, or URLs.InstanceId (string) required
ContactId (string) required
ReferenceTypes (array) required
NextToken (string)
connect/list_data_table_attributesReturns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.InstanceId (string) required
DataTableId (string) required
AttributeIds (array)
NextToken (string)
MaxResults (integer)
connect/list_data_table_primary_valuesLists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.InstanceId (string) required
DataTableId (string) required
RecordIds (array)
PrimaryAttributeValues (array)
NextToken (string)
MaxResults (integer)
connect/list_data_tablesLists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_data_table_valuesLists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.InstanceId (string) required
DataTableId (string) required
RecordIds (array)
PrimaryAttributeValues (array)
NextToken (string)
MaxResults (integer)
connect/list_default_vocabulariesLists the default vocabularies for the specified Amazon Connect instance.InstanceId (string) required
LanguageCode (string)
MaxResults (integer)
NextToken (string)
connect/list_entity_security_profilesLists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.InstanceId (string) required
EntityType (string) required
EntityArn (string) required
NextToken (string)
MaxResults (integer)
connect/list_evaluation_formsLists evaluation forms in the specified Amazon Connect instance.InstanceId (string) required
MaxResults (integer)
NextToken (string)
connect/list_evaluation_form_versionsLists versions of an evaluation form in the specified Amazon Connect instance.InstanceId (string) required
EvaluationFormId (string) required
MaxResults (integer)
NextToken (string)
connect/list_flow_associationsList the flow association based on the filters.InstanceId (string) required
ResourceType (string)
NextToken (string)
MaxResults (integer)
connect/list_hours_of_operation_overridesList the hours of operation overrides.InstanceId (string) required
HoursOfOperationId (string) required
NextToken (string)
MaxResults (integer)
connect/list_hours_of_operationsProvides 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.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_instance_attributesThis 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.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_instancesThis 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.NextToken (string)
MaxResults (integer)
connect/list_instance_storage_configsThis 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.InstanceId (string) required
ResourceType (string) required
NextToken (string)
MaxResults (integer)
connect/list_integration_associationsProvides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.InstanceId (string) required
IntegrationType (string)
NextToken (string)
MaxResults (integer)
IntegrationArn (string)
connect/list_lambda_functionsThis 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.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_lex_botsThis 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.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_notificationsRetrieves a paginated list of all notifications in the Amazon Connect instance.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_phone_numbersProvides 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. We recommend using ListPhoneNumbersV2 to return phone number types. ListPhoneNumbers doesn't support number types UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID. While it returns numbers of those types, it incorrectly lists them as TOLL_FREE or DID. The phone number Arn valuInstanceId (string) required
PhoneNumberTypes (array)
PhoneNumberCountryCodes (array)
NextToken (string)
MaxResults (integer)
connect/list_phone_numbers_v2Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide. When given an instance ARN, ListPhoneNumbersV2 returns only the phone numbers claimed to the instance. When givenTargetArn (string)
InstanceId (string)
MaxResults (integer)
NextToken (string)
PhoneNumberCountryCodes (array)
PhoneNumberTypes (array)
PhoneNumberPrefix (string)
connect/list_predefined_attributesLists predefined attributes for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for: Routing proficiency for example, agent certification that has predefined values for example, a list of possible certifications. For more information, see Create predefined attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such as the name of the business unit handling the cInstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_promptsProvides information about the prompts for the specified Amazon Connect instance.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_queue_quick_connectsLists the quick connects associated with a queue.InstanceId (string) required
QueueId (string) required
NextToken (string)
MaxResults (integer)
connect/list_queuesProvides 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.InstanceId (string) required
QueueTypes (array)
NextToken (string)
MaxResults (integer)
connect/list_quick_connectsProvides information about the quick connects for the specified Amazon Connect instance.InstanceId (string) required
NextToken (string)
MaxResults (integer)
QuickConnectTypes (array)
connect/list_realtime_contact_analysis_segments_v2Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only. This API does not support VOICE. If you attempt to use it for VOICE, an InvalidRequestException occurs.InstanceId (string) required
ContactId (string) required
MaxResults (integer)
NextToken (string)
OutputType (string) required
SegmentTypes (array) required
connect/list_routing_profile_manual_assignment_queuesLists the manual assignment queues associated with a routing profile. Use cases Following are common uses cases for this API: This API returns list of queues where contacts can be manually assigned or picked by an agent who has access to the Worklist app. The user can additionally filter on queues, if they have access to those queues otherwise a invalid request exception will be thrown. For information about how manual contact assignment works in the agent workspace, see the Access the WorklistInstanceId (string) required
RoutingProfileId (string) required
NextToken (string)
MaxResults (integer)
connect/list_routing_profile_queuesLists the queues associated with a routing profile.InstanceId (string) required
RoutingProfileId (string) required
NextToken (string)
MaxResults (integer)
connect/list_routing_profilesProvides 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.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_rulesList all rules for the specified Amazon Connect instance.InstanceId (string) required
PublishStatus (string)
EventSourceName (string)
MaxResults (integer)
NextToken (string)
connect/list_security_keysThis 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.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_security_profile_applicationsReturns a list of third-party applications or MCP Servers in a specific security profile.SecurityProfileId (string) required
InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_security_profile_flow_modulesA list of Flow Modules an AI Agent can invoke as a toolSecurityProfileId (string) required
InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_security_profile_permissionsLists the permissions granted to a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.SecurityProfileId (string) required
InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_security_profilesProvides 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. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_tags_for_resourceLists 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.resourceArn (string) required
connect/list_task_templatesLists task templates for the specified Amazon Connect instance.InstanceId (string) required
NextToken (string)
MaxResults (integer)
Status (string)
Name (string)
connect/list_test_case_execution_recordsLists detailed steps of test case execution that includes all observations along with actions taken and data associated in the specified Amazon Connect instance.InstanceId (string) required
TestCaseId (string) required
TestCaseExecutionId (string) required
Status (string)
NextToken (string)
MaxResults (integer)
connect/list_test_case_executionsLists all test case executions and allows filtering by test case id, test case name, start time, end time or status of the execution for the specified Amazon Connect instance.InstanceId (string) required
TestCaseId (string)
TestCaseName (string)
StartTime (string)
EndTime (string)
Status (string)
NextToken (string)
MaxResults (integer)
connect/list_test_casesLists the test cases present in the specific Amazon Connect instance.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_traffic_distribution_groupsLists traffic distribution groups.MaxResults (integer)
NextToken (string)
InstanceId (string)
connect/list_traffic_distribution_group_usersLists traffic distribution group users.TrafficDistributionGroupId (string) required
MaxResults (integer)
NextToken (string)
connect/list_use_casesLists the use cases for the integration association.InstanceId (string) required
IntegrationAssociationId (string) required
NextToken (string)
MaxResults (integer)
connect/list_user_hierarchy_groupsProvides 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.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_user_notificationsRetrieves a paginated list of notifications for a specific user, including the notification status for that user.InstanceId (string) required
NextToken (string)
MaxResults (integer)
UserId (string) required
connect/list_user_proficienciesLists proficiencies associated with a user.InstanceId (string) required
UserId (string) required
NextToken (string)
MaxResults (integer)
connect/list_usersProvides summary information about the users for the specified Amazon Connect instance.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_viewsReturns views in the given instance. Results are sorted primarily by type, and secondarily by name.InstanceId (string) required
Type (string)
NextToken (string)
MaxResults (integer)
connect/list_view_versionsReturns all the available versions for the specified Amazon Connect instance and view identifier. Results will be sorted from highest to lowest.InstanceId (string) required
ViewId (string) required
NextToken (string)
MaxResults (integer)
connect/list_workspace_mediaLists media assets such as logos associated with a workspace.InstanceId (string) required
WorkspaceId (string) required
connect/list_workspace_pagesLists the page configurations in a workspace, including the views assigned to each page.InstanceId (string) required
WorkspaceId (string) required
NextToken (string)
MaxResults (integer)
connect/list_workspacesLists the workspaces in an Amazon Connect instance.InstanceId (string) required
NextToken (string)
MaxResults (integer)
connect/monitor_contactInitiates silent monitoring of a contact. The Contact Control Panel CCP of the user specified by userId will be set to silent monitoring mode on the contact.InstanceId (string) required
ContactId (string) required
UserId (string) required
AllowedMonitorCapabilities (array)
ClientToken (string)
connect/pause_contactAllows pausing an ongoing task contact.ContactId (string) required
InstanceId (string) required
ContactFlowId (string)
connect/put_user_statusChanges 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.UserId (string) required
InstanceId (string) required
AgentStatusId (string) required
connect/release_phone_numberReleases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed. To release phone numbers from a traffic distribution group, use the ReleasePhoneNumber API, not the Amazon Connect admin website. After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If yoPhoneNumberId (string) required
ClientToken (string)
connect/replicate_instanceReplicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions. For more information about replicating an Amazon Connect instance, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.InstanceId (string) required
ReplicaRegion (string) required
ClientToken (string)
ReplicaAlias (string) required
connect/resume_contactAllows resuming a task contact in a paused state.ContactId (string) required
InstanceId (string) required
ContactFlowId (string)
connect/resume_contact_recordingWhen a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume. Voice and screen recordings are supported.InstanceId (string) required
ContactId (string) required
InitialContactId (string) required
ContactRecordingType (string)
connect/search_agent_statusesSearches AgentStatuses in an Amazon Connect instance, with optional filtering.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. AttributeFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
connect/search_available_phone_numbersSearches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.TargetArn (string)
InstanceId (string)
PhoneNumberCountryCode (string) required
PhoneNumberType (string) required
PhoneNumberPrefix (string)
MaxResults (integer)
NextToken (string)
connect/search_contact_evaluationsSearches contact evaluations in an Amazon Connect instance, with optional filtering. Use cases Following are common uses cases for this API: Find contact evaluations by using specific search criteria. Find contact evaluations that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource create, update or delete. If you don't see updated information for recently changed contact evaluations, try calling thInstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
. NumberCondition (object)
. BooleanCondition (object)
. DateTimeCondition (object)
. DecimalCondition (object)
} (object)
SearchFilter: {
. AttributeFilter (object)
} (object)
connect/search_contact_flow_modulesSearches the flow modules in an Amazon Connect instance, with optional filtering.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. TagFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
. StateCondition (string)
. StatusCondition (string)
} (object)
connect/search_contact_flowsSearches the flows in an Amazon Connect instance, with optional filtering.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. TagFilter (object)
. FlowAttributeFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
. TypeCondition (string)
. StateCondition (string)
. StatusCondition (string)
} (object)
connect/search_contactsSearches contacts in an Amazon Connect instance.InstanceId (string) required
TimeRange: {
. Type (string)
. StartTime (string)
. EndTime (string)
} (object) required
SearchCriteria: {
. Name (object)
. AgentIds (array)
. AgentHierarchyGroups (object)
. Channels (array)
. ContactAnalysis (object)
. InitiationMethods (array)
. QueueIds (array)
. RoutingCriteria (object)
. AdditionalTimeRange (object)
. SearchableContactAttributes (object)
. SearchableSegmentAttributes (object)
. ActiveRegions (array)
. ContactTags (object)
} (object)
MaxResults (integer)
NextToken (string)
Sort: {
. FieldName (string)
. Order (string)
} (object)
connect/search_data_tablesSearches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. AttributeFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
connect/search_email_addressesSearches email address in an instance, with optional filtering.InstanceId (string) required
MaxResults (integer)
NextToken (string)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
SearchFilter: {
. TagFilter (object)
} (object)
connect/search_evaluation_formsSearches evaluation forms in an Amazon Connect instance, with optional filtering. Use cases Following are common uses cases for this API: List all evaluation forms in an instance. Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more. Find all evaluation forms that are tagged with a specific set of tags. Important things to know A Search operation, unlike a List operation, takes time to index changes to resource create, update or delete. If you don'tInstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
. NumberCondition (object)
. BooleanCondition (object)
. DateTimeCondition (object)
} (object)
SearchFilter: {
. AttributeFilter (object)
} (object)
connect/search_hours_of_operation_overridesSearches the hours of operation overrides.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. TagFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
. DateCondition (object)
} (object)
connect/search_hours_of_operationsSearches the hours of operation in an Amazon Connect instance, with optional filtering.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. TagFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
connect/search_notificationsSearches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. AttributeFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
connect/search_predefined_attributesSearches predefined attributes that meet certain criteria. A predefined attribute is made up of a name and a value. You can use predefined attributes for: Routing proficiency for example, agent certification that has predefined values for example, a list of possible certifications. For more information, see Create predefined attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. ForInstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
connect/search_promptsSearches prompts in an Amazon Connect instance, with optional filtering.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. TagFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
connect/search_queuesSearches queues in an Amazon Connect instance, with optional filtering.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. TagFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
. QueueTypeCondition (string)
} (object)
connect/search_quick_connectsSearches quick connects in an Amazon Connect instance, with optional filtering.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. TagFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
connect/search_resource_tagsSearches tags used in an Amazon Connect instance using optional search criteria.InstanceId (string) required
ResourceTypes (array)
NextToken (string)
MaxResults (integer)
SearchCriteria: {
. TagSearchCondition (object)
} (object)
connect/search_routing_profilesSearches routing profiles in an Amazon Connect instance, with optional filtering. SearchRoutingProfiles does not populate LastModifiedRegion, LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but DescribeRoutingProfile does.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. TagFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
connect/search_security_profilesSearches security profiles in an Amazon Connect instance, with optional filtering. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
SearchFilter: {
. TagFilter (object)
} (object)
connect/search_test_casesSearches for test cases in the specified Amazon Connect instance, with optional filtering.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. TagFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
. StatusCondition (string)
} (object)
connect/search_user_hierarchy_groupsSearches UserHierarchyGroups in an Amazon Connect instance, with optional filtering. The UserHierarchyGroup with 'LevelId': '0' is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. AttributeFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
connect/search_usersSearches users in an Amazon Connect instance, with optional filtering. AfterContactWorkTimeLimit is returned in milliseconds.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. TagFilter (object)
. UserAttributeFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
. ListCondition (object)
. HierarchyGroupCondition (object)
} (object)
connect/search_viewsSearches views based on name, description, or tags.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. AttributeFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
. ViewTypeCondition (string)
. ViewStatusCondition (string)
} (object)
connect/search_vocabulariesSearches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.InstanceId (string) required
MaxResults (integer)
NextToken (string)
State (string)
NameStartsWith (string)
LanguageCode (string)
connect/search_workspace_associationsSearches for workspace associations with users or routing profiles based on various criteria.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. AttributeFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
connect/search_workspacesSearches workspaces based on name, description, visibility, or tags.InstanceId (string) required
NextToken (string)
MaxResults (integer)
SearchFilter: {
. AttributeFilter (object)
} (object)
SearchCriteria: {
. OrConditions (array)
. AndConditions (array)
. StringCondition (object)
} (object)
connect/send_chat_integration_eventProcesses chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes: SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat acSourceId (string) required
DestinationId (string) required
Subtype (string)
Event: {
. Type (string)
. ContentType (string)
. Content (string)
} (object) required
NewSessionDetails: {
. SupportedMessagingContentTypes (array)
. ParticipantDetails (object)
. Attributes (object)
. StreamingConfiguration (object)
} (object)
connect/send_outbound_emailSend outbound email for outbound campaigns. For more information about outbound campaigns, see Set up Amazon Connect outbound campaigns. Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.InstanceId (string) required
FromEmailAddress: {
. EmailAddress (string)
. DisplayName (string)
} (object) required
DestinationEmailAddress: {
. EmailAddress (string)
. DisplayName (string)
} (object) required
AdditionalRecipients: {
. CcEmailAddresses (array)
} (object)
EmailMessage: {
. MessageSourceType (string)
. TemplatedMessageConfig (object)
. RawMessage (object)
} (object) required
TrafficType (string) required
SourceCampaign: {
. CampaignId (string)
. OutboundRequestId (string)
} (object)
ClientToken (string)
connect/start_attached_file_uploadProvides a pre-signed Amazon S3 URL in response for uploading your content. You may only use this API to upload attachments to an Amazon Connect Case or Amazon Connect Email.ClientToken (string)
InstanceId (string) required
FileName (string) required
FileSizeInBytes (integer) required
UrlExpiryInSeconds (integer)
FileUseCaseType (string) required
AssociatedResourceArn (string) required
CreatedBy (undefined)
Tags (object)
connect/start_chat_contactInitiates 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: AInstanceId (string) required
ContactFlowId (string) required
Attributes (object)
ParticipantDetails: {
. DisplayName (string)
} (object) required
ParticipantConfiguration: {
. ResponseMode (string)
} (object)
InitialMessage: {
. ContentType (string)
. Content (string)
} (object)
ClientToken (string)
ChatDurationInMinutes (integer)
SupportedMessagingContentTypes (array)
PersistentChat: {
. RehydrationType (string)
. SourceContactId (string)
} (object)
RelatedContactId (string)
SegmentAttributes (object)
CustomerId (string)
DisconnectOnCustomerExit (array)
connect/start_contact_evaluationStarts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started. Evaluations created through the public API do not contain answer values suggested from automation.InstanceId (string) required
ContactId (string) required
EvaluationFormId (string) required
AutoEvaluationConfiguration: {
. Enabled (boolean)
} (object)
ClientToken (string)
Tags (object)
connect/start_contact_media_processingEnables in-flight message processing for an ongoing chat session. Message processing will stay active for the rest of the chat, even if an individual contact segment ends.InstanceId (string)
ContactId (string)
ProcessorArn (string)
FailureMode (string)
connect/start_contact_recordingStarts 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 wInstanceId (string) required
ContactId (string) required
InitialContactId (string) required
VoiceRecordingConfiguration: {
. VoiceRecordingTrack (string)
. IvrRecordingTrack (string)
} (object) required
connect/start_contact_streamingInitiates 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. For more information about chat, see the following topics in the Amazon Connect Administrator Guide: Concepts: Web and mobile messaging capabilities in Amazon Connect Amazon Connect Chat security best practicesInstanceId (string) required
ContactId (string) required
ChatStreamingConfiguration: {
. StreamingEndpointArn (string)
} (object) required
ClientToken (string) required
connect/start_email_contactCreates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.InstanceId (string) required
FromEmailAddress: {
. EmailAddress (string)
. DisplayName (string)
} (object) required
DestinationEmailAddress (string) required
Description (string)
References (object)
Name (string)
EmailMessage: {
. MessageSourceType (string)
. RawMessage (object)
} (object) required
AdditionalRecipients: {
. ToAddresses (array)
. CcAddresses (array)
} (object)
Attachments (array)
ContactFlowId (string)
RelatedContactId (string)
Attributes (object)
SegmentAttributes (object)
ClientToken (string)
connect/start_outbound_chat_contactInitiates a new outbound SMS or WhatsApp contact to a customer. Response of this API provides the ContactId of the outbound SMS or WhatsApp contact created. SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new contact created. This API can be used to initiate outbound SMS or WhatsApp contacts for an agent, or it can also deflect an ongoing contaSourceEndpoint: {
. Type (string)
. Address (string)
} (object) required
DestinationEndpoint: {
. Type (string)
. Address (string)
} (object) required
InstanceId (string) required
SegmentAttributes (object) required
Attributes (object)
ContactFlowId (string) required
ChatDurationInMinutes (integer)
ParticipantDetails: {
. DisplayName (string)
} (object)
InitialSystemMessage: {
. ContentType (string)
. Content (string)
} (object)
InitialTemplatedSystemMessage: {
. KnowledgeBaseId (string)
. MessageTemplateId (string)
. TemplateAttributes (object)
} (object)
RelatedContactId (string)
SupportedMessagingContentTypes (array)
ClientToken (string)
connect/start_outbound_email_contactInitiates a flow to send an agent reply or outbound email contact created from the CreateContact API to a customer.InstanceId (string) required
ContactId (string) required
FromEmailAddress: {
. EmailAddress (string)
. DisplayName (string)
} (object)
DestinationEmailAddress: {
. EmailAddress (string)
. DisplayName (string)
} (object) required
AdditionalRecipients: {
. CcEmailAddresses (array)
} (object)
EmailMessage: {
. MessageSourceType (string)
. TemplatedMessageConfig (object)
. RawMessage (object)
} (object) required
ClientToken (string)
connect/start_outbound_voice_contactPlaces 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. Dialing timeout for this operation can be configured with the “RingTimeoutInSeconds” parameter. If not specified, the defName (string)
Description (string)
References (object)
RelatedContactId (string)
DestinationPhoneNumber (string) required
ContactFlowId (string) required
InstanceId (string) required
ClientToken (string)
SourcePhoneNumber (string)
QueueId (string)
Attributes (object)
AnswerMachineDetectionConfig: {
. EnableAnswerMachineDetection (boolean)
. AwaitAnswerMachinePrompt (boolean)
} (object)
CampaignId (string)
TrafficType (string)
OutboundStrategy: {
. Type (string)
. Config (object)
} (object)
RingTimeoutInSeconds (integer)
connect/start_screen_sharingStarts screen sharing for a contact. For more information about screen sharing, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.ClientToken (string)
InstanceId (string) required
ContactId (string) required
connect/start_task_contactInitiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide. When using PreviousContactId and RelatedContactId input parameters, note the following: PreviousContactId Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain. That is, 12 taInstanceId (string) required
PreviousContactId (string)
ContactFlowId (string)
Attributes (object)
Name (string) required
References (object)
Description (string)
ClientToken (string)
ScheduledTime (string)
TaskTemplateId (string)
QuickConnectId (string)
RelatedContactId (string)
SegmentAttributes (object)
Attachments (array)
connect/start_test_case_executionStarts executing a published test case.InstanceId (string) required
TestCaseId (string) required
ClientToken (string)
connect/start_web_rtccontactPlaces an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified in ContactFlowId and present in the Amazon Connect instance specified as InstanceId.Attributes (object)
ClientToken (string)
ContactFlowId (string) required
InstanceId (string) required
AllowedCapabilities: {
. Customer (object)
. Agent (object)
} (object)
ParticipantDetails: {
. DisplayName (string)
} (object) required
RelatedContactId (string)
References (object)
Description (string)
connect/stop_contactEnds the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods: DISCONNECT TRANSFER QUEUE_TRANSFER EXTERNAL_OUTBOUND MONITOR Chat and task contacts can be terminated in any state, regardless of initiation method.ContactId (string) required
InstanceId (string) required
DisconnectReason: {
. Code (string)
} (object)
connect/stop_contact_media_processingStops in-flight message processing for an ongoing chat session.InstanceId (string)
ContactId (string)
connect/stop_contact_recordingStops 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.InstanceId (string) required
ContactId (string) required
InitialContactId (string) required
ContactRecordingType (string)
connect/stop_contact_streamingEnds message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming API.InstanceId (string) required
ContactId (string) required
StreamingId (string) required
connect/stop_test_case_executionStops a running test execution.InstanceId (string) required
TestCaseExecutionId (string) required
TestCaseId (string) required
ClientToken (string)
connect/submit_contact_evaluationSubmits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object to the question identifier. If a contact evaluation is already in submitted state, this operation will trigger a resubmission.InstanceId (string) required
EvaluationId (string) required
Answers (object)
Notes (object)
SubmittedBy (undefined)
connect/suspend_contact_recordingWhen a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call IVR or agent, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen. The period of time that the recording is suspended is filled with silence in thInstanceId (string) required
ContactId (string) required
InitialContactId (string) required
ContactRecordingType (string)
connect/tag_contactAdds the specified tags to the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.ContactId (string) required
InstanceId (string) required
Tags (object) required
connect/tag_resourceAdds the specified tags to the specified resource. Some of the supported resource types are agents, routing profiles, queues, quick connects, 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.resourceArn (string) required
tags (object) required
connect/transfer_contactTransfers TASK or EMAIL 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 only supported for TASK and EMAIL contacts. Do not use both QueueId andInstanceId (string) required
ContactId (string) required
QueueId (string)
UserId (string)
ContactFlowId (string) required
ClientToken (string)
connect/untag_contactRemoves the specified tags from the contact resource. For more information about this API is used, see Set up granular billing for a detailed view of your Amazon Connect usage.ContactId (string) required
InstanceId (string) required
TagKeys (array) required
connect/untag_resourceRemoves the specified tags from the specified resource.resourceArn (string) required
tagKeys (array) required
connect/update_agent_statusUpdates agent status.InstanceId (string) required
AgentStatusId (string) required
Name (string)
Description (string)
State (string)
DisplayOrder (integer)
ResetOrderNumber (boolean)
connect/update_authentication_profileThis API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Updates the selected authentication profile.AuthenticationProfileId (string) required
InstanceId (string) required
Name (string)
Description (string)
AllowedIps (array)
BlockedIps (array)
PeriodicSessionDuration (integer)
SessionInactivityDuration (integer)
SessionInactivityHandlingEnabled (boolean)
connect/update_contactThis 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.InstanceId (string) required
ContactId (string) required
Name (string)
Description (string)
References (object)
SegmentAttributes (object)
QueueInfo: {
. Id (string)
} (object)
UserInfo: {
. UserId (string)
} (object)
CustomerEndpoint: {
. Type (string)
. Address (string)
} (object)
SystemEndpoint: {
. Type (string)
. Address (string)
} (object)
connect/update_contact_attributesCreates 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 thInitialContactId (string) required
InstanceId (string) required
Attributes (object) required
connect/update_contact_evaluationUpdates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object to the question identifier.InstanceId (string) required
EvaluationId (string) required
Answers (object)
Notes (object)
UpdatedBy (undefined)
connect/update_contact_flow_contentUpdates the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/id:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.InstanceId (string) required
ContactFlowId (string) required
Content (string) required
connect/update_contact_flow_metadataUpdates metadata about specified flow.InstanceId (string) required
ContactFlowId (string) required
Name (string)
Description (string)
ContactFlowState (string)
connect/update_contact_flow_module_aliasUpdates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.InstanceId (string) required
ContactFlowModuleId (string) required
AliasId (string) required
Name (string)
Description (string)
ContactFlowModuleVersion (integer)
connect/update_contact_flow_module_contentUpdates specified flow module for the specified Amazon Connect instance. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/id:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.InstanceId (string) required
ContactFlowModuleId (string) required
Content (string)
Settings (string)
connect/update_contact_flow_module_metadataUpdates metadata about specified flow module.InstanceId (string) required
ContactFlowModuleId (string) required
Name (string)
Description (string)
State (string)
connect/update_contact_flow_nameThe name of the flow. You can also create and update flows using the Amazon Connect Flow language.InstanceId (string) required
ContactFlowId (string) required
Name (string)
Description (string)
connect/update_contact_routing_dataUpdates routing priority and age on the contact QueuePriority and QueueTimeAdjustmentInSeconds. These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing ordInstanceId (string) required
ContactId (string) required
QueueTimeAdjustmentSeconds (integer)
QueuePriority (integer)
RoutingCriteria: {
. Steps (array)
} (object)
connect/update_contact_scheduleUpdates the scheduled time of a task contact that is already scheduled.InstanceId (string) required
ContactId (string) required
ScheduledTime (string) required
connect/update_data_table_attributeUpdates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided. System managed attributes are not mutable by customers. Changing an attribute's validation does not invalidate existing values since validation only runs when values are created or updated.InstanceId (string) required
DataTableId (string) required
AttributeName (string) required
Name (string) required
ValueType (string) required
Description (string)
Primary (boolean)
Validation: {
. MinLength (integer)
. MaxLength (integer)
. MinValues (integer)
. MaxValues (integer)
. IgnoreCase (boolean)
. Minimum (number)
. Maximum (number)
. ExclusiveMinimum (number)
. ExclusiveMaximum (number)
. MultipleOf (number)
. Enum (object)
} (object)
connect/update_data_table_metadataUpdates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.InstanceId (string) required
DataTableId (string) required
Name (string) required
Description (string)
ValueLockLevel (string) required
TimeZone (string) required
connect/update_data_table_primary_valuesUpdates the primary values for a record. This operation affects all existing values that are currently associated to the record and its primary values. Users that have restrictions on attributes and/or primary values are not authorized to use this endpoint. The combination of new primary values must be unique within the table.InstanceId (string) required
DataTableId (string) required
PrimaryValues (array) required
NewPrimaryValues (array) required
LockVersion: {
. DataTable (string)
. Attribute (string)
. PrimaryValues (string)
. Value (string)
} (object) required
connect/update_email_address_metadataUpdates an email address metadata. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.InstanceId (string) required
EmailAddressId (string) required
Description (string)
DisplayName (string)
ClientToken (string)
connect/update_evaluation_formUpdates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form. This operation does not support partial updates. Instead it does a full update of evaluation form content.InstanceId (string) required
EvaluationFormId (string) required
EvaluationFormVersion (integer) required
CreateNewVersion (boolean)
Title (string) required
Description (string)
Items (array) required
ScoringStrategy: {
. Mode (string)
. Status (string)
} (object)
AutoEvaluationConfiguration: {
. Enabled (boolean)
} (object)
ReviewConfiguration: {
. ReviewNotificationRecipients (array)
. EligibilityDays (integer)
} (object)
AsDraft (boolean)
ClientToken (string)
TargetConfiguration: {
. ContactInteractionType (string)
} (object)
LanguageConfiguration: {
. FormLanguage (string)
} (object)
connect/update_hours_of_operationUpdates the hours of operation.InstanceId (string) required
HoursOfOperationId (string) required
Name (string)
Description (string)
TimeZone (string)
Config (array)
connect/update_hours_of_operation_overrideUpdate the hours of operation override.InstanceId (string) required
HoursOfOperationId (string) required
HoursOfOperationOverrideId (string) required
Name (string)
Description (string)
Config (array)
EffectiveFrom (string)
EffectiveTill (string)
RecurrenceConfig: {
. RecurrencePattern (object)
} (object)
OverrideType (string)
connect/update_instance_attributeThis API is in preview release for Amazon Connect and is subject to change. Updates the value for the specified attribute type.InstanceId (string) required
AttributeType (string) required
Value (string) required
ClientToken (string)
connect/update_instance_storage_configThis 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.InstanceId (string) required
AssociationId (string) required
ResourceType (string) required
StorageConfig: {
. AssociationId (string)
. StorageType (string)
. S3Config (object)
. KinesisVideoStreamConfig (object)
. KinesisStreamConfig (object)
. KinesisFirehoseConfig (object)
} (object) required
ClientToken (string)
connect/update_notification_contentUpdates the localized content of an existing notification. This operation applies to all users for whom the notification was sent.InstanceId (string) required
NotificationId (string) required
Content (object) required
connect/update_participant_authenticationInstructs Amazon Connect to resume the authentication process. The subsequent actions depend on the request body contents: If a code is provided: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles. If an error is provided: The error branch of the Authenticate Customer block is executed. The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after thState (string) required
InstanceId (string) required
Code (string)
Error (string)
ErrorDescription (string)
connect/update_participant_role_configUpdates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers: Customer idle timeout Customer auto-disconnect timeout Agent idle timeout Agent auto-disconnect timeout For more information about how chat timeouts work, see Set up chat timeouts for human participants.InstanceId (string) required
ContactId (string) required
ChannelConfiguration (undefined) required
connect/update_phone_numberUpdates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region. After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flowPhoneNumberId (string) required
TargetArn (string)
InstanceId (string)
ClientToken (string)
connect/update_phone_number_metadataUpdates a phone number’s metadata. To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.PhoneNumberId (string) required
PhoneNumberDescription (string)
ClientToken (string)
connect/update_predefined_attributeUpdates a predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. For the predefined attributes per instance quota, see Amazon Connect quotas. Use cases Following are common uses cases for this API: Update routing proficiency for example, agent certification that has predefined values for example, a list of possible certifications. For more information, see Create predefined attributes for routing contacts to agents. Update an attrInstanceId (string) required
Name (string) required
Values (undefined)
Purposes (array)
AttributeConfiguration: {
. EnableValueValidationOnAssociation (boolean)
} (object)
connect/update_promptUpdates a prompt.InstanceId (string) required
PromptId (string) required
Name (string)
Description (string)
S3Uri (string)
connect/update_queue_hours_of_operationUpdates the hours of operation for the specified queue.InstanceId (string) required
QueueId (string) required
HoursOfOperationId (string) required
connect/update_queue_max_contactsUpdates the maximum number of contacts allowed in a queue before it is considered full.InstanceId (string) required
QueueId (string) required
MaxContacts (integer)
connect/update_queue_nameUpdates the name and description of a queue. At least Name or Description must be provided.InstanceId (string) required
QueueId (string) required
Name (string)
Description (string)
connect/update_queue_outbound_caller_configUpdates the outbound caller ID name, number, and outbound whisper flow for a specified queue. If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon WebInstanceId (string) required
QueueId (string) required
OutboundCallerConfig: {
. OutboundCallerIdName (string)
. OutboundCallerIdNumberId (string)
. OutboundFlowId (string)
} (object) required
connect/update_queue_outbound_email_configUpdates the outbound email address Id for a specified queue.InstanceId (string) required
QueueId (string) required
OutboundEmailConfig: {
. OutboundEmailAddressId (string)
} (object) required
connect/update_queue_statusUpdates the status of the queue.InstanceId (string) required
QueueId (string) required
Status (string) required
connect/update_quick_connect_configUpdates the configuration settings for the specified quick connect.InstanceId (string) required
QuickConnectId (string) required
QuickConnectConfig: {
. QuickConnectType (string)
. UserConfig (object)
. QueueConfig (object)
. PhoneConfig (object)
. FlowConfig (object)
} (object) required
connect/update_quick_connect_nameUpdates 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.InstanceId (string) required
QuickConnectId (string) required
Name (string)
Description (string)
connect/update_routing_profile_agent_availability_timerWhether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.InstanceId (string) required
RoutingProfileId (string) required
AgentAvailabilityTimer (string) required
connect/update_routing_profile_concurrencyUpdates the channels that agents can handle in the Contact Control Panel CCP for a routing profile.InstanceId (string) required
RoutingProfileId (string) required
MediaConcurrencies (array) required
connect/update_routing_profile_default_outbound_queueUpdates the default outbound queue of a routing profile.InstanceId (string) required
RoutingProfileId (string) required
DefaultOutboundQueueId (string) required
connect/update_routing_profile_nameUpdates 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.InstanceId (string) required
RoutingProfileId (string) required
Name (string)
Description (string)
connect/update_routing_profile_queuesUpdates the properties associated with a set of queues for a routing profile.InstanceId (string) required
RoutingProfileId (string) required
QueueConfigs (array) required
connect/update_ruleUpdates a rule for the specified Amazon Connect instance. Use the Rules Function language to code conditions for the rule.RuleId (string) required
InstanceId (string) required
Name (string) required
Function (string) required
Actions (array) required
PublishStatus (string) required
connect/update_security_profileUpdates a security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.Description (string)
Permissions (array)
SecurityProfileId (string) required
InstanceId (string) required
AllowedAccessControlTags (object)
TagRestrictedResources (array)
Applications (array)
HierarchyRestrictedResources (array)
AllowedAccessControlHierarchyGroupId (string)
AllowedFlowModules (array)
GranularAccessControlConfiguration: {
. DataTableAccessControlConfiguration (object)
} (object)
connect/update_task_templateUpdates 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.TaskTemplateId (string) required
InstanceId (string) required
Name (string)
Description (string)
ContactFlowId (string)
SelfAssignFlowId (string)
Constraints: {
. RequiredFields (array)
. ReadOnlyFields (array)
. InvisibleFields (array)
} (object)
Defaults: {
. DefaultFieldValues (array)
} (object)
Status (string)
Fields (array)
connect/update_test_caseUpdates any of the metadata for a test case, such as the name, description, and status or content of an existing test case. This API doesn't allow customers to update the tags of the test case resource for the specified Amazon Connect instance.InstanceId (string) required
TestCaseId (string) required
Content (string)
EntryPoint: {
. Type (string)
. VoiceCallEntryPointParameters (object)
} (object)
InitializationData (string)
Name (string)
Description (string)
Status (string)
LastModifiedTime (string)
LastModifiedRegion (string)
connect/update_traffic_distributionUpdates the traffic distribution for a given traffic distribution group. When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls. The SignInConfig distribution is available only on a default TrafficDistributionGroup see the IsDefault parameter in the TrafficDistributionGroup data type. If yId (string) required
TelephonyConfig: {
. Distributions (array)
} (object)
SignInConfig: {
. Distributions (array)
} (object)
AgentConfig: {
. Distributions (array)
} (object)
connect/update_user_configUpdates the configuration settings for the specified user, including per-channel auto-accept and after contact work ACW timeout settings. This operation replaces the UpdateUserPhoneConfig API. While UpdateUserPhoneConfig applies the same ACW timeout to all channels, UpdateUserConfig allows you to set different auto-accept and ACW timeout values for each channel type.AutoAcceptConfigs (array)
AfterContactWorkConfigs (array)
PhoneNumberConfigs (array)
PersistentConnectionConfigs (array)
VoiceEnhancementConfigs (array)
UserId (string) required
InstanceId (string) required
connect/update_user_hierarchyAssigns the specified hierarchy group to the specified user.HierarchyGroupId (string)
UserId (string) required
InstanceId (string) required
connect/update_user_hierarchy_group_nameUpdates the name of the user hierarchy group.Name (string) required
HierarchyGroupId (string) required
InstanceId (string) required
connect/update_user_hierarchy_structureUpdates the user hierarchy structure: add, remove, and rename user hierarchy levels.HierarchyStructure: {
. LevelOne (object)
. LevelTwo (object)
. LevelThree (object)
. LevelFour (object)
. LevelFive (object)
} (object) required
InstanceId (string) required
connect/update_user_identity_infoUpdates 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 ConneIdentityInfo: {
. FirstName (string)
. LastName (string)
. Email (string)
. SecondaryEmail (string)
. Mobile (string)
} (object) required
UserId (string) required
InstanceId (string) required
connect/update_user_notification_statusUpdates the status of a notification for a specific user, such as marking it as read or hidden. Users can only update notification status for notifications that have been sent to them. READ status deprioritizes the notification and greys it out, while HIDDEN status removes it from the notification widget.InstanceId (string) required
NotificationId (string) required
UserId (string) required
Status (string) required
LastModifiedTime (string)
LastModifiedRegion (string)
connect/update_user_phone_configUpdates the phone configuration settings for the specified user. We recommend using the UpdateUserConfig API, which supports additional functionality that is not available in the UpdateUserPhoneConfig API, such as voice enhancement settings and per-channel configuration for auto-accept and After Contact Work ACW timeouts. In comparison, the UpdateUserPhoneConfig API will always set the same ACW timeouts to all channels the user handles.PhoneConfig: {
. PhoneType (string)
. AutoAccept (boolean)
. AfterContactWorkTimeLimit (integer)
. DeskPhoneNumber (string)
. PersistentConnection (boolean)
} (object) required
UserId (string) required
InstanceId (string) required
connect/update_user_proficienciesUpdates the properties associated with the proficiencies of a user.InstanceId (string) required
UserId (string) required
UserProficiencies (array) required
connect/update_user_routing_profileAssigns the specified routing profile to the specified user.RoutingProfileId (string) required
UserId (string) required
InstanceId (string) required
connect/update_user_security_profilesAssigns the specified security profiles to the specified user.SecurityProfileIds (array) required
UserId (string) required
InstanceId (string) required
connect/update_view_contentUpdates the view content of the given view identifier in the specified Amazon Connect instance. It performs content validation if Status is set to SAVED and performs full content validation if Status is PUBLISHED. Note that the $SAVED alias' content will always be updated, but the $LATEST alias' content will only be updated if Status is PUBLISHED.InstanceId (string) required
ViewId (string) required
Status (string) required
Content: {
. Template (string)
. Actions (array)
} (object) required
connect/update_view_metadataUpdates the view metadata. Note that either Name or Description must be provided.InstanceId (string) required
ViewId (string) required
Name (string)
Description (string)
connect/update_workspace_metadataUpdates the metadata of a workspace, such as its name and description.InstanceId (string) required
WorkspaceId (string) required
Name (string)
Description (string)
Title (string)
connect/update_workspace_pageUpdates the configuration of a page in a workspace, including the associated view and input data.InstanceId (string) required
WorkspaceId (string) required
Page (string) required
NewPage (string)
ResourceArn (string)
Slug (string)
InputData (string)
connect/update_workspace_themeUpdates the theme configuration for a workspace, including colors and styling.InstanceId (string) required
WorkspaceId (string) required
Theme: {
. Light (object)
. Dark (object)
} (object)
connect/update_workspace_visibilityUpdates the visibility setting of a workspace, controlling whether it is available to all users, assigned users only, or none.InstanceId (string) required
WorkspaceId (string) required
Visibility (string) required
connectcampaigns/create_campaignCreates a campaign for the specified Amazon Connect account. This API is idempotent.name (string) required
connectInstanceId (string) required
dialerConfig (undefined) required
outboundCallConfig: {
. connectContactFlowId (string)
. connectSourcePhoneNumber (string)
. connectQueueId (string)
. answerMachineDetectionConfig (object)
} (object) required
tags (object)
connectcampaigns/delete_campaignDeletes a campaign from the specified Amazon Connect account.id (string) required
connectcampaigns/delete_connect_instance_configDeletes a connect instance config from the specified AWS account.connectInstanceId (string) required
connectcampaigns/delete_instance_onboarding_jobDelete the Connect Campaigns onboarding job for the specified Amazon Connect instance.connectInstanceId (string) required
connectcampaigns/describe_campaignDescribes the specific campaign.id (string) required
connectcampaigns/get_campaign_stateGet state of a campaign for the specified Amazon Connect account.id (string) required
connectcampaigns/get_campaign_state_batchGet state of campaigns for the specified Amazon Connect account.campaignIds (array) required
connectcampaigns/get_connect_instance_configGet the specific Connect instance config.connectInstanceId (string) required
connectcampaigns/get_instance_onboarding_job_statusGet the specific instance onboarding job status.connectInstanceId (string) required
connectcampaigns/list_campaignsProvides summary information about the campaigns under the specified Amazon Connect account.maxResults (integer)
nextToken (string)
filters: {
. instanceIdFilter (object)
} (object)
connectcampaigns/list_tags_for_resourceList tags for a resource.arn (string) required
connectcampaigns/pause_campaignPauses a campaign for the specified Amazon Connect account.id (string) required
connectcampaigns/put_dial_request_batchCreates dials requests for the specified campaign Amazon Connect account. This API is idempotent.id (string) required
dialRequests (array) required
connectcampaigns/resume_campaignStops a campaign for the specified Amazon Connect account.id (string) required
connectcampaigns/start_campaignStarts a campaign for the specified Amazon Connect account.id (string) required
connectcampaigns/start_instance_onboarding_jobOnboard the specific Amazon Connect instance to Connect Campaigns.connectInstanceId (string) required
encryptionConfig: {
. enabled (boolean)
. encryptionType (string)
. keyArn (string)
} (object) required
connectcampaigns/stop_campaignStops a campaign for the specified Amazon Connect account.id (string) required
connectcampaigns/tag_resourceTag a resource.arn (string) required
tags (object) required
connectcampaigns/untag_resourceUntag a resource.arn (string) required
tagKeys (array) required
connectcampaigns/update_campaign_dialer_configUpdates the dialer config of a campaign. This API is idempotent.id (string) required
dialerConfig (undefined) required
connectcampaigns/update_campaign_nameUpdates the name of a campaign. This API is idempotent.id (string) required
name (string) required
connectcampaigns/update_campaign_outbound_call_configUpdates the outbound call config of a campaign. This API is idempotent.id (string) required
connectContactFlowId (string)
connectSourcePhoneNumber (string)
answerMachineDetectionConfig: {
. enableAnswerMachineDetection (boolean)
. awaitAnswerMachinePrompt (boolean)
} (object)
connectcampaignsv2/create_campaignCreates a campaign for the specified Amazon Connect account. This API is idempotent.name (string) required
connectInstanceId (string) required
channelSubtypeConfig: {
. telephony (object)
. sms (object)
. email (object)
. whatsApp (object)
} (object)
type (string)
source (undefined)
connectCampaignFlowArn (string)
schedule: {
. startTime (string)
. endTime (string)
. refreshFrequency (string)
} (object)
communicationTimeConfig: {
. localTimeZoneConfig (object)
. telephony (object)
. sms (object)
. email (object)
. whatsApp (object)
} (object)
communicationLimitsOverride: {
. allChannelSubtypes
. instanceLimitsHandling (string)
} (object)
tags (object)
connectcampaignsv2/delete_campaignDeletes a campaign from the specified Amazon Connect account.id (string) required
connectcampaignsv2/delete_campaign_channel_subtype_configDeletes the channel subtype config of a campaign. This API is idempotent.id (string) required
channelSubtype (string) required
connectcampaignsv2/delete_campaign_communication_limitsDeletes the communication limits config for a campaign. This API is idempotent.id (string) required
config (string) required
connectcampaignsv2/delete_campaign_communication_timeDeletes the communication time config for a campaign. This API is idempotent.id (string) required
config (string) required
connectcampaignsv2/delete_connect_instance_configDeletes a connect instance config from the specified AWS account.connectInstanceId (string) required
campaignDeletionPolicy (string)
connectcampaignsv2/delete_connect_instance_integrationDelete the integration for the specified Amazon Connect instance.connectInstanceId (string) required
integrationIdentifier (undefined) required
connectcampaignsv2/delete_instance_onboarding_jobDelete the Connect Campaigns onboarding job for the specified Amazon Connect instance.connectInstanceId (string) required
connectcampaignsv2/describe_campaignDescribes the specific campaign.id (string) required
connectcampaignsv2/get_campaign_stateGet state of a campaign for the specified Amazon Connect account.id (string) required
connectcampaignsv2/get_campaign_state_batchGet state of campaigns for the specified Amazon Connect account.campaignIds (array) required
connectcampaignsv2/get_connect_instance_configGet the specific Connect instance config.connectInstanceId (string) required
connectcampaignsv2/get_instance_communication_limitsGet the instance communication limits.connectInstanceId (string) required
connectcampaignsv2/get_instance_onboarding_job_statusGet the specific instance onboarding job status.connectInstanceId (string) required
connectcampaignsv2/list_campaignsProvides summary information about the campaigns under the specified Amazon Connect account.maxResults (integer)
nextToken (string)
filters: {
. instanceIdFilter (object)
} (object)
connectcampaignsv2/list_connect_instance_integrationsProvides summary information about the integration under the specified Connect instance.connectInstanceId (string) required
maxResults (integer)
nextToken (string)
connectcampaignsv2/list_tags_for_resourceList tags for a resource.arn (string) required
connectcampaignsv2/pause_campaignPauses a campaign for the specified Amazon Connect account.id (string) required
connectcampaignsv2/put_connect_instance_integrationPut or update the integration for the specified Amazon Connect instance.connectInstanceId (string) required
integrationConfig (undefined) required
connectcampaignsv2/put_instance_communication_limitsPut the instance communication limits. This API is idempotent.connectInstanceId (string) required
communicationLimitsConfig: {
. allChannelSubtypes
} (object) required
connectcampaignsv2/put_outbound_request_batchCreates outbound requests for the specified campaign Amazon Connect account. This API is idempotent.id (string) required
outboundRequests (array) required
connectcampaignsv2/put_profile_outbound_request_batchTakes in a list of profile outbound requests to be placed as part of an outbound campaign. This API is idempotent.id (string) required
profileOutboundRequests (array) required
connectcampaignsv2/resume_campaignStops a campaign for the specified Amazon Connect account.id (string) required
connectcampaignsv2/start_campaignStarts a campaign for the specified Amazon Connect account.id (string) required
connectcampaignsv2/start_instance_onboarding_jobOnboard the specific Amazon Connect instance to Connect Campaigns.connectInstanceId (string) required
encryptionConfig: {
. enabled (boolean)
. encryptionType (string)
. keyArn (string)
} (object) required
connectcampaignsv2/stop_campaignStops a campaign for the specified Amazon Connect account.id (string) required
connectcampaignsv2/tag_resourceTag a resource.arn (string) required
tags (object) required
connectcampaignsv2/untag_resourceUntag a resource.arn (string) required
tagKeys (array) required
connectcampaignsv2/update_campaign_channel_subtype_configUpdates the channel subtype config of a campaign. This API is idempotent.id (string) required
channelSubtypeConfig: {
. telephony (object)
. sms (object)
. email (object)
. whatsApp (object)
} (object) required
connectcampaignsv2/update_campaign_communication_limitsUpdates the communication limits config for a campaign. This API is idempotent.id (string) required
communicationLimitsOverride: {
. allChannelSubtypes
. instanceLimitsHandling (string)
} (object) required
connectcampaignsv2/update_campaign_communication_timeUpdates the communication time config for a campaign. This API is idempotent.id (string) required
communicationTimeConfig: {
. localTimeZoneConfig (object)
. telephony (object)
. sms (object)
. email (object)
. whatsApp (object)
} (object) required
connectcampaignsv2/update_campaign_flow_associationUpdates the campaign flow associated with a campaign. This API is idempotent.id (string) required
connectCampaignFlowArn (string) required
connectcampaignsv2/update_campaign_nameUpdates the name of a campaign. This API is idempotent.id (string) required
name (string) required
connectcampaignsv2/update_campaign_scheduleUpdates the schedule for a campaign. This API is idempotent.id (string) required
schedule: {
. startTime (string)
. endTime (string)
. refreshFrequency (string)
} (object) required
connectcampaignsv2/update_campaign_sourceUpdates the campaign source with a campaign. This API is idempotent.id (string) required
source (undefined) required
connectcases/list_tags_for_resourceLists tags for a resource.arn (string) required
connectcases/tag_resourceAdds tags to a resource.arn (string) required
tags (object) required
connectcases/untag_resourceUntags a resource.arn (string) required
tagKeys (array) required
connectcases/get_case_audit_eventsReturns the audit history about a specific case if it exists.caseId (string) required
domainId (string) required
maxResults (integer)
nextToken (string)
connectcases/list_cases_for_contactLists cases for a given contact.domainId (string) required
contactArn (string) required
maxResults (integer)
nextToken (string)
connectcases/search_casesSearches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents. For customer_id you must provide the full customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID.domainId (string) required
maxResults (integer)
nextToken (string)
searchTerm (string)
filter (undefined)
sorts (array)
fields (array)
connectcases/create_caseIf you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide 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. When creating a case from a template that has tag propagation configurations, the specified tags are automatically applied to the case. The following fields are required when creating a case: customer_id - You must provdomainId (string) required
templateId (string) required
fields (array) required
clientToken (string)
performedBy (undefined)
tags (object)
connectcases/get_caseReturns information about a specific case if it exists.caseId (string) required
domainId (string) required
fields (array) required
nextToken (string)
connectcases/update_caseIf you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide 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.domainId (string) required
caseId (string) required
fields (array) required
performedBy (undefined)
connectcases/delete_caseThe DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot: Retrieve related items Access audit history Perform any operations that require the CaseID This action is irreversible. After you delete a case, you cannot recover its data.domainId (string) required
caseId (string) required
connectcases/create_related_itemCreates a related item comments, tasks, and contacts and associates it with a case. There's a quota for the number of fields allowed in a Custom type related item. See Amazon Connect Cases quotas. Use cases Following are examples of related items that you may want to associate with a case: Related contacts, such as calls, chats, emails tasks Comments, for agent notes SLAs, to capture target resolution goals Cases, to capture related Amazon Connect Cases Files, such as policy documentation or cusdomainId (string) required
caseId (string) required
type (string) required
content (undefined) required
performedBy (undefined)
connectcases/delete_related_itemDeletes the related item resource under a case. This API cannot be used on a FILE type related attachment. To delete this type of file, use the DeleteAttachedFile APIdomainId (string) required
caseId (string) required
relatedItemId (string) required
connectcases/search_related_itemsSearches for related items that are associated with a case. If no filters are provided, this returns all related items associated with a case.domainId (string) required
caseId (string) required
maxResults (integer)
nextToken (string)
filters (array)
connectcases/batch_get_case_ruleGets a batch of case rules. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.domainId (string) required
caseRules (array) required
connectcases/create_case_ruleCreates a new case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.domainId (string) required
name (string) required
description (string)
rule (undefined) required
connectcases/update_case_ruleUpdates a case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.domainId (string) required
caseRuleId (string) required
name (string)
description (string)
rule (undefined)
connectcases/delete_case_ruleDeletes a case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.domainId (string) required
caseRuleId (string) required
connectcases/list_case_rulesLists all case rules in a Cases domain. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.domainId (string) required
maxResults (integer)
nextToken (string)
connectcases/get_case_event_configurationReturns the case event publishing configuration.domainId (string) required
connectcases/put_case_event_configurationAdds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator GuidedomainId (string) required
eventBridge: {
. enabled (boolean)
. includedData (object)
} (object) required
connectcases/search_all_related_itemsSearches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the case-specific SearchRelatedItems API. Use cases Following are common uses cases for this API: Find cases with similar issues across the domain. For example, search for all cases containing comments about 'product defect' to identify patterns and existing solutions. Locate all cases associated with specific contacts or orders. For example, finddomainId (string) required
maxResults (integer)
nextToken (string)
filters (array)
sorts (array)
connectcases/create_domainCreates 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. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.name (string) required
connectcases/get_domainReturns information about a specific domain if it exists.domainId (string) required
connectcases/delete_domainDeletes a Cases domain. After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See DeleteIntegrationAssociation.domainId (string) required
connectcases/list_domainsLists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.maxResults (integer)
nextToken (string)
connectcases/batch_put_field_optionsCreates and updates a set of field options for a single select field in a Cases domain.domainId (string) required
fieldId (string) required
options (array) required
connectcases/list_field_optionsLists all of the field options for a field identifier in the domain.domainId (string) required
fieldId (string) required
maxResults (integer)
nextToken (string)
values (array)
connectcases/batch_get_fieldReturns the description for the list of fields in the request parameters.domainId (string) required
fields (array) required
connectcases/create_fieldCreates 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.domainId (string) required
name (string) required
type (string) required
description (string)
attributes (undefined)
connectcases/update_fieldUpdates the properties of an existing field.domainId (string) required
fieldId (string) required
name (string)
description (string)
attributes (undefined)
connectcases/delete_fieldDeletes a field from a cases template. You can delete up to 100 fields per domain. After a field is deleted: You can still retrieve the field by calling BatchGetField. You cannot update a deleted field by calling UpdateField; it throws a ValidationException. Deleted fields are not included in the ListFields response. Calling CreateCase with a deleted field throws a ValidationException denoting which field identifiers in the request have been deleted. Calling GetCase with a deleted field identifidomainId (string) required
fieldId (string) required
connectcases/list_fieldsLists all fields in a Cases domain.domainId (string) required
maxResults (integer)
nextToken (string)
connectcases/create_layoutCreates 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.domainId (string) required
name (string) required
content (undefined) required
connectcases/get_layoutReturns the details for the requested layout.domainId (string) required
layoutId (string) required
connectcases/update_layoutUpdates 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.domainId (string) required
layoutId (string) required
name (string)
content (undefined)
connectcases/delete_layoutDeletes a layout from a cases template. You can delete up to 100 layouts per domain. After a layout is deleted: You can still retrieve the layout by calling GetLayout. You cannot update a deleted layout by calling UpdateLayout; it throws a ValidationException. Deleted layouts are not included in the ListLayouts response.domainId (string) required
layoutId (string) required
connectcases/list_layoutsLists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.domainId (string) required
maxResults (integer)
nextToken (string)
connectcases/create_templateCreates a template in the Cases domain. This template is used to define the case object model that is, to 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. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases. Other templatedomainId (string) required
name (string) required
description (string)
layoutConfiguration: {
. defaultLayout (string)
} (object)
requiredFields (array)
status (string)
rules (array)
tagPropagationConfigurations (array)
connectcases/get_templateReturns the details for the requested template. Other template APIs are: CreateTemplate DeleteTemplate ListTemplates UpdateTemplatedomainId (string) required
templateId (string) required
connectcases/update_templateUpdates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. 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. Other template APIs are: CreateTemplate DeleteTemplate GetTemplate ListTemplatesdomainId (string) required
templateId (string) required
name (string)
description (string)
layoutConfiguration: {
. defaultLayout (string)
} (object)
requiredFields (array)
status (string)
rules (array)
tagPropagationConfigurations (array)
connectcases/delete_templateDeletes a cases template. You can delete up to 100 templates per domain. After a cases template is deleted: You can still retrieve the template by calling GetTemplate. You cannot update the template. You cannot create a case by using the deleted template. Deleted templates are not included in the ListTemplates response.domainId (string) required
templateId (string) required
connectcases/list_templatesLists all of the templates in a Cases domain. Each list item is a condensed summary object of the template. Other template APIs are: CreateTemplate DeleteTemplate GetTemplate UpdateTemplatedomainId (string) required
maxResults (integer)
nextToken (string)
status (array)
connectparticipant/cancel_participant_authenticationCancels the authentication session. The opted out branch of the Authenticate Customer flow block will be taken. The current supported channel is chat. This API is not supported for Apple Messages for Business, WhatsApp, or SMS chats. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.SessionId (string) required
ConnectionToken (string) required
connectparticipant/complete_attachment_uploadAllows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded. For security recommendations, see Amazon Connect Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.AttachmentIds (array) required
ClientToken (string) required
ConnectionToken (string) required
connectparticipant/create_participant_connectionCreates the participant's connection. For security recommendations, see Amazon Connect Chat security best practices. For WebRTC security recommendations, see Amazon Connect WebRTC security best practices. 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. For WebRTC participants, if they leave or are disconnected for 60 seconds, a new participant needs to be created usinType (array)
ParticipantToken (string) required
ConnectParticipant (boolean)
connectparticipant/describe_viewRetrieves the view for the specified view token. For security recommendations, see Amazon Connect Chat security best practices.ViewToken (string) required
ConnectionToken (string) required
connectparticipant/disconnect_participantDisconnects a participant. For security recommendations, see Amazon Connect Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.ClientToken (string)
ConnectionToken (string) required
connectparticipant/get_attachmentProvides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts. For security recommendations, see Amazon Connect Chat security best practices. The participant role CUSTOM_BOT is not permitted to access attachments customers may upload. An AccessDeniedException can indicate that the participant may be a CUSTOM_BOT, and it doesn't have access to attachments. ConnectionToken is used for invoking this API instead of ParticipantToken. The AmAttachmentId (string) required
ConnectionToken (string) required
UrlExpiryInSeconds (integer)
connectparticipant/get_authentication_urlRetrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block. For security recommendations, see Amazon Connect Chat security best practices. This API can only be called within one minute of receiving the authenticationInitiated event. The current supported channel is chat. This API is not supported for Apple Messages for Business, WhatsApp, or SMS chats. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon ConnectSessionId (string) required
RedirectUri (string) required
ConnectionToken (string) required
connectparticipant/get_transcriptRetrieves a transcript of the session, including details about any attachments. For information about accessing past chat contact transcripts for a persistent chat, see Enable persistent chat. For security recommendations, see Amazon Connect Chat security best practices. If you have a process that consumes events in the transcript of an chat that has ended, note that chat transcripts contain the following event content types if the event has occurred during the chat session: application/vnd.amazContactId (string)
MaxResults (integer)
NextToken (string)
ScanDirection (string)
SortOrder (string)
StartPosition: {
. Id (string)
. AbsoluteTime (string)
. MostRecent (integer)
} (object)
ConnectionToken (string) required
connectparticipant/send_eventThe application/vnd.amazonaws.connect.event.connection.acknowledged ContentType is no longer maintained since December 31, 2024. This event has been migrated to the CreateParticipantConnection API using the ConnectParticipant field. Sends an event. Message receipts are not supported when there are more than two active participants in the chat. Using the SendEvent API for message receipts when a supervisor is barged-in will result in a conflict exception. For security recommendations, see AmazonContentType (string) required
Content (string)
ClientToken (string)
ConnectionToken (string) required
connectparticipant/send_messageSends a message. For security recommendations, see Amazon Connect Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.ContentType (string) required
Content (string) required
ClientToken (string)
ConnectionToken (string) required
connectparticipant/start_attachment_uploadProvides a pre-signed Amazon S3 URL in response for uploading the file directly to S3. For security recommendations, see Amazon Connect Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.ContentType (string) required
AttachmentSizeInBytes (integer) required
AttachmentName (string) required
ClientToken (string) required
ConnectionToken (string) required
controlcatalog/list_control_mappingsReturns a paginated list of control mappings from the Control Catalog. Control mappings show relationships between controls and other entities, such as common controls or compliance frameworks.NextToken (string)
MaxResults (integer)
Filter: {
. ControlArns (array)
. CommonControlArns (array)
. MappingTypes (array)
} (object)
controlcatalog/list_common_controlsReturns a paginated list of common controls from the Amazon Web Services Control Catalog. You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls.MaxResults (integer)
NextToken (string)
CommonControlFilter: {
. Objectives (array)
} (object)
controlcatalog/get_controlReturns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the ControlArn parameter, in ARN form. GetControl accepts controltower or controlcatalog control ARNs as input. Returns a controlcatalog ARN format. In the API response, controls that have the value GLOBAL in the Scope field do not show the DeployableRegions field, because it does not apply. Controls that have the value REGIONAL in the Scope field returnControlArn (string) required
controlcatalog/list_controlsReturns a paginated list of all available controls in the Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type controlSummary. The ARN is returned in the global controlcatalog format, as shown in the examples.NextToken (string)
MaxResults (integer)
Filter: {
. Implementations (object)
} (object)
controlcatalog/list_domainsReturns a paginated list of domains from the Control Catalog.MaxResults (integer)
NextToken (string)
controlcatalog/list_objectivesReturns a paginated list of objectives from the Control Catalog. You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives.MaxResults (integer)
NextToken (string)
ObjectiveFilter: {
. Domains (array)
} (object)
controltower/disable_controlThis API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .controlIdentifier (string)
targetIdentifier (string)
enabledControlIdentifier (string)
controltower/get_baseline_operationReturns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure. For usage examples, see the Amazon Web Services Control Tower User Guide .operationIdentifier (string) required
controltower/get_baselineRetrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .baselineIdentifier (string) required
controltower/list_baselinesReturns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .nextToken (string)
maxResults (integer)
controltower/get_control_operationReturns 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. For usage examples, see the Controls Reference Guide .operationIdentifier (string) required
controltower/list_control_operationsProvides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.filter: {
. controlIdentifiers (array)
. targetIdentifiers (array)
. enabledControlIdentifiers (array)
. statuses (array)
. controlOperationTypes (array)
} (object)
nextToken (string)
maxResults (integer)
controltower/reset_enabled_baselineRe-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .enabledBaselineIdentifier (string) required
controltower/enable_baselineEnable apply a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .baselineVersion (string) required
parameters (array)
baselineIdentifier (string) required
targetIdentifier (string) required
tags (object)
controltower/get_enabled_baselineRetrieve details of an EnabledBaseline resource by specifying its identifier.enabledBaselineIdentifier (string) required
controltower/update_enabled_baselineUpdates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .baselineVersion (string) required
parameters (array)
enabledBaselineIdentifier (string) required
controltower/disable_baselineDisable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see the Amazon Web Services Control Tower User Guide .enabledBaselineIdentifier (string) required
controltower/list_enabled_baselinesReturns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide .filter: {
. targetIdentifiers (array)
. baselineIdentifiers (array)
. parentIdentifiers (array)
. statuses (array)
. inheritanceDriftStatuses (array)
} (object)
nextToken (string)
maxResults (integer)
includeChildren (boolean)
controltower/reset_enabled_controlResets an enabled control. Does not work for controls implemented with SCPs.enabledControlIdentifier (string) required
controltower/enable_controlThis API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .controlIdentifier (string) required
targetIdentifier (string) required
tags (object)
parameters (array)
controltower/get_enabled_controlRetrieves details about an enabled control. For usage examples, see the Controls Reference Guide .enabledControlIdentifier (string) required
controltower/update_enabled_controlUpdates the configuration of an already enabled control. If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request. If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply. If the DriftSummary status for the control shows as DRIFTED, you cparameters (array) required
enabledControlIdentifier (string) required
controltower/list_enabled_controlsLists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Controls Reference Guide .targetIdentifier (string)
nextToken (string)
maxResults (integer)
filter: {
. controlIdentifiers (array)
. statuses (array)
. driftStatuses (array)
. parentIdentifiers (array)
. inheritanceDriftStatuses (array)
. resourceDriftStatuses (array)
} (object)
includeChildren (boolean)
controltower/get_landing_zone_operationReturns the status of the specified landing zone operation. Details for an operation are available for 90 days.operationIdentifier (string) required
controltower/list_landing_zone_operationsLists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.filter: {
. types (array)
. statuses (array)
} (object)
nextToken (string)
maxResults (integer)
controltower/reset_landing_zoneThis API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in the original configuration, which you specified in the manifest file. Nothing in the manifest file's original landing zone configuration is changed during the reset process, by default. This API is not the same as a rollback of a landing zone version, which is not a supported operation.landingZoneIdentifier (string) required
controltower/create_landing_zoneCreates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.version (string) required
remediationTypes (array)
tags (object)
manifest (undefined)
controltower/get_landing_zoneReturns details about the landing zone. Displays a message in case of error.landingZoneIdentifier (string) required
controltower/update_landing_zoneThis API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.version (string) required
remediationTypes (array)
landingZoneIdentifier (string) required
manifest (undefined)
controltower/delete_landing_zoneDecommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower. Decommissioning a landing zone is a process with significant consequences, and it cannot be undone. We strongly recommend that you perform this decommissioning process only if you intend to stop using your landing zone.landingZoneIdentifier (string) required
controltower/list_landing_zonesReturns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN. Returns one landing zone ARN.nextToken (string)
maxResults (integer)
controltower/tag_resourceApplies tags to a resource. For usage examples, see the Controls Reference Guide .resourceArn (string) required
tags (object) required
controltower/untag_resourceRemoves tags from a resource. For usage examples, see the Controls Reference Guide .resourceArn (string) required
tagKeys (array) required
controltower/list_tags_for_resourceReturns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .resourceArn (string) required
cost_and_usage_report_service/delete_report_definitionDeletes the specified report. Any tags associated with the report are also deleted.ReportName (string) required
cost_and_usage_report_service/describe_report_definitionsLists the Amazon Web Services Cost and Usage Report available to this account.MaxResults (integer)
NextToken (string)
cost_and_usage_report_service/list_tags_for_resourceLists the tags associated with the specified report definition.ReportName (string) required
cost_and_usage_report_service/modify_report_definitionAllows you to programmatically update your report preferences.ReportName (string) required
ReportDefinition: {
. ReportName (string)
. TimeUnit (string)
. Format (string)
. Compression (string)
. AdditionalSchemaElements (array)
. S3Bucket (string)
. S3Prefix (string)
. S3Region (string)
. AdditionalArtifacts (array)
. RefreshClosedReports (boolean)
. ReportVersioning (string)
. BillingViewArn (string)
. ReportStatus (object)
} (object) required
cost_and_usage_report_service/put_report_definitionCreates a new report using the description that you provide.ReportDefinition: {
. ReportName (string)
. TimeUnit (string)
. Format (string)
. Compression (string)
. AdditionalSchemaElements (array)
. S3Bucket (string)
. S3Prefix (string)
. S3Region (string)
. AdditionalArtifacts (array)
. RefreshClosedReports (boolean)
. ReportVersioning (string)
. BillingViewArn (string)
. ReportStatus (object)
} (object) required
Tags (array)
cost_and_usage_report_service/tag_resourceAssociates a set of tags with a report definition.ReportName (string) required
Tags (array) required
cost_and_usage_report_service/untag_resourceDisassociates a set of tags from a report definition.ReportName (string) required
TagKeys (array) required
cost_explorer/create_anomaly_monitorCreates a new cost anomaly detection monitor with the requested type and monitor specification.AnomalyMonitor: {
. MonitorArn (string)
. MonitorName (string)
. CreationDate (string)
. LastUpdatedDate (string)
. LastEvaluatedDate (string)
. MonitorType (string)
. MonitorDimension (string)
. MonitorSpecification (object)
. DimensionalValueCount (integer)
} (object) required
ResourceTags (array)
cost_explorer/create_anomaly_subscriptionAdds an alert subscription to a cost anomaly detection monitor. You can use each subscription to define subscribers with email or SNS notifications. Email subscribers can set an absolute or percentage threshold and a time frequency for receiving notifications.AnomalySubscription: {
. SubscriptionArn (string)
. AccountId (string)
. MonitorArnList (array)
. Subscribers (array)
. Threshold (number)
. Frequency (string)
. SubscriptionName (string)
. ThresholdExpression (object)
} (object) required
ResourceTags (array)
cost_explorer/create_cost_category_definitionCreates a new cost category with the requested name and rules.Name (string) required
EffectiveStart (string)
RuleVersion (string) required
Rules (array) required
DefaultValue (string)
SplitChargeRules (array)
ResourceTags (array)
cost_explorer/delete_anomaly_monitorDeletes a cost anomaly monitor.MonitorArn (string) required
cost_explorer/delete_anomaly_subscriptionDeletes a cost anomaly subscription.SubscriptionArn (string) required
cost_explorer/delete_cost_category_definitionDeletes a cost category. Expenses from this month going forward will no longer be categorized with this cost category.CostCategoryArn (string) required
cost_explorer/describe_cost_category_definitionReturns 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.CostCategoryArn (string) required
EffectiveOn (string)
cost_explorer/get_anomaliesRetrieves all of the cost anomalies detected on your account during the time period that's specified by the DateInterval object. Anomalies are available for up to 90 days.MonitorArn (string)
DateInterval: {
. StartDate (string)
. EndDate (string)
} (object) required
Feedback (string)
TotalImpact: {
. NumericOperator (string)
. StartValue (number)
. EndValue (number)
} (object)
NextPageToken (string)
MaxResults (integer)
cost_explorer/get_anomaly_monitorsRetrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names ARNs.MonitorArnList (array)
NextPageToken (string)
MaxResults (integer)
cost_explorer/get_anomaly_subscriptionsRetrieves the cost anomaly subscription objects for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names ARNs.SubscriptionArnList (array)
MonitorArn (string)
NextPageToken (string)
MaxResults (integer)
cost_explorer/get_approximate_usage_recordsRetrieves estimated usage records for hourly granularity or resource-level data at daily granularity.Granularity (string) required
Services (array)
ApproximationDimension (string) required
cost_explorer/get_commitment_purchase_analysisRetrieves a commitment purchase analysis result based on the AnalysisId.AnalysisId (string) required
cost_explorer/get_cost_and_usageRetrieves 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 abTimePeriod: {
. Start (string)
. End (string)
} (object) required
Granularity (string) required
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
Metrics (array) required
GroupBy (array)
BillingViewArn (string)
NextPageToken (string)
cost_explorer/get_cost_and_usage_comparisonsRetrieves cost and usage comparisons for your account between two periods within the last 13 months. If you have enabled multi-year data at monthly granularity, you can go back up to 38 months.BillingViewArn (string)
BaselineTimePeriod: {
. Start (string)
. End (string)
} (object) required
ComparisonTimePeriod: {
. Start (string)
. End (string)
} (object) required
MetricForComparison (string) required
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
GroupBy (array)
MaxResults (integer)
NextPageToken (string)
cost_explorer/get_cost_and_usage_with_resourcesRetrieves 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. Hourly granularity is oTimePeriod: {
. Start (string)
. End (string)
} (object) required
Granularity (string) required
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object) required
Metrics (array)
GroupBy (array)
BillingViewArn (string)
NextPageToken (string)
cost_explorer/get_cost_categoriesRetrieves 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.SearchString (string)
TimePeriod: {
. Start (string)
. End (string)
} (object) required
CostCategoryName (string)
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
SortBy (array)
BillingViewArn (string)
MaxResults (integer)
NextPageToken (string)
cost_explorer/get_cost_comparison_driversRetrieves key factors driving cost changes between two time periods within the last 13 months, such as usage changes, discount changes, and commitment-based savings. If you have enabled multi-year data at monthly granularity, you can go back up to 38 months.BillingViewArn (string)
BaselineTimePeriod: {
. Start (string)
. End (string)
} (object) required
ComparisonTimePeriod: {
. Start (string)
. End (string)
} (object) required
MetricForComparison (string) required
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
GroupBy (array)
MaxResults (integer)
NextPageToken (string)
cost_explorer/get_cost_forecastRetrieves 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.TimePeriod: {
. Start (string)
. End (string)
} (object) required
Metric (string) required
Granularity (string) required
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
BillingViewArn (string)
PredictionIntervalLevel (integer)
cost_explorer/get_dimension_valuesRetrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.SearchString (string)
TimePeriod: {
. Start (string)
. End (string)
} (object) required
Dimension (string) required
Context (string)
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
SortBy (array)
BillingViewArn (string)
MaxResults (integer)
NextPageToken (string)
cost_explorer/get_reservation_coverageRetrieves 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_ENTimePeriod: {
. Start (string)
. End (string)
} (object) required
GroupBy (array)
Granularity (string)
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
Metrics (array)
NextPageToken (string)
SortBy: {
. Key (string)
. SortOrder (string)
} (object)
MaxResults (integer)
cost_explorer/get_reservation_purchase_recommendationGets 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 categorAccountId (string)
Service (string) required
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
AccountScope (string)
LookbackPeriodInDays (string)
TermInYears (string)
PaymentOption (string)
ServiceSpecification: {
. EC2Specification (object)
} (object)
PageSize (integer)
NextPageToken (string)
cost_explorer/get_reservation_utilizationRetrieves 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.TimePeriod: {
. Start (string)
. End (string)
} (object) required
GroupBy (array)
Granularity (string)
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
SortBy: {
. Key (string)
. SortOrder (string)
} (object)
NextPageToken (string)
MaxResults (integer)
cost_explorer/get_rightsizing_recommendationCreates 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.Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
Configuration: {
. RecommendationTarget (string)
. BenefitsConsidered (boolean)
} (object)
Service (string) required
PageSize (integer)
NextPageToken (string)
cost_explorer/get_savings_plan_purchase_recommendation_detailsRetrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts.RecommendationDetailId (string) required
cost_explorer/get_savings_plans_coverageRetrieves 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 GetDimensionValueTimePeriod: {
. Start (string)
. End (string)
} (object) required
GroupBy (array)
Granularity (string)
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
Metrics (array)
NextToken (string)
MaxResults (integer)
SortBy: {
. Key (string)
. SortOrder (string)
} (object)
cost_explorer/get_savings_plans_purchase_recommendationRetrieves the Savings Plans recommendations for your account. First use StartSavingsPlansPurchaseRecommendationGeneration to generate a new set of recommendations, and then use GetSavingsPlansPurchaseRecommendation to retrieve them.SavingsPlansType (string) required
TermInYears (string) required
PaymentOption (string) required
AccountScope (string)
NextPageToken (string)
PageSize (integer)
LookbackPeriodInDays (string) required
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
cost_explorer/get_savings_plans_utilizationRetrieves 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.TimePeriod: {
. Start (string)
. End (string)
} (object) required
Granularity (string)
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
SortBy: {
. Key (string)
. SortOrder (string)
} (object)
cost_explorer/get_savings_plans_utilization_detailsRetrieves 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. GetSavingsPlanUtilizationDetaTimePeriod: {
. Start (string)
. End (string)
} (object) required
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
DataType (array)
NextToken (string)
MaxResults (integer)
SortBy: {
. Key (string)
. SortOrder (string)
} (object)
cost_explorer/get_tagsQueries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.SearchString (string)
TimePeriod: {
. Start (string)
. End (string)
} (object) required
TagKey (string)
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
SortBy (array)
BillingViewArn (string)
MaxResults (integer)
NextPageToken (string)
cost_explorer/get_usage_forecastRetrieves 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.TimePeriod: {
. Start (string)
. End (string)
} (object) required
Metric (string) required
Granularity (string) required
Filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
BillingViewArn (string)
PredictionIntervalLevel (integer)
cost_explorer/list_commitment_purchase_analysesLists the commitment purchase analyses for your account.AnalysisStatus (string)
NextPageToken (string)
PageSize (integer)
AnalysisIds (array)
cost_explorer/list_cost_allocation_tag_backfill_historyRetrieves a list of your historical cost allocation tag backfill requests.NextToken (string)
MaxResults (integer)
cost_explorer/list_cost_allocation_tagsGet 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.Status (string)
TagKeys (array)
Type (string)
NextToken (string)
MaxResults (integer)
cost_explorer/list_cost_category_definitionsReturns 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 and SupportedResourceTypes 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. TheEffectiveOn (string)
NextToken (string)
MaxResults (integer)
SupportedResourceTypes (array)
cost_explorer/list_cost_category_resource_associationsReturns resource associations of all cost categories defined in the account. You have the option to use CostCategoryArn to get the association for a specific cost category. ListCostCategoryResourceAssociations supports pagination. The request can have a MaxResults range up to 100.CostCategoryArn (string)
NextToken (string)
MaxResults (integer)
cost_explorer/list_savings_plans_purchase_recommendation_generationRetrieves a list of your historical recommendation generations within the past 30 days.GenerationStatus (string)
RecommendationIds (array)
PageSize (integer)
NextPageToken (string)
cost_explorer/list_tags_for_resourceReturns a list of resource tags associated with the resource specified by the Amazon Resource Name ARN.ResourceArn (string) required
cost_explorer/provide_anomaly_feedbackModifies the feedback property of a given cost anomaly.AnomalyId (string) required
Feedback (string) required
cost_explorer/start_commitment_purchase_analysisSpecifies the parameters of a planned commitment purchase and starts the generation of the analysis. This enables you to estimate the cost, coverage, and utilization impact of your planned commitment purchases.CommitmentPurchaseAnalysisConfiguration: {
. SavingsPlansPurchaseAnalysisConfiguration (object)
} (object) required
cost_explorer/start_cost_allocation_tag_backfillRequest a cost allocation tag backfill. This will backfill the activation status either active or inactive for all tag keys from para:BackfillFrom up to the time this request is made. You can request a backfill once every 24 hours.BackfillFrom (string) required
cost_explorer/start_savings_plans_purchase_recommendation_generationRequests a Savings Plans recommendation generation. This enables you to calculate a fresh set of Savings Plans recommendations that takes your latest usage data and current Savings Plans inventory into account. You can refresh Savings Plans recommendations up to three times daily for a consolidated billing family. StartSavingsPlansPurchaseRecommendationGeneration has no request syntax because no input parameters are needed to support this operation.No parameters
cost_explorer/tag_resourceAn 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 remaiResourceArn (string) required
ResourceTags (array) required
cost_explorer/untag_resourceRemoves one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.ResourceArn (string) required
ResourceTagKeys (array) required
cost_explorer/update_anomaly_monitorUpdates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past.MonitorArn (string) required
MonitorName (string)
cost_explorer/update_anomaly_subscriptionUpdates an existing cost anomaly subscription. Specify the fields that you want to update. Omitted fields are unchanged. The JSON below describes the generic construct for each type. See Request Parameters for possible values as they apply to AnomalySubscription.SubscriptionArn (string) required
Threshold (number)
Frequency (string)
MonitorArnList (array)
Subscribers (array)
SubscriptionName (string)
ThresholdExpression: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
. Tags (object)
. CostCategories (object)
} (object)
cost_explorer/update_cost_allocation_tags_statusUpdates 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.CostAllocationTagsStatus (array) required
cost_explorer/update_cost_category_definitionUpdates 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.CostCategoryArn (string) required
EffectiveStart (string)
RuleVersion (string) required
Rules (array) required
DefaultValue (string)
SplitChargeRules (array)
cost_optimization_hub/get_preferencesReturns a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented—estimated savings after discounts or estimated savings before discounts, for example.No parameters
cost_optimization_hub/get_recommendationReturns both the current and recommended resource configuration and the estimated cost impact for a recommendation. The recommendationId is only valid for up to a maximum of 24 hours as recommendations are refreshed daily. To retrieve the recommendationId, use the ListRecommendations API.recommendationId (string) required
cost_optimization_hub/list_efficiency_metricsReturns cost efficiency metrics aggregated over time and optionally grouped by a specified dimension. The metrics provide insights into your cost optimization progress by tracking estimated savings, spending, and measures how effectively you're optimizing your Cloud resources. The operation supports both daily and monthly time granularities and allows grouping results by account ID, Amazon Web Services Region. Results are returned as time-series data, enabling you to analyze trends in your costgroupBy (string)
granularity (string) required
timePeriod: {
. start (string)
. end (string)
} (object) required
maxResults (integer)
orderBy: {
. dimension (string)
. order (string)
} (object)
nextToken (string)
cost_optimization_hub/list_enrollment_statusesRetrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.includeOrganizationInfo (boolean)
accountId (string)
nextToken (string)
maxResults (integer)
cost_optimization_hub/list_recommendationsReturns a list of recommendations.filter: {
. restartNeeded (boolean)
. rollbackPossible (boolean)
. implementationEfforts (array)
. accountIds (array)
. regions (array)
. resourceTypes (array)
. actionTypes (array)
. tags (array)
. resourceIds (array)
. resourceArns (array)
. recommendationIds (array)
} (object)
orderBy: {
. dimension (string)
. order (string)
} (object)
includeAllRecommendations (boolean)
maxResults (integer)
nextToken (string)
cost_optimization_hub/list_recommendation_summariesReturns a concise representation of savings estimates for resources. Also returns de-duped savings across different types of recommendations. The following filters are not supported for this API: recommendationIds, resourceArns, and resourceIds.filter: {
. restartNeeded (boolean)
. rollbackPossible (boolean)
. implementationEfforts (array)
. accountIds (array)
. regions (array)
. resourceTypes (array)
. actionTypes (array)
. tags (array)
. resourceIds (array)
. resourceArns (array)
. recommendationIds (array)
} (object)
groupBy (string) required
maxResults (integer)
metrics (array)
nextToken (string)
cost_optimization_hub/update_enrollment_statusUpdates the enrollment opt in and opt out status of an account to the Cost Optimization Hub 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 Cost Optimization Hub and to view its recommendations. When you opt in, Cost Optimization Hub automatically creates a service-linked role in your account to access its data.status (string) required
includeMemberAccounts (boolean)
cost_optimization_hub/update_preferencesUpdates a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented.savingsEstimationMode (string)
memberAccountDiscountVisibility (string)
preferredCommitment: {
. term (string)
. paymentOption (string)
} (object)
customer_profiles/add_profile_keyAssociates 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.ProfileId (string) required
KeyName (string) required
Values (array) required
DomainName (string) required
customer_profiles/batch_get_calculated_attribute_for_profileFetch the possible attribute values given the attribute name.CalculatedAttributeName (string) required
DomainName (string) required
ProfileIds (array) required
ConditionOverrides: {
. Range (object)
} (object)
customer_profiles/batch_get_profileGet a batch of profiles.DomainName (string) required
ProfileIds (array) required
customer_profiles/create_calculated_attribute_definitionCreates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one ObjectType and at most, two fields from that ObjectType.DomainName (string) required
CalculatedAttributeName (string) required
DisplayName (string)
Description (string)
AttributeDetails: {
. Attributes (array)
. Expression (string)
} (object) required
Conditions: {
. Range (object)
. ObjectCount (integer)
. Threshold (object)
} (object)
Filter: {
. Include (string)
. Groups (array)
} (object)
Statistic (string) required
UseHistoricalData (boolean)
Tags (object)
customer_profiles/create_domainCreates 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 impersonationDomainName (string) required
DefaultExpirationDays (integer) required
DefaultEncryptionKey (string)
DeadLetterQueueUrl (string)
Matching: {
. Enabled (boolean)
. JobSchedule (object)
. AutoMerging (object)
. ExportingConfig (object)
} (object)
RuleBasedMatching: {
. Enabled (boolean)
. MatchingRules (array)
. MaxAllowedRuleLevelForMerging (integer)
. MaxAllowedRuleLevelForMatching (integer)
. AttributeTypesSelector (object)
. ConflictResolution (object)
. ExportingConfig (object)
} (object)
DataStore: {
. Enabled (boolean)
} (object)
Tags (object)
customer_profiles/create_domain_layoutCreates the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.DomainName (string) required
LayoutDefinitionName (string) required
Description (string) required
DisplayName (string) required
IsDefault (boolean)
LayoutType (string) required
Layout (string) required
Tags (object)
customer_profiles/create_event_streamCreates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles. Each event stream can be associated with only one Kinesis Data Stream destination in the same region and Amazon Web Services account as the customer profiles domainDomainName (string) required
Uri (string) required
EventStreamName (string) required
Tags (object)
customer_profiles/create_event_triggerCreates an event trigger, which specifies the rules when to perform action based on customer's ingested data. Each event stream can be associated with only one integration in the same region and AWS account as the event stream.DomainName (string) required
EventTriggerName (string) required
ObjectTypeName (string) required
Description (string)
EventTriggerConditions (array) required
SegmentFilter (string)
EventTriggerLimits: {
. EventExpiration (integer)
. Periods (array)
} (object)
Tags (object)
customer_profiles/create_integration_workflowCreates 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.DomainName (string) required
WorkflowType (string) required
IntegrationConfig: {
. AppflowIntegration (object)
} (object) required
ObjectTypeName (string) required
RoleArn (string) required
Tags (object)
customer_profiles/create_profileCreates a standard profile. A standard profile represents the following attributes for a customer profile in a domain.DomainName (string) required
AccountNumber (string)
AdditionalInformation (string)
PartyType (string)
BusinessName (string)
FirstName (string)
MiddleName (string)
LastName (string)
BirthDate (string)
Gender (string)
PhoneNumber (string)
MobilePhoneNumber (string)
HomePhoneNumber (string)
BusinessPhoneNumber (string)
EmailAddress (string)
PersonalEmailAddress (string)
BusinessEmailAddress (string)
Address: {
. Address1 (string)
. Address2 (string)
. Address3 (string)
. Address4 (string)
. City (string)
. County (string)
. State (string)
. Province (string)
. Country (string)
. PostalCode (string)
} (object)
ShippingAddress: {
. Address1 (string)
. Address2 (string)
. Address3 (string)
. Address4 (string)
. City (string)
. County (string)
. State (string)
. Province (string)
. Country (string)
. PostalCode (string)
} (object)
MailingAddress: {
. Address1 (string)
. Address2 (string)
. Address3 (string)
. Address4 (string)
. City (string)
. County (string)
. State (string)
. Province (string)
. Country (string)
. PostalCode (string)
} (object)
BillingAddress: {
. Address1 (string)
. Address2 (string)
. Address3 (string)
. Address4 (string)
. City (string)
. County (string)
. State (string)
. Province (string)
. Country (string)
. PostalCode (string)
} (object)
Attributes (object)
PartyTypeString (string)
GenderString (string)
ProfileType (string)
EngagementPreferences: {
. Phone (array)
. Email (array)
} (object)
customer_profiles/create_recommenderCreates a recommenderDomainName (string) required
RecommenderName (string) required
RecommenderRecipeName (string) required
RecommenderConfig: {
. EventsConfig (object)
. TrainingFrequency (integer)
} (object)
Description (string)
Tags (object)
customer_profiles/create_segment_definitionCreates a segment definition associated to the given domain.DomainName (string) required
SegmentDefinitionName (string) required
DisplayName (string) required
Description (string)
SegmentGroups: {
. Groups (array)
. Include (string)
} (object)
SegmentSqlQuery (string)
Tags (object)
customer_profiles/create_segment_estimateCreates a segment estimate query.DomainName (string) required
SegmentQuery: {
. Groups (array)
. Include (string)
} (object)
SegmentSqlQuery (string)
customer_profiles/create_segment_snapshotTriggers a job to export a segment to a specified destination.DomainName (string) required
SegmentDefinitionName (string) required
DataFormat (string) required
EncryptionKey (string)
RoleArn (string)
DestinationUri (string)
customer_profiles/create_upload_jobCreates an Upload job to ingest data for segment imports. The metadata is created for the job with the provided field mapping and unique key.DomainName (string) required
DisplayName (string) required
Fields (object) required
UniqueKey (string) required
DataExpiry (integer)
customer_profiles/delete_calculated_attribute_definitionDeletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.DomainName (string) required
CalculatedAttributeName (string) required
customer_profiles/delete_domainDeletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.DomainName (string) required
customer_profiles/delete_domain_layoutDeletes the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.DomainName (string) required
LayoutDefinitionName (string) required
customer_profiles/delete_domain_object_typeDelete a DomainObjectType for the given Domain and ObjectType name.DomainName (string) required
ObjectTypeName (string) required
customer_profiles/delete_event_streamDisables and deletes the specified event stream.DomainName (string) required
EventStreamName (string) required
customer_profiles/delete_event_triggerDisable and deletes the Event Trigger. You cannot delete an Event Trigger with an active Integration associated.DomainName (string) required
EventTriggerName (string) required
customer_profiles/delete_integrationRemoves an integration from a specific domain.DomainName (string) required
Uri (string) required
customer_profiles/delete_profileDeletes the standard customer profile and all data pertaining to the profile.ProfileId (string) required
DomainName (string) required
customer_profiles/delete_profile_keyRemoves a searchable key from a customer profile.ProfileId (string) required
KeyName (string) required
Values (array) required
DomainName (string) required
customer_profiles/delete_profile_objectRemoves an object associated with a profile of a given ProfileObjectType.ProfileId (string) required
ProfileObjectUniqueKey (string) required
ObjectTypeName (string) required
DomainName (string) required
customer_profiles/delete_profile_object_typeRemoves 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.DomainName (string) required
ObjectTypeName (string) required
customer_profiles/delete_recommenderDeletes a recommender.DomainName (string) required
RecommenderName (string) required
customer_profiles/delete_segment_definitionDeletes a segment definition from the domain.DomainName (string) required
SegmentDefinitionName (string) required
customer_profiles/delete_workflowDeletes the specified workflow and all its corresponding resources. This is an async process.DomainName (string) required
WorkflowId (string) required
customer_profiles/detect_profile_object_typeThe process of detecting profile object type mapping by using given objects.Objects (array) required
DomainName (string) required
customer_profiles/get_auto_merging_previewTests 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 beDomainName (string) required
Consolidation: {
. MatchingAttributesList (array)
} (object) required
ConflictResolution: {
. ConflictResolvingModel (string)
. SourceName (string)
} (object) required
MinAllowedConfidenceScoreForMerging (number)
customer_profiles/get_calculated_attribute_definitionProvides more information on a calculated attribute definition for Customer Profiles.DomainName (string) required
CalculatedAttributeName (string) required
customer_profiles/get_calculated_attribute_for_profileRetrieve a calculated attribute for a customer profile.DomainName (string) required
ProfileId (string) required
CalculatedAttributeName (string) required
customer_profiles/get_domainReturns information about a specific domain.DomainName (string) required
customer_profiles/get_domain_layoutGets the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.DomainName (string) required
LayoutDefinitionName (string) required
customer_profiles/get_domain_object_typeReturn a DomainObjectType for the input Domain and ObjectType names.DomainName (string) required
ObjectTypeName (string) required
customer_profiles/get_event_streamReturns information about the specified event stream in a specific domain.DomainName (string) required
EventStreamName (string) required
customer_profiles/get_event_triggerGet a specific Event Trigger from the domain.DomainName (string) required
EventTriggerName (string) required
customer_profiles/get_identity_resolution_jobReturns 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.DomainName (string) required
JobId (string) required
customer_profiles/get_integrationReturns an integration for a domain.DomainName (string) required
Uri (string) required
customer_profiles/get_matchesBefore 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 atNextToken (string)
MaxResults (integer)
DomainName (string) required
customer_profiles/get_object_type_attribute_statisticsThe GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled. This API performs daily calculations to provide statistical information about your attribute values, helping you understand patterns and trends in your data. The statistical calculations are performed once per day, providing a consistent snapshot of your attribute data characteristics. You'll receive null values in twDomainName (string) required
ObjectTypeName (string) required
AttributeName (string) required
customer_profiles/get_profile_history_recordReturns a history record for a specific profile, for a specific domain.DomainName (string) required
ProfileId (string) required
Id (string) required
customer_profiles/get_profile_object_typeReturns the object types for a specific domain.DomainName (string) required
ObjectTypeName (string) required
customer_profiles/get_profile_object_type_templateReturns 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.TemplateId (string) required
customer_profiles/get_profile_recommendationsFetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendationsDomainName (string) required
ProfileId (string) required
RecommenderName (string) required
Context (object)
MaxResults (integer)
customer_profiles/get_recommenderRetrieves a recommender.DomainName (string) required
RecommenderName (string) required
TrainingMetricsCount (integer)
customer_profiles/get_segment_definitionGets a segment definition from the domain.DomainName (string) required
SegmentDefinitionName (string) required
customer_profiles/get_segment_estimateGets the result of a segment estimate query.DomainName (string) required
EstimateId (string) required
customer_profiles/get_segment_membershipDetermines if the given profiles are within a segment.DomainName (string) required
SegmentDefinitionName (string) required
ProfileIds (array) required
customer_profiles/get_segment_snapshotRetrieve the latest status of a segment snapshot.DomainName (string) required
SegmentDefinitionName (string) required
SnapshotId (string) required
customer_profiles/get_similar_profilesReturns a set of profiles that belong to the same matching group using the matchId or profileId. You can also specify the type of matching that you want for finding similar profiles using either RULE_BASED_MATCHING or ML_BASED_MATCHING.NextToken (string)
MaxResults (integer)
DomainName (string) required
MatchType (string) required
SearchKey (string) required
SearchValue (string) required
customer_profiles/get_upload_jobThis API retrieves the details of a specific upload job.DomainName (string) required
JobId (string) required
customer_profiles/get_upload_job_pathThis API retrieves the pre-signed URL and client token for uploading the file associated with the upload job.DomainName (string) required
JobId (string) required
customer_profiles/get_workflowGet details of specified workflow.DomainName (string) required
WorkflowId (string) required
customer_profiles/get_workflow_stepsGet granular list of steps in workflow.DomainName (string) required
WorkflowId (string) required
NextToken (string)
MaxResults (integer)
customer_profiles/list_account_integrationsLists all of the integrations associated to a specific URI in the AWS account.Uri (string) required
NextToken (string)
MaxResults (integer)
IncludeHidden (boolean)
customer_profiles/list_calculated_attribute_definitionsLists calculated attribute definitions for Customer ProfilesDomainName (string) required
NextToken (string)
MaxResults (integer)
customer_profiles/list_calculated_attributes_for_profileRetrieve a list of calculated attributes for a customer profile.NextToken (string)
MaxResults (integer)
DomainName (string) required
ProfileId (string) required
customer_profiles/list_domain_layoutsLists the existing layouts that can be used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.DomainName (string) required
NextToken (string)
MaxResults (integer)
customer_profiles/list_domain_object_typesList all DomainObjectTypes in a Customer Profiles domain.DomainName (string) required
MaxResults (integer)
NextToken (string)
customer_profiles/list_domainsReturns a list of all the domains for an AWS account that have been created.NextToken (string)
MaxResults (integer)
customer_profiles/list_event_streamsReturns a list of all the event streams in a specific domain.DomainName (string) required
NextToken (string)
MaxResults (integer)
customer_profiles/list_event_triggersList all Event Triggers under a domain.DomainName (string) required
NextToken (string)
MaxResults (integer)
customer_profiles/list_identity_resolution_jobsLists all of the Identity Resolution Jobs in your domain. The response sorts the list by JobStartTime.DomainName (string) required
NextToken (string)
MaxResults (integer)
customer_profiles/list_integrationsLists all of the integrations in your domain.DomainName (string) required
NextToken (string)
MaxResults (integer)
IncludeHidden (boolean)
customer_profiles/list_object_type_attributesFetch the possible attribute values given the attribute name.NextToken (string)
MaxResults (integer)
DomainName (string) required
ObjectTypeName (string) required
customer_profiles/list_object_type_attribute_valuesThe ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data validation and consistency checks within your object types. This API works across domain, supporting both custom and standard object types. The API accepts the object type name, attribute name, and domain name as input parameters and returns values up to the storage limit of approximately 350KB.NextToken (string)
MaxResults (integer)
DomainName (string) required
ObjectTypeName (string) required
AttributeName (string) required
customer_profiles/list_profile_attribute_valuesFetch the possible attribute values given the attribute name.DomainName (string) required
AttributeName (string) required
customer_profiles/list_profile_history_recordsReturns a list of history records for a specific profile, for a specific domain.DomainName (string) required
ProfileId (string) required
ObjectTypeName (string)
NextToken (string)
MaxResults (integer)
ActionType (string)
PerformedBy (string)
customer_profiles/list_profile_objectsReturns a list of objects associated with a profile of a given ProfileObjectType.NextToken (string)
MaxResults (integer)
DomainName (string) required
ObjectTypeName (string) required
ProfileId (string) required
ObjectFilter: {
. KeyName (string)
. Values (array)
} (object)
customer_profiles/list_profile_object_typesLists all of the templates available within the service.DomainName (string) required
NextToken (string)
MaxResults (integer)
customer_profiles/list_profile_object_type_templatesLists all of the template information for object types.NextToken (string)
MaxResults (integer)
customer_profiles/list_recommender_recipesReturns a list of available recommender recipes that can be used to create recommenders.MaxResults (integer)
NextToken (string)
customer_profiles/list_recommendersReturns a list of recommenders in the specified domain.DomainName (string) required
MaxResults (integer)
NextToken (string)
customer_profiles/list_rule_based_matchesReturns a set of MatchIds that belong to the given domain.NextToken (string)
MaxResults (integer)
DomainName (string) required
customer_profiles/list_segment_definitionsLists all segment definitions under a domain.DomainName (string) required
MaxResults (integer)
NextToken (string)
customer_profiles/list_tags_for_resourceDisplays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.resourceArn (string) required
customer_profiles/list_upload_jobsThis API retrieves a list of upload jobs for the specified domain.DomainName (string) required
MaxResults (integer)
NextToken (string)
customer_profiles/list_workflowsQuery to list all workflows.DomainName (string) required
WorkflowType (string)
Status (string)
QueryStartDate (string)
QueryEndDate (string)
NextToken (string)
MaxResults (integer)
customer_profiles/merge_profilesRuns 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 fDomainName (string) required
MainProfileId (string) required
ProfileIdsToBeMerged (array) required
FieldSourceProfileIds: {
. AccountNumber (string)
. AdditionalInformation (string)
. PartyType (string)
. BusinessName (string)
. FirstName (string)
. MiddleName (string)
. LastName (string)
. BirthDate (string)
. Gender (string)
. PhoneNumber (string)
. MobilePhoneNumber (string)
. HomePhoneNumber (string)
. BusinessPhoneNumber (string)
. EmailAddress (string)
. PersonalEmailAddress (string)
. BusinessEmailAddress (string)
. Address (string)
. ShippingAddress (string)
. MailingAddress (string)
. BillingAddress (string)
. Attributes (object)
. ProfileType (string)
. EngagementPreferences (string)
} (object)
customer_profiles/put_domain_object_typeCreate/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain.DomainName (string) required
ObjectTypeName (string) required
Description (string)
EncryptionKey (string)
Fields (object) required
Tags (object)
customer_profiles/put_integrationAdds 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.DomainName (string) required
Uri (string)
ObjectTypeName (string)
ObjectTypeNames (object)
Tags (object)
FlowDefinition: {
. Description (string)
. FlowName (string)
. KmsArn (string)
. SourceFlowConfig (object)
. Tasks (array)
. TriggerConfig (object)
} (object)
RoleArn (string)
EventTriggerNames (array)
Scope (string)
customer_profiles/put_profile_objectAdds 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 ProfileObjecObjectTypeName (string) required
Object (string) required
DomainName (string) required
customer_profiles/put_profile_object_typeDefines a ProfileObjectType. To add or remove tags on an existing ObjectType, see TagResource/UntagResource.DomainName (string) required
ObjectTypeName (string) required
Description (string) required
TemplateId (string)
ExpirationDays (integer)
EncryptionKey (string)
AllowProfileCreation (boolean)
SourceLastUpdatedTimestampFormat (string)
MaxProfileObjectCount (integer)
Fields (object)
Keys (object)
Tags (object)
customer_profiles/search_profilesSearches for profiles within a specific domain using one or more predefined search keys e.g., _fullName, _phone, _email, _account, etc. and/or custom-defined search keys. A search key is a data type pair that consists of a KeyName and Values list. This operation supports searching for profiles with a minimum of 1 key-values pair and up to 5 key-values pairs using either AND or OR logic.NextToken (string)
MaxResults (integer)
DomainName (string) required
KeyName (string) required
Values (array) required
AdditionalSearchKeys (array)
LogicalOperator (string)
customer_profiles/start_recommenderStarts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations.DomainName (string) required
RecommenderName (string) required
customer_profiles/start_upload_jobThis API starts the processing of an upload job to ingest profile data.DomainName (string) required
JobId (string) required
customer_profiles/stop_recommenderStops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender.DomainName (string) required
RecommenderName (string) required
customer_profiles/stop_upload_jobThis API stops the processing of an upload job.DomainName (string) required
JobId (string) required
customer_profiles/tag_resourceAssigns 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 useresourceArn (string) required
tags (object) required
customer_profiles/untag_resourceRemoves 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.resourceArn (string) required
tagKeys (array) required
customer_profiles/update_calculated_attribute_definitionUpdates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.DomainName (string) required
CalculatedAttributeName (string) required
DisplayName (string)
Description (string)
Conditions: {
. Range (object)
. ObjectCount (integer)
. Threshold (object)
} (object)
customer_profiles/update_domainUpdates 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.DomainName (string) required
DefaultExpirationDays (integer)
DefaultEncryptionKey (string)
DeadLetterQueueUrl (string)
Matching: {
. Enabled (boolean)
. JobSchedule (object)
. AutoMerging (object)
. ExportingConfig (object)
} (object)
RuleBasedMatching: {
. Enabled (boolean)
. MatchingRules (array)
. MaxAllowedRuleLevelForMerging (integer)
. MaxAllowedRuleLevelForMatching (integer)
. AttributeTypesSelector (object)
. ConflictResolution (object)
. ExportingConfig (object)
} (object)
DataStore: {
. Enabled (boolean)
} (object)
Tags (object)
customer_profiles/update_domain_layoutUpdates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.DomainName (string) required
LayoutDefinitionName (string) required
Description (string)
DisplayName (string)
IsDefault (boolean)
LayoutType (string)
Layout (string)
customer_profiles/update_event_triggerUpdate the properties of an Event Trigger.DomainName (string) required
EventTriggerName (string) required
ObjectTypeName (string)
Description (string)
EventTriggerConditions (array)
SegmentFilter (string)
EventTriggerLimits: {
. EventExpiration (integer)
. Periods (array)
} (object)
customer_profiles/update_profileUpdates 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.DomainName (string) required
ProfileId (string) required
AdditionalInformation (string)
AccountNumber (string)
PartyType (string)
BusinessName (string)
FirstName (string)
MiddleName (string)
LastName (string)
BirthDate (string)
Gender (string)
PhoneNumber (string)
MobilePhoneNumber (string)
HomePhoneNumber (string)
BusinessPhoneNumber (string)
EmailAddress (string)
PersonalEmailAddress (string)
BusinessEmailAddress (string)
Address: {
. Address1 (string)
. Address2 (string)
. Address3 (string)
. Address4 (string)
. City (string)
. County (string)
. State (string)
. Province (string)
. Country (string)
. PostalCode (string)
} (object)
ShippingAddress: {
. Address1 (string)
. Address2 (string)
. Address3 (string)
. Address4 (string)
. City (string)
. County (string)
. State (string)
. Province (string)
. Country (string)
. PostalCode (string)
} (object)
MailingAddress: {
. Address1 (string)
. Address2 (string)
. Address3 (string)
. Address4 (string)
. City (string)
. County (string)
. State (string)
. Province (string)
. Country (string)
. PostalCode (string)
} (object)
BillingAddress: {
. Address1 (string)
. Address2 (string)
. Address3 (string)
. Address4 (string)
. City (string)
. County (string)
. State (string)
. Province (string)
. Country (string)
. PostalCode (string)
} (object)
Attributes (object)
PartyTypeString (string)
GenderString (string)
ProfileType (string)
EngagementPreferences: {
. Phone (array)
. Email (array)
} (object)
customer_profiles/update_recommenderUpdates the properties of an existing recommender, allowing you to modify its configuration and description.DomainName (string) required
RecommenderName (string) required
Description (string)
RecommenderConfig: {
. EventsConfig (object)
. TrainingFrequency (integer)
} (object)
data_pipeline/activate_pipelineValidates 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. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.ActivatePipeline Content-Length: 39 Host: datapipeline.us-epipelineId (string) required
parameterValues (array)
startTimestamp (string)
data_pipeline/add_tagsAdds or modifies tags for the specified pipeline.pipelineId (string) required
tags (array) required
data_pipeline/create_pipelineCreates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.CreatePipeline Content-Length: 91 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams 'name': 'myPipeline', 'uniqueId': '123456789', 'description': 'This is my first pipeline' HTTP/1.1 200 x-amzn-RequestId: b16911ce-0774-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amname (string) required
uniqueId (string) required
description (string)
tags (array)
data_pipeline/deactivate_pipelineDeactivates 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.pipelineId (string) required
cancelActive (boolean)
data_pipeline/delete_pipelineDeletes 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. POST / HTTP/1.1 Content-Type: applicatpipelineId (string) required
data_pipeline/describe_objectsGets 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. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.DescribeObjects Content-Length: 98 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams 'pipelineId': 'df-06372391ZG65EXAMPLE', 'objectIds': 'Schedule', 'evaluateExpressions': true x-amzpipelineId (string) required
objectIds (array) required
evaluateExpressions (boolean)
marker (string)
data_pipeline/describe_pipelinesRetrieves 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 abopipelineIds (array) required
data_pipeline/evaluate_expressionTask 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. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.DescribePipelines Content-Length: 164 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams 'pipelineId': 'df-08785951KAKJEXAMPLE', 'objectId': 'Schedule', 'expression': 'Transform startedpipelineId (string) required
objectId (string) required
expression (string) required
data_pipeline/get_pipeline_definitionGets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.GetPipelineDefinition Content-Length: 40 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams 'pipelineId': 'df-06372391ZG65EXAMPLE' x-amzn-RequestId: e28309e5-0776-11e2-8a14-21bb8a1f50ef ContepipelineId (string) required
version (string)
data_pipeline/list_pipelinesLists the pipeline identifiers for all active pipelines that you have permission to access. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.ListPipelines Content-Length: 14 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams Status: x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 Content-Length: 39 Date: Mon, 12 Nov 2012 17:50:53 GMT 'PipelineIdList': 'marker (string)
data_pipeline/poll_for_taskTask 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 qworkerGroup (string) required
hostname (string)
instanceIdentity: {
. document (string)
. signature (string)
} (object)
data_pipeline/put_pipeline_definitionAdds 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 pipelinepipelineId (string) required
pipelineObjects (array) required
parameterObjects (array)
parameterValues (array)
data_pipeline/query_objectsQueries the specified pipeline for the names of objects that match the specified set of conditions. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.QueryObjects Content-Length: 123 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams 'pipelineId': 'df-06372391ZG65EXAMPLE', 'query': 'selectors': , 'sphere': 'INSTANCE', 'marker': '', 'limit': 10 x-amzn-RequestId: 14d704c1-0775-11e2-af6f-6bc7a6be60d9 ConpipelineId (string) required
query: {
. selectors (array)
} (object)
sphere (string) required
marker (string)
limit (integer)
data_pipeline/remove_tagsRemoves existing tags from the specified pipeline.pipelineId (string) required
tagKeys (array) required
data_pipeline/report_task_progressTask 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 nottaskId (string) required
fields (array)
data_pipeline/report_task_runner_heartbeatTask 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. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.ReportTaskRunnerHeartbeat Content-Length: 84 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12taskrunnerId (string) required
workerGroup (string)
hostname (string)
data_pipeline/set_statusRequests 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. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.SetStatus Content-LengtpipelineId (string) required
objectIds (array) required
status (string) required
data_pipeline/set_task_statusTask 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. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.SetTaskStatus Content-Length: 847 Host: datapipeline.us-east-1.amazonaws.taskId (string) required
taskStatus (string) required
errorId (string)
errorMessage (string)
errorStackTrace (string)
data_pipeline/validate_pipeline_definitionValidates the specified pipeline definition to ensure that it is well formed and can be run without error. Example 1 This example sets an valid pipeline configuration and returns success. POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.ValidatePipelineDefinition Content-Length: 936 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams 'pipelineId': 'df-06372391ZG65EXAMPLE', 'pipelineObjects': 'id': 'DefpipelineId (string) required
pipelineObjects (array) required
parameterObjects (array)
parameterValues (array)
database_migration_service/add_tags_to_resourceAdds metadata tags to an DMS resource, including replication instance, endpoint, subnet 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.ResourceArn (string) required
Tags (array) required
database_migration_service/apply_pending_maintenance_actionApplies a pending maintenance action to a resource for example, to a replication instance.ReplicationInstanceArn (string) required
ApplyAction (string) required
OptInType (string) required
database_migration_service/batch_start_recommendationsEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Starts the analysis of up to 20 source databases to recommend target engines for each source database. This is a batch version of StartRecData (array)
database_migration_service/cancel_metadata_model_conversionCancels a single metadata model conversion operation that was started with StartMetadataModelConversion.MigrationProjectIdentifier (string) required
RequestIdentifier (string) required
database_migration_service/cancel_metadata_model_creationCancels a single metadata model creation operation that was started with StartMetadataModelCreation.MigrationProjectIdentifier (string) required
RequestIdentifier (string) required
database_migration_service/cancel_replication_task_assessment_runCancels 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.ReplicationTaskAssessmentRunArn (string) required
database_migration_service/create_data_migrationCreates a data migration using the provided settings.DataMigrationName (string)
MigrationProjectIdentifier (string) required
DataMigrationType (string) required
ServiceAccessRoleArn (string) required
EnableCloudwatchLogs (boolean)
SourceDataSettings (array)
TargetDataSettings (array)
NumberOfJobs (integer)
Tags (array)
SelectionRules (string)
database_migration_service/create_data_providerCreates a data provider using the provided settings. A data provider stores a data store type and location information about your database.DataProviderName (string)
Description (string)
Engine (string) required
Virtual (boolean)
Settings (undefined) required
Tags (array)
database_migration_service/create_endpointCreates 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.EndpointIdentifier (string) required
EndpointType (string) required
EngineName (string) required
Username (string)
Password (string)
ServerName (string)
Port (integer)
DatabaseName (string)
ExtraConnectionAttributes (string)
KmsKeyId (string)
Tags (array)
CertificateArn (string)
SslMode (string)
ServiceAccessRoleArn (string)
ExternalTableDefinition (string)
DynamoDbSettings: {
. ServiceAccessRoleArn (string)
} (object)
S3Settings: {
. ServiceAccessRoleArn (string)
. ExternalTableDefinition (string)
. CsvRowDelimiter (string)
. CsvDelimiter (string)
. BucketFolder (string)
. BucketName (string)
. CompressionType (string)
. EncryptionMode (string)
. ServerSideEncryptionKmsKeyId (string)
. DataFormat (string)
. EncodingType (string)
. DictPageSizeLimit (integer)
. RowGroupLength (integer)
. DataPageSize (integer)
. ParquetVersion (string)
. EnableStatistics (boolean)
. IncludeOpForFullLoad (boolean)
. CdcInsertsOnly (boolean)
. TimestampColumnName (string)
. ParquetTimestampInMillisecond (boolean)
. CdcInsertsAndUpdates (boolean)
. DatePartitionEnabled (boolean)
. DatePartitionSequence (string)
. DatePartitionDelimiter (string)
. UseCsvNoSupValue (boolean)
. CsvNoSupValue (string)
. PreserveTransactions (boolean)
. CdcPath (string)
. UseTaskStartTimeForFullLoadTimestamp (boolean)
. CannedAclForObjects (string)
. AddColumnName (boolean)
. CdcMaxBatchInterval (integer)
. CdcMinFileSize (integer)
. CsvNullValue (string)
. IgnoreHeaderRows (integer)
. MaxFileSize (integer)
. Rfc4180 (boolean)
. DatePartitionTimezone (string)
. AddTrailingPaddingCharacter (boolean)
. ExpectedBucketOwner (string)
. GlueCatalogGeneration (boolean)
} (object)
DmsTransferSettings: {
. ServiceAccessRoleArn (string)
. BucketName (string)
} (object)
MongoDbSettings: {
. Username (string)
. Password (string)
. ServerName (string)
. Port (integer)
. DatabaseName (string)
. AuthType (string)
. AuthMechanism (string)
. NestingLevel (string)
. ExtractDocId (string)
. DocsToInvestigate (string)
. AuthSource (string)
. KmsKeyId (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. UseUpdateLookUp (boolean)
. ReplicateShardCollections (boolean)
} (object)
KinesisSettings: {
. StreamArn (string)
. MessageFormat (string)
. ServiceAccessRoleArn (string)
. IncludeTransactionDetails (boolean)
. IncludePartitionValue (boolean)
. PartitionIncludeSchemaTable (boolean)
. IncludeTableAlterOperations (boolean)
. IncludeControlDetails (boolean)
. IncludeNullAndEmpty (boolean)
. NoHexPrefix (boolean)
. UseLargeIntegerValue (boolean)
} (object)
KafkaSettings: {
. Broker (string)
. Topic (string)
. MessageFormat (string)
. IncludeTransactionDetails (boolean)
. IncludePartitionValue (boolean)
. PartitionIncludeSchemaTable (boolean)
. IncludeTableAlterOperations (boolean)
. IncludeControlDetails (boolean)
. MessageMaxBytes (integer)
. IncludeNullAndEmpty (boolean)
. SecurityProtocol (string)
. SslClientCertificateArn (string)
. SslClientKeyArn (string)
. SslClientKeyPassword (string)
. SslCaCertificateArn (string)
. SaslUsername (string)
. SaslPassword (string)
. NoHexPrefix (boolean)
. SaslMechanism (string)
. SslEndpointIdentificationAlgorithm (string)
. UseLargeIntegerValue (boolean)
} (object)
ElasticsearchSettings: {
. ServiceAccessRoleArn (string)
. EndpointUri (string)
. FullLoadErrorPercentage (integer)
. ErrorRetryDuration (integer)
. UseNewMappingType (boolean)
} (object)
NeptuneSettings: {
. ServiceAccessRoleArn (string)
. S3BucketName (string)
. S3BucketFolder (string)
. ErrorRetryDuration (integer)
. MaxFileSize (integer)
. MaxRetryCount (integer)
. IamAuthEnabled (boolean)
} (object)
RedshiftSettings: {
. AcceptAnyDate (boolean)
. AfterConnectScript (string)
. BucketFolder (string)
. BucketName (string)
. CaseSensitiveNames (boolean)
. CompUpdate (boolean)
. ConnectionTimeout (integer)
. DatabaseName (string)
. DateFormat (string)
. EmptyAsNull (boolean)
. EncryptionMode (string)
. ExplicitIds (boolean)
. FileTransferUploadStreams (integer)
. LoadTimeout (integer)
. MaxFileSize (integer)
. Password (string)
. Port (integer)
. RemoveQuotes (boolean)
. ReplaceInvalidChars (string)
. ReplaceChars (string)
. ServerName (string)
. ServiceAccessRoleArn (string)
. ServerSideEncryptionKmsKeyId (string)
. TimeFormat (string)
. TrimBlanks (boolean)
. TruncateColumns (boolean)
. Username (string)
. WriteBufferSize (integer)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. MapBooleanAsBoolean (boolean)
} (object)
PostgreSQLSettings: {
. AfterConnectScript (string)
. CaptureDdls (boolean)
. MaxFileSize (integer)
. DatabaseName (string)
. DdlArtifactsSchema (string)
. ExecuteTimeout (integer)
. FailTasksOnLobTruncation (boolean)
. HeartbeatEnable (boolean)
. HeartbeatSchema (string)
. HeartbeatFrequency (integer)
. Password (string)
. Port (integer)
. ServerName (string)
. Username (string)
. SlotName (string)
. PluginName (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. TrimSpaceInChar (boolean)
. MapBooleanAsBoolean (boolean)
. MapJsonbAsClob (boolean)
. MapLongVarcharAs (string)
. DatabaseMode (string)
. BabelfishDatabaseName (string)
. DisableUnicodeSourceFilter (boolean)
. ServiceAccessRoleArn (string)
. AuthenticationMethod (string)
} (object)
MySQLSettings: {
. AfterConnectScript (string)
. CleanSourceMetadataOnMismatch (boolean)
. DatabaseName (string)
. EventsPollInterval (integer)
. TargetDbType (string)
. MaxFileSize (integer)
. ParallelLoadThreads (integer)
. Password (string)
. Port (integer)
. ServerName (string)
. ServerTimezone (string)
. Username (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. ExecuteTimeout (integer)
. ServiceAccessRoleArn (string)
. AuthenticationMethod (string)
} (object)
OracleSettings: {
. AddSupplementalLogging (boolean)
. ArchivedLogDestId (integer)
. AdditionalArchivedLogDestId (integer)
. ExtraArchivedLogDestIds (array)
. AllowSelectNestedTables (boolean)
. ParallelAsmReadThreads (integer)
. ReadAheadBlocks (integer)
. AccessAlternateDirectly (boolean)
. UseAlternateFolderForOnline (boolean)
. OraclePathPrefix (string)
. UsePathPrefix (string)
. ReplacePathPrefix (boolean)
. EnableHomogenousTablespace (boolean)
. DirectPathNoLog (boolean)
. ArchivedLogsOnly (boolean)
. AsmPassword (string)
. AsmServer (string)
. AsmUser (string)
. CharLengthSemantics (string)
. DatabaseName (string)
. DirectPathParallelLoad (boolean)
. FailTasksOnLobTruncation (boolean)
. NumberDatatypeScale (integer)
. Password (string)
. Port (integer)
. ReadTableSpaceName (boolean)
. RetryInterval (integer)
. SecurityDbEncryption (string)
. SecurityDbEncryptionName (string)
. ServerName (string)
. SpatialDataOptionToGeoJsonFunctionName (string)
. StandbyDelayTime (integer)
. Username (string)
. UseBFile (boolean)
. UseDirectPathFullLoad (boolean)
. UseLogminerReader (boolean)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. SecretsManagerOracleAsmAccessRoleArn (string)
. SecretsManagerOracleAsmSecretId (string)
. TrimSpaceInChar (boolean)
. ConvertTimestampWithZoneToUTC (boolean)
. OpenTransactionWindow (integer)
. AuthenticationMethod (string)
} (object)
SybaseSettings: {
. DatabaseName (string)
. Password (string)
. Port (integer)
. ServerName (string)
. Username (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
} (object)
MicrosoftSQLServerSettings: {
. Port (integer)
. BcpPacketSize (integer)
. DatabaseName (string)
. ControlTablesFileGroup (string)
. Password (string)
. QuerySingleAlwaysOnNode (boolean)
. ReadBackupOnly (boolean)
. SafeguardPolicy (string)
. ServerName (string)
. Username (string)
. UseBcpFullLoad (boolean)
. UseThirdPartyBackupDevice (boolean)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. TrimSpaceInChar (boolean)
. TlogAccessMode (string)
. ForceLobLookup (boolean)
. AuthenticationMethod (string)
} (object)
IBMDb2Settings: {
. DatabaseName (string)
. Password (string)
. Port (integer)
. ServerName (string)
. SetDataCaptureChanges (boolean)
. CurrentLsn (string)
. MaxKBytesPerRead (integer)
. Username (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. LoadTimeout (integer)
. WriteBufferSize (integer)
. MaxFileSize (integer)
. KeepCsvFiles (boolean)
} (object)
ResourceIdentifier (string)
DocDbSettings: {
. Username (string)
. Password (string)
. ServerName (string)
. Port (integer)
. DatabaseName (string)
. NestingLevel (string)
. ExtractDocId (boolean)
. DocsToInvestigate (integer)
. KmsKeyId (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. UseUpdateLookUp (boolean)
. ReplicateShardCollections (boolean)
} (object)
RedisSettings: {
. ServerName (string)
. Port (integer)
. SslSecurityProtocol (string)
. AuthType (string)
. AuthUserName (string)
. AuthPassword (string)
. SslCaCertificateArn (string)
} (object)
GcpMySQLSettings: {
. AfterConnectScript (string)
. CleanSourceMetadataOnMismatch (boolean)
. DatabaseName (string)
. EventsPollInterval (integer)
. TargetDbType (string)
. MaxFileSize (integer)
. ParallelLoadThreads (integer)
. Password (string)
. Port (integer)
. ServerName (string)
. ServerTimezone (string)
. Username (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
} (object)
TimestreamSettings: {
. DatabaseName (string)
. MemoryDuration (integer)
. MagneticDuration (integer)
. CdcInsertsAndUpdates (boolean)
. EnableMagneticStoreWrites (boolean)
} (object)
database_migration_service/create_event_subscriptionCreates 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 sourcSubscriptionName (string) required
SnsTopicArn (string) required
SourceType (string)
EventCategories (array)
SourceIds (array)
Enabled (boolean)
Tags (array)
database_migration_service/create_fleet_advisor_collectorEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Creates a Fleet Advisor collector using the specified parameters.CollectorName (string) required
Description (string)
ServiceAccessRoleArn (string) required
S3BucketName (string) required
database_migration_service/create_instance_profileCreates the instance profile using the specified parameters.AvailabilityZone (string)
KmsKeyArn (string)
PubliclyAccessible (boolean)
Tags (array)
NetworkType (string)
InstanceProfileName (string)
Description (string)
SubnetGroupIdentifier (string)
VpcSecurityGroups (array)
database_migration_service/create_migration_projectCreates the migration project using the specified parameters. You can run this action only after you create an instance profile and data providers using CreateInstanceProfile and CreateDataProvider.MigrationProjectName (string)
SourceDataProviderDescriptors (array) required
TargetDataProviderDescriptors (array) required
InstanceProfileIdentifier (string) required
TransformationRules (string)
Description (string)
Tags (array)
SchemaConversionApplicationAttributes: {
. S3BucketPath (string)
. S3BucketRoleArn (string)
} (object)
database_migration_service/create_replication_configCreates a configuration that you can later provide to configure and start an DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.ReplicationConfigIdentifier (string) required
SourceEndpointArn (string) required
TargetEndpointArn (string) required
ComputeConfig: {
. AvailabilityZone (string)
. DnsNameServers (string)
. KmsKeyId (string)
. MaxCapacityUnits (integer)
. MinCapacityUnits (integer)
. MultiAZ (boolean)
. PreferredMaintenanceWindow (string)
. ReplicationSubnetGroupId (string)
. VpcSecurityGroupIds (array)
} (object) required
ReplicationType (string) required
TableMappings (string) required
ReplicationSettings (string)
SupplementalSettings (string)
ResourceIdentifier (string)
Tags (array)
database_migration_service/create_replication_instanceCreates 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. If you don't specify a version when creating a replication instance, DMS will create the instance using the default engine versReplicationInstanceIdentifier (string) required
AllocatedStorage (integer)
ReplicationInstanceClass (string) required
VpcSecurityGroupIds (array)
AvailabilityZone (string)
ReplicationSubnetGroupIdentifier (string)
PreferredMaintenanceWindow (string)
MultiAZ (boolean)
EngineVersion (string)
AutoMinorVersionUpgrade (boolean)
Tags (array)
KmsKeyId (string)
PubliclyAccessible (boolean)
DnsNameServers (string)
ResourceIdentifier (string)
NetworkType (string)
KerberosAuthenticationSettings: {
. KeyCacheSecretId (string)
. KeyCacheSecretIamArn (string)
. Krb5FileContents (string)
} (object)
database_migration_service/create_replication_subnet_groupCreates 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. If a replication subnet group exists in your Amazon Web Services account, the CreateReplicationSubnetGroup action returns the following error message: The Replication Subnet Group already exists. In this case, delete the eReplicationSubnetGroupIdentifier (string) required
ReplicationSubnetGroupDescription (string) required
SubnetIds (array) required
Tags (array)
database_migration_service/create_replication_taskCreates a replication task using the specified parameters.ReplicationTaskIdentifier (string) required
SourceEndpointArn (string) required
TargetEndpointArn (string) required
ReplicationInstanceArn (string) required
MigrationType (string) required
TableMappings (string) required
ReplicationTaskSettings (string)
CdcStartTime (string)
CdcStartPosition (string)
CdcStopPosition (string)
Tags (array)
TaskData (string)
ResourceIdentifier (string)
database_migration_service/delete_certificateDeletes the specified certificate.CertificateArn (string) required
database_migration_service/delete_connectionDeletes the connection between a replication instance and an endpoint.EndpointArn (string) required
ReplicationInstanceArn (string) required
database_migration_service/delete_data_migrationDeletes the specified data migration.DataMigrationIdentifier (string) required
database_migration_service/delete_data_providerDeletes the specified data provider. All migration projects associated with the data provider must be deleted or modified before you can delete the data provider.DataProviderIdentifier (string) required
database_migration_service/delete_endpointDeletes the specified endpoint. All tasks associated with the endpoint must be deleted before you can delete the endpoint.EndpointArn (string) required
database_migration_service/delete_event_subscriptionDeletes an DMS event subscription.SubscriptionName (string) required
database_migration_service/delete_fleet_advisor_collectorEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Deletes the specified Fleet Advisor collector.CollectorReferencedId (string) required
database_migration_service/delete_fleet_advisor_databasesEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Deletes the specified Fleet Advisor collector databases.DatabaseIds (array) required
database_migration_service/delete_instance_profileDeletes the specified instance profile. All migration projects associated with the instance profile must be deleted or modified before you can delete the instance profile.InstanceProfileIdentifier (string) required
database_migration_service/delete_migration_projectDeletes the specified migration project. The migration project must be closed before you can delete it.MigrationProjectIdentifier (string) required
database_migration_service/delete_replication_configDeletes an DMS Serverless replication configuration. This effectively deprovisions any and all replications that use this configuration. You can't delete the configuration for an DMS Serverless replication that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.ReplicationConfigArn (string) required
database_migration_service/delete_replication_instanceDeletes the specified replication instance. You must delete any migration tasks that are associated with the replication instance before you can delete it.ReplicationInstanceArn (string) required
database_migration_service/delete_replication_subnet_groupDeletes a subnet group.ReplicationSubnetGroupIdentifier (string) required
database_migration_service/delete_replication_taskDeletes the specified replication task.ReplicationTaskArn (string) required
database_migration_service/delete_replication_task_assessment_runDeletes 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.ReplicationTaskAssessmentRunArn (string) required
database_migration_service/describe_account_attributesLists 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 thNo parameters
database_migration_service/describe_applicable_individual_assessmentsProvides 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 sourcReplicationTaskArn (string)
ReplicationInstanceArn (string)
ReplicationConfigArn (string)
SourceEngineName (string)
TargetEngineName (string)
MigrationType (string)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_certificatesProvides a description of the certificate.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_connectionsDescribes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_conversion_configurationReturns configuration parameters for a schema conversion project.MigrationProjectIdentifier (string) required
database_migration_service/describe_data_migrationsReturns information about data migrations.Filters (array)
MaxRecords (integer)
Marker (string)
WithoutSettings (boolean)
WithoutStatistics (boolean)
database_migration_service/describe_data_providersReturns a paginated list of data providers for your account in the current region.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_endpointsReturns information about the endpoints for your account in the current region.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_endpoint_settingsReturns information about the possible endpoint settings available when you create an endpoint for a specific database engine.EngineName (string) required
MaxRecords (integer)
Marker (string)
database_migration_service/describe_endpoint_typesReturns information about the type of endpoints available.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_engine_versionsReturns information about the replication instance versions used in the project.MaxRecords (integer)
Marker (string)
database_migration_service/describe_event_categoriesLists 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.SourceType (string)
Filters (array)
database_migration_service/describe_eventsLists 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.SourceIdentifier (string)
SourceType (string)
StartTime (string)
EndTime (string)
Duration (integer)
EventCategories (array)
Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_event_subscriptionsLists 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.SubscriptionName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_extension_pack_associationsReturns a paginated list of extension pack associations for the specified migration project. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.MigrationProjectIdentifier (string) required
Filters (array)
Marker (string)
MaxRecords (integer)
database_migration_service/describe_fleet_advisor_collectorsEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Returns a list of the Fleet Advisor collectors in your account.Filters (array)
MaxRecords (integer)
NextToken (string)
database_migration_service/describe_fleet_advisor_databasesEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Returns a list of Fleet Advisor databases in your account.Filters (array)
MaxRecords (integer)
NextToken (string)
database_migration_service/describe_fleet_advisor_lsa_analysisEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Provides descriptions of large-scale assessment LSA analyses produced by your Fleet Advisor collectors.MaxRecords (integer)
NextToken (string)
database_migration_service/describe_fleet_advisor_schema_object_summaryEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Provides descriptions of the schemas discovered by your Fleet Advisor collectors.Filters (array)
MaxRecords (integer)
NextToken (string)
database_migration_service/describe_fleet_advisor_schemasEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Returns a list of schemas detected by Fleet Advisor Collectors in your account.Filters (array)
MaxRecords (integer)
NextToken (string)
database_migration_service/describe_instance_profilesReturns a paginated list of instance profiles for your account in the current region.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_metadata_modelGets detailed information about the specified metadata model, including its definition and corresponding converted objects in the target database if applicable.SelectionRules (string) required
MigrationProjectIdentifier (string) required
Origin (string) required
database_migration_service/describe_metadata_model_assessmentsReturns a paginated list of metadata model assessments for your account in the current region.MigrationProjectIdentifier (string) required
Filters (array)
Marker (string)
MaxRecords (integer)
database_migration_service/describe_metadata_model_childrenGets a list of child metadata models for the specified metadata model in the database hierarchy.SelectionRules (string) required
MigrationProjectIdentifier (string) required
Origin (string) required
Marker (string)
MaxRecords (integer)
database_migration_service/describe_metadata_model_conversionsReturns a paginated list of metadata model conversions for a migration project.MigrationProjectIdentifier (string) required
Filters (array)
Marker (string)
MaxRecords (integer)
database_migration_service/describe_metadata_model_creationsReturns a paginated list of metadata model creation requests for a migration project.Filters (array)
Marker (string)
MaxRecords (integer)
MigrationProjectIdentifier (string) required
database_migration_service/describe_metadata_model_exports_as_scriptReturns a paginated list of metadata model exports.MigrationProjectIdentifier (string) required
Filters (array)
Marker (string)
MaxRecords (integer)
database_migration_service/describe_metadata_model_exports_to_targetReturns a paginated list of metadata model exports.MigrationProjectIdentifier (string) required
Filters (array)
Marker (string)
MaxRecords (integer)
database_migration_service/describe_metadata_model_importsReturns a paginated list of metadata model imports.MigrationProjectIdentifier (string) required
Filters (array)
Marker (string)
MaxRecords (integer)
database_migration_service/describe_migration_projectsReturns a paginated list of migration projects for your account in the current region.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_orderable_replication_instancesReturns information about the replication instance types that can be created in the specified region.MaxRecords (integer)
Marker (string)
database_migration_service/describe_pending_maintenance_actionsReturns a list of upcoming maintenance events for replication instances in your account in the current Region.ReplicationInstanceArn (string)
Filters (array)
Marker (string)
MaxRecords (integer)
database_migration_service/describe_recommendation_limitationsEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Returns a paginated list of limitations for recommendations of target Amazon Web Services engines.Filters (array)
MaxRecords (integer)
NextToken (string)
database_migration_service/describe_recommendationsEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Returns a paginated list of target engine recommendations for your source databases.Filters (array)
MaxRecords (integer)
NextToken (string)
database_migration_service/describe_refresh_schemas_statusReturns the status of the RefreshSchemas operation.EndpointArn (string) required
database_migration_service/describe_replication_configsReturns one or more existing DMS Serverless replication configurations as a list of structures.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_replication_instancesReturns information about replication instances for your account in the current region.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_replication_instance_task_logsReturns information about the task logs for the specified task.ReplicationInstanceArn (string) required
MaxRecords (integer)
Marker (string)
database_migration_service/describe_replicationsProvides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_replication_subnet_groupsReturns information about the replication subnet groups.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_replication_table_statisticsReturns table and schema statistics for one or more provisioned replications that use a given DMS Serverless replication configuration.ReplicationConfigArn (string) required
MaxRecords (integer)
Marker (string)
Filters (array)
database_migration_service/describe_replication_task_assessment_resultsReturns 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.ReplicationTaskArn (string)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_replication_task_assessment_runsReturns 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.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_replication_task_individual_assessmentsReturns 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.Filters (array)
MaxRecords (integer)
Marker (string)
database_migration_service/describe_replication_tasksReturns information about replication tasks for your account in the current region.Filters (array)
MaxRecords (integer)
Marker (string)
WithoutSettings (boolean)
database_migration_service/describe_schemasReturns information about the schema for the specified endpoint.EndpointArn (string) required
MaxRecords (integer)
Marker (string)
database_migration_service/describe_table_statisticsReturns 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.ReplicationTaskArn (string) required
MaxRecords (integer)
Marker (string)
Filters (array)
database_migration_service/export_metadata_model_assessmentSaves a copy of a database migration assessment report to your Amazon S3 bucket. DMS can save your assessment report as a comma-separated value CSV or a PDF file.MigrationProjectIdentifier (string) required
SelectionRules (string) required
FileName (string)
AssessmentReportTypes (array)
database_migration_service/get_target_selection_rulesConverts source selection rules into their target counterparts for schema conversion operations.MigrationProjectIdentifier (string) required
SelectionRules (string) required
database_migration_service/import_certificateUploads the specified certificate.CertificateIdentifier (string) required
CertificatePem (string)
CertificateWallet (string)
Tags (array)
KmsKeyId (string)
database_migration_service/list_tags_for_resourceLists all metadata tags attached to an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see Tag data type description.ResourceArn (string)
ResourceArnList (array)
database_migration_service/modify_conversion_configurationModifies the specified schema conversion configuration using the provided parameters.MigrationProjectIdentifier (string) required
ConversionConfiguration (string) required
database_migration_service/modify_data_migrationModifies an existing DMS data migration.DataMigrationIdentifier (string) required
DataMigrationName (string)
EnableCloudwatchLogs (boolean)
ServiceAccessRoleArn (string)
DataMigrationType (string)
SourceDataSettings (array)
TargetDataSettings (array)
NumberOfJobs (integer)
SelectionRules (string)
database_migration_service/modify_data_providerModifies the specified data provider using the provided settings. You must remove the data provider from all migration projects before you can modify it.DataProviderIdentifier (string) required
DataProviderName (string)
Description (string)
Engine (string)
Virtual (boolean)
ExactSettings (boolean)
Settings (undefined)
database_migration_service/modify_endpointModifies 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.EndpointArn (string) required
EndpointIdentifier (string)
EndpointType (string)
EngineName (string)
Username (string)
Password (string)
ServerName (string)
Port (integer)
DatabaseName (string)
ExtraConnectionAttributes (string)
CertificateArn (string)
SslMode (string)
ServiceAccessRoleArn (string)
ExternalTableDefinition (string)
DynamoDbSettings: {
. ServiceAccessRoleArn (string)
} (object)
S3Settings: {
. ServiceAccessRoleArn (string)
. ExternalTableDefinition (string)
. CsvRowDelimiter (string)
. CsvDelimiter (string)
. BucketFolder (string)
. BucketName (string)
. CompressionType (string)
. EncryptionMode (string)
. ServerSideEncryptionKmsKeyId (string)
. DataFormat (string)
. EncodingType (string)
. DictPageSizeLimit (integer)
. RowGroupLength (integer)
. DataPageSize (integer)
. ParquetVersion (string)
. EnableStatistics (boolean)
. IncludeOpForFullLoad (boolean)
. CdcInsertsOnly (boolean)
. TimestampColumnName (string)
. ParquetTimestampInMillisecond (boolean)
. CdcInsertsAndUpdates (boolean)
. DatePartitionEnabled (boolean)
. DatePartitionSequence (string)
. DatePartitionDelimiter (string)
. UseCsvNoSupValue (boolean)
. CsvNoSupValue (string)
. PreserveTransactions (boolean)
. CdcPath (string)
. UseTaskStartTimeForFullLoadTimestamp (boolean)
. CannedAclForObjects (string)
. AddColumnName (boolean)
. CdcMaxBatchInterval (integer)
. CdcMinFileSize (integer)
. CsvNullValue (string)
. IgnoreHeaderRows (integer)
. MaxFileSize (integer)
. Rfc4180 (boolean)
. DatePartitionTimezone (string)
. AddTrailingPaddingCharacter (boolean)
. ExpectedBucketOwner (string)
. GlueCatalogGeneration (boolean)
} (object)
DmsTransferSettings: {
. ServiceAccessRoleArn (string)
. BucketName (string)
} (object)
MongoDbSettings: {
. Username (string)
. Password (string)
. ServerName (string)
. Port (integer)
. DatabaseName (string)
. AuthType (string)
. AuthMechanism (string)
. NestingLevel (string)
. ExtractDocId (string)
. DocsToInvestigate (string)
. AuthSource (string)
. KmsKeyId (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. UseUpdateLookUp (boolean)
. ReplicateShardCollections (boolean)
} (object)
KinesisSettings: {
. StreamArn (string)
. MessageFormat (string)
. ServiceAccessRoleArn (string)
. IncludeTransactionDetails (boolean)
. IncludePartitionValue (boolean)
. PartitionIncludeSchemaTable (boolean)
. IncludeTableAlterOperations (boolean)
. IncludeControlDetails (boolean)
. IncludeNullAndEmpty (boolean)
. NoHexPrefix (boolean)
. UseLargeIntegerValue (boolean)
} (object)
KafkaSettings: {
. Broker (string)
. Topic (string)
. MessageFormat (string)
. IncludeTransactionDetails (boolean)
. IncludePartitionValue (boolean)
. PartitionIncludeSchemaTable (boolean)
. IncludeTableAlterOperations (boolean)
. IncludeControlDetails (boolean)
. MessageMaxBytes (integer)
. IncludeNullAndEmpty (boolean)
. SecurityProtocol (string)
. SslClientCertificateArn (string)
. SslClientKeyArn (string)
. SslClientKeyPassword (string)
. SslCaCertificateArn (string)
. SaslUsername (string)
. SaslPassword (string)
. NoHexPrefix (boolean)
. SaslMechanism (string)
. SslEndpointIdentificationAlgorithm (string)
. UseLargeIntegerValue (boolean)
} (object)
ElasticsearchSettings: {
. ServiceAccessRoleArn (string)
. EndpointUri (string)
. FullLoadErrorPercentage (integer)
. ErrorRetryDuration (integer)
. UseNewMappingType (boolean)
} (object)
NeptuneSettings: {
. ServiceAccessRoleArn (string)
. S3BucketName (string)
. S3BucketFolder (string)
. ErrorRetryDuration (integer)
. MaxFileSize (integer)
. MaxRetryCount (integer)
. IamAuthEnabled (boolean)
} (object)
RedshiftSettings: {
. AcceptAnyDate (boolean)
. AfterConnectScript (string)
. BucketFolder (string)
. BucketName (string)
. CaseSensitiveNames (boolean)
. CompUpdate (boolean)
. ConnectionTimeout (integer)
. DatabaseName (string)
. DateFormat (string)
. EmptyAsNull (boolean)
. EncryptionMode (string)
. ExplicitIds (boolean)
. FileTransferUploadStreams (integer)
. LoadTimeout (integer)
. MaxFileSize (integer)
. Password (string)
. Port (integer)
. RemoveQuotes (boolean)
. ReplaceInvalidChars (string)
. ReplaceChars (string)
. ServerName (string)
. ServiceAccessRoleArn (string)
. ServerSideEncryptionKmsKeyId (string)
. TimeFormat (string)
. TrimBlanks (boolean)
. TruncateColumns (boolean)
. Username (string)
. WriteBufferSize (integer)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. MapBooleanAsBoolean (boolean)
} (object)
PostgreSQLSettings: {
. AfterConnectScript (string)
. CaptureDdls (boolean)
. MaxFileSize (integer)
. DatabaseName (string)
. DdlArtifactsSchema (string)
. ExecuteTimeout (integer)
. FailTasksOnLobTruncation (boolean)
. HeartbeatEnable (boolean)
. HeartbeatSchema (string)
. HeartbeatFrequency (integer)
. Password (string)
. Port (integer)
. ServerName (string)
. Username (string)
. SlotName (string)
. PluginName (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. TrimSpaceInChar (boolean)
. MapBooleanAsBoolean (boolean)
. MapJsonbAsClob (boolean)
. MapLongVarcharAs (string)
. DatabaseMode (string)
. BabelfishDatabaseName (string)
. DisableUnicodeSourceFilter (boolean)
. ServiceAccessRoleArn (string)
. AuthenticationMethod (string)
} (object)
MySQLSettings: {
. AfterConnectScript (string)
. CleanSourceMetadataOnMismatch (boolean)
. DatabaseName (string)
. EventsPollInterval (integer)
. TargetDbType (string)
. MaxFileSize (integer)
. ParallelLoadThreads (integer)
. Password (string)
. Port (integer)
. ServerName (string)
. ServerTimezone (string)
. Username (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. ExecuteTimeout (integer)
. ServiceAccessRoleArn (string)
. AuthenticationMethod (string)
} (object)
OracleSettings: {
. AddSupplementalLogging (boolean)
. ArchivedLogDestId (integer)
. AdditionalArchivedLogDestId (integer)
. ExtraArchivedLogDestIds (array)
. AllowSelectNestedTables (boolean)
. ParallelAsmReadThreads (integer)
. ReadAheadBlocks (integer)
. AccessAlternateDirectly (boolean)
. UseAlternateFolderForOnline (boolean)
. OraclePathPrefix (string)
. UsePathPrefix (string)
. ReplacePathPrefix (boolean)
. EnableHomogenousTablespace (boolean)
. DirectPathNoLog (boolean)
. ArchivedLogsOnly (boolean)
. AsmPassword (string)
. AsmServer (string)
. AsmUser (string)
. CharLengthSemantics (string)
. DatabaseName (string)
. DirectPathParallelLoad (boolean)
. FailTasksOnLobTruncation (boolean)
. NumberDatatypeScale (integer)
. Password (string)
. Port (integer)
. ReadTableSpaceName (boolean)
. RetryInterval (integer)
. SecurityDbEncryption (string)
. SecurityDbEncryptionName (string)
. ServerName (string)
. SpatialDataOptionToGeoJsonFunctionName (string)
. StandbyDelayTime (integer)
. Username (string)
. UseBFile (boolean)
. UseDirectPathFullLoad (boolean)
. UseLogminerReader (boolean)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. SecretsManagerOracleAsmAccessRoleArn (string)
. SecretsManagerOracleAsmSecretId (string)
. TrimSpaceInChar (boolean)
. ConvertTimestampWithZoneToUTC (boolean)
. OpenTransactionWindow (integer)
. AuthenticationMethod (string)
} (object)
SybaseSettings: {
. DatabaseName (string)
. Password (string)
. Port (integer)
. ServerName (string)
. Username (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
} (object)
MicrosoftSQLServerSettings: {
. Port (integer)
. BcpPacketSize (integer)
. DatabaseName (string)
. ControlTablesFileGroup (string)
. Password (string)
. QuerySingleAlwaysOnNode (boolean)
. ReadBackupOnly (boolean)
. SafeguardPolicy (string)
. ServerName (string)
. Username (string)
. UseBcpFullLoad (boolean)
. UseThirdPartyBackupDevice (boolean)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. TrimSpaceInChar (boolean)
. TlogAccessMode (string)
. ForceLobLookup (boolean)
. AuthenticationMethod (string)
} (object)
IBMDb2Settings: {
. DatabaseName (string)
. Password (string)
. Port (integer)
. ServerName (string)
. SetDataCaptureChanges (boolean)
. CurrentLsn (string)
. MaxKBytesPerRead (integer)
. Username (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. LoadTimeout (integer)
. WriteBufferSize (integer)
. MaxFileSize (integer)
. KeepCsvFiles (boolean)
} (object)
DocDbSettings: {
. Username (string)
. Password (string)
. ServerName (string)
. Port (integer)
. DatabaseName (string)
. NestingLevel (string)
. ExtractDocId (boolean)
. DocsToInvestigate (integer)
. KmsKeyId (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
. UseUpdateLookUp (boolean)
. ReplicateShardCollections (boolean)
} (object)
RedisSettings: {
. ServerName (string)
. Port (integer)
. SslSecurityProtocol (string)
. AuthType (string)
. AuthUserName (string)
. AuthPassword (string)
. SslCaCertificateArn (string)
} (object)
ExactSettings (boolean)
GcpMySQLSettings: {
. AfterConnectScript (string)
. CleanSourceMetadataOnMismatch (boolean)
. DatabaseName (string)
. EventsPollInterval (integer)
. TargetDbType (string)
. MaxFileSize (integer)
. ParallelLoadThreads (integer)
. Password (string)
. Port (integer)
. ServerName (string)
. ServerTimezone (string)
. Username (string)
. SecretsManagerAccessRoleArn (string)
. SecretsManagerSecretId (string)
} (object)
TimestreamSettings: {
. DatabaseName (string)
. MemoryDuration (integer)
. MagneticDuration (integer)
. CdcInsertsAndUpdates (boolean)
. EnableMagneticStoreWrites (boolean)
} (object)
database_migration_service/modify_event_subscriptionModifies an existing DMS event notification subscription.SubscriptionName (string) required
SnsTopicArn (string)
SourceType (string)
EventCategories (array)
Enabled (boolean)
database_migration_service/modify_instance_profileModifies the specified instance profile using the provided parameters. All migration projects associated with the instance profile must be deleted or modified before you can modify the instance profile.InstanceProfileIdentifier (string) required
AvailabilityZone (string)
KmsKeyArn (string)
PubliclyAccessible (boolean)
NetworkType (string)
InstanceProfileName (string)
Description (string)
SubnetGroupIdentifier (string)
VpcSecurityGroups (array)
database_migration_service/modify_migration_projectModifies the specified migration project using the provided parameters. The migration project must be closed before you can modify it.MigrationProjectIdentifier (string) required
MigrationProjectName (string)
SourceDataProviderDescriptors (array)
TargetDataProviderDescriptors (array)
InstanceProfileIdentifier (string)
TransformationRules (string)
Description (string)
SchemaConversionApplicationAttributes: {
. S3BucketPath (string)
. S3BucketRoleArn (string)
} (object)
database_migration_service/modify_replication_configModifies an existing DMS Serverless replication configuration that you can use to start a replication. This command includes input validation and logic to check the state of any replication that uses this configuration. You can only modify a replication configuration before any replication that uses it has started. As soon as you have initially started a replication with a given configuiration, you can't modify that configuration, even if you stop it. Other run statuses that allow you to run thiReplicationConfigArn (string) required
ReplicationConfigIdentifier (string)
ReplicationType (string)
TableMappings (string)
ReplicationSettings (string)
SupplementalSettings (string)
ComputeConfig: {
. AvailabilityZone (string)
. DnsNameServers (string)
. KmsKeyId (string)
. MaxCapacityUnits (integer)
. MinCapacityUnits (integer)
. MultiAZ (boolean)
. PreferredMaintenanceWindow (string)
. ReplicationSubnetGroupId (string)
. VpcSecurityGroupIds (array)
} (object)
SourceEndpointArn (string)
TargetEndpointArn (string)
database_migration_service/modify_replication_instanceModifies 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.ReplicationInstanceArn (string) required
AllocatedStorage (integer)
ApplyImmediately (boolean)
ReplicationInstanceClass (string)
VpcSecurityGroupIds (array)
PreferredMaintenanceWindow (string)
MultiAZ (boolean)
EngineVersion (string)
AllowMajorVersionUpgrade (boolean)
AutoMinorVersionUpgrade (boolean)
ReplicationInstanceIdentifier (string)
NetworkType (string)
KerberosAuthenticationSettings: {
. KeyCacheSecretId (string)
. KeyCacheSecretIamArn (string)
. Krb5FileContents (string)
} (object)
database_migration_service/modify_replication_subnet_groupModifies the settings for the specified replication subnet group.ReplicationSubnetGroupIdentifier (string) required
ReplicationSubnetGroupDescription (string)
SubnetIds (array) required
database_migration_service/modify_replication_taskModifies 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.ReplicationTaskArn (string) required
ReplicationTaskIdentifier (string)
MigrationType (string)
TableMappings (string)
ReplicationTaskSettings (string)
CdcStartTime (string)
CdcStartPosition (string)
CdcStopPosition (string)
TaskData (string)
database_migration_service/move_replication_taskMoves 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.ReplicationTaskArn (string) required
TargetReplicationInstanceArn (string) required
database_migration_service/reboot_replication_instanceReboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.ReplicationInstanceArn (string) required
ForceFailover (boolean)
ForcePlannedFailover (boolean)
database_migration_service/refresh_schemasPopulates 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.EndpointArn (string) required
ReplicationInstanceArn (string) required
database_migration_service/reload_replication_tablesReloads the target database table with the source data for a given DMS Serverless replication configuration. You can only use this operation with a task in the RUNNING state, otherwise the service will throw an InvalidResourceStateFault exception.ReplicationConfigArn (string) required
TablesToReload (array) required
ReloadOption (string)
database_migration_service/reload_tablesReloads 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.ReplicationTaskArn (string) required
TablesToReload (array) required
ReloadOption (string)
database_migration_service/remove_tags_from_resourceRemoves metadata tags from an DMS resource, including replication instance, endpoint, subnet group, and migration task. For more information, see Tag data type description.ResourceArn (string) required
TagKeys (array) required
database_migration_service/run_fleet_advisor_lsa_analysisEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Runs large-scale assessment LSA analysis on every Fleet Advisor collector in your account.No parameters
database_migration_service/start_data_migrationStarts the specified data migration.DataMigrationIdentifier (string) required
StartType (string) required
database_migration_service/start_extension_pack_associationApplies the extension pack to your target database. An extension pack is an add-on module that emulates functions present in a source database that are required when converting objects to the target database.MigrationProjectIdentifier (string) required
database_migration_service/start_metadata_model_assessmentCreates a database migration assessment report by assessing the migration complexity for your source database. A database migration assessment report summarizes all of the schema conversion tasks. It also details the action items for database objects that can't be converted to the database engine of your target database instance.MigrationProjectIdentifier (string) required
SelectionRules (string) required
database_migration_service/start_metadata_model_conversionConverts your source database objects to a format compatible with the target database.MigrationProjectIdentifier (string) required
SelectionRules (string) required
database_migration_service/start_metadata_model_creationCreates source metadata model of the given type with the specified properties for schema conversion operations. This action supports only these directions: from SQL Server to Aurora PostgreSQL, or from SQL Server to RDS for PostgreSQL.MigrationProjectIdentifier (string) required
SelectionRules (string) required
MetadataModelName (string) required
Properties (undefined) required
database_migration_service/start_metadata_model_export_as_scriptSaves your converted code to a file as a SQL script, and stores this file on your Amazon S3 bucket.MigrationProjectIdentifier (string) required
SelectionRules (string) required
Origin (string) required
FileName (string)
database_migration_service/start_metadata_model_export_to_targetApplies converted database objects to your target database.MigrationProjectIdentifier (string) required
SelectionRules (string) required
OverwriteExtensionPack (boolean)
database_migration_service/start_metadata_model_importLoads the metadata for all the dependent database objects of the parent object. This operation uses your project's Amazon S3 bucket as a metadata cache to improve performance.MigrationProjectIdentifier (string) required
SelectionRules (string) required
Origin (string) required
Refresh (boolean)
database_migration_service/start_recommendationsEnd of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support. Starts the analysis of your source database to provide recommendations of target engines. You can create recommendations for multiple sourDatabaseId (string) required
Settings: {
. InstanceSizingType (string)
. WorkloadType (string)
} (object) required
database_migration_service/start_replicationFor a given DMS Serverless replication configuration, DMS connects to the source endpoint and collects the metadata to analyze the replication workload. Using this metadata, DMS then computes and provisions the required capacity and starts replicating to the target endpoint using the server resources that DMS has provisioned for the DMS Serverless replication.ReplicationConfigArn (string) required
StartReplicationType (string) required
PremigrationAssessmentSettings (string)
CdcStartTime (string)
CdcStartPosition (string)
CdcStopPosition (string)
database_migration_service/start_replication_taskStarts the replication task. For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.ReplicationTaskArn (string) required
StartReplicationTaskType (string) required
CdcStartTime (string)
CdcStartPosition (string)
CdcStopPosition (string)
database_migration_service/start_replication_task_assessmentStarts 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.ReplicationTaskArn (string) required
database_migration_service/start_replication_task_assessment_runStarts 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 completReplicationTaskArn (string) required
ServiceAccessRoleArn (string) required
ResultLocationBucket (string) required
ResultLocationFolder (string)
ResultEncryptionMode (string)
ResultKmsKeyArn (string)
AssessmentRunName (string) required
IncludeOnly (array)
Exclude (array)
Tags (array)
database_migration_service/stop_data_migrationStops the specified data migration.DataMigrationIdentifier (string) required
database_migration_service/stop_replicationFor a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn't deprovision the stopped replications.ReplicationConfigArn (string) required
database_migration_service/stop_replication_taskStops the replication task.ReplicationTaskArn (string) required
database_migration_service/test_connectionTests the connection between the replication instance and the endpoint.ReplicationInstanceArn (string) required
EndpointArn (string) required
database_migration_service/update_subscriptions_to_event_bridgeMigrates 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.5 or higher. If any replication instances are from versions earlier than 3.4.5, the operation raises an error and tells you to upgrade these instances to version 3.4.5 or higher. To enable migration regardless of version, set the Force option to true. However, if yoForceMove (boolean)
databrew/batch_delete_recipe_versionDeletes 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 failsName (string) required
RecipeVersions (array) required
databrew/create_datasetCreates a new DataBrew dataset.Name (string) required
Format (string)
FormatOptions: {
. Json (object)
. Excel (object)
. Csv (object)
} (object)
Input: {
. S3InputDefinition (object)
. DataCatalogInputDefinition (object)
. DatabaseInputDefinition (object)
. Metadata (object)
} (object) required
PathOptions: {
. LastModifiedDateCondition (object)
. FilesLimit (object)
. Parameters (object)
} (object)
Tags (object)
databrew/create_profile_jobCreates a new job to analyze a dataset and create its data profile.DatasetName (string) required
EncryptionKeyArn (string)
EncryptionMode (string)
Name (string) required
LogSubscription (string)
MaxCapacity (integer)
MaxRetries (integer)
OutputLocation: {
. Bucket (string)
. Key (string)
. BucketOwner (string)
} (object) required
Configuration: {
. DatasetStatisticsConfiguration (object)
. ProfileColumns (array)
. ColumnStatisticsConfigurations (array)
. EntityDetectorConfiguration (object)
} (object)
ValidationConfigurations (array)
RoleArn (string) required
Tags (object)
Timeout (integer)
JobSample: {
. Mode (string)
. Size (integer)
} (object)
databrew/create_projectCreates a new DataBrew project.DatasetName (string) required
Name (string) required
RecipeName (string) required
Sample: {
. Size (integer)
. Type (string)
} (object)
RoleArn (string) required
Tags (object)
databrew/create_recipeCreates a new DataBrew recipe.Description (string)
Name (string) required
Steps (array) required
Tags (object)
databrew/create_recipe_jobCreates a new job to transform input data, using steps defined in an existing Glue DataBrew recipeDatasetName (string)
EncryptionKeyArn (string)
EncryptionMode (string)
Name (string) required
LogSubscription (string)
MaxCapacity (integer)
MaxRetries (integer)
Outputs (array)
DataCatalogOutputs (array)
DatabaseOutputs (array)
ProjectName (string)
RecipeReference: {
. Name (string)
. RecipeVersion (string)
} (object)
RoleArn (string) required
Tags (object)
Timeout (integer)
databrew/create_rulesetCreates a new ruleset that can be used in a profile job to validate the data quality of a dataset.Name (string) required
Description (string)
TargetArn (string) required
Rules (array) required
Tags (object)
databrew/create_scheduleCreates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.JobNames (array)
CronExpression (string) required
Tags (object)
Name (string) required
databrew/delete_datasetDeletes a dataset from DataBrew.Name (string) required
databrew/delete_jobDeletes the specified DataBrew job.Name (string) required
databrew/delete_projectDeletes an existing DataBrew project.Name (string) required
databrew/delete_recipe_versionDeletes a single version of a DataBrew recipe.Name (string) required
RecipeVersion (string) required
databrew/delete_rulesetDeletes a ruleset.Name (string) required
databrew/delete_scheduleDeletes the specified DataBrew schedule.Name (string) required
databrew/describe_datasetReturns the definition of a specific DataBrew dataset.Name (string) required
databrew/describe_jobReturns the definition of a specific DataBrew job.Name (string) required
databrew/describe_job_runRepresents one run of a DataBrew job.Name (string) required
RunId (string) required
databrew/describe_projectReturns the definition of a specific DataBrew project.Name (string) required
databrew/describe_recipeReturns the definition of a specific DataBrew recipe corresponding to a particular version.Name (string) required
RecipeVersion (string)
databrew/describe_rulesetRetrieves detailed information about the ruleset.Name (string) required
databrew/describe_scheduleReturns the definition of a specific DataBrew schedule.Name (string) required
databrew/list_datasetsLists all of the DataBrew datasets.MaxResults (integer)
NextToken (string)
databrew/list_job_runsLists all of the previous runs of a particular DataBrew job.Name (string) required
MaxResults (integer)
NextToken (string)
databrew/list_jobsLists all of the DataBrew jobs that are defined.DatasetName (string)
MaxResults (integer)
NextToken (string)
ProjectName (string)
databrew/list_projectsLists all of the DataBrew projects that are defined.NextToken (string)
MaxResults (integer)
databrew/list_recipesLists all of the DataBrew recipes that are defined.MaxResults (integer)
NextToken (string)
RecipeVersion (string)
databrew/list_recipe_versionsLists the versions of a particular DataBrew recipe, except for LATEST_WORKING.MaxResults (integer)
NextToken (string)
Name (string) required
databrew/list_rulesetsList all rulesets available in the current account or rulesets associated with a specific resource dataset.TargetArn (string)
MaxResults (integer)
NextToken (string)
databrew/list_schedulesLists the DataBrew schedules that are defined.JobName (string)
MaxResults (integer)
NextToken (string)
databrew/list_tags_for_resourceLists all the tags for a DataBrew resource.ResourceArn (string) required
databrew/publish_recipePublishes a new version of a DataBrew recipe.Description (string)
Name (string) required
databrew/send_project_session_actionPerforms a recipe step within an interactive DataBrew session that's currently open.Preview (boolean)
Name (string) required
RecipeStep: {
. Action (object)
. ConditionExpressions (array)
} (object)
StepIndex (integer)
ClientSessionId (string)
ViewFrame: {
. StartColumnIndex (integer)
. ColumnRange (integer)
. HiddenColumns (array)
. StartRowIndex (integer)
. RowRange (integer)
. Analytics (string)
} (object)
databrew/start_job_runRuns a DataBrew job.Name (string) required
databrew/start_project_sessionCreates an interactive session, enabling you to manipulate data in a DataBrew project.Name (string) required
AssumeControl (boolean)
databrew/stop_job_runStops a particular run of a job.Name (string) required
RunId (string) required
databrew/tag_resourceAdds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.ResourceArn (string) required
Tags (object) required
databrew/untag_resourceRemoves metadata tags from a DataBrew resource.ResourceArn (string) required
TagKeys (array) required
databrew/update_datasetModifies the definition of an existing DataBrew dataset.Name (string) required
Format (string)
FormatOptions: {
. Json (object)
. Excel (object)
. Csv (object)
} (object)
Input: {
. S3InputDefinition (object)
. DataCatalogInputDefinition (object)
. DatabaseInputDefinition (object)
. Metadata (object)
} (object) required
PathOptions: {
. LastModifiedDateCondition (object)
. FilesLimit (object)
. Parameters (object)
} (object)
databrew/update_profile_jobModifies the definition of an existing profile job.Configuration: {
. DatasetStatisticsConfiguration (object)
. ProfileColumns (array)
. ColumnStatisticsConfigurations (array)
. EntityDetectorConfiguration (object)
} (object)
EncryptionKeyArn (string)
EncryptionMode (string)
Name (string) required
LogSubscription (string)
MaxCapacity (integer)
MaxRetries (integer)
OutputLocation: {
. Bucket (string)
. Key (string)
. BucketOwner (string)
} (object) required
ValidationConfigurations (array)
RoleArn (string) required
Timeout (integer)
JobSample: {
. Mode (string)
. Size (integer)
} (object)
databrew/update_projectModifies the definition of an existing DataBrew project.Sample: {
. Size (integer)
. Type (string)
} (object)
RoleArn (string) required
Name (string) required
databrew/update_recipeModifies the definition of the LATEST_WORKING version of a DataBrew recipe.Description (string)
Name (string) required
Steps (array)
databrew/update_recipe_jobModifies the definition of an existing DataBrew recipe job.EncryptionKeyArn (string)
EncryptionMode (string)
Name (string) required
LogSubscription (string)
MaxCapacity (integer)
MaxRetries (integer)
Outputs (array)
DataCatalogOutputs (array)
DatabaseOutputs (array)
RoleArn (string) required
Timeout (integer)
databrew/update_rulesetUpdates specified ruleset.Name (string) required
Description (string)
Rules (array) required
databrew/update_scheduleModifies the definition of an existing DataBrew schedule.JobNames (array)
CronExpression (string) required
Name (string) required
dataexchange/accept_data_grantThis operation accepts a data grant.DataGrantArn (string) required
dataexchange/cancel_jobThis operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.JobId (string) required
dataexchange/create_data_grantThis operation creates a data grant.Name (string) required
GrantDistributionScope (string) required
ReceiverPrincipal (string) required
SourceDataSetId (string) required
EndsAt (string)
Description (string)
Tags (object)
dataexchange/create_data_setThis operation creates a data set.AssetType (string) required
Description (string) required
Name (string) required
Tags (object)
dataexchange/create_event_actionThis operation creates an event action.Action: {
. ExportRevisionToS3 (object)
} (object) required
Event: {
. RevisionPublished (object)
} (object) required
Tags (object)
dataexchange/create_jobThis operation creates a job.Details: {
. ExportAssetToSignedUrl (object)
. ExportAssetsToS3 (object)
. ExportRevisionsToS3 (object)
. ImportAssetFromSignedUrl (object)
. ImportAssetsFromS3 (object)
. ImportAssetsFromRedshiftDataShares (object)
. ImportAssetFromApiGatewayApi (object)
. CreateS3DataAccessFromS3Bucket (object)
. ImportAssetsFromLakeFormationTagPolicy (object)
} (object) required
Type (string) required
dataexchange/create_revisionThis operation creates a revision for a data set.Comment (string)
DataSetId (string) required
Tags (object)
dataexchange/delete_assetThis operation deletes an asset.AssetId (string) required
DataSetId (string) required
RevisionId (string) required
dataexchange/delete_data_grantThis operation deletes a data grant.DataGrantId (string) required
dataexchange/delete_data_setThis operation deletes a data set.DataSetId (string) required
dataexchange/delete_event_actionThis operation deletes the event action.EventActionId (string) required
dataexchange/delete_revisionThis operation deletes a revision.DataSetId (string) required
RevisionId (string) required
dataexchange/get_assetThis operation returns information about an asset.AssetId (string) required
DataSetId (string) required
RevisionId (string) required
dataexchange/get_data_grantThis operation returns information about a data grant.DataGrantId (string) required
dataexchange/get_data_setThis operation returns information about a data set.DataSetId (string) required
dataexchange/get_event_actionThis operation retrieves information about an event action.EventActionId (string) required
dataexchange/get_jobThis operation returns information about a job.JobId (string) required
dataexchange/get_received_data_grantThis operation returns information about a received data grant.DataGrantArn (string) required
dataexchange/get_revisionThis operation returns information about a revision.DataSetId (string) required
RevisionId (string) required
dataexchange/list_data_grantsThis operation returns information about all data grants.MaxResults (integer)
NextToken (string)
dataexchange/list_data_set_revisionsThis operation lists a data set's revisions sorted by CreatedAt in descending order.DataSetId (string) required
MaxResults (integer)
NextToken (string)
dataexchange/list_data_setsThis 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.MaxResults (integer)
NextToken (string)
Origin (string)
dataexchange/list_event_actionsThis operation lists your event actions.EventSourceId (string)
MaxResults (integer)
NextToken (string)
dataexchange/list_jobsThis operation lists your jobs sorted by CreatedAt in descending order.DataSetId (string)
MaxResults (integer)
NextToken (string)
RevisionId (string)
dataexchange/list_received_data_grantsThis operation returns information about all received data grants.MaxResults (integer)
NextToken (string)
AcceptanceState (array)
dataexchange/list_revision_assetsThis operation lists a revision's assets sorted alphabetically in descending order.DataSetId (string) required
MaxResults (integer)
NextToken (string)
RevisionId (string) required
dataexchange/list_tags_for_resourceThis operation lists the tags on the resource.ResourceArn (string) required
dataexchange/revoke_revisionThis operation revokes subscribers' access to a revision.DataSetId (string) required
RevisionId (string) required
RevocationComment (string) required
dataexchange/send_api_assetThis operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.Body (string)
QueryStringParameters (object)
AssetId (string) required
DataSetId (string) required
RequestHeaders (object)
Method (string)
Path (string)
RevisionId (string) required
dataexchange/send_data_set_notificationThe type of event associated with the data set.Scope: {
. LakeFormationTagPolicies (array)
. RedshiftDataShares (array)
. S3DataAccesses (array)
} (object)
ClientToken (string)
Comment (string)
DataSetId (string) required
Details: {
. DataUpdate (object)
. Deprecation (object)
. SchemaChange (object)
} (object)
Type (string) required
dataexchange/start_jobThis operation starts a job.JobId (string) required
dataexchange/tag_resourceThis operation tags a resource.ResourceArn (string) required
Tags (object) required
dataexchange/untag_resourceThis operation removes one or more tags from a resource.ResourceArn (string) required
TagKeys (array) required
dataexchange/update_assetThis operation updates an asset.AssetId (string) required
DataSetId (string) required
Name (string) required
RevisionId (string) required
dataexchange/update_data_setThis operation updates a data set.DataSetId (string) required
Description (string)
Name (string)
dataexchange/update_event_actionThis operation updates the event action.Action: {
. ExportRevisionToS3 (object)
} (object)
EventActionId (string) required
dataexchange/update_revisionThis operation updates a revision.Comment (string)
DataSetId (string) required
Finalized (boolean)
RevisionId (string) required
datasync/cancel_task_executionStops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completesTaskExecutionArn (string) required
datasync/create_agentActivates an DataSync agent that you deploy in your storage environment. The activation process associates the agent with your Amazon Web Services account. If you haven't deployed an agent yet, see Do I need a DataSync agent?ActivationKey (string) required
AgentName (string)
Tags (array)
VpcEndpointId (string)
SubnetArns (array)
SecurityGroupArns (array)
datasync/create_location_azure_blobCreates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination. You can make transfers with or without a DataSync agent that connects to your container. Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types.ContainerUrl (string) required
AuthenticationType (string) required
SasConfiguration: {
. Token (string)
} (object)
BlobType (string)
AccessTier (string)
Subdirectory (string)
AgentArns (array)
Tags (array)
CmkSecretConfig: {
. SecretArn (string)
. KmsKeyArn (string)
} (object)
CustomSecretConfig: {
. SecretArn (string)
. SecretAccessRoleArn (string)
} (object)
datasync/create_location_efsCreates a transfer location for an Amazon EFS file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses Amazon EFS file systems.Subdirectory (string)
EfsFilesystemArn (string) required
Ec2Config: {
. SubnetArn (string)
. SecurityGroupArns (array)
} (object) required
Tags (array)
AccessPointArn (string)
FileSystemAccessRoleArn (string)
InTransitEncryption (string)
datasync/create_location_fsx_lustreCreates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for Lustre file systems.FsxFilesystemArn (string) required
SecurityGroupArns (array) required
Subdirectory (string)
Tags (array)
datasync/create_location_fsx_ontapCreates a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for ONTAP file systems.Protocol: {
. NFS (object)
. SMB (object)
} (object) required
SecurityGroupArns (array) required
StorageVirtualMachineArn (string) required
Subdirectory (string)
Tags (array)
datasync/create_location_fsx_open_zfsCreates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for OpenZFS file systems. Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.FsxFilesystemArn (string) required
Protocol: {
. NFS (object)
. SMB (object)
} (object) required
SecurityGroupArns (array) required
Subdirectory (string)
Tags (array)
datasync/create_location_fsx_windowsCreates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems.Subdirectory (string)
FsxFilesystemArn (string) required
SecurityGroupArns (array) required
Tags (array)
User (string) required
Domain (string)
Password (string) required
datasync/create_location_hdfsCreates a transfer location for a Hadoop Distributed File System HDFS. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses HDFS clusters.Subdirectory (string)
NameNodes (array) required
BlockSize (integer)
ReplicationFactor (integer)
KmsKeyProviderUri (string)
QopConfiguration: {
. RpcProtection (string)
. DataTransferProtection (string)
} (object)
AuthenticationType (string) required
SimpleUser (string)
KerberosPrincipal (string)
KerberosKeytab (string)
KerberosKrb5Conf (string)
AgentArns (array) required
Tags (array)
datasync/create_location_nfsCreates a transfer location for a Network File System NFS file server. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses NFS file servers.Subdirectory (string) required
ServerHostname (string) required
OnPremConfig: {
. AgentArns (array)
} (object) required
MountOptions: {
. Version (string)
} (object)
Tags (array)
datasync/create_location_object_storageCreates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data. You can make transfers with or without a DataSync agent. Before you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems.ServerHostname (string) required
ServerPort (integer)
ServerProtocol (string)
Subdirectory (string)
BucketName (string) required
AccessKey (string)
SecretKey (string)
AgentArns (array)
Tags (array)
ServerCertificate (string)
CmkSecretConfig: {
. SecretArn (string)
. KmsKeyArn (string)
} (object)
CustomSecretConfig: {
. SecretArn (string)
. SecretAccessRoleArn (string)
} (object)
datasync/create_location_s3Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you read the following topics: Storage class considerations with Amazon S3 locations Evaluating S3 request costs when using DataSync For more information, see Configuring transfers with Amazon S3.Subdirectory (string)
S3BucketArn (string) required
S3StorageClass (string)
S3Config: {
. BucketAccessRoleArn (string)
} (object) required
AgentArns (array)
Tags (array)
datasync/create_location_smbCreates a transfer location for a Server Message Block SMB file server. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses SMB file servers. For more information, see Providing DataSync access to SMB file servers.Subdirectory (string) required
ServerHostname (string) required
User (string)
Domain (string)
Password (string)
CmkSecretConfig: {
. SecretArn (string)
. KmsKeyArn (string)
} (object)
CustomSecretConfig: {
. SecretArn (string)
. SecretAccessRoleArn (string)
} (object)
AgentArns (array) required
MountOptions: {
. Version (string)
} (object)
Tags (array)
AuthenticationType (string)
DnsIpAddresses (array)
KerberosPrincipal (string)
KerberosKeytab (string)
KerberosKrb5Conf (string)
datasync/create_taskConfigures a task, which defines where and how DataSync transfers your data. A task includes a source location, destination location, and transfer options such as bandwidth limits, scheduling, and more. If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.SourceLocationArn (string) required
DestinationLocationArn (string) required
CloudWatchLogGroupArn (string)
Name (string)
Options: {
. VerifyMode (string)
. OverwriteMode (string)
. Atime (string)
. Mtime (string)
. Uid (string)
. Gid (string)
. PreserveDeletedFiles (string)
. PreserveDevices (string)
. PosixPermissions (string)
. BytesPerSecond (integer)
. TaskQueueing (string)
. LogLevel (string)
. TransferMode (string)
. SecurityDescriptorCopyFlags (string)
. ObjectTags (string)
} (object)
Excludes (array)
Schedule: {
. ScheduleExpression (string)
. Status (string)
} (object)
Tags (array)
Includes (array)
ManifestConfig: {
. Action (string)
. Format (string)
. Source (object)
} (object)
TaskReportConfig: {
. Destination (object)
. OutputType (string)
. ReportLevel (string)
. ObjectVersionIds (string)
. Overrides (object)
} (object)
TaskMode (string)
datasync/delete_agentRemoves an DataSync agent resource from your Amazon Web Services account. Keep in mind that this operation which can't be undone doesn't remove the agent's virtual machine VM or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage environment or reuse it to activate a new agent.AgentArn (string) required
datasync/delete_locationDeletes a transfer location resource from DataSync.LocationArn (string) required
datasync/delete_taskDeletes a transfer task resource from DataSync.TaskArn (string) required
datasync/describe_agentReturns information about an DataSync agent, such as its name, service endpoint type, and status.AgentArn (string) required
datasync/describe_location_azure_blobProvides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.LocationArn (string) required
datasync/describe_location_efsProvides details about how an DataSync transfer location for an Amazon EFS file system is configured.LocationArn (string) required
datasync/describe_location_fsx_lustreProvides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.LocationArn (string) required
datasync/describe_location_fsx_ontapProvides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured. If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.LocationArn (string) required
datasync/describe_location_fsx_open_zfsProvides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured. Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.LocationArn (string) required
datasync/describe_location_fsx_windowsProvides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.LocationArn (string) required
datasync/describe_location_hdfsProvides details about how an DataSync transfer location for a Hadoop Distributed File System HDFS is configured.LocationArn (string) required
datasync/describe_location_nfsProvides details about how an DataSync transfer location for a Network File System NFS file server is configured.LocationArn (string) required
datasync/describe_location_object_storageProvides details about how an DataSync transfer location for an object storage system is configured.LocationArn (string) required
datasync/describe_location_s3Provides details about how an DataSync transfer location for an S3 bucket is configured.LocationArn (string) required
datasync/describe_location_smbProvides details about how an DataSync transfer location for a Server Message Block SMB file server is configured.LocationArn (string) required
datasync/describe_taskProvides information about a task, which defines where and how DataSync transfers your data.TaskArn (string) required
datasync/describe_task_executionProvides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing data transfer or check the results of the transfer. Some DescribeTaskExecution response elements are only relevant to a specific task mode. For information, see Understanding task mode differences and Understanding data transfer performance counters.TaskExecutionArn (string) required
datasync/list_agentsReturns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request. With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents. ListAgents is eventually consistent. This means the result of running the operation might not reflect that you just createdMaxResults (integer)
NextToken (string)
datasync/list_locationsReturns 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.MaxResults (integer)
NextToken (string)
Filters (array)
datasync/list_tags_for_resourceReturns all the tags associated with an Amazon Web Services resource.ResourceArn (string) required
MaxResults (integer)
NextToken (string)
datasync/list_task_executionsReturns a list of executions for an DataSync transfer task.TaskArn (string)
MaxResults (integer)
NextToken (string)
datasync/list_tasksReturns a list of the DataSync tasks you created.MaxResults (integer)
NextToken (string)
Filters (array)
datasync/start_task_executionStarts an DataSync transfer task. For each task, you can only run one task execution at a time. There are several steps to a task execution. For more information, see Task execution statuses. If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.TaskArn (string) required
OverrideOptions: {
. VerifyMode (string)
. OverwriteMode (string)
. Atime (string)
. Mtime (string)
. Uid (string)
. Gid (string)
. PreserveDeletedFiles (string)
. PreserveDevices (string)
. PosixPermissions (string)
. BytesPerSecond (integer)
. TaskQueueing (string)
. LogLevel (string)
. TransferMode (string)
. SecurityDescriptorCopyFlags (string)
. ObjectTags (string)
} (object)
Includes (array)
Excludes (array)
ManifestConfig: {
. Action (string)
. Format (string)
. Source (object)
} (object)
TaskReportConfig: {
. Destination (object)
. OutputType (string)
. ReportLevel (string)
. ObjectVersionIds (string)
. Overrides (object)
} (object)
Tags (array)
datasync/tag_resourceApplies a tag to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources. These include DataSync resources, such as locations, tasks, and task executions.ResourceArn (string) required
Tags (array) required
datasync/untag_resourceRemoves tags from an Amazon Web Services resource.ResourceArn (string) required
Keys (array) required
datasync/update_agentUpdates the name of an DataSync agent.AgentArn (string) required
Name (string)
datasync/update_location_azure_blobModifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with Azure Blob Storage.LocationArn (string) required
Subdirectory (string)
AuthenticationType (string)
SasConfiguration: {
. Token (string)
} (object)
BlobType (string)
AccessTier (string)
AgentArns (array)
CmkSecretConfig: {
. SecretArn (string)
. KmsKeyArn (string)
} (object)
CustomSecretConfig: {
. SecretArn (string)
. SecretAccessRoleArn (string)
} (object)
datasync/update_location_efsModifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with Amazon EFS.LocationArn (string) required
Subdirectory (string)
AccessPointArn (string)
FileSystemAccessRoleArn (string)
InTransitEncryption (string)
datasync/update_location_fsx_lustreModifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for Lustre.LocationArn (string) required
Subdirectory (string)
datasync/update_location_fsx_ontapModifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for ONTAP.LocationArn (string) required
Protocol: {
. NFS (object)
. SMB (object)
} (object)
Subdirectory (string)
datasync/update_location_fsx_open_zfsModifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for OpenZFS. Request parameters related to SMB aren't supported with the UpdateLocationFsxOpenZfs operation.LocationArn (string) required
Protocol: {
. NFS (object)
. SMB (object)
} (object)
Subdirectory (string)
datasync/update_location_fsx_windowsModifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for Windows File Server.LocationArn (string) required
Subdirectory (string)
Domain (string)
User (string)
Password (string)
datasync/update_location_hdfsModifies the following configuration parameters of the Hadoop Distributed File System HDFS transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an HDFS cluster.LocationArn (string) required
Subdirectory (string)
NameNodes (array)
BlockSize (integer)
ReplicationFactor (integer)
KmsKeyProviderUri (string)
QopConfiguration: {
. RpcProtection (string)
. DataTransferProtection (string)
} (object)
AuthenticationType (string)
SimpleUser (string)
KerberosPrincipal (string)
KerberosKeytab (string)
KerberosKrb5Conf (string)
AgentArns (array)
datasync/update_location_nfsModifies the following configuration parameters of the Network File System NFS transfer location that you're using with DataSync. For more information, see Configuring transfers with an NFS file server.LocationArn (string) required
Subdirectory (string)
ServerHostname (string)
OnPremConfig: {
. AgentArns (array)
} (object)
MountOptions: {
. Version (string)
} (object)
datasync/update_location_object_storageModifies the following configuration parameters of the object storage transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an object storage system.LocationArn (string) required
ServerPort (integer)
ServerProtocol (string)
Subdirectory (string)
ServerHostname (string)
AccessKey (string)
SecretKey (string)
AgentArns (array)
ServerCertificate (string)
CmkSecretConfig: {
. SecretArn (string)
. KmsKeyArn (string)
} (object)
CustomSecretConfig: {
. SecretArn (string)
. SecretAccessRoleArn (string)
} (object)
datasync/update_location_s3Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync. Before you begin, make sure that you read the following topics: Storage class considerations with Amazon S3 locations Evaluating S3 request costs when using DataSyncLocationArn (string) required
Subdirectory (string)
S3StorageClass (string)
S3Config: {
. BucketAccessRoleArn (string)
} (object)
datasync/update_location_smbModifies the following configuration parameters of the Server Message Block SMB transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an SMB file server.LocationArn (string) required
Subdirectory (string)
ServerHostname (string)
User (string)
Domain (string)
Password (string)
CmkSecretConfig: {
. SecretArn (string)
. KmsKeyArn (string)
} (object)
CustomSecretConfig: {
. SecretArn (string)
. SecretAccessRoleArn (string)
} (object)
AgentArns (array)
MountOptions: {
. Version (string)
} (object)
AuthenticationType (string)
DnsIpAddresses (array)
KerberosPrincipal (string)
KerberosKeytab (string)
KerberosKrb5Conf (string)
datasync/update_taskUpdates the configuration of a task, which defines where and how DataSync transfers your data.TaskArn (string) required
Options: {
. VerifyMode (string)
. OverwriteMode (string)
. Atime (string)
. Mtime (string)
. Uid (string)
. Gid (string)
. PreserveDeletedFiles (string)
. PreserveDevices (string)
. PosixPermissions (string)
. BytesPerSecond (integer)
. TaskQueueing (string)
. LogLevel (string)
. TransferMode (string)
. SecurityDescriptorCopyFlags (string)
. ObjectTags (string)
} (object)
Excludes (array)
Schedule: {
. ScheduleExpression (string)
. Status (string)
} (object)
Name (string)
CloudWatchLogGroupArn (string)
Includes (array)
ManifestConfig: {
. Action (string)
. Format (string)
. Source (object)
} (object)
TaskReportConfig: {
. Destination (object)
. OutputType (string)
. ReportLevel (string)
. ObjectVersionIds (string)
. Overrides (object)
} (object)
datasync/update_task_executionUpdates the configuration of a running DataSync task execution. Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond , which throttles bandwidth for a running or queued task execution.TaskExecutionArn (string) required
Options: {
. VerifyMode (string)
. OverwriteMode (string)
. Atime (string)
. Mtime (string)
. Uid (string)
. Gid (string)
. PreserveDeletedFiles (string)
. PreserveDevices (string)
. PosixPermissions (string)
. BytesPerSecond (integer)
. TaskQueueing (string)
. LogLevel (string)
. TransferMode (string)
. SecurityDescriptorCopyFlags (string)
. ObjectTags (string)
} (object) required
datazone/accept_predictionsAccepts automatically generated business-friendly metadata for your Amazon DataZone assets.domainIdentifier (string) required
identifier (string) required
revision (string)
acceptRule: {
. rule (string)
. threshold (number)
} (object)
acceptChoices (array)
clientToken (string)
datazone/accept_subscription_requestAccepts a subscription request to a specific asset.domainIdentifier (string) required
identifier (string) required
decisionComment (string)
assetScopes (array)
assetPermissions (array)
datazone/add_entity_ownerAdds the owner of an entity a domain unit.domainIdentifier (string) required
entityType (string) required
entityIdentifier (string) required
owner (undefined) required
clientToken (string)
datazone/add_policy_grantAdds a policy grant an authorization policy to a specified entity, including domain units, environment blueprint configurations, or environment profiles.domainIdentifier (string) required
entityType (string) required
entityIdentifier (string) required
policyType (string) required
principal (undefined) required
detail (undefined) required
clientToken (string)
datazone/associate_environment_roleAssociates the environment role in Amazon DataZone.domainIdentifier (string) required
environmentIdentifier (string) required
environmentRoleArn (string) required
datazone/associate_governed_termsAssociates governed terms with an asset.domainIdentifier (string) required
entityIdentifier (string) required
entityType (string) required
governedGlossaryTerms (array) required
datazone/batch_get_attributes_metadataGets the attribute metadata.domainIdentifier (string) required
entityType (string) required
entityIdentifier (string) required
entityRevision (string)
attributeIdentifiers (array) required
datazone/batch_put_attributes_metadataWrites the attribute metadata.domainIdentifier (string) required
entityType (string) required
entityIdentifier (string) required
clientToken (string)
attributes (array) required
datazone/cancel_subscriptionCancels the subscription to the specified asset.domainIdentifier (string) required
identifier (string) required
datazone/create_account_poolCreates an account pool.domainIdentifier (string) required
name (string) required
description (string)
resolutionStrategy (string) required
accountSource (undefined) required
datazone/create_asset_filterCreates a data asset filter. Asset filters provide a sophisticated way to create controlled views of data assets by selecting specific columns or applying row-level filters. This capability is crucial for organizations that need to share data while maintaining security and privacy controls. For example, your database might be filtered to show only non-PII fields to certain users, or sales data might be filtered by region for different regional teams. Asset filters enable fine-grained access contdomainIdentifier (string) required
assetIdentifier (string) required
name (string) required
description (string)
configuration (undefined) required
clientToken (string)
datazone/create_connectionCreates a new connection. In Amazon DataZone, a connection enables you to connect your resources domains, projects, and environments to external resources and services.awsLocation: {
. accessRole (string)
. awsAccountId (string)
. awsRegion (string)
. iamConnectionId (string)
} (object)
clientToken (string)
description (string)
domainIdentifier (string) required
environmentIdentifier (string)
name (string) required
props (undefined)
enableTrustedIdentityPropagation (boolean)
scope (string)
datazone/create_environmentCreate an Amazon DataZone environment.projectIdentifier (string) required
domainIdentifier (string) required
description (string)
name (string) required
environmentProfileIdentifier (string)
userParameters (array)
glossaryTerms (array)
environmentAccountIdentifier (string)
environmentAccountRegion (string)
environmentBlueprintIdentifier (string)
deploymentOrder (integer)
environmentConfigurationId (string)
datazone/create_environment_actionCreates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.domainIdentifier (string) required
environmentIdentifier (string) required
name (string) required
parameters (undefined) required
description (string)
datazone/create_environment_blueprintCreates a Amazon DataZone blueprint.domainIdentifier (string) required
name (string) required
description (string)
provisioningProperties (undefined) required
userParameters (array)
datazone/create_environment_profileCreates an Amazon DataZone environment profile.domainIdentifier (string) required
name (string) required
description (string)
environmentBlueprintIdentifier (string) required
projectIdentifier (string) required
userParameters (array)
awsAccountId (string)
awsAccountRegion (string)
datazone/create_group_profileCreates a group profile in Amazon DataZone.domainIdentifier (string) required
groupIdentifier (string) required
clientToken (string)
datazone/create_listing_change_setPublishes a listing a record of an asset at a given time or removes a listing from the catalog.domainIdentifier (string) required
entityIdentifier (string) required
entityType (string) required
entityRevision (string)
action (string) required
clientToken (string)
datazone/create_projectCreates an Amazon DataZone project.domainIdentifier (string) required
name (string) required
description (string)
resourceTags (object)
glossaryTerms (array)
domainUnitId (string)
projectProfileId (string)
userParameters (array)
datazone/create_project_membershipCreates a project membership in Amazon DataZone.domainIdentifier (string) required
projectIdentifier (string) required
member (undefined) required
designation (string) required
datazone/create_project_profileCreates a project profile.domainIdentifier (string) required
name (string) required
description (string)
status (string)
projectResourceTags (array)
allowCustomProjectResourceTags (boolean)
projectResourceTagsDescription (string)
environmentConfigurations (array)
domainUnitIdentifier (string)
datazone/create_subscription_grantCreates a subsscription grant in Amazon DataZone.domainIdentifier (string) required
environmentIdentifier (string) required
subscriptionTargetIdentifier (string)
grantedEntity (undefined) required
assetTargetNames (array)
clientToken (string)
datazone/create_subscription_requestCreates a subscription request in Amazon DataZone.domainIdentifier (string) required
subscribedPrincipals (array) required
subscribedListings (array) required
requestReason (string) required
clientToken (string)
metadataForms (array)
assetPermissions (array)
assetScopes (array)
datazone/create_subscription_targetCreates a subscription target in Amazon DataZone.domainIdentifier (string) required
environmentIdentifier (string) required
name (string) required
type (string) required
subscriptionTargetConfig (array) required
authorizedPrincipals (array) required
manageAccessRole (string) required
applicableAssetTypes (array) required
provider (string)
clientToken (string)
subscriptionGrantCreationMode (string)
datazone/create_user_profileCreates a user profile in Amazon DataZone.domainIdentifier (string) required
userIdentifier (string) required
userType (string)
clientToken (string)
datazone/delete_account_poolDeletes an account pool.domainIdentifier (string) required
identifier (string) required
datazone/delete_asset_filterDeletes an asset filter. Prerequisites: The asset filter must exist. The domain and asset must not have been deleted. Ensure the --identifier refers to a valid filter ID.domainIdentifier (string) required
assetIdentifier (string) required
identifier (string) required
datazone/delete_connectionDeletes and connection. In Amazon DataZone, a connection enables you to connect your resources domains, projects, and environments to external resources and services.domainIdentifier (string) required
identifier (string) required
datazone/delete_data_export_configurationDeletes data export configuration for a domain. This operation does not delete the S3 table created by the PutDataExportConfiguration operation. To temporarily disable export without deleting the configuration, use the PutDataExportConfiguration operation with the --no-enable-export flag instead. This allows you to re-enable export for the same domain using the --enable-export flag without deleting S3 table.domainIdentifier (string) required
datazone/delete_environmentDeletes an environment in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
datazone/delete_environment_actionDeletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.domainIdentifier (string) required
environmentIdentifier (string) required
identifier (string) required
datazone/delete_environment_blueprintDeletes a blueprint in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
datazone/delete_environment_profileDeletes an environment profile in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
datazone/delete_projectDeletes a project in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
skipDeletionCheck (boolean)
datazone/delete_project_membershipDeletes project membership in Amazon DataZone.domainIdentifier (string) required
projectIdentifier (string) required
member (undefined) required
datazone/delete_project_profileDeletes a project profile.domainIdentifier (string) required
identifier (string) required
datazone/delete_subscription_grantDeletes and subscription grant in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
datazone/delete_subscription_requestDeletes a subscription request in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
datazone/delete_subscription_targetDeletes a subscription target in Amazon DataZone.domainIdentifier (string) required
environmentIdentifier (string) required
identifier (string) required
datazone/delete_time_series_data_pointsDeletes the specified time series form for the specified asset.domainIdentifier (string) required
entityIdentifier (string) required
entityType (string) required
formName (string) required
clientToken (string)
datazone/disassociate_environment_roleDisassociates the environment role in Amazon DataZone.domainIdentifier (string) required
environmentIdentifier (string) required
environmentRoleArn (string) required
datazone/disassociate_governed_termsDisassociates restricted terms from an asset.domainIdentifier (string) required
entityIdentifier (string) required
entityType (string) required
governedGlossaryTerms (array) required
datazone/get_account_poolGets the details of the account pool.domainIdentifier (string) required
identifier (string) required
datazone/get_asset_filterGets an asset filter. Prerequisites: Domain --domain-identifier, asset --asset-identifier, and filter --identifier must all exist. The asset filter should not have been deleted. The asset must still exist since the filter is linked to it.domainIdentifier (string) required
assetIdentifier (string) required
identifier (string) required
datazone/get_connectionGets a connection. In Amazon DataZone, a connection enables you to connect your resources domains, projects, and environments to external resources and services.domainIdentifier (string) required
identifier (string) required
withSecret (boolean)
datazone/get_data_export_configurationGets data export configuration details.domainIdentifier (string) required
datazone/get_environmentGets an Amazon DataZone environment.domainIdentifier (string) required
identifier (string) required
datazone/get_environment_actionGets the specified environment action.domainIdentifier (string) required
environmentIdentifier (string) required
identifier (string) required
datazone/get_environment_blueprintGets an Amazon DataZone blueprint.domainIdentifier (string) required
identifier (string) required
datazone/get_environment_credentialsGets the credentials of an environment in Amazon DataZone.domainIdentifier (string) required
environmentIdentifier (string) required
datazone/get_environment_profileGets an evinronment profile in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
datazone/get_group_profileGets a group profile in Amazon DataZone.domainIdentifier (string) required
groupIdentifier (string) required
datazone/get_iam_portal_login_urlGets the data portal URL for the specified Amazon DataZone domain.domainIdentifier (string) required
datazone/get_job_runThe details of the job run.domainIdentifier (string) required
identifier (string) required
datazone/get_lineage_eventDescribes the lineage event.domainIdentifier (string) required
identifier (string) required
datazone/get_lineage_nodeGets the data lineage node.domainIdentifier (string) required
identifier (string) required
eventTimestamp (string)
datazone/get_projectGets a project in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
datazone/get_project_profileThe details of the project profile.domainIdentifier (string) required
identifier (string) required
datazone/get_subscriptionGets a subscription in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
datazone/get_subscription_grantGets the subscription grant in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
datazone/get_subscription_request_detailsGets the details of the specified subscription request.domainIdentifier (string) required
identifier (string) required
datazone/get_subscription_targetGets the subscription target in Amazon DataZone.domainIdentifier (string) required
environmentIdentifier (string) required
identifier (string) required
datazone/get_time_series_data_pointGets the existing data point for the asset.domainIdentifier (string) required
entityIdentifier (string) required
entityType (string) required
identifier (string) required
formName (string) required
datazone/get_user_profileGets a user profile in Amazon DataZone.domainIdentifier (string) required
userIdentifier (string) required
type (string)
datazone/list_account_poolsLists existing account pools.domainIdentifier (string) required
name (string)
sortBy (string)
sortOrder (string)
nextToken (string)
maxResults (integer)
datazone/list_accounts_in_account_poolLists the accounts in the specified account pool.domainIdentifier (string) required
identifier (string) required
nextToken (string)
maxResults (integer)
datazone/list_asset_filtersLists asset filters. Prerequisites: A valid domain and asset must exist. The asset must have at least one filter created to return results.domainIdentifier (string) required
assetIdentifier (string) required
status (string)
nextToken (string)
maxResults (integer)
datazone/list_asset_revisionsLists the revisions for the asset. Prerequisites: The asset must exist in the domain. There must be at least one revision of the asset which happens automatically after creation. The domain must be valid and active. User must have permissions on the asset and domain.domainIdentifier (string) required
identifier (string) required
nextToken (string)
maxResults (integer)
datazone/list_connectionsLists connections. In Amazon DataZone, a connection enables you to connect your resources domains, projects, and environments to external resources and services.domainIdentifier (string) required
maxResults (integer)
nextToken (string)
sortBy (string)
sortOrder (string)
name (string)
environmentIdentifier (string)
projectIdentifier (string)
type (string)
scope (string)
datazone/list_data_product_revisionsLists data product revisions. Prerequisites: The data product ID must exist within the domain. User must have view permissions on the data product. The domain must be in a valid and accessible state.domainIdentifier (string) required
identifier (string) required
maxResults (integer)
nextToken (string)
datazone/list_data_source_run_activitiesLists data source run activities.domainIdentifier (string) required
identifier (string) required
status (string)
nextToken (string)
maxResults (integer)
datazone/list_entity_ownersLists the entity domain units owners.domainIdentifier (string) required
entityType (string) required
entityIdentifier (string) required
maxResults (integer)
nextToken (string)
datazone/list_environment_actionsLists existing environment actions.domainIdentifier (string) required
environmentIdentifier (string) required
nextToken (string)
maxResults (integer)
datazone/list_environment_blueprintsLists blueprints in an Amazon DataZone environment.domainIdentifier (string) required
maxResults (integer)
nextToken (string)
name (string)
managed (boolean)
datazone/list_environment_profilesLists Amazon DataZone environment profiles.domainIdentifier (string) required
awsAccountId (string)
awsAccountRegion (string)
environmentBlueprintIdentifier (string)
projectIdentifier (string)
name (string)
nextToken (string)
maxResults (integer)
datazone/list_environmentsLists Amazon DataZone environments.domainIdentifier (string) required
awsAccountId (string)
status (string)
awsAccountRegion (string)
projectIdentifier (string) required
environmentProfileIdentifier (string)
environmentBlueprintIdentifier (string)
provider (string)
name (string)
maxResults (integer)
nextToken (string)
datazone/list_job_runsLists job runs.domainIdentifier (string) required
jobIdentifier (string) required
status (string)
sortOrder (string)
nextToken (string)
maxResults (integer)
datazone/list_lineage_eventsLists lineage events.domainIdentifier (string) required
maxResults (integer)
timestampAfter (string)
timestampBefore (string)
processingStatus (string)
sortOrder (string)
nextToken (string)
datazone/list_lineage_node_historyLists the history of the specified data lineage node.domainIdentifier (string) required
maxResults (integer)
nextToken (string)
identifier (string) required
direction (string)
eventTimestampGTE (string)
eventTimestampLTE (string)
sortOrder (string)
datazone/list_notificationsLists all Amazon DataZone notifications.domainIdentifier (string) required
type (string) required
afterTimestamp (string)
beforeTimestamp (string)
subjects (array)
taskStatus (string)
maxResults (integer)
nextToken (string)
datazone/list_policy_grantsLists policy grants.domainIdentifier (string) required
entityType (string) required
entityIdentifier (string) required
policyType (string) required
maxResults (integer)
nextToken (string)
datazone/list_project_membershipsLists all members of the specified project.domainIdentifier (string) required
projectIdentifier (string) required
sortBy (string)
sortOrder (string)
nextToken (string)
maxResults (integer)
datazone/list_project_profilesLists project profiles.domainIdentifier (string) required
name (string)
sortBy (string)
sortOrder (string)
nextToken (string)
maxResults (integer)
datazone/list_projectsLists Amazon DataZone projects.domainIdentifier (string) required
userIdentifier (string)
groupIdentifier (string)
name (string)
nextToken (string)
maxResults (integer)
datazone/list_subscription_grantsLists subscription grants.domainIdentifier (string) required
environmentId (string)
subscriptionTargetId (string)
subscribedListingId (string)
subscriptionId (string)
owningProjectId (string)
owningIamPrincipalArn (string)
owningUserId (string)
owningGroupId (string)
sortBy (string)
sortOrder (string)
maxResults (integer)
nextToken (string)
datazone/list_subscription_requestsLists Amazon DataZone subscription requests.domainIdentifier (string) required
status (string)
subscribedListingId (string)
owningProjectId (string)
owningIamPrincipalArn (string)
approverProjectId (string)
owningUserId (string)
owningGroupId (string)
sortBy (string)
sortOrder (string)
maxResults (integer)
nextToken (string)
datazone/list_subscriptionsLists subscriptions in Amazon DataZone.domainIdentifier (string) required
subscriptionRequestIdentifier (string)
status (string)
subscribedListingId (string)
owningProjectId (string)
owningIamPrincipalArn (string)
owningUserId (string)
owningGroupId (string)
approverProjectId (string)
sortBy (string)
sortOrder (string)
maxResults (integer)
nextToken (string)
datazone/list_subscription_targetsLists subscription targets in Amazon DataZone.domainIdentifier (string) required
environmentIdentifier (string) required
sortBy (string)
sortOrder (string)
maxResults (integer)
nextToken (string)
datazone/list_tags_for_resourceLists tags for the specified resource in Amazon DataZone.resourceArn (string) required
datazone/list_time_series_data_pointsLists time series data points.domainIdentifier (string) required
entityIdentifier (string) required
entityType (string) required
formName (string) required
startedAt (string)
endedAt (string)
nextToken (string)
maxResults (integer)
datazone/post_lineage_eventPosts a data lineage event.domainIdentifier (string) required
event (string) required
clientToken (string)
datazone/post_time_series_data_pointsPosts time series data points to Amazon DataZone for the specified asset.domainIdentifier (string) required
entityIdentifier (string) required
entityType (string) required
forms (array) required
clientToken (string)
datazone/put_data_export_configurationCreates data export configuration details. If you want to temporarily disable export and later re-enable it for the same domain, use the --no-enable-export flag to disable and the --enable-export flag to re-enable. This preserves the configuration and allows you to re-enable export without deleting S3 table. You can enable asset metadata export for only one domain per account per Region. To enable export for a different domain, complete the following steps: Delete the export configuration for thdomainIdentifier (string) required
enableExport (boolean) required
encryptionConfiguration: {
. kmsKeyArn (string)
. sseAlgorithm (string)
} (object)
clientToken (string)
datazone/reject_predictionsRejects automatically generated business-friendly metadata for your Amazon DataZone assets.domainIdentifier (string) required
identifier (string) required
revision (string)
rejectRule: {
. rule (string)
. threshold (number)
} (object)
rejectChoices (array)
clientToken (string)
datazone/reject_subscription_requestRejects the specified subscription request.domainIdentifier (string) required
identifier (string) required
decisionComment (string)
datazone/remove_entity_ownerRemoves an owner from an entity.domainIdentifier (string) required
entityType (string) required
entityIdentifier (string) required
owner (undefined) required
clientToken (string)
datazone/remove_policy_grantRemoves a policy grant.domainIdentifier (string) required
entityType (string) required
entityIdentifier (string) required
policyType (string) required
principal (undefined) required
grantIdentifier (string)
clientToken (string)
datazone/revoke_subscriptionRevokes a specified subscription in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
retainPermissions (boolean)
datazone/searchSearches for assets in Amazon DataZone. Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. Search can be scoped to specific types of resources like assets, glossary terms, or data products and can be filtered using various criteridomainIdentifier (string) required
owningProjectIdentifier (string)
maxResults (integer)
nextToken (string)
searchScope (string) required
searchText (string)
searchIn (array)
filters (undefined)
sort: {
. attribute (string)
. order (string)
} (object)
additionalAttributes (array)
datazone/search_group_profilesSearches group profiles in Amazon DataZone.domainIdentifier (string) required
groupType (string) required
searchText (string)
maxResults (integer)
nextToken (string)
datazone/search_listingsSearches listings in Amazon DataZone. SearchListings is a powerful capability that enables users to discover and explore published assets and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. SearchListings also supports filtering using various criteria such as creation date, owner, or status. This API is essential for making the wealth of data resourcesdomainIdentifier (string) required
searchText (string)
searchIn (array)
maxResults (integer)
nextToken (string)
filters (undefined)
aggregations (array)
sort: {
. attribute (string)
. order (string)
} (object)
additionalAttributes (array)
datazone/search_typesSearches for types in Amazon DataZone. Prerequisites: The --domain-identifier must refer to an existing Amazon DataZone domain. --search-scope must be one of the valid values including: ASSET_TYPE, GLOSSARY_TERM_TYPE, DATA_PRODUCT_TYPE. The --managed flag must be present without a value. The user must have permissions for form or asset types in the domain. If using --filters, ensure that the JSON is valid. Filters contain correct structure attribute, value, operator.domainIdentifier (string) required
maxResults (integer)
nextToken (string)
searchScope (string) required
searchText (string)
searchIn (array)
filters (undefined)
sort: {
. attribute (string)
. order (string)
} (object)
managed (boolean) required
datazone/search_user_profilesSearches user profiles in Amazon DataZone.domainIdentifier (string) required
userType (string) required
searchText (string)
maxResults (integer)
nextToken (string)
datazone/tag_resourceTags a resource in Amazon DataZone.resourceArn (string) required
tags (object) required
datazone/untag_resourceUntags a resource in Amazon DataZone.resourceArn (string) required
tagKeys (array) required
datazone/update_account_poolUpdates the account pool.domainIdentifier (string) required
identifier (string) required
name (string)
description (string)
resolutionStrategy (string)
accountSource (undefined)
datazone/update_asset_filterUpdates an asset filter. Prerequisites: The domain, asset, and asset filter identifier must all exist. The asset must contain the columns being referenced in the update. If applying a row filter, ensure the column referenced in the expression exists in the asset schema.domainIdentifier (string) required
assetIdentifier (string) required
identifier (string) required
name (string)
description (string)
configuration (undefined)
datazone/update_connectionUpdates a connection. In Amazon DataZone, a connection enables you to connect your resources domains, projects, and environments to external resources and services.domainIdentifier (string) required
identifier (string) required
description (string)
awsLocation: {
. accessRole (string)
. awsAccountId (string)
. awsRegion (string)
. iamConnectionId (string)
} (object)
props (undefined)
datazone/update_environmentUpdates the specified environment in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
name (string)
description (string)
glossaryTerms (array)
blueprintVersion (string)
userParameters (array)
datazone/update_environment_actionUpdates an environment action.domainIdentifier (string) required
environmentIdentifier (string) required
identifier (string) required
parameters (undefined)
name (string)
description (string)
datazone/update_environment_blueprintUpdates an environment blueprint in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
description (string)
provisioningProperties (undefined)
userParameters (array)
datazone/update_environment_profileUpdates the specified environment profile in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
name (string)
description (string)
userParameters (array)
awsAccountId (string)
awsAccountRegion (string)
datazone/update_group_profileUpdates the specified group profile in Amazon DataZone.domainIdentifier (string) required
groupIdentifier (string) required
status (string) required
datazone/update_projectUpdates the specified project in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
name (string)
description (string)
resourceTags (object)
glossaryTerms (array)
domainUnitId (string)
environmentDeploymentDetails: {
. overallDeploymentStatus (string)
. environmentFailureReasons (object)
} (object)
userParameters (array)
projectProfileVersion (string)
datazone/update_project_profileUpdates a project profile.domainIdentifier (string) required
identifier (string) required
name (string)
description (string)
status (string)
projectResourceTags (array)
allowCustomProjectResourceTags (boolean)
projectResourceTagsDescription (string)
environmentConfigurations (array)
domainUnitIdentifier (string)
datazone/update_root_domain_unit_ownerUpdates the owner of the root domain unit.domainIdentifier (string) required
currentOwner (string) required
newOwner (string) required
clientToken (string)
datazone/update_subscription_grant_statusUpdates the status of the specified subscription grant status in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
assetIdentifier (string) required
status (string) required
failureCause: {
. message (string)
} (object)
targetName (string)
datazone/update_subscription_requestUpdates a specified subscription request in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
requestReason (string) required
datazone/update_subscription_targetUpdates the specified subscription target in Amazon DataZone.domainIdentifier (string) required
environmentIdentifier (string) required
identifier (string) required
name (string)
authorizedPrincipals (array)
applicableAssetTypes (array)
subscriptionTargetConfig (array)
manageAccessRole (string)
provider (string)
subscriptionGrantCreationMode (string)
datazone/update_user_profileUpdates the specified user profile in Amazon DataZone.domainIdentifier (string) required
userIdentifier (string) required
type (string)
status (string) required
datazone/create_asset_revisionCreates a revision of the asset. Asset revisions represent new versions of existing assets, capturing changes to either the underlying data or its metadata. They maintain a historical record of how assets evolve over time, who made changes, and when those changes occurred. This versioning capability is crucial for governance and compliance, allowing organizations to track changes, understand their impact, and roll back if necessary. Prerequisites: Asset must already exist in the domain with idenname (string) required
domainIdentifier (string) required
identifier (string) required
typeRevision (string)
description (string)
glossaryTerms (array)
formsInput (array)
predictionConfiguration: {
. businessNameGeneration (object)
} (object)
clientToken (string)
datazone/create_assetCreates an asset in Amazon DataZone catalog. Before creating assets, make sure that the following requirements are met: --domain-identifier must refer to an existing domain. --owning-project-identifier must be a valid project within the domain. Asset type must be created beforehand using create-asset-type, or be a supported system-defined type. For more information, see create-asset-type. --type-revision if used must match a valid revision of the asset type. formsInput is required when it is assname (string) required
domainIdentifier (string) required
externalIdentifier (string)
typeIdentifier (string) required
typeRevision (string)
description (string)
glossaryTerms (array)
formsInput (array)
owningProjectIdentifier (string) required
predictionConfiguration: {
. businessNameGeneration (object)
} (object)
clientToken (string)
datazone/get_assetGets an Amazon DataZone asset. An asset is the fundamental building block in Amazon DataZone, representing any data resource that needs to be cataloged and managed. It can take many forms, from Amazon S3 buckets and database tables to dashboards and machine learning models. Each asset contains comprehensive metadata about the resource, including its location, schema, ownership, and lineage information. Assets are essential for organizing and managing data resources across an organization, makingdomainIdentifier (string) required
identifier (string) required
revision (string)
datazone/delete_assetDeletes an asset in Amazon DataZone. --domain-identifier must refer to a valid and existing domain. --identifier must refer to an existing asset in the specified domain. Asset must not be referenced in any existing asset filters. Asset must not be linked to any draft or published data product. User must have delete permissions for the domain and project.domainIdentifier (string) required
identifier (string) required
datazone/delete_asset_typeDeletes an asset type in Amazon DataZone. Prerequisites: The asset type must exist in the domain. You must have DeleteAssetType permission. The asset type must not be in use e.g., assigned to any asset. If used, deletion will fail. You should retrieve the asset type using get-asset-type to confirm its presence before deletion.domainIdentifier (string) required
identifier (string) required
datazone/get_asset_typeGets an Amazon DataZone asset type. Asset types define the categories and characteristics of different kinds of data assets within Amazon DataZone.. They determine what metadata fields are required, what operations are possible, and how the asset integrates with other Amazon Web Services services. Asset types can range from built-in types like Amazon S3 buckets and Amazon Web Services Glue tables to custom types defined for specific organizational needs. Understanding asset types is crucial fordomainIdentifier (string) required
identifier (string) required
revision (string)
datazone/create_asset_typeCreates a custom asset type. Prerequisites: The formsInput field is required, however, can be passed as empty e.g. -forms-input . You must have CreateAssetType permissions. The domain-identifier and owning-project-identifier must be valid and active. The name of the asset type must be unique within the domain — duplicate names will cause failure. JSON input must be valid — incorrect formatting causes Invalid JSON errors.domainIdentifier (string) required
name (string) required
description (string)
formsInput (object) required
owningProjectIdentifier (string) required
datazone/create_data_product_revisionCreates a data product revision. Prerequisites: The original data product must exist in the given domain. User must have permissions on the data product. The domain must be valid and accessible. The new revision name must comply with naming constraints if required.domainIdentifier (string) required
identifier (string) required
name (string) required
description (string)
glossaryTerms (array)
items (array)
formsInput (array)
clientToken (string)
datazone/create_data_productCreates a data product. A data product is a comprehensive package that combines data assets with their associated metadata, documentation, and access controls. It's designed to serve specific business needs or use cases, making it easier for users to find and consume data appropriately. Data products include important information about data quality, freshness, and usage guidelines, effectively bridging the gap between data producers and consumers while ensuring proper governance. Prerequisites:domainIdentifier (string) required
name (string) required
owningProjectIdentifier (string) required
description (string)
glossaryTerms (array)
formsInput (array)
items (array)
clientToken (string)
datazone/get_data_productGets the data product. Prerequisites: The data product ID must exist. The domain must be valid and accessible. User must have read or discovery permissions for the data product.domainIdentifier (string) required
identifier (string) required
revision (string)
datazone/delete_data_productDeletes a data product in Amazon DataZone. Prerequisites: The data product must exist and not be deleted or archived. The user must have delete permissions for the data product. Domain and project must be active.domainIdentifier (string) required
identifier (string) required
datazone/create_data_sourceCreates an Amazon DataZone data source.name (string) required
description (string)
domainIdentifier (string) required
projectIdentifier (string) required
environmentIdentifier (string)
connectionIdentifier (string)
type (string) required
configuration (undefined)
recommendation: {
. enableBusinessNameGeneration (boolean)
} (object)
enableSetting (string)
schedule: {
. timezone (string)
. schedule (string)
} (object)
publishOnImport (boolean)
assetFormsInput (array)
clientToken (string)
datazone/get_data_sourceGets an Amazon DataZone data source.domainIdentifier (string) required
identifier (string) required
datazone/update_data_sourceUpdates the specified data source in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
name (string)
description (string)
enableSetting (string)
publishOnImport (boolean)
assetFormsInput (array)
schedule: {
. timezone (string)
. schedule (string)
} (object)
configuration (undefined)
recommendation: {
. enableBusinessNameGeneration (boolean)
} (object)
retainPermissionsOnRevokeFailure (boolean)
datazone/delete_data_sourceDeletes a data source in Amazon DataZone.domainIdentifier (string) required
identifier (string) required
clientToken (string)
retainPermissionsOnRevokeFailure (boolean)
datazone/list_data_sourcesLists data sources in Amazon DataZone.domainIdentifier (string) required
projectIdentifier (string) required
environmentIdentifier (string)
connectionIdentifier (string)
type (string)
status (string)
name (string)
nextToken (string)
maxResults (integer)
datazone/start_data_source_runStart the run of the specified data source in Amazon DataZone.domainIdentifier (string) required
dataSourceIdentifier (string) required
clientToken (string)
datazone/get_data_source_runGets an Amazon DataZone data source run.domainIdentifier (string) required
identifier (string) required
datazone/list_data_source_runsLists data source runs in Amazon DataZone.domainIdentifier (string) required
dataSourceIdentifier (string) required
status (string)
nextToken (string)
maxResults (integer)
datazone/create_domainCreates an Amazon DataZone domain.name (string) required
description (string)
singleSignOn: {
. type (string)
. userAssignment (string)
. idcInstanceArn (string)
} (object)
domainExecutionRole (string) required
kmsKeyIdentifier (string)
tags (object)
domainVersion (string)
serviceRole (string)
clientToken (string)
datazone/get_domainGets an Amazon DataZone domain.identifier (string) required
datazone/update_domainUpdates a Amazon DataZone domain.identifier (string) required
description (string)
singleSignOn: {
. type (string)
. userAssignment (string)
. idcInstanceArn (string)
} (object)
domainExecutionRole (string)
serviceRole (string)
name (string)
clientToken (string)
datazone/delete_domainDeletes a Amazon DataZone domain.identifier (string) required
clientToken (string)
skipDeletionCheck (boolean)
datazone/list_domainsLists Amazon DataZone domains.status (string)
maxResults (integer)
nextToken (string)
datazone/create_domain_unitCreates a domain unit in Amazon DataZone.domainIdentifier (string) required
name (string) required
parentDomainUnitIdentifier (string) required
description (string)
clientToken (string)
datazone/get_domain_unitGets the details of the specified domain unit.domainIdentifier (string) required
identifier (string) required
datazone/update_domain_unitUpdates the domain unit.domainIdentifier (string) required
identifier (string) required
description (string)
name (string)
datazone/delete_domain_unitDeletes a domain unit.domainIdentifier (string) required
identifier (string) required
datazone/list_domain_units_for_parentLists child domain units for the specified parent domain unit.domainIdentifier (string) required
parentDomainUnitIdentifier (string) required
maxResults (integer)
nextToken (string)
datazone/get_environment_blueprint_configurationGets the blueprint configuration in Amazon DataZone.domainIdentifier (string) required
environmentBlueprintIdentifier (string) required
datazone/delete_environment_blueprint_configurationDeletes the blueprint configuration in Amazon DataZone.domainIdentifier (string) required
environmentBlueprintIdentifier (string) required
datazone/list_environment_blueprint_configurationsLists blueprint configurations for a Amazon DataZone environment.domainIdentifier (string) required
maxResults (integer)
nextToken (string)
datazone/put_environment_blueprint_configurationWrites the configuration for the specified environment blueprint in Amazon DataZone.domainIdentifier (string) required
environmentBlueprintIdentifier (string) required
provisioningRoleArn (string)
manageAccessRoleArn (string)
environmentRolePermissionBoundary (string)
enabledRegions (array) required
regionalParameters (object)
globalParameters (object)
provisioningConfigurations (array)
datazone/delete_form_typeDeletes and metadata form type in Amazon DataZone. Prerequisites: The form type must exist in the domain. The form type must not be in use by any asset types or assets. The domain must be valid and accessible. User must have delete permissions on the form type. Any dependencies such as linked asset types must be removed first.domainIdentifier (string) required
formTypeIdentifier (string) required
datazone/get_form_typeGets a metadata form type in Amazon DataZone. Form types define the structure and validation rules for collecting metadata about assets in Amazon DataZone. They act as templates that ensure consistent metadata capture across similar types of assets, while allowing for customization to meet specific organizational needs. Form types can include required fields, validation rules, and dependencies, helping maintain high-quality metadata that makes data assets more discoverable and usable. The form tdomainIdentifier (string) required
formTypeIdentifier (string) required
revision (string)
datazone/create_form_typeCreates a metadata form type. Prerequisites: The domain must exist and be in an ENABLED state. The owning project must exist and be accessible. The name must be unique within the domain. For custom form types, to indicate that a field should be searchable, annotate it with @amazon.datazone searchable. By default, searchable fields are indexed for semantic search, where related query terms will match the attribute value even if they are not stemmed or keyword matches. To indicate that a field shodomainIdentifier (string) required
name (string) required
model (undefined) required
owningProjectIdentifier (string) required
status (string)
description (string)
datazone/create_glossaryCreates an Amazon DataZone business glossary. Specifies that this is a create glossary policy. A glossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, makdomainIdentifier (string) required
name (string) required
owningProjectIdentifier (string) required
description (string)
status (string)
usageRestrictions (array)
clientToken (string)
datazone/get_glossaryGets a business glossary in Amazon DataZone. Prerequisites: The specified glossary ID must exist and be associated with the given domain. The caller must have the datazone:GetGlossary permission on the domain.domainIdentifier (string) required
identifier (string) required
datazone/update_glossaryUpdates the business glossary in Amazon DataZone. Prerequisites: The glossary must exist in the given domain. The caller must have the datazone:UpdateGlossary permission to update it. When updating the name, the new name must be unique within the domain. The glossary must not be deleted or in a terminal state.domainIdentifier (string) required
identifier (string) required
name (string)
description (string)
status (string)
clientToken (string)
datazone/delete_glossaryDeletes a business glossary in Amazon DataZone. Prerequisites: The glossary must be in DISABLED state. The glossary must not have any glossary terms associated with it. The glossary must exist in the specified domain. The caller must have the datazone:DeleteGlossary permission in the domain and glossary. Glossary should not be linked to any active metadata forms.domainIdentifier (string) required
identifier (string) required
datazone/create_glossary_termCreates a business glossary term. A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of datadomainIdentifier (string) required
glossaryIdentifier (string) required
name (string) required
status (string)
shortDescription (string)
longDescription (string)
termRelations: {
. isA (array)
. classifies (array)
} (object)
clientToken (string)
datazone/get_glossary_termGets a business glossary term in Amazon DataZone. Prerequisites: Glossary term with identifier must exist in the domain. User must have permission on the glossary term. Domain must be accessible and active.domainIdentifier (string) required
identifier (string) required
datazone/update_glossary_termUpdates a business glossary term in Amazon DataZone. Prerequisites: Glossary term must exist in the specified domain. New name must not conflict with existing terms in the same glossary. User must have permissions on the term. The term must not be in DELETED status.domainIdentifier (string) required
glossaryIdentifier (string)
identifier (string) required
name (string)
shortDescription (string)
longDescription (string)
termRelations: {
. isA (array)
. classifies (array)
} (object)
status (string)
datazone/delete_glossary_termDeletes a business glossary term in Amazon DataZone. Prerequisites: Glossary term must exist and be active. The term must not be linked to other assets or child terms. Caller must have delete permissions in the domain/glossary. Ensure all associations such as to assets or parent terms are removed before deletion.domainIdentifier (string) required
identifier (string) required
datazone/get_listingGets a listing a record of an asset at a given time. If you specify a listing version, only details that are specific to that version are returned.domainIdentifier (string) required
identifier (string) required
listingRevision (string)
datazone/delete_listingDeletes a listing a record of an asset at a given time.domainIdentifier (string) required
identifier (string) required
datazone/start_metadata_generation_runStarts the metadata generation run. Prerequisites: Asset must be created and belong to the specified domain and project. Asset type must be supported for metadata generation e.g., Amazon Web Services Glue table. Asset must have a structured schema with valid rows and columns. Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS. The user must have permission to run metadata generation in the domain/project.domainIdentifier (string) required
type (string)
types (array)
target: {
. type (string)
. identifier (string)
. revision (string)
} (object) required
clientToken (string)
owningProjectIdentifier (string) required
datazone/get_metadata_generation_runGets a metadata generation run in Amazon DataZone. Prerequisites: Valid domain and run identifier. The metadata generation run must exist. User must have read access to the metadata run.domainIdentifier (string) required
identifier (string) required
type (string)
datazone/cancel_metadata_generation_runCancels the metadata generation run. Prerequisites: The run must exist and be in a cancelable status e.g., SUBMITTED, IN_PROGRESS. Runs in SUCCEEDED status cannot be cancelled. User must have access to the run and cancel permissions.domainIdentifier (string) required
identifier (string) required
datazone/list_metadata_generation_runsLists all metadata generation runs. Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistencdomainIdentifier (string) required
status (string)
type (string)
nextToken (string)
maxResults (integer)
targetIdentifier (string)
datazone/create_ruleCreates a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows e.g., publishing assets to the catalog, requesting subscriptions, creating projects within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a datdomainIdentifier (string) required
name (string) required
target (undefined) required
action (string) required
scope: {
. assetType (object)
. dataProduct (boolean)
. project (object)
} (object) required
detail (undefined) required
description (string)
clientToken (string)
datazone/get_ruleGets the details of a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows e.g., publishing assets to the catalog, requesting subscriptions, creating projects within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publdomainIdentifier (string) required
identifier (string) required
revision (string)
datazone/update_ruleUpdates a rule. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows e.g., publishing assets to the catalog, requesting subscriptions, creating projects within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a dadomainIdentifier (string) required
identifier (string) required
name (string)
description (string)
scope: {
. assetType (object)
. dataProduct (boolean)
. project (object)
} (object)
detail (undefined)
includeChildDomainUnits (boolean)
datazone/delete_ruleDeletes a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows e.g., publishing assets to the catalog, requesting subscriptions, creating projects within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a datdomainIdentifier (string) required
identifier (string) required
datazone/list_rulesLists existing rules. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows e.g., publishing assets to the catalog, requesting subscriptions, creating projects within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishindomainIdentifier (string) required
targetType (string) required
targetIdentifier (string) required
ruleType (string)
action (string)
projectIds (array)
assetTypes (array)
dataProduct (boolean)
includeCascaded (boolean)
maxResults (integer)
nextToken (string)
dax/create_clusterCreates a DAX cluster. All nodes in the cluster run the same DAX caching software.ClusterName (string) required
NodeType (string) required
Description (string)
ReplicationFactor (integer) required
AvailabilityZones (array)
SubnetGroupName (string)
SecurityGroupIds (array)
PreferredMaintenanceWindow (string)
NotificationTopicArn (string)
IamRoleArn (string) required
ParameterGroupName (string)
Tags (array)
SSESpecification: {
. Enabled (boolean)
} (object)
ClusterEndpointEncryptionType (string)
NetworkType (string)
dax/create_parameter_groupCreates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.ParameterGroupName (string) required
Description (string)
dax/create_subnet_groupCreates a new subnet group.SubnetGroupName (string) required
Description (string)
SubnetIds (array) required
dax/decrease_replication_factorRemoves 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.ClusterName (string) required
NewReplicationFactor (integer) required
AvailabilityZones (array)
NodeIdsToRemove (array)
dax/delete_clusterDeletes 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.ClusterName (string) required
dax/delete_parameter_groupDeletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.ParameterGroupName (string) required
dax/delete_subnet_groupDeletes a subnet group. You cannot delete a subnet group if it is associated with any DAX clusters.SubnetGroupName (string) required
dax/describe_clustersReturns 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 forClusterNames (array)
MaxResults (integer)
NextToken (string)
dax/describe_default_parametersReturns the default system parameter information for the DAX caching software.MaxResults (integer)
NextToken (string)
dax/describe_eventsReturns 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.SourceName (string)
SourceType (string)
StartTime (string)
EndTime (string)
Duration (integer)
MaxResults (integer)
NextToken (string)
dax/describe_parameter_groupsReturns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.ParameterGroupNames (array)
MaxResults (integer)
NextToken (string)
dax/describe_parametersReturns the detailed parameter list for a particular parameter group.ParameterGroupName (string) required
Source (string)
MaxResults (integer)
NextToken (string)
dax/describe_subnet_groupsReturns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.SubnetGroupNames (array)
MaxResults (integer)
NextToken (string)
dax/increase_replication_factorAdds one or more nodes to a DAX cluster.ClusterName (string) required
NewReplicationFactor (integer) required
AvailabilityZones (array)
dax/list_tagsList all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account.ResourceName (string) required
NextToken (string)
dax/reboot_nodeReboots 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.ClusterName (string) required
NodeId (string) required
dax/tag_resourceAssociates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account.ResourceName (string) required
Tags (array) required
dax/untag_resourceRemoves the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account.ResourceName (string) required
TagKeys (array) required
dax/update_clusterModifies 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.ClusterName (string) required
Description (string)
PreferredMaintenanceWindow (string)
NotificationTopicArn (string)
NotificationTopicStatus (string)
ParameterGroupName (string)
SecurityGroupIds (array)
dax/update_parameter_groupModifies 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.ParameterGroupName (string) required
ParameterNameValues (array) required
dax/update_subnet_groupModifies an existing subnet group.SubnetGroupName (string) required
Description (string)
SubnetIds (array)
deadline/create_queue_fleet_associationCreates an association between a queue and a fleet.farmId (string) required
queueId (string) required
fleetId (string) required
deadline/create_queue_limit_associationAssociates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.farmId (string) required
queueId (string) required
limitId (string) required
deadline/delete_queue_fleet_associationDeletes a queue-fleet association.farmId (string) required
queueId (string) required
fleetId (string) required
deadline/delete_queue_limit_associationRemoves the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.farmId (string) required
queueId (string) required
limitId (string) required
deadline/get_queue_fleet_associationGets a queue-fleet association.farmId (string) required
queueId (string) required
fleetId (string) required
deadline/get_queue_limit_associationGets information about a specific association between a queue and a limit.farmId (string) required
queueId (string) required
limitId (string) required
deadline/get_sessions_statistics_aggregationGets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.farmId (string) required
aggregationId (string) required
maxResults (integer)
nextToken (string)
deadline/list_available_metered_productsA list of the available metered products.nextToken (string)
maxResults (integer)
deadline/list_queue_fleet_associationsLists queue-fleet associations.farmId (string) required
queueId (string)
fleetId (string)
nextToken (string)
maxResults (integer)
deadline/list_queue_limit_associationsGets a list of the associations between queues and limits defined in a farm.farmId (string) required
queueId (string)
limitId (string)
nextToken (string)
maxResults (integer)
deadline/list_tags_for_resourceLists tags for a resource.resourceArn (string) required
deadline/search_jobsSearches for jobs.farmId (string) required
queueIds (array) required
filterExpressions: {
. filters (array)
. operator (string)
} (object)
sortExpressions (array)
itemOffset (integer) required
pageSize (integer)
deadline/search_stepsSearches for steps.farmId (string) required
queueIds (array) required
jobId (string)
filterExpressions: {
. filters (array)
. operator (string)
} (object)
sortExpressions (array)
itemOffset (integer) required
pageSize (integer)
deadline/search_tasksSearches for tasks.farmId (string) required
queueIds (array) required
jobId (string)
filterExpressions: {
. filters (array)
. operator (string)
} (object)
sortExpressions (array)
itemOffset (integer) required
pageSize (integer)
deadline/search_workersSearches for workers.farmId (string) required
fleetIds (array) required
filterExpressions: {
. filters (array)
. operator (string)
} (object)
sortExpressions (array)
itemOffset (integer) required
pageSize (integer)
deadline/start_sessions_statistics_aggregationStarts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. You can only have one running aggregation for your Deadline Cloud farm. Call the GetSessionsStatisticsAggregation operation and check the status field to see if an aggregation is running. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.farmId (string) required
resourceIds (undefined) required
startTime (string) required
endTime (string) required
timezone (string)
period (string)
groupBy (array) required
statistics (array) required
deadline/tag_resourceTags a resource using the resource's ARN and desired tags.resourceArn (string) required
tags (object)
deadline/untag_resourceRemoves a tag from a resource using the resource's ARN and tag to remove.resourceArn (string) required
tagKeys (array) required
deadline/update_queue_fleet_associationUpdates a queue-fleet association.farmId (string) required
queueId (string) required
fleetId (string) required
status (string) required
deadline/update_queue_limit_associationUpdates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE values, there will be a delay before the status transitions to the STOPPED state.farmId (string) required
queueId (string) required
limitId (string) required
status (string) required
deadline/associate_member_to_farmAssigns a farm membership level to a member.farmId (string) required
principalId (string) required
principalType (string) required
identityStoreId (string) required
membershipLevel (string) required
deadline/create_limitCreates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues. You must add the amountRequirementName to a step in a job template to declare the limit requirement.clientToken (string)
displayName (string) required
amountRequirementName (string) required
maxCount (integer) required
farmId (string) required
description (string)
deadline/create_storage_profileCreates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.clientToken (string)
farmId (string) required
displayName (string) required
osFamily (string) required
fileSystemLocations (array)
deadline/delete_limitRemoves a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any queues.farmId (string) required
limitId (string) required
deadline/delete_storage_profileDeletes a storage profile.farmId (string) required
storageProfileId (string) required
deadline/disassociate_member_from_farmDisassociates a member from a farm.farmId (string) required
principalId (string) required
deadline/get_limitGets information about a specific limit.farmId (string) required
limitId (string) required
deadline/get_storage_profileGets a storage profile.farmId (string) required
storageProfileId (string) required
deadline/list_farm_membersLists the members of a farm.farmId (string) required
nextToken (string)
maxResults (integer)
deadline/list_limitsGets a list of limits defined in the specified farm.farmId (string) required
nextToken (string)
maxResults (integer)
deadline/list_storage_profilesLists storage profiles.farmId (string) required
nextToken (string)
maxResults (integer)
deadline/update_limitUpdates the properties of the specified limit.farmId (string) required
limitId (string) required
displayName (string)
description (string)
maxCount (integer)
deadline/update_storage_profileUpdates a storage profile.clientToken (string)
farmId (string) required
storageProfileId (string) required
displayName (string)
osFamily (string)
fileSystemLocationsToAdd (array)
fileSystemLocationsToRemove (array)
deadline/create_farmCreates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.clientToken (string)
displayName (string) required
description (string)
kmsKeyArn (string)
tags (object)
deadline/get_farmGet a farm.farmId (string) required
deadline/update_farmUpdates a farm.farmId (string) required
displayName (string)
description (string)
deadline/delete_farmDeletes a farm.farmId (string) required
deadline/list_farmsLists farms.nextToken (string)
principalId (string)
maxResults (integer)
deadline/create_budgetCreates a budget to set spending thresholds for your rendering activity.clientToken (string)
farmId (string) required
usageTrackingResource (undefined) required
displayName (string) required
description (string)
approximateDollarLimit (number) required
actions (array) required
schedule (undefined) required
tags (object)
deadline/get_budgetGet a budget.farmId (string) required
budgetId (string) required
deadline/update_budgetUpdates a budget that sets spending thresholds for rendering activity.clientToken (string)
farmId (string) required
budgetId (string) required
displayName (string)
description (string)
status (string)
approximateDollarLimit (number)
actionsToAdd (array)
actionsToRemove (array)
schedule (undefined)
deadline/delete_budgetDeletes a budget.farmId (string) required
budgetId (string) required
deadline/list_budgetsA list of budgets in a farm.nextToken (string)
farmId (string) required
maxResults (integer)
status (string)
deadline/associate_member_to_fleetAssigns a fleet membership level to a member.farmId (string) required
fleetId (string) required
principalId (string) required
principalType (string) required
identityStoreId (string) required
membershipLevel (string) required
deadline/assume_fleet_role_for_readGet Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.farmId (string) required
fleetId (string) required
deadline/disassociate_member_from_fleetDisassociates a member from a fleet.farmId (string) required
fleetId (string) required
principalId (string) required
deadline/list_fleet_membersLists fleet members.farmId (string) required
fleetId (string) required
nextToken (string)
maxResults (integer)
deadline/create_fleetCreates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.clientToken (string)
farmId (string) required
displayName (string) required
description (string)
roleArn (string) required
minWorkerCount (integer)
maxWorkerCount (integer) required
configuration (undefined) required
tags (object)
hostConfiguration: {
. scriptBody (string)
. scriptTimeoutSeconds (integer)
} (object)
deadline/get_fleetGet a fleet.farmId (string) required
fleetId (string) required
deadline/update_fleetUpdates a fleet.clientToken (string)
farmId (string) required
fleetId (string) required
displayName (string)
description (string)
roleArn (string)
minWorkerCount (integer)
maxWorkerCount (integer)
configuration (undefined)
hostConfiguration: {
. scriptBody (string)
. scriptTimeoutSeconds (integer)
} (object)
deadline/delete_fleetDeletes a fleet.clientToken (string)
farmId (string) required
fleetId (string) required
deadline/list_fleetsLists fleets.farmId (string) required
principalId (string)
displayName (string)
status (string)
nextToken (string)
maxResults (integer)
deadline/assume_fleet_role_for_workerGet credentials from the fleet role for a worker.farmId (string) required
fleetId (string) required
workerId (string) required
deadline/assume_queue_role_for_workerAllows a worker to assume a queue role.farmId (string) required
fleetId (string) required
workerId (string) required
queueId (string) required
deadline/batch_get_job_entityGet batched job details for a worker.farmId (string) required
fleetId (string) required
workerId (string) required
identifiers (array) required
deadline/list_sessions_for_workerLists sessions for a worker.farmId (string) required
fleetId (string) required
workerId (string) required
nextToken (string)
maxResults (integer)
deadline/update_worker_scheduleUpdates the schedule for a worker.farmId (string) required
fleetId (string) required
workerId (string) required
updatedSessionActions (object)
deadline/create_workerCreates a worker. A worker tells your instance how much processing power vCPU, and memory GiB you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude. Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker beforefarmId (string) required
fleetId (string) required
hostProperties: {
. ipAddresses (object)
. hostName (string)
} (object)
clientToken (string)
tags (object)
deadline/get_workerGets a worker.farmId (string) required
fleetId (string) required
workerId (string) required
deadline/update_workerUpdates a worker.farmId (string) required
fleetId (string) required
workerId (string) required
status (string)
capabilities: {
. amounts (array)
. attributes (array)
} (object)
hostProperties: {
. ipAddresses (object)
. hostName (string)
} (object)
deadline/delete_workerDeletes a worker.farmId (string) required
fleetId (string) required
workerId (string) required
deadline/list_workersLists workers.farmId (string) required
fleetId (string) required
nextToken (string)
maxResults (integer)
deadline/associate_member_to_queueAssigns a queue membership level to a memberfarmId (string) required
queueId (string) required
principalId (string) required
principalType (string) required
identityStoreId (string) required
membershipLevel (string) required
deadline/assume_queue_role_for_readGets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.farmId (string) required
queueId (string) required
deadline/assume_queue_role_for_userAllows a user to assume a role for a queue.farmId (string) required
queueId (string) required
deadline/create_queue_environmentCreates an environment for a queue that defines how jobs in the queue run.clientToken (string)
farmId (string) required
queueId (string) required
priority (integer) required
templateType (string) required
template (string) required
deadline/delete_queue_environmentDeletes a queue environment.farmId (string) required
queueId (string) required
queueEnvironmentId (string) required
deadline/disassociate_member_from_queueDisassociates a member from a queue.farmId (string) required
queueId (string) required
principalId (string) required
deadline/get_queue_environmentGets a queue environment.farmId (string) required
queueId (string) required
queueEnvironmentId (string) required
deadline/get_storage_profile_for_queueGets a storage profile for a queue.farmId (string) required
queueId (string) required
storageProfileId (string) required
deadline/list_queue_environmentsLists queue environments.farmId (string) required
queueId (string) required
nextToken (string)
maxResults (integer)
deadline/list_queue_membersLists the members in a queue.farmId (string) required
queueId (string) required
nextToken (string)
maxResults (integer)
deadline/list_storage_profiles_for_queueLists storage profiles for a queue.farmId (string) required
queueId (string) required
nextToken (string)
maxResults (integer)
deadline/update_queue_environmentUpdates the queue environment.clientToken (string)
farmId (string) required
queueId (string) required
queueEnvironmentId (string) required
priority (integer)
templateType (string)
template (string)
deadline/create_queueCreates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.clientToken (string)
farmId (string) required
displayName (string) required
description (string)
defaultBudgetAction (string)
jobAttachmentSettings: {
. s3BucketName (string)
. rootPrefix (string)
} (object)
roleArn (string)
jobRunAsUser: {
. posix (object)
. windows (object)
. runAs (string)
} (object)
requiredFileSystemLocationNames (array)
allowedStorageProfileIds (array)
tags (object)
deadline/get_queueGets a queue.farmId (string) required
queueId (string) required
deadline/update_queueUpdates a queue.clientToken (string)
farmId (string) required
queueId (string) required
displayName (string)
description (string)
defaultBudgetAction (string)
jobAttachmentSettings: {
. s3BucketName (string)
. rootPrefix (string)
} (object)
roleArn (string)
jobRunAsUser: {
. posix (object)
. windows (object)
. runAs (string)
} (object)
requiredFileSystemLocationNamesToAdd (array)
requiredFileSystemLocationNamesToRemove (array)
allowedStorageProfileIdsToAdd (array)
allowedStorageProfileIdsToRemove (array)
deadline/delete_queueDeletes a queue. You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue.farmId (string) required
queueId (string) required
deadline/list_queuesLists queues.farmId (string) required
principalId (string)
status (string)
nextToken (string)
maxResults (integer)
deadline/associate_member_to_jobAssigns a job membership level to a memberfarmId (string) required
queueId (string) required
jobId (string) required
principalId (string) required
principalType (string) required
identityStoreId (string) required
membershipLevel (string) required
deadline/copy_job_templateCopies a job template to an Amazon S3 bucket.farmId (string) required
jobId (string) required
queueId (string) required
targetS3Location: {
. bucketName (string)
. key (string)
} (object) required
deadline/disassociate_member_from_jobDisassociates a member from a job.farmId (string) required
queueId (string) required
jobId (string) required
principalId (string) required
deadline/get_sessionGets a session.farmId (string) required
queueId (string) required
jobId (string) required
sessionId (string) required
deadline/get_session_actionGets a session action for the job.farmId (string) required
queueId (string) required
jobId (string) required
sessionActionId (string) required
deadline/get_stepGets a step.farmId (string) required
queueId (string) required
jobId (string) required
stepId (string) required
deadline/get_taskGets a task.farmId (string) required
queueId (string) required
jobId (string) required
stepId (string) required
taskId (string) required
deadline/list_job_membersLists members on a job.farmId (string) required
queueId (string) required
jobId (string) required
nextToken (string)
maxResults (integer)
deadline/list_job_parameter_definitionsLists parameter definitions of a job.farmId (string) required
jobId (string) required
queueId (string) required
nextToken (string)
maxResults (integer)
deadline/list_session_actionsLists session actions.farmId (string) required
queueId (string) required
jobId (string) required
sessionId (string)
taskId (string)
nextToken (string)
maxResults (integer)
deadline/list_sessionsLists sessions.farmId (string) required
queueId (string) required
jobId (string) required
nextToken (string)
maxResults (integer)
deadline/list_step_consumersLists step consumers.farmId (string) required
queueId (string) required
jobId (string) required
stepId (string) required
nextToken (string)
maxResults (integer)
deadline/list_step_dependenciesLists the dependencies for a step.farmId (string) required
queueId (string) required
jobId (string) required
stepId (string) required
nextToken (string)
maxResults (integer)
deadline/list_stepsLists steps for a job.farmId (string) required
queueId (string) required
jobId (string) required
nextToken (string)
maxResults (integer)
deadline/list_tasksLists tasks for a job.farmId (string) required
queueId (string) required
jobId (string) required
stepId (string) required
nextToken (string)
maxResults (integer)
deadline/update_sessionUpdates a session.clientToken (string)
targetLifecycleStatus (string) required
farmId (string) required
queueId (string) required
jobId (string) required
sessionId (string) required
deadline/update_stepUpdates a step.targetTaskRunStatus (string) required
clientToken (string)
farmId (string) required
queueId (string) required
jobId (string) required
stepId (string) required
deadline/update_taskUpdates a task.clientToken (string)
targetRunStatus (string) required
farmId (string) required
queueId (string) required
jobId (string) required
stepId (string) required
taskId (string) required
deadline/create_jobCreates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.farmId (string) required
queueId (string) required
clientToken (string)
template (string)
templateType (string)
priority (integer) required
parameters (object)
attachments: {
. manifests (array)
. fileSystem (string)
} (object)
storageProfileId (string)
targetTaskRunStatus (string)
maxFailedTasksCount (integer)
maxRetriesPerTask (integer)
maxWorkerCount (integer)
sourceJobId (string)
nameOverride (string)
descriptionOverride (string)
tags (object)
deadline/get_jobGets a Deadline Cloud job.farmId (string) required
queueId (string) required
jobId (string) required
deadline/update_jobUpdates a job. When you change the status of the job to ARCHIVED, the job can't be scheduled or archived. An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.clientToken (string)
targetTaskRunStatus (string)
priority (integer)
maxFailedTasksCount (integer)
maxRetriesPerTask (integer)
lifecycleStatus (string)
maxWorkerCount (integer)
name (string)
description (string)
farmId (string) required
queueId (string) required
jobId (string) required
deadline/list_jobsLists jobs.farmId (string) required
principalId (string)
queueId (string) required
nextToken (string)
maxResults (integer)
deadline/delete_metered_productDeletes a metered product.licenseEndpointId (string) required
productId (string) required
deadline/list_metered_productsLists metered products.licenseEndpointId (string) required
nextToken (string)
maxResults (integer)
deadline/put_metered_productAdds a metered product.licenseEndpointId (string) required
productId (string) required
deadline/create_license_endpointCreates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.clientToken (string)
vpcId (string) required
subnetIds (array) required
securityGroupIds (array) required
tags (object)
deadline/get_license_endpointGets a licence endpoint.licenseEndpointId (string) required
deadline/delete_license_endpointDeletes a license endpoint.licenseEndpointId (string) required
deadline/list_license_endpointsLists license endpoints.nextToken (string)
maxResults (integer)
deadline/create_monitorCreates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.clientToken (string)
displayName (string) required
identityCenterInstanceArn (string) required
subdomain (string) required
roleArn (string) required
tags (object)
deadline/get_monitorGets information about the specified monitor.monitorId (string) required
deadline/update_monitorModifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.monitorId (string) required
subdomain (string)
displayName (string)
roleArn (string)
deadline/delete_monitorRemoves a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.monitorId (string) required
deadline/list_monitorsGets a list of your monitors in Deadline Cloud.nextToken (string)
maxResults (integer)
detective/accept_invitationAccepts 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.GraphArn (string) required
detective/batch_get_graph_member_datasourcesGets data source package information for the behavior graph.GraphArn (string) required
AccountIds (array) required
detective/batch_get_membership_datasourcesGets information on the data source package history for an account.GraphArns (array) required
detective/create_graphCreates 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. 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 RegioTags (object)
detective/create_membersCreateMembers 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 verifiedGraphArn (string) required
Message (string)
DisableEmailNotification (boolean)
Accounts (array) required
detective/delete_graphDisables 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.GraphArn (string) required
detective/delete_membersRemoves 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 accounGraphArn (string) required
AccountIds (array) required
detective/describe_organization_configurationReturns 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.GraphArn (string) required
detective/disable_organization_admin_accountRemoves the Detective administrator account in the current Region. Deletes the organization behavior graph. Can only be called by the organization management account. Removing the Detective administrator account does not affect the delegated administrator account for Detective in Organizations. To remove the delegated administrator account in Organizations, use the Organizations API. Removing the delegated administrator account also removes the Detective administrator account in all Regions, excNo parameters
detective/disassociate_membershipRemoves 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.GraphArn (string) required
detective/enable_organization_admin_accountDesignates 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 organizationAccountId (string) required
detective/get_investigationDetective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise IOC is an artifact observed in or on a network, system, or environment that can with a high level of confidence identify malicious activity or a security incident. GetInvestigation returns the investigation results of an investigation for a behavior graph.GraphArn (string) required
InvestigationId (string) required
detective/get_membersReturns the membership details for specified member accounts for a behavior graph.GraphArn (string) required
AccountIds (array) required
detective/list_datasource_packagesLists data source packages in the behavior graph.GraphArn (string) required
NextToken (string)
MaxResults (integer)
detective/list_graphsReturns 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.NextToken (string)
MaxResults (integer)
detective/list_indicatorsGets the indicators from an investigation. You can use the information from the indicators to determine if an IAM user and/or IAM role is involved in an unusual activity that could indicate malicious behavior and its impact.GraphArn (string) required
InvestigationId (string) required
IndicatorType (string)
NextToken (string)
MaxResults (integer)
detective/list_investigationsDetective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise IOC is an artifact observed in or on a network, system, or environment that can with a high level of confidence identify malicious activity or a security incident. ListInvestigations lists all active Detective investigations.GraphArn (string) required
NextToken (string)
MaxResults (integer)
FilterCriteria: {
. Severity (object)
. Status (object)
. State (object)
. EntityArn (object)
. CreatedTime (object)
} (object)
SortCriteria: {
. Field (string)
. SortOrder (string)
} (object)
detective/list_invitationsRetrieves 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.NextToken (string)
MaxResults (integer)
detective/list_membersRetrieves 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.GraphArn (string) required
NextToken (string)
MaxResults (integer)
detective/list_organization_admin_accountsReturns information about the Detective administrator account for an organization. Can only be called by the organization management account.NextToken (string)
MaxResults (integer)
detective/list_tags_for_resourceReturns the tag values that are assigned to a behavior graph.ResourceArn (string) required
detective/reject_invitationRejects 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.GraphArn (string) required
detective/start_investigationDetective investigations lets you investigate IAM users and IAM roles using indicators of compromise. An indicator of compromise IOC is an artifact observed in or on a network, system, or environment that can with a high level of confidence identify malicious activity or a security incident. StartInvestigation initiates an investigation on an entity in a behavior graph.GraphArn (string) required
EntityArn (string) required
ScopeStartTime (string) required
ScopeEndTime (string) required
detective/start_monitoring_memberSends 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.GraphArn (string) required
AccountId (string) required
detective/tag_resourceApplies tag values to a behavior graph.ResourceArn (string) required
Tags (object) required
detective/untag_resourceRemoves tags from a behavior graph.ResourceArn (string) required
TagKeys (array) required
detective/update_datasource_packagesStarts a data source package for the Detective behavior graph.GraphArn (string) required
DatasourcePackages (array) required
detective/update_investigation_stateUpdates the state of an investigation.GraphArn (string) required
InvestigationId (string) required
State (string) required
detective/update_organization_configurationUpdates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization.GraphArn (string) required
AutoEnable (boolean)
device_farm/create_device_poolCreates a device pool.projectArn (string) required
name (string) required
description (string)
rules (array) required
maxDevices (integer)
device_farm/create_instance_profileCreates a profile that can be applied to one or more private fleet device instances.name (string) required
description (string)
packageCleanup (boolean)
excludeAppPackagesFromCleanup (array)
rebootAfterUse (boolean)
device_farm/create_network_profileCreates a network profile.projectArn (string) required
name (string) required
description (string)
type (string)
uplinkBandwidthBits (integer)
downlinkBandwidthBits (integer)
uplinkDelayMs (integer)
downlinkDelayMs (integer)
uplinkJitterMs (integer)
downlinkJitterMs (integer)
uplinkLossPercent (integer)
downlinkLossPercent (integer)
device_farm/create_projectCreates a project.name (string) required
defaultJobTimeoutMinutes (integer)
vpcConfig: {
. securityGroupIds (array)
. subnetIds (array)
. vpcId (string)
} (object)
environmentVariables (array)
executionRoleArn (string)
device_farm/create_remote_access_sessionSpecifies and starts a remote access session.projectArn (string) required
deviceArn (string) required
appArn (string)
instanceArn (string)
name (string)
configuration: {
. auxiliaryApps (array)
. billingMethod (string)
. vpceConfigurationArns (array)
. deviceProxy (object)
} (object)
interactionMode (string)
skipAppResign (boolean)
device_farm/create_test_grid_projectCreates a Selenium testing project. Projects are used to track TestGridSession instances.name (string) required
description (string)
vpcConfig: {
. securityGroupIds (array)
. subnetIds (array)
. vpcId (string)
} (object)
device_farm/create_test_grid_urlCreates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.projectArn (string) required
expiresInSeconds (integer) required
device_farm/create_uploadUploads an app or test scripts.projectArn (string) required
name (string) required
type (string) required
contentType (string)
device_farm/create_vpceconfigurationCreates a configuration record in Device Farm for your Amazon Virtual Private Cloud VPC endpoint.vpceConfigurationName (string) required
vpceServiceName (string) required
serviceDnsName (string) required
vpceConfigurationDescription (string)
device_farm/delete_device_poolDeletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.arn (string) required
device_farm/delete_instance_profileDeletes a profile that can be applied to one or more private device instances.arn (string) required
device_farm/delete_network_profileDeletes a network profile.arn (string) required
device_farm/delete_projectDeletes an AWS Device Farm project, given the project ARN. You cannot delete a project if it has an active run or session. You cannot undo this operation.arn (string) required
device_farm/delete_remote_access_sessionDeletes a completed remote access session and its results. You cannot delete a remote access session if it is still active. You cannot undo this operation.arn (string) required
device_farm/delete_runDeletes the run, given the run ARN. You cannot delete a run if it is still active. You cannot undo this operation.arn (string) required
device_farm/delete_test_grid_projectDeletes a Selenium testing project and all content generated under it. You cannot delete a project if it has active sessions. You cannot undo this operation.projectArn (string) required
device_farm/delete_uploadDeletes an upload given the upload ARN.arn (string) required
device_farm/delete_vpceconfigurationDeletes a configuration for your Amazon Virtual Private Cloud VPC endpoint.arn (string) required
device_farm/get_account_settingsReturns the number of unmetered iOS or unmetered Android devices that have been purchased by the account.No parameters
device_farm/get_deviceGets information about a unique device type.arn (string) required
device_farm/get_device_instanceReturns information about a device instance that belongs to a private device fleet.arn (string) required
device_farm/get_device_poolGets information about a device pool.arn (string) required
device_farm/get_device_pool_compatibilityGets information about compatibility with a device pool.devicePoolArn (string) required
appArn (string)
testType (string)
test: {
. type (string)
. testPackageArn (string)
. testSpecArn (string)
. filter (string)
. parameters (object)
} (object)
configuration: {
. extraDataPackageArn (string)
. networkProfileArn (string)
. locale (string)
. location (object)
. vpceConfigurationArns (array)
. deviceProxy (object)
. customerArtifactPaths (object)
. radios (object)
. auxiliaryApps (array)
. billingMethod (string)
. environmentVariables (array)
. executionRoleArn (string)
} (object)
projectArn (string)
device_farm/get_instance_profileReturns information about the specified instance profile.arn (string) required
device_farm/get_jobGets information about a job.arn (string) required
device_farm/get_network_profileReturns information about a network profile.arn (string) required
device_farm/get_offering_statusGets 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.nextToken (string)
device_farm/get_projectGets information about a project.arn (string) required
device_farm/get_remote_access_sessionReturns a link to a currently running remote access session.arn (string) required
device_farm/get_runGets information about a run.arn (string) required
device_farm/get_suiteGets information about a suite.arn (string) required
device_farm/get_testGets information about a test.arn (string) required
device_farm/get_test_grid_projectRetrieves information about a Selenium testing project.projectArn (string) required
device_farm/get_test_grid_sessionA 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.projectArn (string)
sessionId (string)
sessionArn (string)
device_farm/get_uploadGets information about an upload.arn (string) required
device_farm/get_vpceconfigurationReturns information about the configuration settings for your Amazon Virtual Private Cloud VPC endpoint.arn (string) required
device_farm/install_to_remote_access_sessionInstalls 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.remoteAccessSessionArn (string) required
appArn (string) required
device_farm/list_artifactsGets information about artifacts.arn (string) required
type (string) required
nextToken (string)
device_farm/list_device_instancesReturns information about the private device instances associated with one or more AWS accounts.maxResults (integer)
nextToken (string)
device_farm/list_device_poolsGets information about device pools.arn (string) required
type (string)
nextToken (string)
device_farm/list_devicesGets information about unique device types.arn (string)
nextToken (string)
filters (array)
device_farm/list_instance_profilesReturns information about all the instance profiles in an AWS account.maxResults (integer)
nextToken (string)
device_farm/list_jobsGets information about jobs for a given test run.arn (string) required
nextToken (string)
device_farm/list_network_profilesReturns the list of available network profiles.arn (string) required
type (string)
nextToken (string)
device_farm/list_offering_promotionsReturns 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.nextToken (string)
device_farm/list_offeringsReturns 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.nextToken (string)
device_farm/list_offering_transactionsReturns 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.nextToken (string)
device_farm/list_projectsGets information about projects.arn (string)
nextToken (string)
device_farm/list_remote_access_sessionsReturns a list of all currently running remote access sessions.arn (string) required
nextToken (string)
device_farm/list_runsGets information about runs, given an AWS Device Farm project ARN.arn (string) required
nextToken (string)
device_farm/list_samplesGets information about samples, given an AWS Device Farm job ARN.arn (string) required
nextToken (string)
device_farm/list_suitesGets information about test suites for a given job.arn (string) required
nextToken (string)
device_farm/list_tags_for_resourceList the tags for an AWS Device Farm resource.ResourceARN (string) required
device_farm/list_test_grid_projectsGets a list of all Selenium testing projects in your account.maxResult (integer)
nextToken (string)
device_farm/list_test_grid_session_actionsReturns a list of the actions taken in a TestGridSession.sessionArn (string) required
maxResult (integer)
nextToken (string)
device_farm/list_test_grid_session_artifactsRetrieves a list of artifacts created during the session.sessionArn (string) required
type (string)
maxResult (integer)
nextToken (string)
device_farm/list_test_grid_sessionsRetrieves a list of sessions for a TestGridProject.projectArn (string) required
status (string)
creationTimeAfter (string)
creationTimeBefore (string)
endTimeAfter (string)
endTimeBefore (string)
maxResult (integer)
nextToken (string)
device_farm/list_testsGets information about tests in a given test suite.arn (string) required
nextToken (string)
device_farm/list_unique_problemsGets 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.arn (string) required
nextToken (string)
device_farm/list_uploadsGets information about uploads, given an AWS Device Farm project ARN.arn (string) required
type (string)
nextToken (string)
device_farm/list_vpceconfigurationsReturns information about all Amazon Virtual Private Cloud VPC endpoint configurations in the AWS account.maxResults (integer)
nextToken (string)
device_farm/purchase_offeringImmediately 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.offeringId (string) required
quantity (integer) required
offeringPromotionId (string)
device_farm/renew_offeringExplicitly 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.offeringId (string) required
quantity (integer) required
device_farm/schedule_runSchedules a run.projectArn (string) required
appArn (string)
devicePoolArn (string)
deviceSelectionConfiguration: {
. filters (array)
. maxDevices (integer)
} (object)
name (string)
test: {
. type (string)
. testPackageArn (string)
. testSpecArn (string)
. filter (string)
. parameters (object)
} (object) required
configuration: {
. extraDataPackageArn (string)
. networkProfileArn (string)
. locale (string)
. location (object)
. vpceConfigurationArns (array)
. deviceProxy (object)
. customerArtifactPaths (object)
. radios (object)
. auxiliaryApps (array)
. billingMethod (string)
. environmentVariables (array)
. executionRoleArn (string)
} (object)
executionConfiguration: {
. jobTimeoutMinutes (integer)
. accountsCleanup (boolean)
. appPackagesCleanup (boolean)
. videoCapture (boolean)
. skipAppResign (boolean)
} (object)
device_farm/stop_jobInitiates 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.arn (string) required
device_farm/stop_remote_access_sessionEnds a specified remote access session.arn (string) required
device_farm/stop_runInitiates 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.arn (string) required
device_farm/tag_resourceAssociates 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.ResourceARN (string) required
Tags (array) required
device_farm/untag_resourceDeletes the specified tags from a resource.ResourceARN (string) required
TagKeys (array) required
device_farm/update_device_instanceUpdates information about a private device instance.arn (string) required
profileArn (string)
labels (array)
device_farm/update_device_poolModifies 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.arn (string) required
name (string)
description (string)
rules (array)
maxDevices (integer)
clearMaxDevices (boolean)
device_farm/update_instance_profileUpdates information about an existing private device instance profile.arn (string) required
name (string)
description (string)
packageCleanup (boolean)
excludeAppPackagesFromCleanup (array)
rebootAfterUse (boolean)
device_farm/update_network_profileUpdates the network profile.arn (string) required
name (string)
description (string)
type (string)
uplinkBandwidthBits (integer)
downlinkBandwidthBits (integer)
uplinkDelayMs (integer)
downlinkDelayMs (integer)
uplinkJitterMs (integer)
downlinkJitterMs (integer)
uplinkLossPercent (integer)
downlinkLossPercent (integer)
device_farm/update_projectModifies the specified project name, given the project ARN and a new name.arn (string) required
name (string)
defaultJobTimeoutMinutes (integer)
vpcConfig: {
. securityGroupIds (array)
. subnetIds (array)
. vpcId (string)
} (object)
environmentVariables (array)
executionRoleArn (string)
device_farm/update_test_grid_projectChange details of a project.projectArn (string) required
name (string)
description (string)
vpcConfig: {
. securityGroupIds (array)
. subnetIds (array)
. vpcId (string)
} (object)
device_farm/update_uploadUpdates an uploaded test spec.arn (string) required
name (string)
contentType (string)
editContent (boolean)
device_farm/update_vpceconfigurationUpdates information about an Amazon Virtual Private Cloud VPC endpoint configuration.arn (string) required
vpceConfigurationName (string)
vpceServiceName (string)
serviceDnsName (string)
vpceConfigurationDescription (string)
devops_guru/add_notification_channelAdds 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 send 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 fConfig: {
. Sns (object)
. Filters (object)
} (object) required
devops_guru/delete_insightDeletes the insight along with the associated anomalies, events and recommendations.Id (string) required
devops_guru/describe_account_healthReturns 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.No parameters
devops_guru/describe_account_overviewFor 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.FromTime (string) required
ToTime (string)
devops_guru/describe_anomalyReturns details about an anomaly that you specify using its ID.Id (string) required
AccountId (string)
devops_guru/describe_event_sources_configReturns 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.No parameters
devops_guru/describe_feedbackReturns the most recent feedback submitted in the current Amazon Web Services account and Region.InsightId (string)
devops_guru/describe_insightReturns details about an insight that you specify using its ID.Id (string) required
AccountId (string)
devops_guru/describe_organization_healthReturns active insights, predictive insights, and resource hours analyzed in last hour.AccountIds (array)
OrganizationalUnitIds (array)
devops_guru/describe_organization_overviewReturns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.FromTime (string) required
ToTime (string)
AccountIds (array)
OrganizationalUnitIds (array)
devops_guru/describe_organization_resource_collection_healthProvides 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.OrganizationResourceCollectionType (string) required
AccountIds (array)
OrganizationalUnitIds (array)
NextToken (string)
MaxResults (integer)
devops_guru/describe_resource_collection_healthReturns 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 resoResourceCollectionType (string) required
NextToken (string)
devops_guru/describe_service_integrationReturns 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.No parameters
devops_guru/get_cost_estimationReturns 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.NextToken (string)
devops_guru/get_resource_collectionReturns 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 CloudFormationResourceCollectionType (string) required
NextToken (string)
devops_guru/list_anomalies_for_insightReturns a list of the anomalies that belong to an insight that you specify using its ID.InsightId (string) required
StartTimeRange: {
. FromTime (string)
. ToTime (string)
} (object)
MaxResults (integer)
NextToken (string)
AccountId (string)
Filters: {
. ServiceCollection (object)
} (object)
devops_guru/list_anomalous_log_groupsReturns the list of log groups that contain log anomalies.InsightId (string) required
MaxResults (integer)
NextToken (string)
devops_guru/list_eventsReturns 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.Filters: {
. InsightId (string)
. EventTimeRange (object)
. EventClass (string)
. EventSource (string)
. DataSource (string)
. ResourceCollection (object)
} (object) required
MaxResults (integer)
NextToken (string)
AccountId (string)
devops_guru/list_insightsReturns 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.StatusFilter: {
. Ongoing (object)
. Closed (object)
. Any (object)
} (object) required
MaxResults (integer)
NextToken (string)
devops_guru/list_monitored_resourcesReturns the list of all log groups that are being monitored and tagged by DevOps Guru.Filters: {
. ResourcePermission (string)
. ResourceTypeFilters (array)
} (object)
MaxResults (integer)
NextToken (string)
devops_guru/list_notification_channelsReturns 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.NextToken (string)
devops_guru/list_organization_insightsReturns a list of insights associated with the account or OU Id.StatusFilter: {
. Ongoing (object)
. Closed (object)
. Any (object)
} (object) required
MaxResults (integer)
AccountIds (array)
OrganizationalUnitIds (array)
NextToken (string)
devops_guru/list_recommendationsReturns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.InsightId (string) required
NextToken (string)
Locale (string)
AccountId (string)
devops_guru/put_feedbackCollects customer feedback about the specified insight.InsightFeedback: {
. Id (string)
. Feedback (string)
} (object)
devops_guru/remove_notification_channelRemoves 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.Id (string) required
devops_guru/search_insightsReturns 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 or 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.StartTimeRange: {
. FromTime (string)
. ToTime (string)
} (object) required
Filters: {
. Severities (array)
. Statuses (array)
. ResourceCollection (object)
. ServiceCollection (object)
} (object)
MaxResults (integer)
NextToken (string)
Type (string) required
devops_guru/search_organization_insightsReturns 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.AccountIds (array) required
StartTimeRange: {
. FromTime (string)
. ToTime (string)
} (object) required
Filters: {
. Severities (array)
. Statuses (array)
. ResourceCollection (object)
. ServiceCollection (object)
} (object)
MaxResults (integer)
NextToken (string)
Type (string) required
devops_guru/start_cost_estimationStarts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.ResourceCollection: {
. CloudFormation (object)
. Tags (array)
} (object) required
ClientToken (string)
devops_guru/update_event_sources_configEnables 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.EventSources: {
. AmazonCodeGuruProfiler (object)
} (object)
devops_guru/update_resource_collectionUpdates 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 createsAction (string) required
ResourceCollection: {
. CloudFormation (object)
. Tags (array)
} (object) required
devops_guru/update_service_integrationEnables 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.ServiceIntegration: {
. OpsCenter (object)
. LogsAnomalyDetection (object)
. KMSServerSideEncryption (object)
} (object) required
direct_connect/accept_direct_connect_gateway_association_proposalAccepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.directConnectGatewayId (string) required
proposalId (string) required
associatedGatewayOwnerAccount (string) required
overrideAllowedPrefixesToDirectConnectGateway (array)
direct_connect/allocate_connection_on_interconnectDeprecated. 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.bandwidth (string) required
connectionName (string) required
ownerAccount (string) required
interconnectId (string) required
vlan (integer) required
direct_connect/allocate_hosted_connectionCreates 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.connectionId (string) required
ownerAccount (string) required
bandwidth (string) required
connectionName (string) required
vlan (integer) required
tags (array)
direct_connect/allocate_private_virtual_interfaceProvisions 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.connectionId (string) required
ownerAccount (string) required
newPrivateVirtualInterfaceAllocation: {
. virtualInterfaceName (string)
. vlan (integer)
. asn (integer)
. asnLong (integer)
. mtu (integer)
. authKey (string)
. amazonAddress (string)
. addressFamily (string)
. customerAddress (string)
. tags (array)
} (object) required
direct_connect/allocate_public_virtual_interfaceProvisions 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 IPvconnectionId (string) required
ownerAccount (string) required
newPublicVirtualInterfaceAllocation: {
. virtualInterfaceName (string)
. vlan (integer)
. asn (integer)
. asnLong (integer)
. authKey (string)
. amazonAddress (string)
. customerAddress (string)
. addressFamily (string)
. routeFilterPrefixes (array)
. tags (array)
} (object) required
direct_connect/allocate_transit_virtual_interfaceProvisions 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 thconnectionId (string) required
ownerAccount (string) required
newTransitVirtualInterfaceAllocation: {
. virtualInterfaceName (string)
. vlan (integer)
. asn (integer)
. asnLong (integer)
. mtu (integer)
. authKey (string)
. amazonAddress (string)
. customerAddress (string)
. addressFamily (string)
. tags (array)
} (object) required
direct_connect/associate_connection_with_lagAssociates 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 settinconnectionId (string) required
lagId (string) required
direct_connect/associate_hosted_connectionAssociates 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.connectionId (string) required
parentConnectionId (string) required
direct_connect/associate_mac_sec_keyAssociates a MAC Security MACsec Connection Key Name CKN/ Connectivity Association Key CAK pair with a Direct Connect 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.connectionId (string) required
secretARN (string)
ckn (string)
cak (string)
direct_connect/associate_virtual_interfaceAssociates 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 intervirtualInterfaceId (string) required
connectionId (string) required
direct_connect/confirm_connectionConfirms 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.connectionId (string) required
direct_connect/confirm_customer_agreementThe confirmation of the terms of agreement when creating the connection/link aggregation group LAG.agreementName (string)
direct_connect/confirm_private_virtual_interfaceAccepts 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.virtualInterfaceId (string) required
virtualGatewayId (string)
directConnectGatewayId (string)
direct_connect/confirm_public_virtual_interfaceAccepts 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.virtualInterfaceId (string) required
direct_connect/confirm_transit_virtual_interfaceAccepts 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.virtualInterfaceId (string) required
directConnectGatewayId (string) required
direct_connect/create_bgppeerCreates 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 automaticalvirtualInterfaceId (string)
newBGPPeer: {
. asn (integer)
. asnLong (integer)
. authKey (string)
. addressFamily (string)
. amazonAddress (string)
. customerAddress (string)
} (object)
direct_connect/create_connectionCreates 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 connlocation (string) required
bandwidth (string) required
connectionName (string) required
lagId (string)
tags (array)
providerName (string)
requestMACSec (boolean)
direct_connect/create_direct_connect_gatewayCreates 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 virdirectConnectGatewayName (string) required
tags (array)
amazonSideAsn (integer)
direct_connect/create_direct_connect_gateway_associationCreates 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.directConnectGatewayId (string) required
gatewayId (string)
addAllowedPrefixesToDirectConnectGateway (array)
virtualGatewayId (string)
direct_connect/create_direct_connect_gateway_association_proposalCreates 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.directConnectGatewayId (string) required
directConnectGatewayOwnerAccount (string) required
gatewayId (string) required
addAllowedPrefixesToDirectConnectGateway (array)
removeAllowedPrefixesToDirectConnectGateway (array)
direct_connect/create_interconnectCreates 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 tointerconnectName (string) required
bandwidth (string) required
location (string) required
lagId (string)
tags (array)
providerName (string)
requestMACSec (boolean)
direct_connect/create_lagCreates 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, 10Gbps, 100Gbps, or 400Gbps and must terminate at the same Direct Connect endpoint. You can hnumberOfConnections (integer) required
location (string) required
connectionsBandwidth (string) required
lagName (string) required
connectionId (string)
tags (array)
childConnectionTags (array)
providerName (string)
requestMACSec (boolean)
direct_connect/create_private_virtual_interfaceCreates 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 withinconnectionId (string) required
newPrivateVirtualInterface: {
. virtualInterfaceName (string)
. vlan (integer)
. asn (integer)
. asnLong (integer)
. mtu (integer)
. authKey (string)
. amazonAddress (string)
. customerAddress (string)
. addressFamily (string)
. virtualGatewayId (string)
. directConnectGatewayId (string)
. tags (array)
. enableSiteLink (boolean)
} (object) required
direct_connect/create_public_virtual_interfaceCreates 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.connectionId (string) required
newPublicVirtualInterface: {
. virtualInterfaceName (string)
. vlan (integer)
. asn (integer)
. asnLong (integer)
. authKey (string)
. amazonAddress (string)
. customerAddress (string)
. addressFamily (string)
. routeFilterPrefixes (array)
. tags (array)
} (object) required
direct_connect/create_transit_virtual_interfaceCreates 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 usconnectionId (string) required
newTransitVirtualInterface: {
. virtualInterfaceName (string)
. vlan (integer)
. asn (integer)
. asnLong (integer)
. mtu (integer)
. authKey (string)
. amazonAddress (string)
. customerAddress (string)
. addressFamily (string)
. directConnectGatewayId (string)
. tags (array)
. enableSiteLink (boolean)
} (object) required
direct_connect/delete_bgppeerDeletes 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.virtualInterfaceId (string)
asn (integer)
asnLong (integer)
customerAddress (string)
bgpPeerId (string)
direct_connect/delete_connectionDeletes 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.connectionId (string) required
direct_connect/delete_direct_connect_gatewayDeletes 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.directConnectGatewayId (string) required
direct_connect/delete_direct_connect_gateway_associationDeletes 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.associationId (string)
directConnectGatewayId (string)
virtualGatewayId (string)
direct_connect/delete_direct_connect_gateway_association_proposalDeletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.proposalId (string) required
direct_connect/delete_interconnectDeletes the specified interconnect. Intended for use by Direct Connect Partners only.interconnectId (string) required
direct_connect/delete_lagDeletes the specified link aggregation group LAG. You cannot delete a LAG if it has active virtual interfaces or hosted connections.lagId (string) required
direct_connect/delete_virtual_interfaceDeletes a virtual interface.virtualInterfaceId (string) required
direct_connect/describe_connection_loaDeprecated. 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.connectionId (string) required
providerName (string)
loaContentType (string)
direct_connect/describe_connectionsDisplays the specified connection or all connections in this Region.connectionId (string)
maxResults (integer)
nextToken (string)
direct_connect/describe_connections_on_interconnectDeprecated. Use DescribeHostedConnections instead. Lists the connections that have been provisioned on the specified interconnect. Intended for use by Direct Connect Partners only.interconnectId (string) required
direct_connect/describe_customer_metadataGet and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.No parameters
direct_connect/describe_direct_connect_gateway_association_proposalsDescribes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.directConnectGatewayId (string)
proposalId (string)
associatedGatewayId (string)
maxResults (integer)
nextToken (string)
direct_connect/describe_direct_connect_gateway_associationsLists 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 responassociationId (string)
associatedGatewayId (string)
directConnectGatewayId (string)
maxResults (integer)
nextToken (string)
virtualGatewayId (string)
direct_connect/describe_direct_connect_gateway_attachmentsLists 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 anddirectConnectGatewayId (string)
virtualInterfaceId (string)
maxResults (integer)
nextToken (string)
direct_connect/describe_direct_connect_gatewaysLists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.directConnectGatewayId (string)
maxResults (integer)
nextToken (string)
direct_connect/describe_hosted_connectionsLists the hosted connections that have been provisioned on the specified interconnect or link aggregation group LAG. Intended for use by Direct Connect Partners only.connectionId (string) required
maxResults (integer)
nextToken (string)
direct_connect/describe_interconnect_loaDeprecated. 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.interconnectId (string) required
providerName (string)
loaContentType (string)
direct_connect/describe_interconnectsLists the interconnects owned by the Amazon Web Services account or only the specified interconnect.interconnectId (string)
maxResults (integer)
nextToken (string)
direct_connect/describe_lagsDescribes all your link aggregation groups LAG or the specified LAG.lagId (string)
maxResults (integer)
nextToken (string)
direct_connect/describe_loaGets 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.connectionId (string) required
providerName (string)
loaContentType (string)
direct_connect/describe_locationsLists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.No parameters
direct_connect/describe_router_configurationDetails about the router.virtualInterfaceId (string) required
routerTypeIdentifier (string)
direct_connect/describe_tagsDescribes the tags associated with the specified Direct Connect resources.resourceArns (array) required
direct_connect/describe_virtual_gatewaysDeprecated. Use DescribeVpnGateways instead. See DescribeVPNGateways in the Amazon Elastic Compute Cloud API Reference. Lists the virtual private gateways owned by the Amazon Web Services account. You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.No parameters
direct_connect/describe_virtual_interfacesDisplays 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. If you're using an asn, the respoconnectionId (string)
virtualInterfaceId (string)
maxResults (integer)
nextToken (string)
direct_connect/disassociate_connection_from_lagDisassociates 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 fconnectionId (string) required
lagId (string) required
direct_connect/disassociate_mac_sec_keyRemoves the association between a MAC Security MACsec security key and a Direct Connect connection.connectionId (string) required
secretARN (string) required
direct_connect/list_virtual_interface_test_historyLists the virtual interface failover test history.testId (string)
virtualInterfaceId (string)
bgpPeers (array)
status (string)
maxResults (integer)
nextToken (string)
direct_connect/start_bgp_failover_testStarts 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.virtualInterfaceId (string) required
bgpPeers (array)
testDurationInMinutes (integer)
direct_connect/stop_bgp_failover_testStops the virtual interface failover test.virtualInterfaceId (string) required
direct_connect/tag_resourceAdds 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.resourceArn (string) required
tags (array) required
direct_connect/untag_resourceRemoves one or more tags from the specified Direct Connect resource.resourceArn (string) required
tagKeys (array) required
direct_connect/update_connectionUpdates the Direct Connect connection configuration. You can update the following parameters for a connection: The connection name The connection's MAC Security MACsec encryption mode.connectionId (string) required
connectionName (string)
encryptionMode (string)
direct_connect/update_direct_connect_gatewayUpdates the name of a current Direct Connect gateway.directConnectGatewayId (string) required
newDirectConnectGatewayName (string) required
direct_connect/update_direct_connect_gateway_associationUpdates the specified attributes of the Direct Connect gateway association. Add or remove prefixes from the association.associationId (string)
addAllowedPrefixesToDirectConnectGateway (array)
removeAllowedPrefixesToDirectConnectGateway (array)
direct_connect/update_lagUpdates 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 thlagId (string) required
lagName (string)
minimumLinks (integer)
encryptionMode (string)
direct_connect/update_virtual_interface_attributesUpdates the specified attributes of the specified virtual private interface. 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 supvirtualInterfaceId (string) required
mtu (integer)
enableSiteLink (boolean)
virtualInterfaceName (string)
directory_service_data/add_group_memberAdds an existing user, group, or computer as a group member.DirectoryId (string) required
GroupName (string) required
MemberName (string) required
MemberRealm (string)
ClientToken (string)
directory_service_data/create_groupCreates a new group.DirectoryId (string) required
SAMAccountName (string) required
GroupType (string)
GroupScope (string)
OtherAttributes (object)
ClientToken (string)
directory_service_data/create_userCreates a new user.DirectoryId (string) required
SAMAccountName (string) required
EmailAddress (string)
GivenName (string)
Surname (string)
OtherAttributes (object)
ClientToken (string)
directory_service_data/delete_groupDeletes a group.DirectoryId (string) required
SAMAccountName (string) required
ClientToken (string)
directory_service_data/delete_userDeletes a user.DirectoryId (string) required
SAMAccountName (string) required
ClientToken (string)
directory_service_data/describe_groupReturns information about a specific group.DirectoryId (string) required
Realm (string)
SAMAccountName (string) required
OtherAttributes (array)
directory_service_data/describe_userReturns information about a specific user.DirectoryId (string) required
SAMAccountName (string) required
OtherAttributes (array)
Realm (string)
directory_service_data/disable_userDeactivates an active user account. For information about how to enable an inactive user account, see ResetUserPassword in the Directory Service API Reference.DirectoryId (string) required
SAMAccountName (string) required
ClientToken (string)
directory_service_data/list_group_membersReturns member information for the specified group. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroupMembers.NextToken member contains a token that you pass in the next call to ListGroupMembers. This retrieves the next set of items. You can also specify a maximum number of return results with the MaxResults parameter.DirectoryId (string) required
Realm (string)
MemberRealm (string)
SAMAccountName (string) required
NextToken (string)
MaxResults (integer)
directory_service_data/list_groupsReturns group information for the specified directory. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroups.NextToken member contains a token that you pass in the next call to ListGroups. This retrieves the next set of items. You can also specify a maximum number of return results with the MaxResults parameter.DirectoryId (string) required
Realm (string)
NextToken (string)
MaxResults (integer)
directory_service_data/list_groups_for_memberReturns group information for the specified member. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroupsForMember.NextToken member contains a token that you pass in the next call to ListGroupsForMember. This retrieves the next set of items. You can also specify a maximum number of return results with the MaxResults parameter.DirectoryId (string) required
Realm (string)
MemberRealm (string)
SAMAccountName (string) required
NextToken (string)
MaxResults (integer)
directory_service_data/list_usersReturns user information for the specified directory. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListUsers.NextToken member contains a token that you pass in the next call to ListUsers. This retrieves the next set of items. You can also specify a maximum number of return results with the MaxResults parameter.DirectoryId (string) required
Realm (string)
NextToken (string)
MaxResults (integer)
directory_service_data/remove_group_memberRemoves a member from a group.DirectoryId (string) required
GroupName (string) required
MemberName (string) required
MemberRealm (string)
ClientToken (string)
directory_service_data/search_groupsSearches the specified directory for a group. You can find groups that match the SearchString parameter with the value of their attributes included in the SearchString parameter. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the SearchGroups.NextToken member contains a token that you pass in the next call to SearchGroups. This retrieves the next set of items. You can also specify a maximum number of return resultsDirectoryId (string) required
SearchString (string) required
SearchAttributes (array) required
Realm (string)
NextToken (string)
MaxResults (integer)
directory_service_data/search_usersSearches the specified directory for a user. You can find users that match the SearchString parameter with the value of their attributes included in the SearchString parameter. This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the SearchUsers.NextToken member contains a token that you pass in the next call to SearchUsers. This retrieves the next set of items. You can also specify a maximum number of return results witDirectoryId (string) required
Realm (string)
SearchString (string) required
SearchAttributes (array) required
NextToken (string)
MaxResults (integer)
directory_service_data/update_groupUpdates group information.DirectoryId (string) required
SAMAccountName (string) required
GroupType (string)
GroupScope (string)
OtherAttributes (object)
UpdateType (string)
ClientToken (string)
directory_service_data/update_userUpdates user information.DirectoryId (string) required
SAMAccountName (string) required
EmailAddress (string)
GivenName (string)
Surname (string)
OtherAttributes (object)
UpdateType (string)
ClientToken (string)
directory_service/accept_shared_directoryAccepts a directory sharing request that was sent from the directory owner account.SharedDirectoryId (string) required
directory_service/add_ip_routesIf 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 poDirectoryId (string) required
IpRoutes (array) required
UpdateSecurityGroupForDirectoryControllers (boolean)
directory_service/add_regionAdds two domain controllers in the specified Region for the specified directory.DirectoryId (string) required
RegionName (string) required
VPCSettings: {
. VpcId (string)
. SubnetIds (array)
} (object) required
directory_service/add_tags_to_resourceAdds 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.ResourceId (string) required
Tags (array) required
directory_service/cancel_schema_extensionCancels 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.DirectoryId (string) required
SchemaExtensionId (string) required
directory_service/connect_directoryCreates 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.Name (string) required
ShortName (string)
Password (string) required
Description (string)
Size (string) required
ConnectSettings: {
. VpcId (string)
. SubnetIds (array)
. CustomerDnsIps (array)
. CustomerDnsIpsV6 (array)
. CustomerUserName (string)
} (object) required
Tags (array)
NetworkType (string)
directory_service/create_aliasCreates 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://.awsapps.com. After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.DirectoryId (string) required
Alias (string) required
directory_service/create_computerCreates an Active Directory computer object in the specified directory.DirectoryId (string) required
ComputerName (string) required
Password (string) required
OrganizationalUnitDistinguishedName (string)
ComputerAttributes (array)
directory_service/create_conditional_forwarderCreates 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.DirectoryId (string) required
RemoteDomainName (string) required
DnsIpAddrs (array)
DnsIpv6Addrs (array)
directory_service/create_directoryCreates 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.Name (string) required
ShortName (string)
Password (string) required
Description (string)
Size (string) required
VpcSettings: {
. VpcId (string)
. SubnetIds (array)
} (object)
Tags (array)
NetworkType (string)
directory_service/create_hybrid_adCreates a hybrid directory that connects your self-managed Active Directory AD infrastructure and Amazon Web Services. You must have a successful directory assessment using StartADAssessment to validate your environment compatibility before you use this operation. Updates are applied asynchronously. Use DescribeDirectories to monitor the progress of directory creation.SecretArn (string) required
AssessmentId (string) required
Tags (array)
directory_service/create_log_subscriptionCreates 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.DirectoryId (string) required
LogGroupName (string) required
directory_service/create_microsoft_adCreates 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.Name (string) required
ShortName (string)
Password (string) required
Description (string)
VpcSettings: {
. VpcId (string)
. SubnetIds (array)
} (object) required
Edition (string)
Tags (array)
NetworkType (string)
directory_service/create_snapshotCreates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud. You cannot take snapshots of AD Connector directories.DirectoryId (string) required
Name (string)
directory_service/create_trustDirectory 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 exDirectoryId (string) required
RemoteDomainName (string) required
TrustPassword (string) required
TrustDirection (string) required
TrustType (string)
ConditionalForwarderIpAddrs (array)
ConditionalForwarderIpv6Addrs (array)
SelectiveAuth (string)
directory_service/delete_adassessmentDeletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration information. You cannot delete system-initiated assessments. You can delete customer-created assessments even if they are in progress.AssessmentId (string) required
directory_service/delete_conditional_forwarderDeletes a conditional forwarder that has been set up for your Amazon Web Services directory.DirectoryId (string) required
RemoteDomainName (string) required
directory_service/delete_directoryDeletes 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.DirectoryId (string) required
directory_service/delete_log_subscriptionDeletes the specified log subscription.DirectoryId (string) required
directory_service/delete_snapshotDeletes a directory snapshot.SnapshotId (string) required
directory_service/delete_trustDeletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.TrustId (string) required
DeleteAssociatedConditionalForwarder (boolean)
directory_service/deregister_certificateDeletes from the system the certificate that was registered for secure LDAP or client certificate authentication.DirectoryId (string) required
CertificateId (string) required
directory_service/deregister_event_topicRemoves the specified directory as a publisher to the specified Amazon SNS topic.DirectoryId (string) required
TopicName (string) required
directory_service/describe_adassessmentRetrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. Use this operation to monitor assessment progress and review results.AssessmentId (string) required
directory_service/describe_caenrollment_policyRetrieves detailed information about the certificate authority CA enrollment policy for the specified directory. This policy determines how client certificates are automatically enrolled and managed through Amazon Web Services Private Certificate Authority.DirectoryId (string) required
directory_service/describe_certificateDisplays information about the certificate registered for secure LDAP or client certificate authentication.DirectoryId (string) required
CertificateId (string) required
directory_service/describe_client_authentication_settingsRetrieves 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.DirectoryId (string) required
Type (string)
NextToken (string)
Limit (integer)
directory_service/describe_conditional_forwardersObtains 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.DirectoryId (string) required
RemoteDomainNames (array)
directory_service/describe_directoriesObtains 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 DeDirectoryIds (array)
NextToken (string)
Limit (integer)
directory_service/describe_directory_data_accessObtains status of directory data access enablement through the Directory Service Data API for the specified directory.DirectoryId (string) required
directory_service/describe_domain_controllersProvides information about any domain controllers in your directory.DirectoryId (string) required
DomainControllerIds (array)
NextToken (string)
Limit (integer)
directory_service/describe_event_topicsObtains 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.DirectoryId (string)
TopicNames (array)
directory_service/describe_hybrid_adupdateRetrieves information about update activities for a hybrid directory. This operation provides details about configuration changes, administrator account updates, and self-managed instance settings IDs and DNS IPs.DirectoryId (string) required
UpdateType (string)
NextToken (string)
directory_service/describe_ldapssettingsDescribes the status of LDAP security for the specified directory.DirectoryId (string) required
Type (string)
NextToken (string)
Limit (integer)
directory_service/describe_regionsProvides information about the Regions that are configured for multi-Region replication.DirectoryId (string) required
RegionName (string)
NextToken (string)
directory_service/describe_settingsRetrieves information about the configurable settings for the specified directory.DirectoryId (string) required
Status (string)
NextToken (string)
directory_service/describe_shared_directoriesReturns the shared directories in your account.OwnerDirectoryId (string) required
SharedDirectoryIds (array)
NextToken (string)
Limit (integer)
directory_service/describe_snapshotsObtains 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.DirectoryId (string)
SnapshotIds (array)
NextToken (string)
Limit (integer)
directory_service/describe_trustsObtains 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.DirectoryId (string)
TrustIds (array)
NextToken (string)
Limit (integer)
directory_service/describe_update_directoryDescribes the updates of a directory for a particular update type.DirectoryId (string) required
UpdateType (string) required
RegionName (string)
NextToken (string)
directory_service/disable_caenrollment_policyDisables the certificate authority CA enrollment policy for the specified directory. This stops automatic certificate enrollment and management for domain-joined clients, but does not affect existing certificates. Disabling the CA enrollment policy prevents new certificates from being automatically enrolled, but existing certificates remain valid and functional until they expire.DirectoryId (string) required
directory_service/disable_client_authenticationDisables alternative client authentication methods for the specified directory.DirectoryId (string) required
Type (string) required
directory_service/disable_directory_data_accessDeactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.DirectoryId (string) required
directory_service/disable_ldapsDeactivates LDAP secure calls for the specified directory.DirectoryId (string) required
Type (string) required
directory_service/disable_radiusDisables multi-factor authentication MFA with the Remote Authentication Dial In User Service RADIUS server for an AD Connector or Microsoft AD directory.DirectoryId (string) required
directory_service/disable_ssoDisables single-sign on for a directory.DirectoryId (string) required
UserName (string)
Password (string)
directory_service/enable_caenrollment_policyEnables certificate authority CA enrollment policy for the specified directory. This allows domain-joined clients to automatically request and receive certificates from the specified Amazon Web Services Private Certificate Authority. Before enabling CA enrollment, ensure that the PCA connector is properly configured and accessible from the directory. The connector must be in an active state and have the necessary permissions.DirectoryId (string) required
PcaConnectorArn (string) required
directory_service/enable_client_authenticationEnables alternative client authentication methods for the specified directory.DirectoryId (string) required
Type (string) required
directory_service/enable_directory_data_accessEnables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.DirectoryId (string) required
directory_service/enable_ldapsActivates the switch for the specific directory to always use LDAP secure calls.DirectoryId (string) required
Type (string) required
directory_service/enable_radiusEnables multi-factor authentication MFA with the Remote Authentication Dial In User Service RADIUS server for an AD Connector or Microsoft AD directory.DirectoryId (string) required
RadiusSettings: {
. RadiusServers (array)
. RadiusServersIpv6 (array)
. RadiusPort (integer)
. RadiusTimeout (integer)
. RadiusRetries (integer)
. SharedSecret (string)
. AuthenticationProtocol (string)
. DisplayLabel (string)
. UseSameUsername (boolean)
} (object) required
directory_service/enable_ssoEnables 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.DirectoryId (string) required
UserName (string)
Password (string)
directory_service/get_directory_limitsObtains directory limit information for the current Region.No parameters
directory_service/get_snapshot_limitsObtains the manual snapshot limits for a directory.DirectoryId (string) required
directory_service/list_adassessmentsRetrieves a list of directory assessments for the specified directory or all assessments in your account. Use this operation to monitor assessment status and manage multiple assessments.DirectoryId (string)
NextToken (string)
Limit (integer)
directory_service/list_certificatesFor the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.DirectoryId (string) required
NextToken (string)
Limit (integer)
directory_service/list_ip_routesLists the address blocks that you have added to a directory.DirectoryId (string) required
NextToken (string)
Limit (integer)
directory_service/list_log_subscriptionsLists the active log subscriptions for the Amazon Web Services account.DirectoryId (string)
NextToken (string)
Limit (integer)
directory_service/list_schema_extensionsLists all schema extensions applied to a Microsoft AD Directory.DirectoryId (string) required
NextToken (string)
Limit (integer)
directory_service/list_tags_for_resourceLists all tags on a directory.ResourceId (string) required
NextToken (string)
Limit (integer)
directory_service/register_certificateRegisters a certificate for a secure LDAP or client certificate authentication.DirectoryId (string) required
CertificateData (string) required
Type (string)
ClientCertAuthSettings: {
. OCSPUrl (string)
} (object)
directory_service/register_event_topicAssociates 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.DirectoryId (string) required
TopicName (string) required
directory_service/reject_shared_directoryRejects a directory sharing request that was sent from the directory owner account.SharedDirectoryId (string) required
directory_service/remove_ip_routesRemoves IP address blocks from a directory.DirectoryId (string) required
CidrIps (array)
CidrIpv6s (array)
directory_service/remove_regionStops 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.DirectoryId (string) required
directory_service/remove_tags_from_resourceRemoves tags from a directory.ResourceId (string) required
TagKeys (array) required
directory_service/reset_user_passwordResets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled users will become enabled and can be authenticated following the API call. 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 isDirectoryId (string) required
UserName (string) required
NewPassword (string) required
directory_service/restore_from_snapshotRestores 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.SnapshotId (string) required
directory_service/share_directoryShares 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 theDirectoryId (string) required
ShareNotes (string)
ShareTarget: {
. Id (string)
. Type (string)
} (object) required
ShareMethod (string) required
directory_service/start_adassessmentInitiates a directory assessment to validate your self-managed AD environment for hybrid domain join. The assessment checks compatibility and connectivity of the self-managed AD environment. A directory assessment is automatically created when you create a hybrid directory. There are two types of assessments: CUSTOMER and SYSTEM. Your Amazon Web Services account has a limit of 100 CUSTOMER directory assessments. The assessment process typically takes 30 minutes or more to complete. The assessmenAssessmentConfiguration: {
. CustomerDnsIps (array)
. DnsName (string)
. VpcSettings (object)
. InstanceIds (array)
. SecurityGroupIds (array)
} (object)
DirectoryId (string)
directory_service/start_schema_extensionApplies a schema extension to a Microsoft AD directory.DirectoryId (string) required
CreateSnapshotBeforeSchemaExtension (boolean) required
LdifContent (string) required
Description (string) required
directory_service/unshare_directoryStops the directory sharing between the directory owner and consumer accounts.DirectoryId (string) required
UnshareTarget: {
. Id (string)
. Type (string)
} (object) required
directory_service/update_conditional_forwarderUpdates a conditional forwarder that has been set up for your Amazon Web Services directory.DirectoryId (string) required
RemoteDomainName (string) required
DnsIpAddrs (array)
DnsIpv6Addrs (array)
directory_service/update_directory_setupUpdates directory configuration for the specified update type.DirectoryId (string) required
UpdateType (string) required
OSUpdateSettings: {
. OSVersion (string)
} (object)
DirectorySizeUpdateSettings: {
. DirectorySize (string)
} (object)
NetworkUpdateSettings: {
. NetworkType (string)
. CustomerDnsIpsV6 (array)
} (object)
CreateSnapshotBeforeUpdate (boolean)
directory_service/update_hybrid_adUpdates the configuration of an existing hybrid directory. You can recover hybrid directory administrator account or modify self-managed instance settings. Updates are applied asynchronously. Use DescribeHybridADUpdate to monitor the progress of configuration changes. The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays musDirectoryId (string) required
HybridAdministratorAccountUpdate: {
. SecretArn (string)
} (object)
SelfManagedInstancesSettings: {
. CustomerDnsIps (array)
. InstanceIds (array)
} (object)
directory_service/update_number_of_domain_controllersAdds 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.DirectoryId (string) required
DesiredNumber (integer) required
directory_service/update_radiusUpdates the Remote Authentication Dial In User Service RADIUS server information for an AD Connector or Microsoft AD directory.DirectoryId (string) required
RadiusSettings: {
. RadiusServers (array)
. RadiusServersIpv6 (array)
. RadiusPort (integer)
. RadiusTimeout (integer)
. RadiusRetries (integer)
. SharedSecret (string)
. AuthenticationProtocol (string)
. DisplayLabel (string)
. UseSameUsername (boolean)
} (object) required
directory_service/update_settingsUpdates the configurable settings for the specified directory.DirectoryId (string) required
Settings (array) required
directory_service/update_trustUpdates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.TrustId (string) required
SelectiveAuth (string)
directory_service/verify_trustDirectory 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.TrustId (string) required
dlm/create_lifecycle_policyCreates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data Lifecycle Manager supports the following policy types: Custom EBS snapshot policy Custom EBS-backed AMI policy Cross-account copy event policy Default policy for EBS snapshots Default policy for EBS-backed AMIs For more information, see Default policies vs custom policies. If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.ExecutionRoleArn (string) required
Description (string) required
State (string) required
PolicyDetails: {
. PolicyType (string)
. ResourceTypes (array)
. ResourceLocations (array)
. TargetTags (array)
. Schedules (array)
. Parameters (object)
. EventSource (object)
. Actions (array)
. PolicyLanguage (string)
. ResourceType (string)
. CreateInterval (integer)
. RetainInterval (integer)
. CopyTags (boolean)
. CrossRegionCopyTargets (array)
. ExtendDeletion (boolean)
. Exclusions (object)
} (object)
Tags (object)
DefaultPolicy (string)
CreateInterval (integer)
RetainInterval (integer)
CopyTags (boolean)
ExtendDeletion (boolean)
CrossRegionCopyTargets (array)
Exclusions: {
. ExcludeBootVolumes (boolean)
. ExcludeVolumeTypes (array)
. ExcludeTags (array)
} (object)
dlm/delete_lifecycle_policyDeletes the specified lifecycle policy and halts the automated operations that the policy specified. For more information about deleting a policy, see Delete lifecycle policies.PolicyId (string) required
dlm/get_lifecycle_policiesGets summary information about all or the specified data lifecycle policies. To get complete information about a policy, use GetLifecyclePolicy.PolicyIds (array)
State (string)
ResourceTypes (array)
TargetTags (array)
TagsToAdd (array)
DefaultPolicyType (string)
dlm/get_lifecycle_policyGets detailed information about the specified lifecycle policy.PolicyId (string) required
dlm/list_tags_for_resourceLists the tags for the specified resource.ResourceArn (string) required
dlm/tag_resourceAdds the specified tags to the specified resource.ResourceArn (string) required
Tags (object) required
dlm/untag_resourceRemoves the specified tags from the specified resource.ResourceArn (string) required
TagKeys (array) required
dlm/update_lifecycle_policyUpdates the specified lifecycle policy. For more information about updating a policy, see Modify lifecycle policies.PolicyId (string) required
ExecutionRoleArn (string)
State (string)
Description (string)
PolicyDetails: {
. PolicyType (string)
. ResourceTypes (array)
. ResourceLocations (array)
. TargetTags (array)
. Schedules (array)
. Parameters (object)
. EventSource (object)
. Actions (array)
. PolicyLanguage (string)
. ResourceType (string)
. CreateInterval (integer)
. RetainInterval (integer)
. CopyTags (boolean)
. CrossRegionCopyTargets (array)
. ExtendDeletion (boolean)
. Exclusions (object)
} (object)
CreateInterval (integer)
RetainInterval (integer)
CopyTags (boolean)
ExtendDeletion (boolean)
CrossRegionCopyTargets (array)
Exclusions: {
. ExcludeBootVolumes (boolean)
. ExcludeVolumeTypes (array)
. ExcludeTags (array)
} (object)
docdb_elastic/apply_pending_maintenance_actionThe type of pending maintenance action to be applied to the resource.resourceArn (string) required
applyAction (string) required
optInType (string) required
applyOn (string)
docdb_elastic/copy_cluster_snapshotCopies a snapshot of an elastic cluster.snapshotArn (string) required
targetSnapshotName (string) required
kmsKeyId (string)
copyTags (boolean)
tags (object)
docdb_elastic/create_clusterCreates a new Amazon DocumentDB elastic cluster and returns its cluster structure.clusterName (string) required
authType (string) required
adminUserName (string) required
adminUserPassword (string) required
shardCapacity (integer) required
shardCount (integer) required
vpcSecurityGroupIds (array)
subnetIds (array)
kmsKeyId (string)
clientToken (string)
preferredMaintenanceWindow (string)
tags (object)
backupRetentionPeriod (integer)
preferredBackupWindow (string)
shardInstanceCount (integer)
docdb_elastic/create_cluster_snapshotCreates a snapshot of an elastic cluster.clusterArn (string) required
snapshotName (string) required
tags (object)
docdb_elastic/delete_clusterDelete an elastic cluster.clusterArn (string) required
docdb_elastic/delete_cluster_snapshotDelete an elastic cluster snapshot.snapshotArn (string) required
docdb_elastic/get_clusterReturns information about a specific elastic cluster.clusterArn (string) required
docdb_elastic/get_cluster_snapshotReturns information about a specific elastic cluster snapshotsnapshotArn (string) required
docdb_elastic/get_pending_maintenance_actionRetrieves all maintenance actions that are pending.resourceArn (string) required
docdb_elastic/list_clustersReturns information about provisioned Amazon DocumentDB elastic clusters.nextToken (string)
maxResults (integer)
docdb_elastic/list_cluster_snapshotsReturns information about snapshots for a specified elastic cluster.clusterArn (string)
nextToken (string)
maxResults (integer)
snapshotType (string)
docdb_elastic/list_pending_maintenance_actionsRetrieves a list of all maintenance actions that are pending.nextToken (string)
maxResults (integer)
docdb_elastic/list_tags_for_resourceLists all tags on a elastic cluster resourceresourceArn (string) required
docdb_elastic/restore_cluster_from_snapshotRestores an elastic cluster from a snapshot.clusterName (string) required
snapshotArn (string) required
vpcSecurityGroupIds (array)
subnetIds (array)
kmsKeyId (string)
tags (object)
shardCapacity (integer)
shardInstanceCount (integer)
docdb_elastic/start_clusterRestarts the stopped elastic cluster that is specified by clusterARN.clusterArn (string) required
docdb_elastic/stop_clusterStops the running elastic cluster that is specified by clusterArn. The elastic cluster must be in the available state.clusterArn (string) required
docdb_elastic/tag_resourceAdds metadata tags to an elastic cluster resourceresourceArn (string) required
tags (object) required
docdb_elastic/untag_resourceRemoves metadata tags from an elastic cluster resourceresourceArn (string) required
tagKeys (array) required
docdb_elastic/update_clusterModifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance windowclusterArn (string) required
authType (string)
shardCapacity (integer)
shardCount (integer)
vpcSecurityGroupIds (array)
subnetIds (array)
adminUserPassword (string)
clientToken (string)
preferredMaintenanceWindow (string)
backupRetentionPeriod (integer)
preferredBackupWindow (string)
shardInstanceCount (integer)
docdb/add_source_identifier_to_subscriptionAdds a source identifier to an existing event notification subscription.SubscriptionName (string) required
SourceIdentifier (string) required
docdb/add_tags_to_resourceAdds 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.ResourceName (string) required
Tags (array) required
docdb/apply_pending_maintenance_actionApplies a pending maintenance action to a resource for example, to an Amazon DocumentDB instance.ResourceIdentifier (string) required
ApplyAction (string) required
OptInType (string) required
docdb/copy_dbcluster_parameter_groupCopies the specified cluster parameter group.SourceDBClusterParameterGroupIdentifier (string) required
TargetDBClusterParameterGroupIdentifier (string) required
TargetDBClusterParameterGroupDescription (string) required
Tags (array)
docdb/copy_dbcluster_snapshotCopies 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 stSourceDBClusterSnapshotIdentifier (string) required
TargetDBClusterSnapshotIdentifier (string) required
KmsKeyId (string)
PreSignedUrl (string)
CopyTags (boolean)
Tags (array)
docdb/create_dbclusterCreates a new Amazon DocumentDB cluster.AvailabilityZones (array)
BackupRetentionPeriod (integer)
DBClusterIdentifier (string) required
DBClusterParameterGroupName (string)
VpcSecurityGroupIds (array)
DBSubnetGroupName (string)
Engine (string) required
EngineVersion (string)
Port (integer)
MasterUsername (string)
MasterUserPassword (string)
PreferredBackupWindow (string)
PreferredMaintenanceWindow (string)
Tags (array)
StorageEncrypted (boolean)
KmsKeyId (string)
PreSignedUrl (string)
EnableCloudwatchLogsExports (array)
DeletionProtection (boolean)
GlobalClusterIdentifier (string)
StorageType (string)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
} (object)
ManageMasterUserPassword (boolean)
MasterUserSecretKmsKeyId (string)
NetworkType (string)
docdb/create_dbcluster_parameter_groupCreates 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 crDBClusterParameterGroupName (string) required
DBParameterGroupFamily (string) required
Description (string) required
Tags (array)
docdb/create_dbcluster_snapshotCreates a snapshot of a cluster.DBClusterSnapshotIdentifier (string) required
DBClusterIdentifier (string) required
Tags (array)
docdb/create_dbinstanceCreates a new instance.DBInstanceIdentifier (string) required
DBInstanceClass (string) required
Engine (string) required
AvailabilityZone (string)
PreferredMaintenanceWindow (string)
AutoMinorVersionUpgrade (boolean)
Tags (array)
DBClusterIdentifier (string) required
CopyTagsToSnapshot (boolean)
PromotionTier (integer)
EnablePerformanceInsights (boolean)
PerformanceInsightsKMSKeyId (string)
CACertificateIdentifier (string)
docdb/create_dbsubnet_groupCreates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.DBSubnetGroupName (string) required
DBSubnetGroupDescription (string) required
SubnetIds (array) required
Tags (array)
docdb/create_event_subscriptionCreates 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 SourcSubscriptionName (string) required
SnsTopicArn (string) required
SourceType (string)
EventCategories (array)
SourceIds (array)
Enabled (boolean)
Tags (array)
docdb/create_global_clusterCreates 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 10 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 secondarGlobalClusterIdentifier (string) required
SourceDBClusterIdentifier (string)
Engine (string)
EngineVersion (string)
DeletionProtection (boolean)
DatabaseName (string)
StorageEncrypted (boolean)
docdb/delete_dbclusterDeletes 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.DBClusterIdentifier (string) required
SkipFinalSnapshot (boolean)
FinalDBSnapshotIdentifier (string)
docdb/delete_dbcluster_parameter_groupDeletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.DBClusterParameterGroupName (string) required
docdb/delete_dbcluster_snapshotDeletes 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.DBClusterSnapshotIdentifier (string) required
docdb/delete_dbinstanceDeletes a previously provisioned instance.DBInstanceIdentifier (string) required
docdb/delete_dbsubnet_groupDeletes a subnet group. The specified database subnet group must not be associated with any DB instances.DBSubnetGroupName (string) required
docdb/delete_event_subscriptionDeletes an Amazon DocumentDB event notification subscription.SubscriptionName (string) required
docdb/delete_global_clusterDeletes 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.GlobalClusterIdentifier (string) required
docdb/describe_certificatesReturns a list of certificate authority CA certificates provided by Amazon DocumentDB for this Amazon Web Services account.CertificateIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
docdb/describe_dbcluster_parameter_groupsReturns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.DBClusterParameterGroupName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
docdb/describe_dbcluster_parametersReturns the detailed parameter list for a particular cluster parameter group.DBClusterParameterGroupName (string) required
Source (string)
Filters (array)
MaxRecords (integer)
Marker (string)
docdb/describe_dbclustersReturns 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.DBClusterIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
docdb/describe_dbcluster_snapshot_attributesReturns 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 ADBClusterSnapshotIdentifier (string) required
docdb/describe_dbcluster_snapshotsReturns information about cluster snapshots. This API operation supports pagination.DBClusterIdentifier (string)
DBClusterSnapshotIdentifier (string)
SnapshotType (string)
Filters (array)
MaxRecords (integer)
Marker (string)
IncludeShared (boolean)
IncludePublic (boolean)
docdb/describe_dbengine_versionsReturns a list of the available engines.Engine (string)
EngineVersion (string)
DBParameterGroupFamily (string)
Filters (array)
MaxRecords (integer)
Marker (string)
DefaultOnly (boolean)
ListSupportedCharacterSets (boolean)
ListSupportedTimezones (boolean)
docdb/describe_dbinstancesReturns information about provisioned Amazon DocumentDB instances. This API supports pagination.DBInstanceIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
docdb/describe_dbsubnet_groupsReturns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.DBSubnetGroupName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
docdb/describe_engine_default_cluster_parametersReturns the default engine and system parameter information for the cluster database engine.DBParameterGroupFamily (string) required
Filters (array)
MaxRecords (integer)
Marker (string)
docdb/describe_event_categoriesDisplays a list of categories for all event source types, or, if specified, for a specified source type.SourceType (string)
Filters (array)
docdb/describe_eventsReturns 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.SourceIdentifier (string)
SourceType (string)
StartTime (string)
EndTime (string)
Duration (integer)
EventCategories (array)
Filters (array)
MaxRecords (integer)
Marker (string)
docdb/describe_event_subscriptionsLists 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.SubscriptionName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
docdb/describe_global_clustersReturns information about Amazon DocumentDB global clusters. This API supports pagination. This action only applies to Amazon DocumentDB clusters.GlobalClusterIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
docdb/describe_orderable_dbinstance_optionsReturns a list of orderable instance options for the specified engine.Engine (string) required
EngineVersion (string)
DBInstanceClass (string)
LicenseModel (string)
Vpc (boolean)
Filters (array)
MaxRecords (integer)
Marker (string)
docdb/describe_pending_maintenance_actionsReturns a list of resources for example, instances that have at least one pending maintenance action.ResourceIdentifier (string)
Filters (array)
Marker (string)
MaxRecords (integer)
docdb/failover_dbclusterForces 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.DBClusterIdentifier (string)
TargetDBInstanceIdentifier (string)
docdb/failover_global_clusterPromotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs. Use this operation to respond to an unplanned event, such as a regional disaster in the primary region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writeGlobalClusterIdentifier (string) required
TargetDbClusterIdentifier (string) required
AllowDataLoss (boolean)
Switchover (boolean)
docdb/list_tags_for_resourceLists all tags on an Amazon DocumentDB resource.ResourceName (string) required
Filters (array)
docdb/modify_dbclusterModifies 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.DBClusterIdentifier (string) required
NewDBClusterIdentifier (string)
ApplyImmediately (boolean)
BackupRetentionPeriod (integer)
DBClusterParameterGroupName (string)
VpcSecurityGroupIds (array)
Port (integer)
MasterUserPassword (string)
PreferredBackupWindow (string)
PreferredMaintenanceWindow (string)
CloudwatchLogsExportConfiguration: {
. EnableLogTypes (array)
. DisableLogTypes (array)
} (object)
EngineVersion (string)
AllowMajorVersionUpgrade (boolean)
DeletionProtection (boolean)
StorageType (string)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
} (object)
ManageMasterUserPassword (boolean)
MasterUserSecretKmsKeyId (string)
RotateMasterUserPassword (boolean)
NetworkType (string)
docdb/modify_dbcluster_parameter_groupModifies 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 cluDBClusterParameterGroupName (string) required
Parameters (array) required
docdb/modify_dbcluster_snapshot_attributeAdds 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 ServicesDBClusterSnapshotIdentifier (string) required
AttributeName (string) required
ValuesToAdd (array)
ValuesToRemove (array)
docdb/modify_dbinstanceModifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.DBInstanceIdentifier (string) required
DBInstanceClass (string)
ApplyImmediately (boolean)
PreferredMaintenanceWindow (string)
AutoMinorVersionUpgrade (boolean)
NewDBInstanceIdentifier (string)
CACertificateIdentifier (string)
CopyTagsToSnapshot (boolean)
PromotionTier (integer)
EnablePerformanceInsights (boolean)
PerformanceInsightsKMSKeyId (string)
CertificateRotationRestart (boolean)
docdb/modify_dbsubnet_groupModifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.DBSubnetGroupName (string) required
DBSubnetGroupDescription (string)
SubnetIds (array) required
docdb/modify_event_subscriptionModifies an existing Amazon DocumentDB event notification subscription.SubscriptionName (string) required
SnsTopicArn (string)
SourceType (string)
EventCategories (array)
Enabled (boolean)
docdb/modify_global_clusterModify 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.GlobalClusterIdentifier (string) required
NewGlobalClusterIdentifier (string)
DeletionProtection (boolean)
docdb/reboot_dbinstanceYou 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.DBInstanceIdentifier (string) required
ForceFailover (boolean)
docdb/remove_from_global_clusterDetaches 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.GlobalClusterIdentifier (string) required
DbClusterIdentifier (string) required
docdb/remove_source_identifier_from_subscriptionRemoves a source identifier from an existing Amazon DocumentDB event notification subscription.SubscriptionName (string) required
SourceIdentifier (string) required
docdb/remove_tags_from_resourceRemoves metadata tags from an Amazon DocumentDB resource.ResourceName (string) required
TagKeys (array) required
docdb/reset_dbcluster_parameter_groupModifies 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.DBClusterParameterGroupName (string) required
ResetAllParameters (boolean)
Parameters (array)
docdb/restore_dbcluster_from_snapshotCreates 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.AvailabilityZones (array)
DBClusterIdentifier (string) required
SnapshotIdentifier (string) required
Engine (string) required
EngineVersion (string)
Port (integer)
DBSubnetGroupName (string)
VpcSecurityGroupIds (array)
Tags (array)
KmsKeyId (string)
EnableCloudwatchLogsExports (array)
DeletionProtection (boolean)
DBClusterParameterGroupName (string)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
} (object)
StorageType (string)
NetworkType (string)
docdb/restore_dbcluster_to_point_in_timeRestores 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.DBClusterIdentifier (string) required
RestoreType (string)
SourceDBClusterIdentifier (string) required
RestoreToTime (string)
UseLatestRestorableTime (boolean)
Port (integer)
DBSubnetGroupName (string)
VpcSecurityGroupIds (array)
Tags (array)
KmsKeyId (string)
EnableCloudwatchLogsExports (array)
DeletionProtection (boolean)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
} (object)
StorageType (string)
NetworkType (string)
docdb/start_dbclusterRestarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.DBClusterIdentifier (string) required
docdb/stop_dbclusterStops 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.DBClusterIdentifier (string) required
docdb/switchover_global_clusterSwitches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.GlobalClusterIdentifier (string) required
TargetDbClusterIdentifier (string) required
drs/create_extended_source_serverCreate an extended source server in the target Account based on the source server in staging account.sourceServerArn (string) required
tags (object)
drs/delete_launch_actionDeletes a resource launch action.resourceId (string) required
actionId (string) required
drs/initialize_serviceInitialize Elastic Disaster Recovery.No parameters
drs/list_extensible_source_serversReturns 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.stagingAccountID (string) required
maxResults (integer)
nextToken (string)
drs/list_launch_actionsLists resource launch actions.resourceId (string) required
filters: {
. actionIds (array)
} (object)
maxResults (integer)
nextToken (string)
drs/list_staging_accountsReturns an array of staging accounts for existing extended source servers.maxResults (integer)
nextToken (string)
drs/list_tags_for_resourceList all tags for your Elastic Disaster Recovery resources.resourceArn (string) required
drs/put_launch_actionPuts a resource launch action.resourceId (string) required
actionCode (string) required
order (integer) required
actionId (string) required
optional (boolean) required
active (boolean) required
name (string) required
actionVersion (string) required
category (string) required
parameters (object)
description (string) required
drs/tag_resourceAdds 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.resourceArn (string) required
tags (object) required
drs/untag_resourceDeletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.resourceArn (string) required
tagKeys (array) required
drs/describe_job_log_itemsRetrieves a detailed Job log with pagination.jobID (string) required
maxResults (integer)
nextToken (string)
drs/delete_jobDeletes a single Job by ID.jobID (string) required
drs/describe_jobsReturns 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.filters: {
. jobIDs (array)
. fromDate (string)
. toDate (string)
} (object)
maxResults (integer)
nextToken (string)
drs/create_launch_configuration_templateCreates a new Launch Configuration Template.tags (object)
launchDisposition (string)
targetInstanceTypeRightSizingMethod (string)
copyPrivateIp (boolean)
copyTags (boolean)
licensing: {
. osByol (boolean)
} (object)
exportBucketArn (string)
postLaunchEnabled (boolean)
launchIntoSourceInstance (boolean)
drs/update_launch_configuration_templateUpdates an existing Launch Configuration Template by ID.launchConfigurationTemplateID (string) required
launchDisposition (string)
targetInstanceTypeRightSizingMethod (string)
copyPrivateIp (boolean)
copyTags (boolean)
licensing: {
. osByol (boolean)
} (object)
exportBucketArn (string)
postLaunchEnabled (boolean)
launchIntoSourceInstance (boolean)
drs/delete_launch_configuration_templateDeletes a single Launch Configuration Template by ID.launchConfigurationTemplateID (string) required
drs/describe_launch_configuration_templatesLists all Launch Configuration Templates, filtered by Launch Configuration Template IDslaunchConfigurationTemplateIDs (array)
maxResults (integer)
nextToken (string)
drs/delete_recovery_instanceDeletes 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.recoveryInstanceID (string) required
drs/disconnect_recovery_instanceDisconnect 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 therecoveryInstanceID (string) required
drs/get_failback_replication_configurationLists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.recoveryInstanceID (string) required
drs/reverse_replicationStart replication to origin / target region - applies only to protected instances that originated in EC2. For recovery instances on target region - starts replication back to origin region. For failback instances on origin region - starts replication to target region to re-protect them.recoveryInstanceID (string) required
drs/stop_failbackStops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.recoveryInstanceID (string) required
drs/update_failback_replication_configurationAllows you to update the failback replication configuration of a Recovery Instance by ID.recoveryInstanceID (string) required
name (string)
bandwidthThrottling (integer)
usePrivateIP (boolean)
drs/start_failback_launchInitiates 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.recoveryInstanceIDs (array) required
tags (object)
drs/terminate_recovery_instancesInitiates 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.recoveryInstanceIDs (array) required
drs/describe_recovery_instancesLists all Recovery Instances or multiple Recovery Instances by ID.filters: {
. recoveryInstanceIDs (array)
. sourceServerIDs (array)
} (object)
maxResults (integer)
nextToken (string)
drs/create_replication_configuration_templateCreates a new ReplicationConfigurationTemplate.stagingAreaSubnetId (string) required
associateDefaultSecurityGroup (boolean) required
replicationServersSecurityGroupsIDs (array) required
replicationServerInstanceType (string) required
useDedicatedReplicationServer (boolean) required
defaultLargeStagingDiskType (string) required
ebsEncryption (string) required
ebsEncryptionKeyArn (string)
bandwidthThrottling (integer) required
dataPlaneRouting (string) required
createPublicIP (boolean) required
stagingAreaTags (object) required
pitPolicy (array) required
tags (object)
autoReplicateNewDisks (boolean)
drs/update_replication_configuration_templateUpdates a ReplicationConfigurationTemplate by ID.replicationConfigurationTemplateID (string) required
arn (string)
stagingAreaSubnetId (string)
associateDefaultSecurityGroup (boolean)
replicationServersSecurityGroupsIDs (array)
replicationServerInstanceType (string)
useDedicatedReplicationServer (boolean)
defaultLargeStagingDiskType (string)
ebsEncryption (string)
ebsEncryptionKeyArn (string)
bandwidthThrottling (integer)
dataPlaneRouting (string)
createPublicIP (boolean)
stagingAreaTags (object)
pitPolicy (array)
autoReplicateNewDisks (boolean)
drs/delete_replication_configuration_templateDeletes a single Replication Configuration Template by IDreplicationConfigurationTemplateID (string) required
drs/describe_replication_configuration_templatesLists all ReplicationConfigurationTemplates, filtered by Source Server IDs.replicationConfigurationTemplateIDs (array)
maxResults (integer)
nextToken (string)
drs/associate_source_network_stackAssociate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously deployed CloudFormation stacks.sourceNetworkID (string) required
cfnStackName (string) required
drs/export_source_network_cfn_templateExport the Source Network CloudFormation template to an S3 bucket.sourceNetworkID (string) required
drs/start_source_network_replicationStarts replication for a Source Network. This action would make the Source Network protected.sourceNetworkID (string) required
drs/stop_source_network_replicationStops replication for a Source Network. This action would make the Source Network unprotected.sourceNetworkID (string) required
drs/start_source_network_recoveryDeploy VPC for the specified Source Network and modify launch templates to use this network. The VPC will be deployed using a dedicated CloudFormation stack.sourceNetworks (array) required
deployAsNew (boolean)
tags (object)
drs/create_source_networkCreate a new Source Network resource for a provided VPC ID.vpcID (string) required
originAccountID (string) required
originRegion (string) required
tags (object)
drs/delete_source_networkDelete Source Network resource.sourceNetworkID (string) required
drs/describe_source_networksLists all Source Networks or multiple Source Networks filtered by ID.filters: {
. sourceNetworkIDs (array)
. originAccountID (string)
. originRegion (string)
} (object)
maxResults (integer)
nextToken (string)
drs/describe_recovery_snapshotsLists all Recovery Snapshots for a single Source Server.sourceServerID (string) required
filters: {
. fromDateTime (string)
. toDateTime (string)
} (object)
order (string)
maxResults (integer)
nextToken (string)
drs/disconnect_source_serverDisconnects 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 itsesourceServerID (string) required
drs/get_launch_configurationGets a LaunchConfiguration, filtered by Source Server IDs.sourceServerID (string) required
drs/get_replication_configurationGets a ReplicationConfiguration, filtered by Source Server ID.sourceServerID (string) required
drs/retry_data_replicationWARNING: RetryDataReplication is deprecated. 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.sourceServerID (string) required
drs/start_replicationStarts replication for a stopped Source Server. This action would make the Source Server protected again and restart billing for it.sourceServerID (string) required
drs/stop_replicationStops replication for a Source Server. This action would make the Source Server unprotected, delete its existing snapshots and stop billing for it.sourceServerID (string) required
drs/update_launch_configurationUpdates a LaunchConfiguration by Source Server ID.sourceServerID (string) required
name (string)
launchDisposition (string)
targetInstanceTypeRightSizingMethod (string)
copyPrivateIp (boolean)
copyTags (boolean)
licensing: {
. osByol (boolean)
} (object)
postLaunchEnabled (boolean)
launchIntoInstanceProperties: {
. launchIntoEC2InstanceID (string)
} (object)
drs/update_replication_configurationAllows you to update a ReplicationConfiguration by Source Server ID.sourceServerID (string) required
name (string)
stagingAreaSubnetId (string)
associateDefaultSecurityGroup (boolean)
replicationServersSecurityGroupsIDs (array)
replicationServerInstanceType (string)
useDedicatedReplicationServer (boolean)
defaultLargeStagingDiskType (string)
replicatedDisks (array)
ebsEncryption (string)
ebsEncryptionKeyArn (string)
bandwidthThrottling (integer)
dataPlaneRouting (string)
createPublicIP (boolean)
stagingAreaTags (object)
pitPolicy (array)
autoReplicateNewDisks (boolean)
drs/start_recoveryLaunches 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.sourceServers (array) required
isDrill (boolean)
tags (object)
drs/delete_source_serverDeletes a single Source Server by ID. The Source Server must be disconnected first.sourceServerID (string) required
drs/describe_source_serversLists all Source Servers or multiple Source Servers filtered by ID.filters: {
. sourceServerIDs (array)
. hardwareId (string)
. stagingAccountIDs (array)
} (object)
maxResults (integer)
nextToken (string)
dsql/list_tags_for_resourceLists all of the tags for a resource.resourceArn (string) required
dsql/tag_resourceTags a resource with a map of key and value pairs.resourceArn (string) required
tags (object) required
dsql/untag_resourceRemoves a tag from a resource.resourceArn (string) required
tagKeys (array) required
dsql/delete_cluster_policyDeletes the resource-based policy attached to a cluster. This removes all access permissions defined by the policy, reverting to default access controls.identifier (string) required
expectedPolicyVersion (string)
clientToken (string)
dsql/get_cluster_policyRetrieves the resource-based policy document attached to a cluster. This policy defines the access permissions and conditions for the cluster.identifier (string) required
dsql/get_vpc_endpoint_service_nameRetrieves the VPC endpoint service name.identifier (string) required
dsql/put_cluster_policyAttaches a resource-based policy to a cluster. This policy defines access permissions and conditions for the cluster, allowing you to control which principals can perform actions on the cluster.identifier (string) required
policy (string) required
bypassPolicyLockoutSafetyCheck (boolean)
expectedPolicyVersion (string)
clientToken (string)
dsql/create_clusterThe CreateCluster API allows you to create both single-Region clusters and multi-Region clusters. With the addition of the multiRegionProperties parameter, you can create a cluster with witness Region support and establish peer relationships with clusters in other Regions during creation. Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters, as detailed in the Required permissions section below. Required permissions dsql:CreateClusterdeletionProtectionEnabled (boolean)
kmsEncryptionKey (string)
tags (object)
clientToken (string)
multiRegionProperties: {
. witnessRegion (string)
. clusters (array)
} (object)
policy (string)
bypassPolicyLockoutSafetyCheck (boolean)
dsql/get_clusterRetrieves information about a cluster.identifier (string) required
dsql/update_clusterThe UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions. Note that updating multi-Region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section. Required permissions dsql:UpdateCluster Permission to update a DSQL cluster. Resoidentifier (string) required
deletionProtectionEnabled (boolean)
kmsEncryptionKey (string)
clientToken (string)
multiRegionProperties: {
. witnessRegion (string)
. clusters (array)
} (object)
dsql/delete_clusterDeletes a cluster in Amazon Aurora DSQL.identifier (string) required
clientToken (string)
dsql/list_clustersRetrieves information about a list of clusters.maxResults (integer)
nextToken (string)
dynamodb_streams/describe_streamReturns 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 StartingSequenceNumbeStreamArn (string) required
Limit (integer)
ExclusiveStartShardId (string)
ShardFilter: {
. Type (string)
. ShardId (string)
} (object)
dynamodb_streams/get_recordsRetrieves 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 ofShardIterator (string) required
Limit (integer)
dynamodb_streams/get_shard_iteratorReturns 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.StreamArn (string) required
ShardId (string) required
ShardIteratorType (string) required
SequenceNumber (string)
dynamodb_streams/list_streamsReturns 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.TableName (string)
Limit (integer)
ExclusiveStartStreamArn (string)
dynamodb/batch_execute_statementThis 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. For more information, see Running batch operations with PartiQL for DynamoDB . The entire batch must consist of either read statements or write statements, you cannot mix both in one batch. A HTTP 200 responseStatements (array) required
ReturnConsumedCapacity (string)
dynamodb/batch_get_itemThe 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, more than 1MB per partition is requested, or an internal processing failure occurs. If a partial result is returned, the operation returns aRequestItems (object) required
ReturnConsumedCapacity (string)
dynamodb/batch_write_itemThe 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. BatchWriteItRequestItems (object) required
ReturnConsumedCapacity (string)
ReturnItemCollectionMetrics (string)
dynamodb/create_backupCreates 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 caTableName (string) required
BackupName (string) required
dynamodb/create_global_tableCreates 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 documentation is for version 2017.11.29 Legacy of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 Current when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 Legacy. To detGlobalTableName (string) required
ReplicationGroup (array) required
dynamodb/create_tableThe 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 operationsAttributeDefinitions (array)
TableName (string) required
KeySchema (array)
LocalSecondaryIndexes (array)
GlobalSecondaryIndexes (array)
BillingMode (string)
ProvisionedThroughput: {
. ReadCapacityUnits (integer)
. WriteCapacityUnits (integer)
} (object)
StreamSpecification: {
. StreamEnabled (boolean)
. StreamViewType (string)
} (object)
SSESpecification: {
. Enabled (boolean)
. SSEType (string)
. KMSMasterKeyId (string)
} (object)
Tags (array)
TableClass (string)
DeletionProtectionEnabled (boolean)
WarmThroughput: {
. ReadUnitsPerSecond (integer)
. WriteUnitsPerSecond (integer)
} (object)
ResourcePolicy (string)
OnDemandThroughput: {
. MaxReadRequestUnits (integer)
. MaxWriteRequestUnits (integer)
} (object)
GlobalTableSourceArn (string)
GlobalTableSettingsReplicationMode (string)
dynamodb/delete_backupDeletes an existing backup of a table. You can call DeleteBackup at a maximum rate of 10 times per second.BackupArn (string) required
dynamodb/delete_itemDeletes 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 deletesTableName (string) required
Key (object) required
Expected (object)
ConditionalOperator (string)
ReturnValues (string)
ReturnConsumedCapacity (string)
ReturnItemCollectionMetrics (string)
ConditionExpression (string)
ExpressionAttributeNames (object)
ExpressionAttributeValues (object)
ReturnValuesOnConditionCheckFailure (string)
dynamodb/delete_resource_policyDeletes the resource-based policy attached to the resource, which can be a table or stream. DeleteResourcePolicy is an idempotent operation; running it multiple times on the same resource doesn't result in an error response, unless you specify an ExpectedRevisionId, which will then return a PolicyNotFoundException. To make sure that you don't inadvertently lock yourself out of your own resources, the root principal in your Amazon Web Services account can perform DeleteResourcePolicy requests, evResourceArn (string) required
ExpectedRevisionId (string)
dynamodb/delete_tableThe 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 continueTableName (string) required
dynamodb/describe_backupDescribes an existing backup of a table. You can call DescribeBackup at a maximum rate of 10 times per second.BackupArn (string) required
dynamodb/describe_continuous_backupsChecks 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 yoTableName (string) required
dynamodb/describe_contributor_insightsReturns information about contributor insights for a given table or global secondary index.TableName (string) required
IndexName (string)
dynamodb/describe_endpointsReturns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy.No parameters
dynamodb/describe_exportDescribes an existing table export.ExportArn (string) required
dynamodb/describe_global_tableReturns information about the specified global table. This documentation is for version 2017.11.29 Legacy of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 Current when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 Legacy. To determine which version you're using, see Determining the global table version you are using. To update existing global tables fromGlobalTableName (string) required
dynamodb/describe_global_table_settingsDescribes Region-specific settings for a global table. This documentation is for version 2017.11.29 Legacy of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 Current when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 Legacy. To determine which version you're using, see Determining the global table version you are using. To update existing global tables fromGlobalTableName (string) required
dynamodb/describe_importRepresents the properties of the import.ImportArn (string) required
dynamodb/describe_kinesis_streaming_destinationReturns information about the status of Kinesis streaming.TableName (string) required
dynamodb/describe_limitsReturns 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, sNo parameters
dynamodb/describe_tableReturns 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.TableName (string) required
dynamodb/describe_table_replica_auto_scalingDescribes auto scaling settings across replicas of the global table at once.TableName (string) required
dynamodb/describe_time_to_liveGives a description of the Time to Live TTL status on the specified table.TableName (string) required
dynamodb/disable_kinesis_streaming_destinationStops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.TableName (string) required
StreamArn (string) required
EnableKinesisStreamingConfiguration: {
. ApproximateCreationDateTimePrecision (string)
} (object)
dynamodb/enable_kinesis_streaming_destinationStarts 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.TableName (string) required
StreamArn (string) required
EnableKinesisStreamingConfiguration: {
. ApproximateCreationDateTimePrecision (string)
} (object)
dynamodb/execute_statementThis 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 cStatement (string) required
Parameters (array)
ConsistentRead (boolean)
NextToken (string)
ReturnConsumedCapacity (string)
Limit (integer)
ReturnValuesOnConditionCheckFailure (string)
dynamodb/execute_transactionThis 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.TransactStatements (array) required
ClientRequestToken (string)
ReturnConsumedCapacity (string)
dynamodb/export_table_to_point_in_timeExports 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.TableArn (string) required
ExportTime (string)
ClientToken (string)
S3Bucket (string) required
S3BucketOwner (string)
S3Prefix (string)
S3SseAlgorithm (string)
S3SseKmsKeyId (string)
ExportFormat (string)
ExportType (string)
IncrementalExportSpecification: {
. ExportFromTime (string)
. ExportToTime (string)
. ExportViewType (string)
} (object)
dynamodb/get_itemThe 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.TableName (string) required
Key (object) required
AttributesToGet (array)
ConsistentRead (boolean)
ReturnConsumedCapacity (string)
ProjectionExpression (string)
ExpressionAttributeNames (object)
dynamodb/get_resource_policyReturns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format. GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request: If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException. If you issue a GetResourcePolicyrequest immediately afterResourceArn (string) required
dynamodb/import_tableImports table data from an S3 bucket.ClientToken (string)
S3BucketSource: {
. S3BucketOwner (string)
. S3Bucket (string)
. S3KeyPrefix (string)
} (object) required
InputFormat (string) required
InputFormatOptions: {
. Csv (object)
} (object)
InputCompressionType (string)
TableCreationParameters: {
. TableName (string)
. AttributeDefinitions (array)
. KeySchema (array)
. BillingMode (string)
. ProvisionedThroughput (object)
. OnDemandThroughput (object)
. SSESpecification (object)
. GlobalSecondaryIndexes (array)
} (object) required
dynamodb/list_backupsList DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. To list these 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 wasTableName (string)
Limit (integer)
TimeRangeLowerBound (string)
TimeRangeUpperBound (string)
ExclusiveStartBackupArn (string)
BackupType (string)
dynamodb/list_contributor_insightsReturns a list of ContributorInsightsSummary for a table and all its global secondary indexes.TableName (string)
NextToken (string)
MaxResults (integer)
dynamodb/list_exportsLists completed exports within the past 90 days.TableArn (string)
MaxResults (integer)
NextToken (string)
dynamodb/list_global_tablesLists all global tables that have a replica in the specified Region. This documentation is for version 2017.11.29 Legacy of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 Current when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 Legacy. To determine which version you're using, see Determining the global table version you are using. To update existing globExclusiveStartGlobalTableName (string)
Limit (integer)
RegionName (string)
dynamodb/list_importsLists completed imports within the past 90 days.TableArn (string)
PageSize (integer)
NextToken (string)
dynamodb/list_tablesReturns 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.ExclusiveStartTableName (string)
Limit (integer)
dynamodb/list_tags_of_resourceList 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.ResourceArn (string) required
NextToken (string)
dynamodb/put_itemCreates 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 anTableName (string) required
Item (object) required
Expected (object)
ReturnValues (string)
ReturnConsumedCapacity (string)
ReturnItemCollectionMetrics (string)
ConditionalOperator (string)
ConditionExpression (string)
ExpressionAttributeNames (object)
ExpressionAttributeValues (object)
ReturnValuesOnConditionCheckFailure (string)
dynamodb/put_resource_policyAttaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is eventually consistent . PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId that doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned. PutResourcResourceArn (string) required
Policy (string) required
ExpectedRevisionId (string)
ConfirmRemoveSelfResourceAccess (boolean)
dynamodb/queryYou 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 QTableName (string) required
IndexName (string)
Select (string)
AttributesToGet (array)
Limit (integer)
ConsistentRead (boolean)
KeyConditions (object)
QueryFilter (object)
ConditionalOperator (string)
ScanIndexForward (boolean)
ExclusiveStartKey (object)
ReturnConsumedCapacity (string)
ProjectionExpression (string)
FilterExpression (string)
KeyConditionExpression (string)
ExpressionAttributeNames (object)
ExpressionAttributeValues (object)
dynamodb/restore_table_from_backupCreates a new table from an existing backup. Any number of users can execute up to 50 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 settingsTargetTableName (string) required
BackupArn (string) required
BillingModeOverride (string)
GlobalSecondaryIndexOverride (array)
LocalSecondaryIndexOverride (array)
ProvisionedThroughputOverride: {
. ReadCapacityUnits (integer)
. WriteCapacityUnits (integer)
} (object)
OnDemandThroughputOverride: {
. MaxReadRequestUnits (integer)
. MaxWriteRequestUnits (integer)
} (object)
SSESpecificationOverride: {
. Enabled (boolean)
. SSEType (string)
. KMSMasterKeyId (string)
} (object)
dynamodb/restore_table_to_point_in_timeRestores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days. Any number of users can execute up to 50 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:hourSourceTableArn (string)
SourceTableName (string)
TargetTableName (string) required
UseLatestRestorableTime (boolean)
RestoreDateTime (string)
BillingModeOverride (string)
GlobalSecondaryIndexOverride (array)
LocalSecondaryIndexOverride (array)
ProvisionedThroughputOverride: {
. ReadCapacityUnits (integer)
. WriteCapacityUnits (integer)
} (object)
OnDemandThroughputOverride: {
. MaxReadRequestUnits (integer)
. MaxWriteRequestUnits (integer)
} (object)
SSESpecificationOverride: {
. Enabled (boolean)
. SSEType (string)
. KMSMasterKeyId (string)
} (object)
dynamodb/scanThe 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 size of scanned items exceeds the maximum dataset size limit of 1 MB, the scan completes and results are returned to the user. The LastEvaluatedKey value is also returned and the requestor can use the LastEvaluatedKey to continue the scan in a subsequent operation. Each scan responTableName (string) required
IndexName (string)
AttributesToGet (array)
Limit (integer)
Select (string)
ScanFilter (object)
ConditionalOperator (string)
ExclusiveStartKey (object)
ReturnConsumedCapacity (string)
TotalSegments (integer)
Segment (integer)
ProjectionExpression (string)
FilterExpression (string)
ExpressionAttributeNames (object)
ExpressionAttributeValues (object)
ConsistentRead (boolean)
dynamodb/tag_resourceAssociate 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. TagResource is an asynchronous operation. If you issue a ListTagsOfResource request immediately after a TagResource request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because ListTagsOfRResourceArn (string) required
Tags (array) required
dynamodb/transact_get_itemsTransactGetItems 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 tTransactItems (array) required
ReturnConsumedCapacity (string)
dynamodb/transact_write_itemsTransactWriteItems 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 defineTransactItems (array) required
ReturnConsumedCapacity (string)
ReturnItemCollectionMetrics (string)
ClientRequestToken (string)
dynamodb/untag_resourceRemoves the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to five times per second, per account. UntagResource is an asynchronous operation. If you issue a ListTagsOfResource request immediately after an UntagResource request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because ListTagsOfResource uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment.ResourceArn (string) required
TagKeys (array) required
dynamodb/update_continuous_backupsUpdateContinuousBackups 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.TableName (string) required
PointInTimeRecoverySpecification: {
. PointInTimeRecoveryEnabled (boolean)
. RecoveryPeriodInDays (integer)
} (object) required
dynamodb/update_contributor_insightsUpdates 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 InsightTableName (string) required
IndexName (string)
ContributorInsightsAction (string) required
ContributorInsightsMode (string)
dynamodb/update_global_tableAdds 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. This documentation is for version 2017.11.29 Legacy of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 CurGlobalTableName (string) required
ReplicaUpdates (array) required
dynamodb/update_global_table_settingsUpdates settings for a global table. This documentation is for version 2017.11.29 Legacy of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 Current when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 Legacy. To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.2GlobalTableName (string) required
GlobalTableBillingMode (string)
GlobalTableProvisionedWriteCapacityUnits (integer)
GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate: {
. MinimumUnits (integer)
. MaximumUnits (integer)
. AutoScalingDisabled (boolean)
. AutoScalingRoleArn (string)
. ScalingPolicyUpdate (object)
} (object)
GlobalTableGlobalSecondaryIndexSettingsUpdate (array)
ReplicaSettingsUpdate (array)
dynamodb/update_itemEdits 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.TableName (string) required
Key (object) required
AttributeUpdates (object)
Expected (object)
ConditionalOperator (string)
ReturnValues (string)
ReturnConsumedCapacity (string)
ReturnItemCollectionMetrics (string)
UpdateExpression (string)
ConditionExpression (string)
ExpressionAttributeNames (object)
ExpressionAttributeValues (object)
ReturnValuesOnConditionCheckFailure (string)
dynamodb/update_kinesis_streaming_destinationThe command to update the Kinesis stream destination.TableName (string) required
StreamArn (string) required
UpdateKinesisStreamingConfiguration: {
. ApproximateCreationDateTimePrecision (string)
} (object)
dynamodb/update_tableModifies 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's executing, the tableAttributeDefinitions (array)
TableName (string) required
BillingMode (string)
ProvisionedThroughput: {
. ReadCapacityUnits (integer)
. WriteCapacityUnits (integer)
} (object)
GlobalSecondaryIndexUpdates (array)
StreamSpecification: {
. StreamEnabled (boolean)
. StreamViewType (string)
} (object)
SSESpecification: {
. Enabled (boolean)
. SSEType (string)
. KMSMasterKeyId (string)
} (object)
ReplicaUpdates (array)
TableClass (string)
DeletionProtectionEnabled (boolean)
MultiRegionConsistency (string)
GlobalTableWitnessUpdates (array)
OnDemandThroughput: {
. MaxReadRequestUnits (integer)
. MaxWriteRequestUnits (integer)
} (object)
WarmThroughput: {
. ReadUnitsPerSecond (integer)
. WriteUnitsPerSecond (integer)
} (object)
dynamodb/update_table_replica_auto_scalingUpdates auto scaling settings on your global tables at once.GlobalSecondaryIndexUpdates (array)
TableName (string) required
ProvisionedWriteCapacityAutoScalingUpdate: {
. MinimumUnits (integer)
. MaximumUnits (integer)
. AutoScalingDisabled (boolean)
. AutoScalingRoleArn (string)
. ScalingPolicyUpdate (object)
} (object)
ReplicaUpdates (array)
dynamodb/update_time_to_liveThe 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 attributeTableName (string) required
TimeToLiveSpecification: {
. Enabled (boolean)
. AttributeName (string)
} (object) required
ebs/complete_snapshotSeals 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. You should always retry requests that receive server 5xx error responses, and ThrottlingException and RequestThrottledException client error responses. For more information see Error retries in the Amazon Elastic Compute Cloud User Guide.SnapshotId (string) required
ChangedBlocksCount (integer) required
Checksum (string)
ChecksumAlgorithm (string)
ChecksumAggregationMethod (string)
ebs/get_snapshot_blockReturns the data in a block in an Amazon Elastic Block Store snapshot. You should always retry requests that receive server 5xx error responses, and ThrottlingException and RequestThrottledException client error responses. For more information see Error retries in the Amazon Elastic Compute Cloud User Guide.SnapshotId (string) required
BlockIndex (integer) required
BlockToken (string) required
ebs/list_changed_blocksReturns information about the blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage. You should always retry requests that receive server 5xx error responses, and ThrottlingException and RequestThrottledException client error responses. For more information see Error retries in the Amazon Elastic Compute Cloud User Guide.FirstSnapshotId (string)
SecondSnapshotId (string) required
NextToken (string)
MaxResults (integer)
StartingBlockIndex (integer)
ebs/list_snapshot_blocksReturns information about the blocks in an Amazon Elastic Block Store snapshot. You should always retry requests that receive server 5xx error responses, and ThrottlingException and RequestThrottledException client error responses. For more information see Error retries in the Amazon Elastic Compute Cloud User Guide.SnapshotId (string) required
NextToken (string)
MaxResults (integer)
StartingBlockIndex (integer)
ebs/put_snapshot_blockWrites 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. You should always retry requests that receive server 5xx error responses, and ThrottlingException and RequestThrottledException client error responses. For more information see Error retries in the Amazon Elastic Compute Cloud User Guide.SnapshotId (string) required
BlockIndex (integer) required
BlockData (string) required
DataLength (integer) required
Progress (integer)
Checksum (string) required
ChecksumAlgorithm (string) required
ebs/start_snapshotCreates 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. You should always retry requests that receive server 5xx error responses, and ThrottlingException and RequestThrottledException client error responses. For more information see Error retries in the Amazon Elastic Compute Cloud User Guide.VolumeSize (integer) required
ParentSnapshotId (string)
Tags (array)
Description (string)
ClientToken (string)
Encrypted (boolean)
KmsKeyArn (string)
Timeout (integer)
ec2_instance_connect/send_serial_console_sshpublic_keyPushes 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.InstanceId (string) required
SerialPort (integer)
SSHPublicKey (string) required
ec2_instance_connect/send_sshpublic_keyPushes 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.InstanceId (string) required
InstanceOSUser (string) required
SSHPublicKey (string) required
AvailabilityZone (string)
ec2/accept_address_transferAccepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon VPC User Guide.Address (string) required
TagSpecifications (array)
DryRun (boolean)
ec2/accept_capacity_reservation_billing_ownershipAccepts a request to assign billing of the available capacity of a shared Capacity Reservation to your account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.DryRun (boolean)
CapacityReservationId (string) required
ec2/accept_reserved_instances_exchange_quoteAccepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.DryRun (boolean)
ReservedInstanceIds (array) required
TargetConfigurations (array)
ec2/accept_transit_gateway_multicast_domain_associationsAccepts a request to associate subnets with a transit gateway multicast domain.TransitGatewayMulticastDomainId (string)
TransitGatewayAttachmentId (string)
SubnetIds (array)
DryRun (boolean)
ec2/accept_transit_gateway_peering_attachmentAccepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.TransitGatewayAttachmentId (string) required
DryRun (boolean)
ec2/accept_transit_gateway_vpc_attachmentAccepts 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.TransitGatewayAttachmentId (string) required
DryRun (boolean)
ec2/accept_vpc_endpoint_connectionsAccepts connection requests to your VPC endpoint service.DryRun (boolean)
ServiceId (string) required
VpcEndpointIds (array) required
ec2/accept_vpc_peering_connectionAccept 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.DryRun (boolean)
VpcPeeringConnectionId (string) required
ec2/advertise_byoip_cidrAdvertises 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 BYOIPCidr (string) required
Asn (string)
DryRun (boolean)
NetworkBorderGroup (string)
ec2/allocate_addressAllocates 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 one of the following address pools: Amazon's pool of IPv4 addresses Public IPv4 address range that you own and bring to your Amazon Web ServiDomain (string)
Address (string)
PublicIpv4Pool (string)
NetworkBorderGroup (string)
CustomerOwnedIpv4Pool (string)
TagSpecifications (array)
IpamPoolId (string)
DryRun (boolean)
ec2/allocate_hostsAllocates 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.InstanceFamily (string)
TagSpecifications (array)
HostRecovery (string)
OutpostArn (string)
HostMaintenance (string)
AssetIds (array)
AvailabilityZoneId (string)
AutoPlacement (string)
ClientToken (string)
InstanceType (string)
Quantity (integer)
AvailabilityZone (string)
ec2/allocate_ipam_pool_cidrAllocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide. This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.DryRun (boolean)
IpamPoolId (string) required
Cidr (string)
NetmaskLength (integer)
ClientToken (string)
Description (string)
PreviewNextCidr (boolean)
AllowedCidrs (array)
DisallowedCidrs (array)
ec2/apply_security_groups_to_client_vpn_target_networkApplies 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.ClientVpnEndpointId (string) required
VpcId (string) required
SecurityGroupIds (array) required
DryRun (boolean)
ec2/assign_ipv6addressesAssigns the specified IPv6 addresses to the specified network interface. You can specify specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from 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 by instance type. You must specify either the IPv6 addresses or the IPv6 address count in the request. You can optionally use Prefix DelegationIpv6PrefixCount (integer)
Ipv6Prefixes (array)
NetworkInterfaceId (string) required
Ipv6Addresses (array)
Ipv6AddressCount (integer)
ec2/assign_private_ip_addressesAssigns the specified secondary private IP addresses to the specified network interface. You can specify specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned from the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 User Guide. When you move a secondary private IP addIpv4Prefixes (array)
Ipv4PrefixCount (integer)
NetworkInterfaceId (string) required
PrivateIpAddresses (array)
SecondaryPrivateIpAddressCount (integer)
AllowReassignment (boolean)
ec2/assign_private_nat_gateway_addressAssigns private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.NatGatewayId (string) required
PrivateIpAddresses (array)
PrivateIpAddressCount (integer)
DryRun (boolean)
ec2/associate_addressAssociates 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. 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 aAllocationId (string)
InstanceId (string)
PublicIp (string)
DryRun (boolean)
NetworkInterfaceId (string)
PrivateIpAddress (string)
AllowReassociation (boolean)
ec2/associate_capacity_reservation_billing_ownerInitiates a request to assign billing of the unused capacity of a shared Capacity Reservation to a consumer account that is consolidated under the same Amazon Web Services organizations payer account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.DryRun (boolean)
CapacityReservationId (string) required
UnusedReservationBillingOwnerId (string) required
ec2/associate_client_vpn_target_networkAssociates 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 sClientVpnEndpointId (string) required
SubnetId (string) required
ClientToken (string)
DryRun (boolean)
ec2/associate_dhcp_optionsAssociates 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 sDhcpOptionsId (string) required
VpcId (string) required
DryRun (boolean)
ec2/associate_enclave_certificate_iam_roleAssociates 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 associatedCertificateArn (string) required
RoleArn (string) required
DryRun (boolean)
ec2/associate_iam_instance_profileAssociates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.IamInstanceProfile: {
. Arn (string)
. Name (string)
} (object) required
InstanceId (string) required
ec2/associate_instance_event_windowAssociates 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.DryRun (boolean)
InstanceEventWindowId (string) required
AssociationTarget: {
. InstanceIds (array)
. InstanceTags (array)
. DedicatedHostIds (array)
} (object) required
ec2/associate_ipam_byoasnAssociates your Autonomous System Number ASN with a BYOIP CIDR that you own in the same Amazon Web Services Region. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide. After the association succeeds, the ASN is eligible for advertisement. You can view the association with DescribeByoipCidrs. You can advertise the CIDR with AdvertiseByoipCidr.DryRun (boolean)
Asn (string) required
Cidr (string) required
ec2/associate_ipam_resource_discoveryAssociates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.DryRun (boolean)
IpamId (string) required
IpamResourceDiscoveryId (string) required
TagSpecifications (array)
ClientToken (string)
ec2/associate_nat_gateway_addressAssociates Elastic IP addresses EIPs and private IPv4 addresses with a public NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide. By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon VPC User Guide. When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the ENatGatewayId (string) required
AllocationIds (array) required
PrivateIpAddresses (array)
DryRun (boolean)
AvailabilityZone (string)
AvailabilityZoneId (string)
ec2/associate_route_serverAssociates a route server with a VPC to enable dynamic route updates. A route server association is the connection established between a route server and a VPC. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.RouteServerId (string) required
VpcId (string) required
DryRun (boolean)
ec2/associate_route_tableAssociates 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 VPC User Guide.GatewayId (string)
PublicIpv4Pool (string)
DryRun (boolean)
SubnetId (string)
RouteTableId (string) required
ec2/associate_security_group_vpcAssociates a security group with another VPC in the same Region. This enables you to use the same security group with network interfaces and instances in the specified VPC. The VPC you want to associate the security group with must be in the same Region. You can associate the security group with another VPC if your account owns the VPC or if the VPC was shared with you. You must own the security group. You cannot use this feature with default security groups. You cannot use this feature with theGroupId (string) required
VpcId (string) required
DryRun (boolean)
ec2/associate_subnet_cidr_blockAssociates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet.Ipv6IpamPoolId (string)
Ipv6NetmaskLength (integer)
SubnetId (string) required
Ipv6CidrBlock (string)
ec2/associate_transit_gateway_multicast_domainAssociates 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.TransitGatewayMulticastDomainId (string) required
TransitGatewayAttachmentId (string) required
SubnetIds (array) required
DryRun (boolean)
ec2/associate_transit_gateway_policy_tableAssociates the specified transit gateway attachment with a transit gateway policy table.TransitGatewayPolicyTableId (string) required
TransitGatewayAttachmentId (string) required
DryRun (boolean)
ec2/associate_transit_gateway_route_tableAssociates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.TransitGatewayRouteTableId (string) required
TransitGatewayAttachmentId (string) required
DryRun (boolean)
ec2/associate_trunk_interfaceAssociates a branch network interface with a trunk network interface. Before you create the association, use CreateNetworkInterface command and set the 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.BranchInterfaceId (string) required
TrunkInterfaceId (string) required
VlanId (integer)
GreKey (integer)
ClientToken (string)
DryRun (boolean)
ec2/associate_vpc_cidr_blockAssociates 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. 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 IP addressing for your VPCs and subnets iCidrBlock (string)
Ipv6CidrBlockNetworkBorderGroup (string)
Ipv6Pool (string)
Ipv6CidrBlock (string)
Ipv4IpamPoolId (string)
Ipv4NetmaskLength (integer)
Ipv6IpamPoolId (string)
Ipv6NetmaskLength (integer)
VpcId (string) required
AmazonProvidedIpv6CidrBlock (boolean)
ec2/attach_classic_link_vpcThis action is deprecated. Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC 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 changDryRun (boolean)
InstanceId (string) required
VpcId (string) required
Groups (array) required
ec2/attach_internet_gatewayAttaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information, see Internet gateways in the Amazon VPC User Guide.DryRun (boolean)
InternetGatewayId (string) required
VpcId (string) required
ec2/attach_network_interfaceAttaches a network interface to an instance.NetworkCardIndex (integer)
EnaSrdSpecification: {
. EnaSrdEnabled (boolean)
. EnaSrdUdpSpecification (object)
} (object)
EnaQueueCount (integer)
DryRun (boolean)
NetworkInterfaceId (string) required
InstanceId (string) required
DeviceIndex (integer) required
ec2/attach_verified_access_trust_providerAttaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.VerifiedAccessInstanceId (string) required
VerifiedAccessTrustProviderId (string) required
ClientToken (string)
DryRun (boolean)
ec2/attach_volumeAttaches an Amazon EBS volume to a running or stopped instance, and exposes it to the instance with the specified device name. The maximum number of Amazon EBS volumes that you can attach to an instance depends on the instance type. If you exceed the volume attachment limit for an instance type, the attachment request fails with the AttachmentLimitExceeded error. For more information, see Instance volume limits. After you attach an EBS volume, you must make it available for use. For more informaDevice (string) required
InstanceId (string) required
VolumeId (string) required
EbsCardIndex (integer)
DryRun (boolean)
ec2/attach_vpn_gatewayAttaches an available 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.VpcId (string) required
VpnGatewayId (string) required
DryRun (boolean)
ec2/authorize_client_vpn_ingressAdds 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.ClientVpnEndpointId (string) required
TargetNetworkCidr (string) required
AccessGroupId (string)
AuthorizeAllGroups (boolean)
Description (string)
ClientToken (string)
DryRun (boolean)
ec2/authorize_security_group_egressAdds the specified outbound egress rules to a security group. An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address ranges, the IP address ranges specified by a prefix list, or the instances that are associated with a source security group. For more information, see Security group rules. You must specify exactly one of the following destinations: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule for exaTagSpecifications (array)
DryRun (boolean)
GroupId (string) required
SourceSecurityGroupName (string)
SourceSecurityGroupOwnerId (string)
IpProtocol (string)
FromPort (integer)
ToPort (integer)
CidrIp (string)
IpPermissions (array)
ec2/authorize_security_group_ingressAdds the specified inbound ingress rules to a security group. An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 address range, the IP address ranges that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see Security group rules. You must specify exactly one of the following sources: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for eachCidrIp (string)
FromPort (integer)
GroupId (string)
GroupName (string)
IpPermissions (array)
IpProtocol (string)
SourceSecurityGroupName (string)
SourceSecurityGroupOwnerId (string)
ToPort (integer)
TagSpecifications (array)
DryRun (boolean)
ec2/bundle_instanceBundles 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.InstanceId (string) required
Storage: {
. S3 (object)
} (object) required
DryRun (boolean)
ec2/cancel_bundle_taskCancels a bundling operation for an instance store-backed Windows instance.BundleId (string) required
DryRun (boolean)
ec2/cancel_capacity_reservationCancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled. You can cancel a Capacity Reservation that is in the following states: assessing active and there is no commitment duration or the commitment duration has elapsed. You can't cancel a future-dated Capacity Reservation during the commitment duration. You can't modify or cancel a Capacity Block. For more information, see Capacity Blocks for ML. If a future-dated CapCapacityReservationId (string) required
DryRun (boolean)
ec2/cancel_capacity_reservation_fleetsCancels 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.DryRun (boolean)
CapacityReservationFleetIds (array) required
ec2/cancel_conversion_taskCancels 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.DryRun (boolean)
ConversionTaskId (string) required
ReasonMessage (string)
ec2/cancel_declarative_policies_reportCancels the generation of an account status report. You can only cancel a report while it has the running status. Reports with other statuses complete, cancelled, or error can't be canceled. For more information, see Generating the account status report for declarative policies in the Amazon Web Services Organizations User Guide.DryRun (boolean)
ReportId (string) required
ec2/cancel_export_taskCancels 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.ExportTaskId (string) required
ec2/cancel_image_launch_permissionRemoves your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon EC2 User Guide.ImageId (string) required
DryRun (boolean)
ec2/cancel_import_taskCancels an in-process import virtual machine or import snapshot task.CancelReason (string)
DryRun (boolean)
ImportTaskId (string)
ec2/cancel_reserved_instances_listingCancels the specified Reserved Instance listing in the Reserved Instance Marketplace. For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.ReservedInstancesListingId (string) required
ec2/cancel_spot_fleet_requestsCancels the specified Spot Fleet requests. After you cancel a Spot Fleet request, the Spot Fleet launches no new instances. You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to 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. Terminating an inDryRun (boolean)
SpotFleetRequestIds (array) required
TerminateInstances (boolean) required
ec2/cancel_spot_instance_requestsCancels one or more Spot Instance requests. Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.DryRun (boolean)
SpotInstanceRequestIds (array) required
ec2/confirm_product_instanceDetermines 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.InstanceId (string) required
ProductCode (string) required
DryRun (boolean)
ec2/copy_fpga_imageCopies the specified Amazon FPGA Image AFI to the current Region.DryRun (boolean)
SourceFpgaImageId (string) required
Description (string)
Name (string)
SourceRegion (string) required
ClientToken (string)
ec2/copy_imageInitiates an AMI copy operation. You must specify the source AMI ID and both the source and destination locations. The copy operation must be initiated in the destination Region. CopyImage supports the following source to destination copies: Region to Region Region to Outpost Parent Region to Local Zone Local Zone to parent Region Between Local Zones with the same parent Region only supported for certain Local Zones CopyImage does not support the following source to destination copies: Local ZonClientToken (string)
Description (string)
Encrypted (boolean)
KmsKeyId (string)
Name (string) required
SourceImageId (string) required
SourceRegion (string) required
DestinationOutpostArn (string)
CopyImageTags (boolean)
TagSpecifications (array)
SnapshotCopyCompletionDurationMinutes (integer)
DestinationAvailabilityZone (string)
DestinationAvailabilityZoneId (string)
DryRun (boolean)
ec2/copy_snapshotCreates an exact copy of an Amazon EBS snapshot. The location of the source snapshot determines whether you can copy it or not, and the allowed destinations for the snapshot copy. If the source snapshot is in a Region, you can copy it within that Region, to another Region, to an Outpost associated with that Region, or to a Local Zone in that Region. If the source snapshot is in a Local Zone, you can copy it within that Local Zone, to another Local Zone in the same zone group, or to the parent ReDescription (string)
DestinationOutpostArn (string)
DestinationRegion (string)
Encrypted (boolean)
KmsKeyId (string)
PresignedUrl (string)
SourceRegion (string) required
SourceSnapshotId (string) required
TagSpecifications (array)
CompletionDurationMinutes (integer)
DestinationAvailabilityZone (string)
DryRun (boolean)
ec2/copy_volumesCreates a crash-consistent, point-in-time copy of an existing Amazon EBS volume within the same Availability Zone. The volume copy can be attached to an Amazon EC2 instance once it reaches the available state. For more information, see Copy an Amazon EBS volume.SourceVolumeId (string) required
Iops (integer)
Size (integer)
VolumeType (string)
DryRun (boolean)
TagSpecifications (array)
MultiAttachEnabled (boolean)
Throughput (integer)
ClientToken (string)
ec2/create_capacity_manager_data_exportCreates a new data export configuration for EC2 Capacity Manager. This allows you to automatically export capacity usage data to an S3 bucket on a scheduled basis. The exported data includes metrics for On-Demand, Spot, and Capacity Reservations usage across your organization.S3BucketName (string) required
S3BucketPrefix (string)
Schedule (string) required
OutputFormat (string) required
ClientToken (string)
DryRun (boolean)
TagSpecifications (array)
ec2/create_capacity_reservationCreates 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. You can create a Capacity Reservation at any time, and you can choose when it starts. You can create a Capacity Reservation for immediate use or you can request a Capacity Reservation for a future date. For more information, see Reserve compute capacity with On-Demand Capacity Reservations in the AmaClientToken (string)
InstanceType (string) required
InstancePlatform (string) required
AvailabilityZone (string)
AvailabilityZoneId (string)
Tenancy (string)
InstanceCount (integer) required
EbsOptimized (boolean)
EphemeralStorage (boolean)
EndDate (string)
EndDateType (string)
InstanceMatchCriteria (string)
TagSpecifications (array)
DryRun (boolean)
OutpostArn (string)
PlacementGroupArn (string)
StartDate (string)
CommitmentDuration (integer)
DeliveryPreference (string)
ec2/create_capacity_reservation_by_splittingCreate a new Capacity Reservation by splitting the capacity of the source Capacity Reservation. The new Capacity Reservation will have the same attributes as the source Capacity Reservation except for tags. The source Capacity Reservation must be active and owned by your Amazon Web Services account.DryRun (boolean)
ClientToken (string)
SourceCapacityReservationId (string) required
InstanceCount (integer) required
TagSpecifications (array)
ec2/create_capacity_reservation_fleetCreates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.AllocationStrategy (string)
ClientToken (string)
InstanceTypeSpecifications (array) required
Tenancy (string)
TotalTargetCapacity (integer) required
EndDate (string)
InstanceMatchCriteria (string)
TagSpecifications (array)
DryRun (boolean)
ec2/create_carrier_gatewayCreates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.VpcId (string) required
TagSpecifications (array)
DryRun (boolean)
ClientToken (string)
ec2/create_client_vpn_endpointCreates 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.ClientCidrBlock (string)
ServerCertificateArn (string) required
AuthenticationOptions (array) required
ConnectionLogOptions: {
. Enabled (boolean)
. CloudwatchLogGroup (string)
. CloudwatchLogStream (string)
} (object) required
DnsServers (array)
TransportProtocol (string)
VpnPort (integer)
Description (string)
SplitTunnel (boolean)
DryRun (boolean)
ClientToken (string)
TagSpecifications (array)
SecurityGroupIds (array)
VpcId (string)
SelfServicePortal (string)
ClientConnectOptions: {
. Enabled (boolean)
. LambdaFunctionArn (string)
} (object)
SessionTimeoutHours (integer)
ClientLoginBannerOptions: {
. Enabled (boolean)
. BannerText (string)
} (object)
ClientRouteEnforcementOptions: {
. Enforced (boolean)
} (object)
DisconnectOnSessionTimeout (boolean)
EndpointIpAddressType (string)
TrafficIpAddressType (string)
ec2/create_client_vpn_routeAdds 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.ClientVpnEndpointId (string) required
DestinationCidrBlock (string) required
TargetVpcSubnetId (string) required
Description (string)
ClientToken (string)
DryRun (boolean)
ec2/create_coip_cidrCreates a range of customer-owned IP addresses.Cidr (string) required
CoipPoolId (string) required
DryRun (boolean)
ec2/create_coip_poolCreates a pool of customer-owned IP CoIP addresses.LocalGatewayRouteTableId (string) required
TagSpecifications (array)
DryRun (boolean)
ec2/create_customer_gatewayProvides 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 assignedBgpAsn (integer)
PublicIp (string)
CertificateArn (string)
Type (string) required
TagSpecifications (array)
DeviceName (string)
IpAddress (string)
BgpAsnExtended (integer)
DryRun (boolean)
ec2/create_default_subnetCreates 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 Create a default subnet in the Amazon VPC User Guide.AvailabilityZone (string)
DryRun (boolean)
Ipv6Native (boolean)
AvailabilityZoneId (string)
ec2/create_default_vpcCreates 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 VPCs in the Amazon VPC 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.DryRun (boolean)
ec2/create_delegate_mac_volume_ownership_taskDelegates ownership of the Amazon EBS root volume for an Apple silicon Mac instance to an administrative user.ClientToken (string)
DryRun (boolean)
InstanceId (string) required
MacCredentials (string) required
TagSpecifications (array)
ec2/create_dhcp_optionsCreates a custom set of DHCP options. After you create a DHCP option set, you associate it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly launched instances in the VPC use this set of DHCP options. The following are the individual DHCP options you can specify. For more information, see DHCP option sets in the Amazon VPC User Guide. domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in any othDhcpConfigurations (array) required
TagSpecifications (array)
DryRun (boolean)
ec2/create_egress_only_internet_gatewayIPv6 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.ClientToken (string)
DryRun (boolean)
VpcId (string) required
TagSpecifications (array)
ec2/create_fleetCreates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances. Instances are launched immediately if there is available capacity. A single EC2 Fleet can include 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.DryRun (boolean)
ClientToken (string)
SpotOptions: {
. AllocationStrategy (string)
. MaintenanceStrategies (object)
. InstanceInterruptionBehavior (string)
. InstancePoolsToUseCount (integer)
. SingleInstanceType (boolean)
. SingleAvailabilityZone (boolean)
. MinTargetCapacity (integer)
. MaxTotalPrice (string)
} (object)
OnDemandOptions: {
. AllocationStrategy (string)
. CapacityReservationOptions (object)
. SingleInstanceType (boolean)
. SingleAvailabilityZone (boolean)
. MinTargetCapacity (integer)
. MaxTotalPrice (string)
} (object)
ExcessCapacityTerminationPolicy (string)
LaunchTemplateConfigs (array) required
TargetCapacitySpecification: {
. TotalTargetCapacity (integer)
. OnDemandTargetCapacity (integer)
. SpotTargetCapacity (integer)
. DefaultTargetCapacityType (string)
. TargetCapacityUnitType (string)
} (object) required
TerminateInstancesWithExpiration (boolean)
Type (string)
ValidFrom (string)
ValidUntil (string)
ReplaceUnhealthyInstances (boolean)
TagSpecifications (array)
Context (string)
ec2/create_flow_logsCreates 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 VPC 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.DryRun (boolean)
ClientToken (string)
DeliverLogsPermissionArn (string)
DeliverCrossAccountRole (string)
LogGroupName (string)
ResourceIds (array) required
ResourceType (string) required
TrafficType (string)
LogDestinationType (string)
LogDestination (string)
LogFormat (string)
TagSpecifications (array)
MaxAggregationInterval (integer)
DestinationOptions: {
. FileFormat (string)
. HiveCompatiblePartitions (boolean)
. PerHourPartition (boolean)
} (object)
ec2/create_fpga_imageCreates an Amazon FPGA Image AFI from the specified design checkpoint DCP. The create operation is asynchronous. To verify that the AFI was successfully created and 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.DryRun (boolean)
InputStorageLocation: {
. Bucket (string)
. Key (string)
} (object) required
LogsStorageLocation: {
. Bucket (string)
. Key (string)
} (object)
Description (string)
Name (string)
ClientToken (string)
TagSpecifications (array)
ec2/create_imageCreates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. 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. The location of the source instance determines where you can create the snapshots of theTagSpecifications (array)
SnapshotLocation (string)
DryRun (boolean)
InstanceId (string) required
Name (string) required
Description (string)
NoReboot (boolean)
BlockDeviceMappings (array)
ec2/create_image_usage_reportCreates a report that shows how your image is used across other Amazon Web Services accounts. The report provides visibility into which accounts are using the specified image, and how many resources EC2 instances or launch templates are referencing it. For more information, see View your AMI usage in the Amazon EC2 User Guide.ImageId (string) required
DryRun (boolean)
ResourceTypes (array) required
AccountIds (array)
ClientToken (string)
TagSpecifications (array)
ec2/create_instance_connect_endpointCreates an EC2 Instance Connect Endpoint. An EC2 Instance Connect Endpoint allows you to connect to an instance, without requiring the instance to have a public IPv4 or public IPv6 address. For more information, see Connect to your instances using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.DryRun (boolean)
SubnetId (string) required
SecurityGroupIds (array)
PreserveClientIp (boolean)
ClientToken (string)
TagSpecifications (array)
IpAddressType (string)
ec2/create_instance_event_windowCreates 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 oDryRun (boolean)
Name (string)
TimeRanges (array)
CronExpression (string)
TagSpecifications (array)
ec2/create_instance_export_taskExports a running or stopped instance to an Amazon S3 bucket. For information about the prerequisites for your Amazon S3 bucket, 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.TagSpecifications (array)
Description (string)
InstanceId (string) required
TargetEnvironment (string) required
ExportToS3Task: {
. DiskImageFormat (string)
. ContainerFormat (string)
. S3Bucket (string)
. S3Prefix (string)
} (object) required
ec2/create_internet_gatewayCreates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway. For more information, see Internet gateways in the Amazon VPC User Guide.TagSpecifications (array)
DryRun (boolean)
ec2/create_interruptible_capacity_reservation_allocationCreates an interruptible Capacity Reservation by specifying the number of unused instances you want to allocate from your source reservation. This helps you make unused capacity available for other workloads within your account while maintaining control to reclaim it.CapacityReservationId (string) required
InstanceCount (integer) required
ClientToken (string)
DryRun (boolean)
TagSpecifications (array)
ec2/create_ipamCreate 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.DryRun (boolean)
Description (string)
OperatingRegions (array)
TagSpecifications (array)
ClientToken (string)
Tier (string)
EnablePrivateGua (boolean)
MeteredAccount (string)
ec2/create_ipam_external_resource_verification_tokenCreate a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services BYOIP.DryRun (boolean)
IpamId (string) required
TagSpecifications (array)
ClientToken (string)
ec2/create_ipam_policyCreates an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individualDryRun (boolean)
TagSpecifications (array)
ClientToken (string)
IpamId (string) required
ec2/create_ipam_poolCreate 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.DryRun (boolean)
IpamScopeId (string) required
Locale (string)
SourceIpamPoolId (string)
Description (string)
AddressFamily (string) required
AutoImport (boolean)
PubliclyAdvertisable (boolean)
AllocationMinNetmaskLength (integer)
AllocationMaxNetmaskLength (integer)
AllocationDefaultNetmaskLength (integer)
AllocationResourceTags (array)
TagSpecifications (array)
ClientToken (string)
AwsService (string)
PublicIpSource (string)
SourceResource: {
. ResourceId (string)
. ResourceType (string)
. ResourceRegion (string)
. ResourceOwner (string)
} (object)
ec2/create_ipam_prefix_list_resolverCreates an IPAM prefix list resolver. An IPAM prefix list resolver is a component that manages the synchronization between IPAM's CIDR selection rules and customer-managed prefix lists. It automates connectivity configurations by selecting CIDRs from IPAM's database based on your business logic and synchronizing them with prefix lists used in resources such as VPC route tables and security groups. For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM inDryRun (boolean)
IpamId (string) required
Description (string)
AddressFamily (string) required
Rules (array)
TagSpecifications (array)
ClientToken (string)
ec2/create_ipam_prefix_list_resolver_targetCreates an IPAM prefix list resolver target. An IPAM prefix list resolver target is an association between a specific customer-managed prefix list and an IPAM prefix list resolver. The target enables the resolver to synchronize CIDRs selected by its rules into the specified prefix list, which can then be referenced in Amazon Web Services resources. For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM in the Amazon VPC IPAM User Guide.DryRun (boolean)
IpamPrefixListResolverId (string) required
PrefixListId (string) required
PrefixListRegion (string) required
DesiredVersion (integer)
TrackLatestVersion (boolean) required
TagSpecifications (array)
ClientToken (string)
ec2/create_ipam_resource_discoveryCreates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.DryRun (boolean)
Description (string)
OperatingRegions (array)
TagSpecifications (array)
ClientToken (string)
ec2/create_ipam_scopeCreate 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.DryRun (boolean)
IpamId (string) required
Description (string)
TagSpecifications (array)
ClientToken (string)
ExternalAuthorityConfiguration: {
. Type (string)
. ExternalResourceIdentifier (string)
} (object)
ec2/create_key_pairCreates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified 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 cKeyName (string) required
KeyType (string)
TagSpecifications (array)
KeyFormat (string)
DryRun (boolean)
ec2/create_launch_templateCreates 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 Store instance launch parameters in Amazon EC2 launch templates in the Amazon EC2 User Guide. To clone an existing launch template as the basis for a new launch template, use the Amazon EC2 console. The API, SDKs, and CLI do not support clonDryRun (boolean)
ClientToken (string)
LaunchTemplateName (string) required
VersionDescription (string)
LaunchTemplateData: {
. KernelId (string)
. EbsOptimized (boolean)
. IamInstanceProfile (object)
. BlockDeviceMappings (array)
. NetworkInterfaces (array)
. ImageId (string)
. InstanceType (string)
. KeyName (string)
. Monitoring (object)
. Placement (object)
. RamDiskId (string)
. DisableApiTermination (boolean)
. InstanceInitiatedShutdownBehavior (string)
. UserData (string)
. TagSpecifications (array)
. ElasticGpuSpecifications (array)
. ElasticInferenceAccelerators (array)
. SecurityGroupIds (array)
. SecurityGroups (array)
. InstanceMarketOptions (object)
. CreditSpecification (object)
. CpuOptions (object)
. CapacityReservationSpecification (object)
. LicenseSpecifications (array)
. HibernationOptions (object)
. MetadataOptions (object)
. EnclaveOptions (object)
. InstanceRequirements (object)
. PrivateDnsNameOptions (object)
. MaintenanceOptions (object)
. DisableApiStop (boolean)
. Operator (object)
. NetworkPerformanceOptions (object)
. SecondaryInterfaces (array)
} (object) required
Operator: {
. Principal (string)
} (object)
TagSpecifications (array)
ec2/create_launch_template_versionCreates a new version of a launch template. You must specify an existing launch template, either by name or ID. You can determine whether the new version inherits parameters from a source version, and add or overwrite parameters as needed. Launch template versions are numbered in the order in which they are created. You can't 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, youDryRun (boolean)
ClientToken (string)
LaunchTemplateId (string)
LaunchTemplateName (string)
SourceVersion (string)
VersionDescription (string)
LaunchTemplateData: {
. KernelId (string)
. EbsOptimized (boolean)
. IamInstanceProfile (object)
. BlockDeviceMappings (array)
. NetworkInterfaces (array)
. ImageId (string)
. InstanceType (string)
. KeyName (string)
. Monitoring (object)
. Placement (object)
. RamDiskId (string)
. DisableApiTermination (boolean)
. InstanceInitiatedShutdownBehavior (string)
. UserData (string)
. TagSpecifications (array)
. ElasticGpuSpecifications (array)
. ElasticInferenceAccelerators (array)
. SecurityGroupIds (array)
. SecurityGroups (array)
. InstanceMarketOptions (object)
. CreditSpecification (object)
. CpuOptions (object)
. CapacityReservationSpecification (object)
. LicenseSpecifications (array)
. HibernationOptions (object)
. MetadataOptions (object)
. EnclaveOptions (object)
. InstanceRequirements (object)
. PrivateDnsNameOptions (object)
. MaintenanceOptions (object)
. DisableApiStop (boolean)
. Operator (object)
. NetworkPerformanceOptions (object)
. SecondaryInterfaces (array)
} (object) required
ResolveAlias (boolean)
ec2/create_local_gateway_routeCreates a static route for the specified local gateway route table. You must specify one of the following targets: LocalGatewayVirtualInterfaceGroupId NetworkInterfaceIdDestinationCidrBlock (string)
LocalGatewayRouteTableId (string) required
LocalGatewayVirtualInterfaceGroupId (string)
DryRun (boolean)
NetworkInterfaceId (string)
DestinationPrefixListId (string)
ec2/create_local_gateway_route_tableCreates a local gateway route table.LocalGatewayId (string) required
Mode (string)
TagSpecifications (array)
DryRun (boolean)
ec2/create_local_gateway_route_table_virtual_interface_group_associationCreates a local gateway route table virtual interface group association.LocalGatewayRouteTableId (string) required
LocalGatewayVirtualInterfaceGroupId (string) required
TagSpecifications (array)
DryRun (boolean)
ec2/create_local_gateway_route_table_vpc_associationAssociates the specified VPC with the specified local gateway route table.LocalGatewayRouteTableId (string) required
VpcId (string) required
TagSpecifications (array)
DryRun (boolean)
ec2/create_local_gateway_virtual_interfaceCreate a virtual interface for a local gateway.LocalGatewayVirtualInterfaceGroupId (string) required
OutpostLagId (string) required
Vlan (integer) required
LocalAddress (string) required
PeerAddress (string) required
PeerBgpAsn (integer)
TagSpecifications (array)
DryRun (boolean)
PeerBgpAsnExtended (integer)
ec2/create_local_gateway_virtual_interface_groupCreate a local gateway virtual interface group.LocalGatewayId (string) required
LocalBgpAsn (integer)
LocalBgpAsnExtended (integer)
TagSpecifications (array)
DryRun (boolean)
ec2/create_mac_system_integrity_protection_modification_taskCreates a System Integrity Protection SIP modification task to configure the SIP settings for an x86 Mac instance or Apple silicon Mac instance. For more information, see Configure SIP for Amazon EC2 instances in the Amazon EC2 User Guide. When you configure the SIP settings for your instance, you can either enable or disable all SIP settings, or you can specify a custom SIP configuration that selectively enables or disables specific SIP settings. If you implement a custom configuration, connectClientToken (string)
DryRun (boolean)
InstanceId (string) required
MacCredentials (string)
MacSystemIntegrityProtectionConfiguration: {
. AppleInternal (string)
. BaseSystem (string)
. DebuggingRestrictions (string)
. DTraceRestrictions (string)
. FilesystemProtections (string)
. KextSigning (string)
. NvramProtections (string)
} (object)
MacSystemIntegrityProtectionStatus (string) required
TagSpecifications (array)
ec2/create_managed_prefix_listCreates a managed prefix list. You can specify entries for the prefix list. Each entry consists of a CIDR block and an optional description.DryRun (boolean)
PrefixListName (string) required
Entries (array)
MaxEntries (integer) required
TagSpecifications (array)
AddressFamily (string) required
ClientToken (string)
ec2/create_nat_gatewayCreates 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-pAvailabilityMode (string)
AllocationId (string)
ClientToken (string)
DryRun (boolean)
SubnetId (string)
VpcId (string)
AvailabilityZoneAddresses (array)
TagSpecifications (array)
ConnectivityType (string)
PrivateIpAddress (string)
SecondaryAllocationIds (array)
SecondaryPrivateIpAddresses (array)
SecondaryPrivateIpAddressCount (integer)
ec2/create_network_aclCreates 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 VPC User Guide.TagSpecifications (array)
ClientToken (string)
DryRun (boolean)
VpcId (string) required
ec2/create_network_acl_entryCreates 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 exaDryRun (boolean)
NetworkAclId (string) required
RuleNumber (integer) required
Protocol (string) required
RuleAction (string) required
Egress (boolean) required
CidrBlock (string)
Ipv6CidrBlock (string)
IcmpTypeCode: {
. Code (integer)
. Type (integer)
} (object)
PortRange: {
. From (integer)
. To (integer)
} (object)
ec2/create_network_insights_access_scopeCreates 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.MatchPaths (array)
ExcludePaths (array)
ClientToken (string) required
TagSpecifications (array)
DryRun (boolean)
ec2/create_network_insights_pathCreates 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 the Reachability Analyzer Guide.SourceIp (string)
DestinationIp (string)
Source (string) required
Destination (string)
Protocol (string) required
DestinationPort (integer)
TagSpecifications (array)
DryRun (boolean)
ClientToken (string) required
FilterAtSource: {
. SourceAddress (string)
. SourcePortRange (object)
. DestinationAddress (string)
. DestinationPortRange (object)
} (object)
FilterAtDestination: {
. SourceAddress (string)
. SourcePortRange (object)
. DestinationAddress (string)
. DestinationPortRange (object)
} (object)
ec2/create_network_interfaceCreates 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 about network interfaces, see Elastic network interfaces in the Amazon EC2 User Guide.Ipv4Prefixes (array)
Ipv4PrefixCount (integer)
Ipv6Prefixes (array)
Ipv6PrefixCount (integer)
InterfaceType (string)
TagSpecifications (array)
ClientToken (string)
EnablePrimaryIpv6 (boolean)
ConnectionTrackingSpecification: {
. TcpEstablishedTimeout (integer)
. UdpStreamTimeout (integer)
. UdpTimeout (integer)
} (object)
Operator: {
. Principal (string)
} (object)
SubnetId (string) required
Description (string)
PrivateIpAddress (string)
Groups (array)
PrivateIpAddresses (array)
SecondaryPrivateIpAddressCount (integer)
Ipv6Addresses (array)
Ipv6AddressCount (integer)
DryRun (boolean)
ec2/create_network_interface_permissionGrants 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.NetworkInterfaceId (string) required
AwsAccountId (string)
AwsService (string)
Permission (string) required
DryRun (boolean)
ec2/create_placement_groupCreates 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 sharPartitionCount (integer)
TagSpecifications (array)
SpreadLevel (string)
LinkedGroupId (string)
DryRun (boolean)
GroupName (string)
Strategy (string)
ec2/create_public_ipv4poolCreates 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.DryRun (boolean)
TagSpecifications (array)
NetworkBorderGroup (string)
ec2/create_replace_root_volume_taskReplaces the EBS-backed root volume for a running instance with a new volume that is restored to the original root volume's launch state, that is restored to a specific snapshot taken from the original root volume, or that is restored from an AMI that has the same key characteristics as that of the instance. For more information, see Replace a root volume in the Amazon EC2 User Guide.InstanceId (string) required
SnapshotId (string)
ClientToken (string)
DryRun (boolean)
TagSpecifications (array)
ImageId (string)
DeleteReplacedRootVolume (boolean)
VolumeInitializationRate (integer)
ec2/create_reserved_instances_listingCreates 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 InstReservedInstancesId (string) required
InstanceCount (integer) required
PriceSchedules (array) required
ClientToken (string) required
ec2/create_restore_image_taskStarts 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 S3 in the Amazon EC2 User Guide. For more information, see Store and restore an AMI using S3 in the Amazon EC2 User Guide.Bucket (string) required
ObjectKey (string) required
Name (string)
TagSpecifications (array)
DryRun (boolean)
ec2/create_routeCreates 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 tDestinationPrefixListId (string)
VpcEndpointId (string)
TransitGatewayId (string)
LocalGatewayId (string)
CarrierGatewayId (string)
CoreNetworkArn (string)
OdbNetworkArn (string)
DryRun (boolean)
RouteTableId (string) required
DestinationCidrBlock (string)
GatewayId (string)
DestinationIpv6CidrBlock (string)
EgressOnlyInternetGatewayId (string)
InstanceId (string)
NetworkInterfaceId (string)
VpcPeeringConnectionId (string)
NatGatewayId (string)
ec2/create_route_serverCreates a new route server to manage dynamic routing in a VPC. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing andAmazonSideAsn (integer) required
ClientToken (string)
DryRun (boolean)
PersistRoutes (string)
PersistRoutesDuration (integer)
SnsNotificationsEnabled (boolean)
TagSpecifications (array)
ec2/create_route_server_endpointCreates a new endpoint for a route server in a specified subnet. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP Border Gateway Protocol connections between your route server and your BGP peers. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.RouteServerId (string) required
SubnetId (string) required
ClientToken (string)
DryRun (boolean)
TagSpecifications (array)
ec2/create_route_server_peerCreates a new BGP peer for a specified route server endpoint. A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services such as a firewall appliance or other network security function running on an EC2 instance. The device must meet these requirements: Have an elastic network interface in the VPC Support BGP Border Gateway Protocol Can initiate BGP sessions For more information see Dynamic routing in your VPC with VPC Route Server in the AmazRouteServerEndpointId (string) required
PeerAddress (string) required
BgpOptions: {
. PeerAsn (integer)
. PeerLivenessDetection (string)
} (object) required
DryRun (boolean)
TagSpecifications (array)
ec2/create_route_tableCreates 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 VPC User Guide.TagSpecifications (array)
ClientToken (string)
DryRun (boolean)
VpcId (string) required
ec2/create_secondary_networkCreates an Amazon secondary network. The allowed size for a secondary network CIDR block is between /28 netmask 16 IP addresses and /12 netmask 1,048,576 IP addresses.ClientToken (string)
DryRun (boolean)
Ipv4CidrBlock (string) required
NetworkType (string) required
TagSpecifications (array)
ec2/create_secondary_subnetCreates a secondary subnet in a secondary network. A secondary subnet CIDR block must not overlap with the CIDR block of an existing secondary subnet in the secondary network. After you create a secondary subnet, you can't change its CIDR block. The allowed size for a secondary subnet CIDR block is between /28 netmask 16 IP addresses and /12 netmask 1,048,576 IP addresses. Amazon reserves the first four IP addresses and the last IP address in each secondary subnet for internal use.ClientToken (string)
AvailabilityZone (string)
AvailabilityZoneId (string)
DryRun (boolean)
Ipv4CidrBlock (string) required
SecondaryNetworkId (string) required
TagSpecifications (array)
ec2/create_security_groupCreates 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 EC2 User Guide and Security groups for your VPC in the Amazon VPC User Guide. When you create a security group, you specify a friendly name of your choice. You can't have two security groups for the same VPC with the same name. You have a default security group for use in your VPC. If you don't specifyDescription (string) required
GroupName (string) required
VpcId (string)
TagSpecifications (array)
DryRun (boolean)
ec2/create_snapshotCreates 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. The location of the source EBS volume determines where you can create the snapshot. If the source volume is in a Region, you must create the snapshot in the same Region as the volume. If the source volume is in a Local Zone, you can create the snapshot in the same Local Zone or in its parent Amazon Web Services RegionDescription (string)
OutpostArn (string)
VolumeId (string) required
TagSpecifications (array)
Location (string)
DryRun (boolean)
ec2/create_snapshotsCreates crash-consistent snapshots of multiple EBS volumes attached to an Amazon EC2 instance. Volumes are chosen by specifying an instance. Each volume attached to the specified instance will produce one snapshot 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. The location of the source instance determines where you can creDescription (string)
InstanceSpecification: {
. InstanceId (string)
. ExcludeBootVolume (boolean)
. ExcludeDataVolumeIds (array)
} (object) required
OutpostArn (string)
TagSpecifications (array)
DryRun (boolean)
CopyTagsFromSource (string)
Location (string)
ec2/create_spot_datafeed_subscriptionCreates 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.DryRun (boolean)
Bucket (string) required
Prefix (string)
ec2/create_store_image_taskStores 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 S3 in the Amazon EC2 User Guide. For more information, see Store and restore an AMI using S3 in the Amazon EC2 User Guide.ImageId (string) required
Bucket (string) required
S3ObjectTags (array)
DryRun (boolean)
ec2/create_subnetCreates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block. A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC. After you create a subnet, you can't change its CIDR block. The allowed size for an IPTagSpecifications (array)
AvailabilityZone (string)
AvailabilityZoneId (string)
CidrBlock (string)
Ipv6CidrBlock (string)
OutpostArn (string)
VpcId (string) required
Ipv6Native (boolean)
Ipv4IpamPoolId (string)
Ipv4NetmaskLength (integer)
Ipv6IpamPoolId (string)
Ipv6NetmaskLength (integer)
DryRun (boolean)
ec2/create_subnet_cidr_reservationCreates a subnet CIDR reservation. For more information, see Subnet CIDR reservations in the Amazon VPC User Guide and Manage prefixes for your network interfaces in the Amazon EC2 User Guide.SubnetId (string) required
Cidr (string) required
ReservationType (string) required
Description (string)
DryRun (boolean)
TagSpecifications (array)
ec2/create_tagsAdds 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 tDryRun (boolean)
Resources (array) required
Tags (array) required
ec2/create_traffic_mirror_filterCreates 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.Description (string)
TagSpecifications (array)
DryRun (boolean)
ClientToken (string)
ec2/create_traffic_mirror_filter_ruleCreates 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.TrafficMirrorFilterId (string) required
TrafficDirection (string) required
RuleNumber (integer) required
RuleAction (string) required
DestinationPortRange: {
. FromPort (integer)
. ToPort (integer)
} (object)
SourcePortRange: {
. FromPort (integer)
. ToPort (integer)
} (object)
Protocol (integer)
DestinationCidrBlock (string) required
SourceCidrBlock (string) required
Description (string)
DryRun (boolean)
ClientToken (string)
TagSpecifications (array)
ec2/create_traffic_mirror_sessionCreates 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 CreateTrafficMirrorFiltNetworkInterfaceId (string) required
TrafficMirrorTargetId (string) required
TrafficMirrorFilterId (string) required
PacketLength (integer)
SessionNumber (integer) required
VirtualNetworkId (integer)
Description (string)
TagSpecifications (array)
DryRun (boolean)
ClientToken (string)
ec2/create_traffic_mirror_targetCreates 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.NetworkInterfaceId (string)
NetworkLoadBalancerArn (string)
Description (string)
TagSpecifications (array)
DryRun (boolean)
ClientToken (string)
GatewayLoadBalancerEndpointId (string)
ec2/create_transit_gatewayCreates 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 CreateVpnConnDescription (string)
Options: {
. AmazonSideAsn (integer)
. AutoAcceptSharedAttachments (string)
. DefaultRouteTableAssociation (string)
. DefaultRouteTablePropagation (string)
. VpnEcmpSupport (string)
. DnsSupport (string)
. SecurityGroupReferencingSupport (string)
. MulticastSupport (string)
. TransitGatewayCidrBlocks (array)
} (object)
TagSpecifications (array)
DryRun (boolean)
ec2/create_transit_gateway_connectCreates 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.TransportTransitGatewayAttachmentId (string) required
Options: {
. Protocol (string)
} (object) required
TagSpecifications (array)
DryRun (boolean)
ec2/create_transit_gateway_connect_peerCreates 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 Amazon Web Services Transit Gateways Guide.TransitGatewayAttachmentId (string) required
TransitGatewayAddress (string)
PeerAddress (string) required
BgpOptions: {
. PeerAsn (integer)
} (object)
InsideCidrBlocks (array) required
TagSpecifications (array)
DryRun (boolean)
ec2/create_transit_gateway_metering_policyCreates a metering policy for a transit gateway to track and measure network traffic.TransitGatewayId (string) required
MiddleboxAttachmentIds (array)
TagSpecifications (array)
DryRun (boolean)
ec2/create_transit_gateway_metering_policy_entryCreates an entry in a transit gateway metering policy to define traffic measurement rules.TransitGatewayMeteringPolicyId (string) required
PolicyRuleNumber (integer) required
SourceTransitGatewayAttachmentId (string)
SourceTransitGatewayAttachmentType (string)
SourceCidrBlock (string)
SourcePortRange (string)
DestinationTransitGatewayAttachmentId (string)
DestinationTransitGatewayAttachmentType (string)
DestinationCidrBlock (string)
DestinationPortRange (string)
Protocol (string)
MeteredAccount (string) required
DryRun (boolean)
ec2/create_transit_gateway_multicast_domainCreates 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.TransitGatewayId (string) required
Options: {
. Igmpv2Support (string)
. StaticSourcesSupport (string)
. AutoAcceptSharedAssociations (string)
} (object)
TagSpecifications (array)
DryRun (boolean)
ec2/create_transit_gateway_peering_attachmentRequests 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.TransitGatewayId (string) required
PeerTransitGatewayId (string) required
PeerAccountId (string) required
PeerRegion (string) required
Options: {
. DynamicRouting (string)
} (object)
TagSpecifications (array)
DryRun (boolean)
ec2/create_transit_gateway_policy_tableCreates a transit gateway policy table.TransitGatewayId (string) required
TagSpecifications (array)
DryRun (boolean)
ec2/create_transit_gateway_prefix_list_referenceCreates a reference route to a prefix list in a specified transit gateway route table.TransitGatewayRouteTableId (string) required
PrefixListId (string) required
TransitGatewayAttachmentId (string)
Blackhole (boolean)
DryRun (boolean)
ec2/create_transit_gateway_routeCreates a static route for the specified transit gateway route table.DestinationCidrBlock (string) required
TransitGatewayRouteTableId (string) required
TransitGatewayAttachmentId (string)
Blackhole (boolean)
DryRun (boolean)
ec2/create_transit_gateway_route_tableCreates a route table for the specified transit gateway.TransitGatewayId (string) required
TagSpecifications (array)
DryRun (boolean)
ec2/create_transit_gateway_route_table_announcementAdvertises a new transit gateway route table.TransitGatewayRouteTableId (string) required
PeeringAttachmentId (string) required
TagSpecifications (array)
DryRun (boolean)
ec2/create_transit_gateway_vpc_attachmentAttaches 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.TransitGatewayId (string) required
VpcId (string) required
SubnetIds (array) required
Options: {
. DnsSupport (string)
. SecurityGroupReferencingSupport (string)
. Ipv6Support (string)
. ApplianceModeSupport (string)
} (object)
TagSpecifications (array)
DryRun (boolean)
ec2/create_verified_access_endpointAn Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.VerifiedAccessGroupId (string) required
EndpointType (string) required
AttachmentType (string) required
DomainCertificateArn (string)
ApplicationDomain (string)
EndpointDomainPrefix (string)
SecurityGroupIds (array)
LoadBalancerOptions: {
. Protocol (string)
. Port (integer)
. LoadBalancerArn (string)
. SubnetIds (array)
. PortRanges (array)
} (object)
NetworkInterfaceOptions: {
. NetworkInterfaceId (string)
. Protocol (string)
. Port (integer)
. PortRanges (array)
} (object)
Description (string)
PolicyDocument (string)
TagSpecifications (array)
ClientToken (string)
DryRun (boolean)
SseSpecification: {
. CustomerManagedKeyEnabled (boolean)
. KmsKeyArn (string)
} (object)
RdsOptions: {
. Protocol (string)
. Port (integer)
. RdsDbInstanceArn (string)
. RdsDbClusterArn (string)
. RdsDbProxyArn (string)
. RdsEndpoint (string)
. SubnetIds (array)
} (object)
CidrOptions: {
. Protocol (string)
. SubnetIds (array)
. Cidr (string)
. PortRanges (array)
} (object)
ec2/create_verified_access_groupAn Amazon Web Services Verified Access group is a collection of Amazon Web Services Verified Access endpoints who's associated applications have similar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For example, you can group all Verified Access instances associated with 'sales' applications together and use one common Verified Access policy.VerifiedAccessInstanceId (string) required
Description (string)
PolicyDocument (string)
TagSpecifications (array)
ClientToken (string)
DryRun (boolean)
SseSpecification: {
. CustomerManagedKeyEnabled (boolean)
. KmsKeyArn (string)
} (object)
ec2/create_verified_access_instanceAn Amazon Web Services Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met.Description (string)
TagSpecifications (array)
ClientToken (string)
DryRun (boolean)
FIPSEnabled (boolean)
CidrEndpointsCustomSubDomain (string)
ec2/create_verified_access_trust_providerA trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices. When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request.TrustProviderType (string) required
UserTrustProviderType (string)
DeviceTrustProviderType (string)
OidcOptions: {
. Issuer (string)
. AuthorizationEndpoint (string)
. TokenEndpoint (string)
. UserInfoEndpoint (string)
. ClientId (string)
. ClientSecret (string)
. Scope (string)
} (object)
DeviceOptions: {
. TenantId (string)
. PublicSigningKeyUrl (string)
} (object)
PolicyReferenceName (string) required
Description (string)
TagSpecifications (array)
ClientToken (string)
DryRun (boolean)
SseSpecification: {
. CustomerManagedKeyEnabled (boolean)
. KmsKeyArn (string)
} (object)
NativeApplicationOidcOptions: {
. PublicSigningKeyEndpoint (string)
. Issuer (string)
. AuthorizationEndpoint (string)
. TokenEndpoint (string)
. UserInfoEndpoint (string)
. ClientId (string)
. ClientSecret (string)
. Scope (string)
} (object)
ec2/create_volumeCreates 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 EBAvailabilityZone (string)
AvailabilityZoneId (string)
Encrypted (boolean)
Iops (integer)
KmsKeyId (string)
OutpostArn (string)
Size (integer)
SnapshotId (string)
VolumeType (string)
TagSpecifications (array)
MultiAttachEnabled (boolean)
Throughput (integer)
ClientToken (string)
VolumeInitializationRate (integer)
Operator: {
. Principal (string)
} (object)
DryRun (boolean)
ec2/create_vpcCreates a VPC with the specified CIDR blocks. A VPC must have an associated IPv4 CIDR block. You can choose an IPv4 CIDR block or an IPAM-allocated IPv4 CIDR block. You can optionally associate an IPv6 CIDR block with a VPC. You can choose an IPv6 CIDR block, an Amazon-provided IPv6 CIDR block, an IPAM-allocated IPv6 CIDR block, or an IPv6 CIDR block that you brought to Amazon Web Services. For more information, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide. By defaultCidrBlock (string)
Ipv6Pool (string)
Ipv6CidrBlock (string)
Ipv4IpamPoolId (string)
Ipv4NetmaskLength (integer)
Ipv6IpamPoolId (string)
Ipv6NetmaskLength (integer)
Ipv6CidrBlockNetworkBorderGroup (string)
VpcEncryptionControl: {
. Mode (string)
. InternetGatewayExclusion (string)
. EgressOnlyInternetGatewayExclusion (string)
. NatGatewayExclusion (string)
. VirtualPrivateGatewayExclusion (string)
. VpcPeeringExclusion (string)
. LambdaExclusion (string)
. VpcLatticeExclusion (string)
. ElasticFileSystemExclusion (string)
} (object)
TagSpecifications (array)
DryRun (boolean)
InstanceTenancy (string)
AmazonProvidedIpv6CidrBlock (boolean)
ec2/create_vpc_block_public_access_exclusionCreate a VPC Block Public Access BPA exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC UseDryRun (boolean)
SubnetId (string)
VpcId (string)
InternetGatewayExclusionMode (string) required
TagSpecifications (array)
ec2/create_vpc_encryption_controlCreates a VPC Encryption Control configuration for a specified VPC. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements for standards like HIPAA, FedRAMP, and PCI DSS. For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.DryRun (boolean)
VpcId (string) required
TagSpecifications (array)
ec2/create_vpc_endpointCreates a VPC endpoint. A VPC endpoint provides a private connection between the specified VPC and the specified endpoint service. You can use an endpoint service 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 User Guide.DryRun (boolean)
VpcEndpointType (string)
VpcId (string) required
ServiceName (string)
PolicyDocument (string)
RouteTableIds (array)
SubnetIds (array)
SecurityGroupIds (array)
IpAddressType (string)
DnsOptions: {
. DnsRecordIpType (string)
. PrivateDnsOnlyForInboundResolverEndpoint (boolean)
. PrivateDnsPreference (string)
. PrivateDnsSpecifiedDomains (array)
} (object)
ClientToken (string)
PrivateDnsEnabled (boolean)
TagSpecifications (array)
SubnetConfigurations (array)
ServiceNetworkArn (string)
ResourceConfigurationArn (string)
ServiceRegion (string)
ec2/create_vpc_endpoint_connection_notificationCreates 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 Creating an Amazon SNS topic in the Amazon SNS Developer Guide. You can create a connection notification for interface endpoints only.DryRun (boolean)
ServiceId (string)
VpcEndpointId (string)
ConnectionNotificationArn (string) required
ConnectionEvents (array) required
ClientToken (string)
ec2/create_vpc_endpoint_service_configurationCreates a VPC endpoint service to which service consumers Amazon Web Services accounts, 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 domaDryRun (boolean)
AcceptanceRequired (boolean)
PrivateDnsName (string)
NetworkLoadBalancerArns (array)
GatewayLoadBalancerArns (array)
SupportedIpAddressTypes (array)
SupportedRegions (array)
ClientToken (string)
TagSpecifications (array)
ec2/create_vpc_peering_connectionRequests 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 VPC peering limitations in the VPC Peering Guide. The owner of the accepter VPC mPeerRegion (string)
TagSpecifications (array)
DryRun (boolean)
VpcId (string) required
PeerVpcId (string)
PeerOwnerId (string)
ec2/create_vpn_concentratorCreates a VPN concentrator that aggregates multiple VPN connections to a transit gateway.Type (string) required
TransitGatewayId (string)
TagSpecifications (array)
DryRun (boolean)
ec2/create_vpn_connectionCreates 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 connectCustomerGatewayId (string) required
Type (string) required
VpnGatewayId (string)
TransitGatewayId (string)
VpnConcentratorId (string)
TagSpecifications (array)
PreSharedKeyStorage (string)
DryRun (boolean)
Options: {
. EnableAcceleration (boolean)
. TunnelInsideIpVersion (string)
. TunnelOptions (array)
. LocalIpv4NetworkCidr (string)
. RemoteIpv4NetworkCidr (string)
. LocalIpv6NetworkCidr (string)
. RemoteIpv6NetworkCidr (string)
. OutsideIpAddressType (string)
. TransportTransitGatewayAttachmentId (string)
. TunnelBandwidth (string)
. StaticRoutesOnly (boolean)
} (object)
ec2/create_vpn_connection_routeCreates 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.DestinationCidrBlock (string) required
VpnConnectionId (string) required
ec2/create_vpn_gatewayCreates 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.AvailabilityZone (string)
Type (string) required
TagSpecifications (array)
AmazonSideAsn (integer)
DryRun (boolean)
ec2/delete_capacity_manager_data_exportDeletes an existing Capacity Manager data export configuration. This stops future scheduled exports but does not delete previously exported files from S3.CapacityManagerDataExportId (string) required
DryRun (boolean)
ec2/delete_carrier_gatewayDeletes 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.CarrierGatewayId (string) required
DryRun (boolean)
ec2/delete_client_vpn_endpointDeletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.ClientVpnEndpointId (string) required
DryRun (boolean)
ec2/delete_client_vpn_routeDeletes 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.ClientVpnEndpointId (string) required
TargetVpcSubnetId (string)
DestinationCidrBlock (string) required
DryRun (boolean)
ec2/delete_coip_cidrDeletes a range of customer-owned IP addresses.Cidr (string) required
CoipPoolId (string) required
DryRun (boolean)
ec2/delete_coip_poolDeletes a pool of customer-owned IP CoIP addresses.CoipPoolId (string) required
DryRun (boolean)
ec2/delete_customer_gatewayDeletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.CustomerGatewayId (string) required
DryRun (boolean)
ec2/delete_dhcp_optionsDeletes 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.DhcpOptionsId (string) required
DryRun (boolean)
ec2/delete_egress_only_internet_gatewayDeletes an egress-only internet gateway.DryRun (boolean)
EgressOnlyInternetGatewayId (string) required
ec2/delete_fleetsDeletes the specified EC2 Fleet request. After you delete an EC2 Fleet request, it launches no new instances. You must also specify whether a deleted EC2 Fleet request should terminate its instances. If you choose to terminate the instances, the EC2 Fleet request enters the deleted_terminating state. Otherwise, it enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually. A deleted instant fleet with running instances is not supDryRun (boolean)
FleetIds (array) required
TerminateInstances (boolean) required
ec2/delete_flow_logsDeletes one or more flow logs.DryRun (boolean)
FlowLogIds (array) required
ec2/delete_fpga_imageDeletes the specified Amazon FPGA Image AFI.DryRun (boolean)
FpgaImageId (string) required
ec2/delete_image_usage_reportDeletes the specified image usage report. For more information, see View your AMI usage in the Amazon EC2 User Guide.ReportId (string) required
DryRun (boolean)
ec2/delete_instance_connect_endpointDeletes the specified EC2 Instance Connect Endpoint.DryRun (boolean)
InstanceConnectEndpointId (string) required
ec2/delete_instance_event_windowDeletes the specified event window. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.DryRun (boolean)
ForceDelete (boolean)
InstanceEventWindowId (string) required
ec2/delete_internet_gatewayDeletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.DryRun (boolean)
InternetGatewayId (string) required
ec2/delete_ipamDelete 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.DryRun (boolean)
IpamId (string) required
Cascade (boolean)
ec2/delete_ipam_external_resource_verification_tokenDelete a verification token. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services BYOIP.DryRun (boolean)
IpamExternalResourceVerificationTokenId (string) required
ec2/delete_ipam_policyDeletes an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individualDryRun (boolean)
IpamPolicyId (string) required
ec2/delete_ipam_poolDelete 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.DryRun (boolean)
IpamPoolId (string) required
Cascade (boolean)
ec2/delete_ipam_prefix_list_resolverDeletes an IPAM prefix list resolver. Before deleting a resolver, you must first delete all resolver targets associated with it.DryRun (boolean)
IpamPrefixListResolverId (string) required
ec2/delete_ipam_prefix_list_resolver_targetDeletes an IPAM prefix list resolver target. This removes the association between the resolver and the managed prefix list, stopping automatic CIDR synchronization. For more information about IPAM prefix list resolver, see Automate prefix list updates with IPAM in the Amazon VPC IPAM User Guide.DryRun (boolean)
IpamPrefixListResolverTargetId (string) required
ec2/delete_ipam_resource_discoveryDeletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.DryRun (boolean)
IpamResourceDiscoveryId (string) required
ec2/delete_ipam_scopeDelete 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.DryRun (boolean)
IpamScopeId (string) required
ec2/delete_key_pairDeletes the specified key pair, by removing the public key from Amazon EC2.KeyName (string)
KeyPairId (string)
DryRun (boolean)
ec2/delete_launch_templateDeletes a launch template. Deleting a launch template deletes all of its versions.DryRun (boolean)
LaunchTemplateId (string)
LaunchTemplateName (string)
ec2/delete_launch_template_versionsDeletes one or more versions of a launch template. You can't 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. You can delete up to 200 launch template versions in a single request. To delete more than 200 versions in a single request, use DeleteLaunchTemplate, which deletes the launch template and allDryRun (boolean)
LaunchTemplateId (string)
LaunchTemplateName (string)
Versions (array) required
ec2/delete_local_gateway_routeDeletes the specified route from the specified local gateway route table.DestinationCidrBlock (string)
LocalGatewayRouteTableId (string) required
DryRun (boolean)
DestinationPrefixListId (string)
ec2/delete_local_gateway_route_tableDeletes a local gateway route table.LocalGatewayRouteTableId (string) required
DryRun (boolean)
ec2/delete_local_gateway_route_table_virtual_interface_group_associationDeletes a local gateway route table virtual interface group association.LocalGatewayRouteTableVirtualInterfaceGroupAssociationId (string) required
DryRun (boolean)
ec2/delete_local_gateway_route_table_vpc_associationDeletes the specified association between a VPC and local gateway route table.LocalGatewayRouteTableVpcAssociationId (string) required
DryRun (boolean)
ec2/delete_local_gateway_virtual_interfaceDeletes the specified local gateway virtual interface.LocalGatewayVirtualInterfaceId (string) required
DryRun (boolean)
ec2/delete_local_gateway_virtual_interface_groupDelete the specified local gateway interface group.LocalGatewayVirtualInterfaceGroupId (string) required
DryRun (boolean)
ec2/delete_managed_prefix_listDeletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.DryRun (boolean)
PrefixListId (string) required
ec2/delete_nat_gatewayDeletes 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.DryRun (boolean)
NatGatewayId (string) required
ec2/delete_network_aclDeletes 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.DryRun (boolean)
NetworkAclId (string) required
ec2/delete_network_acl_entryDeletes the specified ingress or egress entry rule from the specified network ACL.DryRun (boolean)
NetworkAclId (string) required
RuleNumber (integer) required
Egress (boolean) required
ec2/delete_network_insights_access_scopeDeletes the specified Network Access Scope.DryRun (boolean)
NetworkInsightsAccessScopeId (string) required
ec2/delete_network_insights_access_scope_analysisDeletes the specified Network Access Scope analysis.NetworkInsightsAccessScopeAnalysisId (string) required
DryRun (boolean)
ec2/delete_network_insights_analysisDeletes the specified network insights analysis.DryRun (boolean)
NetworkInsightsAnalysisId (string) required
ec2/delete_network_insights_pathDeletes the specified path.DryRun (boolean)
NetworkInsightsPathId (string) required
ec2/delete_network_interfaceDeletes the specified network interface. You must detach the network interface before you can delete it.DryRun (boolean)
NetworkInterfaceId (string) required
ec2/delete_network_interface_permissionDeletes 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.NetworkInterfacePermissionId (string) required
Force (boolean)
DryRun (boolean)
ec2/delete_placement_groupDeletes 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.DryRun (boolean)
GroupName (string) required
ec2/delete_public_ipv4poolDelete 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.DryRun (boolean)
PoolId (string) required
NetworkBorderGroup (string)
ec2/delete_queued_reserved_instancesDeletes the queued purchases for the specified Reserved Instances.DryRun (boolean)
ReservedInstancesIds (array) required
ec2/delete_routeDeletes the specified route from the specified route table.DestinationPrefixListId (string)
DryRun (boolean)
RouteTableId (string) required
DestinationCidrBlock (string)
DestinationIpv6CidrBlock (string)
ec2/delete_route_serverDeletes the specified route server. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with thirRouteServerId (string) required
DryRun (boolean)
ec2/delete_route_server_endpointDeletes the specified route server endpoint. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP Border Gateway Protocol connections between your route server and your BGP peers.RouteServerEndpointId (string) required
DryRun (boolean)
ec2/delete_route_server_peerDeletes the specified BGP peer from a route server. A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services such as a firewall appliance or other network security function running on an EC2 instance. The device must meet these requirements: Have an elastic network interface in the VPC Support BGP Border Gateway Protocol Can initiate BGP sessionsRouteServerPeerId (string) required
DryRun (boolean)
ec2/delete_route_tableDeletes 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.DryRun (boolean)
RouteTableId (string) required
ec2/delete_secondary_networkDeletes a secondary network. You must delete all secondary subnets in the secondary network before you can delete the secondary network.ClientToken (string)
DryRun (boolean)
SecondaryNetworkId (string) required
ec2/delete_secondary_subnetDeletes a secondary subnet. A secondary subnet must not contain any secondary interfaces prior to deletion.ClientToken (string)
DryRun (boolean)
SecondarySubnetId (string) required
ec2/delete_security_groupDeletes a security group. If you attempt to delete a security group that is associated with an instance or network interface, is referenced by another security group in the same VPC, or has a VPC association, the operation fails with DependencyViolation.GroupId (string)
GroupName (string)
DryRun (boolean)
ec2/delete_snapshotDeletes 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 devicSnapshotId (string) required
DryRun (boolean)
ec2/delete_spot_datafeed_subscriptionDeletes the data feed for Spot Instances.DryRun (boolean)
ec2/delete_subnetDeletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.SubnetId (string) required
DryRun (boolean)
ec2/delete_subnet_cidr_reservationDeletes a subnet CIDR reservation.SubnetCidrReservationId (string) required
DryRun (boolean)
ec2/delete_tagsDeletes 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.DryRun (boolean)
Resources (array) required
Tags (array)
ec2/delete_traffic_mirror_filterDeletes the specified Traffic Mirror filter. You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.TrafficMirrorFilterId (string) required
DryRun (boolean)
ec2/delete_traffic_mirror_filter_ruleDeletes the specified Traffic Mirror rule.TrafficMirrorFilterRuleId (string) required
DryRun (boolean)
ec2/delete_traffic_mirror_sessionDeletes the specified Traffic Mirror session.TrafficMirrorSessionId (string) required
DryRun (boolean)
ec2/delete_traffic_mirror_targetDeletes the specified Traffic Mirror target. You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.TrafficMirrorTargetId (string) required
DryRun (boolean)
ec2/delete_transit_gatewayDeletes the specified transit gateway.TransitGatewayId (string) required
DryRun (boolean)
ec2/delete_transit_gateway_connectDeletes the specified Connect attachment. You must first delete any Connect peers for the attachment.TransitGatewayAttachmentId (string) required
DryRun (boolean)
ec2/delete_transit_gateway_connect_peerDeletes the specified Connect peer.TransitGatewayConnectPeerId (string) required
DryRun (boolean)
ec2/delete_transit_gateway_metering_policyDeletes a transit gateway metering policy.TransitGatewayMeteringPolicyId (string) required
DryRun (boolean)
ec2/delete_transit_gateway_metering_policy_entryDeletes an entry from a transit gateway metering policy.TransitGatewayMeteringPolicyId (string) required
PolicyRuleNumber (integer) required
DryRun (boolean)
ec2/delete_transit_gateway_multicast_domainDeletes the specified transit gateway multicast domain.TransitGatewayMulticastDomainId (string) required
DryRun (boolean)
ec2/delete_transit_gateway_peering_attachmentDeletes a transit gateway peering attachment.TransitGatewayAttachmentId (string) required
DryRun (boolean)
ec2/delete_transit_gateway_policy_tableDeletes the specified transit gateway policy table.TransitGatewayPolicyTableId (string) required
DryRun (boolean)
ec2/delete_transit_gateway_prefix_list_referenceDeletes a reference route to a prefix list in a specified transit gateway route table.TransitGatewayRouteTableId (string) required
PrefixListId (string) required
DryRun (boolean)
ec2/delete_transit_gateway_routeDeletes the specified route from the specified transit gateway route table.TransitGatewayRouteTableId (string) required
DestinationCidrBlock (string) required
DryRun (boolean)
ec2/delete_transit_gateway_route_tableDeletes the specified transit gateway route table. If there are any route tables associated with the transit gateway route table, you must first run DisassociateRouteTable before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table.TransitGatewayRouteTableId (string) required
DryRun (boolean)
ec2/delete_transit_gateway_route_table_announcementAdvertises to the transit gateway that a transit gateway route table is deleted.TransitGatewayRouteTableAnnouncementId (string) required
DryRun (boolean)
ec2/delete_transit_gateway_vpc_attachmentDeletes the specified VPC attachment.TransitGatewayAttachmentId (string) required
DryRun (boolean)
ec2/delete_verified_access_endpointDelete an Amazon Web Services Verified Access endpoint.VerifiedAccessEndpointId (string) required
ClientToken (string)
DryRun (boolean)
ec2/delete_verified_access_groupDelete an Amazon Web Services Verified Access group.VerifiedAccessGroupId (string) required
ClientToken (string)
DryRun (boolean)
ec2/delete_verified_access_instanceDelete an Amazon Web Services Verified Access instance.VerifiedAccessInstanceId (string) required
DryRun (boolean)
ClientToken (string)
ec2/delete_verified_access_trust_providerDelete an Amazon Web Services Verified Access trust provider.VerifiedAccessTrustProviderId (string) required
DryRun (boolean)
ClientToken (string)
ec2/delete_volumeDeletes 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 EBS User Guide.VolumeId (string) required
DryRun (boolean)
ec2/delete_vpcDeletes 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. When you delete the VPC, it deletes the default security group, network ACL, and route table for the VPC. If you created a flow log for tVpcId (string) required
DryRun (boolean)
ec2/delete_vpc_block_public_access_exclusionDelete a VPC Block Public Access BPA exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC UseDryRun (boolean)
ExclusionId (string) required
ec2/delete_vpc_encryption_controlDeletes a VPC Encryption Control configuration. This removes the encryption policy enforcement from the specified VPC. For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.DryRun (boolean)
VpcEncryptionControlId (string) required
ec2/delete_vpc_endpoint_connection_notificationsDeletes the specified VPC endpoint connection notifications.DryRun (boolean)
ConnectionNotificationIds (array) required
ec2/delete_vpc_endpointsDeletes the specified VPC endpoints. When you delete a gateway endpoint, we delete the endpoint routes in the route tables for the endpoint. When you delete a Gateway Load Balancer endpoint, we delete its 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 its endpoint network interfaces.DryRun (boolean)
VpcEndpointIds (array) required
ec2/delete_vpc_endpoint_service_configurationsDeletes the specified VPC endpoint service configurations. Before you can delete an endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.DryRun (boolean)
ServiceIds (array) required
ec2/delete_vpc_peering_connectionDeletes 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 or rejected state.DryRun (boolean)
VpcPeeringConnectionId (string) required
ec2/delete_vpn_concentratorDeletes the specified VPN concentrator.VpnConcentratorId (string) required
DryRun (boolean)
ec2/delete_vpn_connectionDeletes 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 reconfigVpnConnectionId (string) required
DryRun (boolean)
ec2/delete_vpn_connection_routeDeletes 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.DestinationCidrBlock (string) required
VpnConnectionId (string) required
ec2/delete_vpn_gatewayDeletes 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.VpnGatewayId (string) required
DryRun (boolean)
ec2/deprovision_byoip_cidrReleases 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 and you must not have any IP addresses allocated from its address range.Cidr (string) required
DryRun (boolean)
ec2/deprovision_ipam_byoasnDeprovisions your Autonomous System Number ASN from your Amazon Web Services account. This action can only be called after any BYOIP CIDR associations are removed from your Amazon Web Services account with DisassociateIpamByoasn. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.DryRun (boolean)
IpamId (string) required
Asn (string) required
ec2/deprovision_ipam_pool_cidrDeprovision 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.DryRun (boolean)
IpamPoolId (string) required
Cidr (string)
ec2/deprovision_public_ipv4pool_cidrDeprovision a CIDR from a public IPv4 pool.DryRun (boolean)
PoolId (string) required
Cidr (string) required
ec2/deregister_imageDeregisters the specified AMI. A deregistered AMI can't be used to launch new instances. If a deregistered EBS-backed AMI matches a Recycle Bin retention rule, it moves to the Recycle Bin for the specified retention period. It can be restored before its retention period expires, after which it is permanently deleted. If the deregistered AMI doesn't match a retention rule, it is permanently deleted immediately. For more information, see Recover deleted Amazon EBS snapshots and EBS-backed AMIs witImageId (string) required
DeleteAssociatedSnapshots (boolean)
DryRun (boolean)
ec2/deregister_instance_event_notification_attributesDeregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.DryRun (boolean)
InstanceTagAttribute: {
. IncludeAllTagsOfInstance (boolean)
. InstanceTagKeys (array)
} (object) required
ec2/deregister_transit_gateway_multicast_group_membersDeregisters the specified members network interfaces from the transit gateway multicast group.TransitGatewayMulticastDomainId (string)
GroupIpAddress (string)
NetworkInterfaceIds (array)
DryRun (boolean)
ec2/deregister_transit_gateway_multicast_group_sourcesDeregisters the specified sources network interfaces from the transit gateway multicast group.TransitGatewayMulticastDomainId (string)
GroupIpAddress (string)
NetworkInterfaceIds (array)
DryRun (boolean)
ec2/describe_account_attributesDescribes attributes of your Amazon Web Services account. The following are the supported account attributes: 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. max-elastic-ips: The maximum number of Elastic IP addresses that you can allocDryRun (boolean)
AttributeNames (array)
ec2/describe_addressesDescribes the specified Elastic IP addresses or all of your Elastic IP addresses.PublicIps (array)
DryRun (boolean)
Filters (array)
AllocationIds (array)
ec2/describe_addresses_attributeDescribes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.AllocationIds (array)
Attribute (string)
NextToken (string)
MaxResults (integer)
DryRun (boolean)
ec2/describe_address_transfersDescribes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide. When you transfer an Elastic IP address, there is a two-step handshake between the source and transfer Amazon Web Services accounts. When the source account starts the transfer, the transfer account has seven days to accept the Elastic IP address transfer. During those seven days, the source account can view the pending transfer by using this action. After seven days, tAllocationIds (array)
NextToken (string)
MaxResults (integer)
DryRun (boolean)
ec2/describe_aggregate_id_formatDescribes 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 | imageDryRun (boolean)
ec2/describe_availability_zonesDescribes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon EC2 User Guide. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.ZoneNames (array)
ZoneIds (array)
AllAvailabilityZones (boolean)
DryRun (boolean)
Filters (array)
ec2/describe_aws_network_performance_metric_subscriptionsDescribes the current Infrastructure Performance metric subscriptions.MaxResults (integer)
NextToken (string)
Filters (array)
DryRun (boolean)
ec2/describe_bundle_tasksDescribes 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. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.BundleIds (array)
DryRun (boolean)
Filters (array)
ec2/describe_byoip_cidrsDescribes the IP address ranges that were provisioned for use with Amazon Web Services resources through through bring your own IP addresses BYOIP.DryRun (boolean)
MaxResults (integer) required
NextToken (string)
ec2/describe_capacity_block_extension_historyDescribes the events for the specified Capacity Block extension during the specified time.CapacityReservationIds (array)
NextToken (string)
MaxResults (integer)
Filters (array)
DryRun (boolean)
ec2/describe_capacity_block_extension_offeringsDescribes Capacity Block extension offerings available for purchase in the Amazon Web Services Region that you're currently using.DryRun (boolean)
CapacityBlockExtensionDurationHours (integer) required
CapacityReservationId (string) required
NextToken (string)
MaxResults (integer)
ec2/describe_capacity_block_offeringsDescribes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you can purchase a specific GPU instance type or EC2 UltraServer for a period of time. To search for an available Capacity Block offering, you specify a reservation duration and instance count.DryRun (boolean)
InstanceType (string)
InstanceCount (integer)
StartDateRange (string)
EndDateRange (string)
CapacityDurationHours (integer) required
NextToken (string)
MaxResults (integer)
UltraserverType (string)
UltraserverCount (integer)
ec2/describe_capacity_blocksDescribes details about Capacity Blocks in the Amazon Web Services Region that you're currently using.CapacityBlockIds (array)
NextToken (string)
MaxResults (integer)
Filters (array)
DryRun (boolean)
ec2/describe_capacity_block_statusDescribes the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks.CapacityBlockIds (array)
NextToken (string)
MaxResults (integer)
Filters (array)
DryRun (boolean)
ec2/describe_capacity_manager_data_exportsDescribes one or more Capacity Manager data export configurations. Returns information about export settings, delivery status, and recent export activity.CapacityManagerDataExportIds (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
Filters (array)
ec2/describe_capacity_reservation_billing_requestsDescribes a request to assign the billing of the unused capacity of a Capacity Reservation. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.CapacityReservationIds (array)
Role (string) required
NextToken (string)
MaxResults (integer)
Filters (array)
DryRun (boolean)
ec2/describe_capacity_reservation_fleetsDescribes one or more Capacity Reservation Fleets.CapacityReservationFleetIds (array)
NextToken (string)
MaxResults (integer)
Filters (array)
DryRun (boolean)
ec2/describe_capacity_reservationsDescribes 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.CapacityReservationIds (array)
NextToken (string)
MaxResults (integer)
Filters (array)
DryRun (boolean)
ec2/describe_capacity_reservation_topologyDescribes a tree-based hierarchy that represents the physical host placement of your pending or active Capacity Reservations within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your capacity within the Amazon Web Services network before it is launched and use this information to allocate capacity together to support your tightly coupled workloads. Capacity Reservation topology is supported for specific instance types only. For more inforDryRun (boolean)
NextToken (string)
MaxResults (integer)
CapacityReservationIds (array)
Filters (array)
ec2/describe_carrier_gatewaysDescribes one or more of your carrier gateways.CarrierGatewayIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_classic_link_instancesThis action is deprecated. Describes 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.DryRun (boolean)
InstanceIds (array)
Filters (array)
NextToken (string)
MaxResults (integer)
ec2/describe_client_vpn_authorization_rulesDescribes the authorization rules for a specified Client VPN endpoint.ClientVpnEndpointId (string) required
DryRun (boolean)
NextToken (string)
Filters (array)
MaxResults (integer)
ec2/describe_client_vpn_connectionsDescribes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.ClientVpnEndpointId (string) required
Filters (array)
NextToken (string)
MaxResults (integer)
DryRun (boolean)
ec2/describe_client_vpn_endpointsDescribes one or more Client VPN endpoints in the account.ClientVpnEndpointIds (array)
MaxResults (integer)
NextToken (string)
Filters (array)
DryRun (boolean)
ec2/describe_client_vpn_routesDescribes the routes for the specified Client VPN endpoint.ClientVpnEndpointId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_client_vpn_target_networksDescribes the target networks associated with the specified Client VPN endpoint.ClientVpnEndpointId (string) required
AssociationIds (array)
MaxResults (integer)
NextToken (string)
Filters (array)
DryRun (boolean)
ec2/describe_coip_poolsDescribes the specified customer-owned address pools or all of your customer-owned address pools.PoolIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_conversion_tasksDescribes 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.DryRun (boolean)
ConversionTaskIds (array)
ec2/describe_customer_gatewaysDescribes 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.CustomerGatewayIds (array)
Filters (array)
DryRun (boolean)
ec2/describe_declarative_policies_reportsDescribes the metadata of an account status report, including the status of the report. To view the full report, download it from the Amazon S3 bucket where it was saved. Reports are accessible only when they have the complete status. Reports with other statuses running, cancelled, or error are not available in the S3 bucket. For more information about downloading objects from an S3 bucket, see Downloading objects in the Amazon Simple Storage Service User Guide. For more information, see GeneratDryRun (boolean)
NextToken (string)
MaxResults (integer)
ReportIds (array)
ec2/describe_dhcp_optionsDescribes your DHCP option sets. The default is to describe all your DHCP option sets. Alternatively, you can specify specific DHCP option set IDs or filter the results to include only the DHCP option sets that match specific criteria. For more information, see DHCP option sets in the Amazon VPC User Guide.DhcpOptionsIds (array)
NextToken (string)
MaxResults (integer)
DryRun (boolean)
Filters (array)
ec2/describe_egress_only_internet_gatewaysDescribes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to include only the egress-only internet gateways that match specific criteria.DryRun (boolean)
EgressOnlyInternetGatewayIds (array)
MaxResults (integer)
NextToken (string)
Filters (array)
ec2/describe_elastic_gpusAmazon Elastic Graphics reached end of life on January 8, 2024. Describes the Elastic Graphics accelerator associated with your instances.ElasticGpuIds (array)
DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_export_image_tasksDescribes the specified export image tasks or all of your export image tasks.DryRun (boolean)
Filters (array)
ExportImageTaskIds (array)
MaxResults (integer)
NextToken (string)
ec2/describe_export_tasksDescribes the specified export instance tasks or all of your export instance tasks.Filters (array)
ExportTaskIds (array)
ec2/describe_fast_launch_imagesDescribe details for Windows AMIs that are configured for Windows fast launch.ImageIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_fast_snapshot_restoresDescribes the state of fast snapshot restores for your snapshots.Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_fleet_historyDescribes 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.DryRun (boolean)
EventType (string)
MaxResults (integer)
NextToken (string)
FleetId (string) required
StartTime (string) required
ec2/describe_fleet_instancesDescribes the running instances for the specified EC2 Fleet. Currently, DescribeFleetInstances does not support fleets of type instant. Instead, use DescribeFleets, specifying the instant fleet ID in the request. For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.DryRun (boolean)
MaxResults (integer)
NextToken (string)
FleetId (string) required
Filters (array)
ec2/describe_fleetsDescribes the specified EC2 Fleet or all of your EC2 Fleets. If a fleet is of type instant, you must specify the fleet ID in the request, otherwise the fleet does not appear in the response. For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.DryRun (boolean)
MaxResults (integer)
NextToken (string)
FleetIds (array)
Filters (array)
ec2/describe_flow_logsDescribes 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.DryRun (boolean)
Filter (array)
FlowLogIds (array)
MaxResults (integer)
NextToken (string)
ec2/describe_fpga_image_attributeDescribes the specified attribute of the specified Amazon FPGA Image AFI.DryRun (boolean)
FpgaImageId (string) required
Attribute (string) required
ec2/describe_fpga_imagesDescribes 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.DryRun (boolean)
FpgaImageIds (array)
Owners (array)
Filters (array)
NextToken (string)
MaxResults (integer)
ec2/describe_host_reservation_offeringsDescribes 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 GuidFilter (array)
MaxDuration (integer)
MaxResults (integer)
MinDuration (integer)
NextToken (string)
OfferingId (string)
ec2/describe_host_reservationsDescribes reservations that are associated with Dedicated Hosts in your account.Filter (array)
HostReservationIdSet (array)
MaxResults (integer)
NextToken (string)
ec2/describe_hostsDescribes 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.HostIds (array)
NextToken (string)
MaxResults (integer)
Filter (array)
ec2/describe_iam_instance_profile_associationsDescribes your IAM instance profile associations.AssociationIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_identity_id_formatDescribes 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 | customerResource (string)
PrincipalArn (string) required
ec2/describe_id_formatDescribes 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-taskResource (string)
ec2/describe_image_attributeDescribes the specified attribute of the specified AMI. You can specify only one attribute at a time. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.Attribute (string) required
ImageId (string) required
DryRun (boolean)
ec2/describe_image_referencesDescribes your Amazon Web Services resources that are referencing the specified images. For more information, see Identify your resources referencing specified AMIs in the Amazon EC2 User Guide.ImageIds (array) required
IncludeAllResourceTypes (boolean)
ResourceTypes (array)
NextToken (string)
DryRun (boolean)
MaxResults (integer)
ec2/describe_imagesDescribes 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 oExecutableUsers (array)
ImageIds (array)
Owners (array)
IncludeDeprecated (boolean)
IncludeDisabled (boolean)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
Filters (array)
ec2/describe_image_usage_report_entriesDescribes the entries in image usage reports, showing how your images are used across other Amazon Web Services accounts. For more information, see View your AMI usage in the Amazon EC2 User Guide.ImageIds (array)
ReportIds (array)
NextToken (string)
Filters (array)
DryRun (boolean)
MaxResults (integer)
ec2/describe_image_usage_reportsDescribes the configuration and status of image usage reports, filtered by report IDs or image IDs. For more information, see View your AMI usage in the Amazon EC2 User Guide.ImageIds (array)
ReportIds (array)
NextToken (string)
Filters (array)
DryRun (boolean)
MaxResults (integer)
ec2/describe_import_image_tasksDisplays details about an import virtual machine or import snapshot tasks that are already created.DryRun (boolean)
Filters (array)
ImportTaskIds (array)
MaxResults (integer)
NextToken (string)
ec2/describe_import_snapshot_tasksDescribes your import snapshot tasks.DryRun (boolean)
Filters (array)
ImportTaskIds (array)
MaxResults (integer)
NextToken (string)
ec2/describe_instance_attributeDescribes the specified attribute of the specified instance. You can specify only one attribute at a time. Available attributes include SQL license exemption configuration for instances registered with the SQL LE service.DryRun (boolean)
InstanceId (string) required
Attribute (string) required
ec2/describe_instance_connect_endpointsDescribes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.DryRun (boolean)
MaxResults (integer)
NextToken (string)
Filters (array)
InstanceConnectEndpointIds (array)
ec2/describe_instance_credit_specificationsDescribes 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 instanceDryRun (boolean)
Filters (array)
InstanceIds (array)
MaxResults (integer)
NextToken (string)
ec2/describe_instance_event_notification_attributesDescribes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.DryRun (boolean)
ec2/describe_instance_event_windowsDescribes 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 anDryRun (boolean)
InstanceEventWindowIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_instance_image_metadataDescribes the AMI that was used to launch an instance, even if the AMI is deprecated, deregistered, made private no longer public or shared with your account, or not allowed. 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 perFilters (array)
InstanceIds (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_instancesDescribes 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. The responseInstanceIds (array)
DryRun (boolean)
Filters (array)
NextToken (string)
MaxResults (integer)
ec2/describe_instance_sql_ha_history_statesDescribes the historical SQL Server High Availability states for Amazon EC2 instances that are enabled for Amazon EC2 High Availability for SQL Server monitoring.InstanceIds (array)
StartTime (string)
EndTime (string)
NextToken (string)
MaxResults (integer)
Filters (array)
DryRun (boolean)
ec2/describe_instance_sql_ha_statesDescribes the SQL Server High Availability states for Amazon EC2 instances that are enabled for Amazon EC2 High Availability for SQL Server monitoring.InstanceIds (array)
NextToken (string)
MaxResults (integer)
Filters (array)
DryRun (boolean)
ec2/describe_instance_statusDescribes 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 GInstanceIds (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
Filters (array)
IncludeAllInstances (boolean)
ec2/describe_instance_topologyDescribes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads. Instance topology is supported for specific instance types only. For more information, see Prerequisites for Amazon EC2 instance topology in the Amazon EC2 User Guide. The Amazon EC2 API foDryRun (boolean)
NextToken (string)
MaxResults (integer)
InstanceIds (array)
GroupNames (array)
Filters (array)
ec2/describe_instance_type_offeringsLists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.DryRun (boolean)
LocationType (string)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_instance_typesDescribes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.DryRun (boolean)
InstanceTypes (array)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_internet_gatewaysDescribes your internet gateways. The default is to describe all your internet gateways. Alternatively, you can specify specific internet gateway IDs or filter the results to include only the internet gateways that match specific criteria.NextToken (string)
MaxResults (integer)
DryRun (boolean)
InternetGatewayIds (array)
Filters (array)
ec2/describe_ipam_byoasnDescribes your Autonomous System Numbers ASNs, their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.DryRun (boolean)
MaxResults (integer)
NextToken (string)
ec2/describe_ipam_external_resource_verification_tokensDescribe verification tokens. A verification token is an Amazon Web Services-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to Amazon Web Services BYOIP.DryRun (boolean)
Filters (array)
NextToken (string)
MaxResults (integer)
IpamExternalResourceVerificationTokenIds (array)
ec2/describe_ipam_policiesDescribes one or more IPAM policies. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied toDryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
IpamPolicyIds (array)
ec2/describe_ipam_poolsGet information about your IPAM pools.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
IpamPoolIds (array)
ec2/describe_ipam_prefix_list_resolversDescribes one or more IPAM prefix list resolvers. Use this operation to view the configuration, status, and properties of your resolvers.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
IpamPrefixListResolverIds (array)
ec2/describe_ipam_prefix_list_resolver_targetsDescribes one or more IPAM prefix list resolver Targets. Use this operation to view the configuration and status of resolver targets.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
IpamPrefixListResolverTargetIds (array)
IpamPrefixListResolverId (string)
ec2/describe_ipam_resource_discoveriesDescribes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.DryRun (boolean)
IpamResourceDiscoveryIds (array)
NextToken (string)
MaxResults (integer)
Filters (array)
ec2/describe_ipam_resource_discovery_associationsDescribes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..DryRun (boolean)
IpamResourceDiscoveryAssociationIds (array)
NextToken (string)
MaxResults (integer)
Filters (array)
ec2/describe_ipamsGet information about your IPAM pools. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
IpamIds (array)
ec2/describe_ipam_scopesGet information about your IPAM scopes.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
IpamScopeIds (array)
ec2/describe_ipv6poolsDescribes your IPv6 address pools.PoolIds (array)
NextToken (string)
MaxResults (integer)
DryRun (boolean)
Filters (array)
ec2/describe_key_pairsDescribes the specified key pairs or all of your key pairs. For more information about key pairs, see Amazon EC2 key pairs in the Amazon EC2 User Guide.KeyNames (array)
KeyPairIds (array)
IncludePublicKey (boolean)
DryRun (boolean)
Filters (array)
ec2/describe_launch_templatesDescribes one or more launch templates.DryRun (boolean)
LaunchTemplateIds (array)
LaunchTemplateNames (array)
Filters (array)
NextToken (string)
MaxResults (integer)
ec2/describe_launch_template_versionsDescribes 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.DryRun (boolean)
LaunchTemplateId (string)
LaunchTemplateName (string)
Versions (array)
MinVersion (string)
MaxVersion (string)
NextToken (string)
MaxResults (integer)
Filters (array)
ResolveAlias (boolean)
ec2/describe_local_gateway_route_tablesDescribes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.LocalGatewayRouteTableIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_local_gateway_route_table_virtual_interface_group_associationsDescribes the associations between virtual interface groups and local gateway route tables.LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_local_gateway_route_table_vpc_associationsDescribes the specified associations between VPCs and local gateway route tables.LocalGatewayRouteTableVpcAssociationIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_local_gatewaysDescribes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.LocalGatewayIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_local_gateway_virtual_interface_groupsDescribes the specified local gateway virtual interface groups.LocalGatewayVirtualInterfaceGroupIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_local_gateway_virtual_interfacesDescribes the specified local gateway virtual interfaces.LocalGatewayVirtualInterfaceIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_locked_snapshotsDescribes the lock status for a snapshot.Filters (array)
MaxResults (integer)
NextToken (string)
SnapshotIds (array)
DryRun (boolean)
ec2/describe_mac_hostsDescribes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts.Filters (array)
HostIds (array)
MaxResults (integer)
NextToken (string)
ec2/describe_mac_modification_tasksDescribes a System Integrity Protection SIP modification task or volume ownership delegation task for an Amazon EC2 Mac instance. For more information, see Configure SIP for Amazon EC2 instances in the Amazon EC2 User Guide.DryRun (boolean)
Filters (array)
MacModificationTaskIds (array)
MaxResults (integer)
NextToken (string)
ec2/describe_managed_prefix_listsDescribes your managed prefix lists and any Amazon Web Services-managed prefix lists.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
PrefixListIds (array)
ec2/describe_moving_addressesThis action is deprecated. Describes your Elastic IP addresses that are being moved from or being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.DryRun (boolean)
PublicIps (array)
NextToken (string)
Filters (array)
MaxResults (integer)
ec2/describe_nat_gatewaysDescribes your NAT gateways. The default is to describe all your NAT gateways. Alternatively, you can specify specific NAT gateway IDs or filter the results to include only the NAT gateways that match specific criteria.DryRun (boolean)
Filter (array)
MaxResults (integer)
NatGatewayIds (array)
NextToken (string)
ec2/describe_network_aclsDescribes your network ACLs. The default is to describe all your network ACLs. Alternatively, you can specify specific network ACL IDs or filter the results to include only the network ACLs that match specific criteria. For more information, see Network ACLs in the Amazon VPC User Guide.NextToken (string)
MaxResults (integer)
DryRun (boolean)
NetworkAclIds (array)
Filters (array)
ec2/describe_network_insights_access_scope_analysesDescribes the specified Network Access Scope analyses.NetworkInsightsAccessScopeAnalysisIds (array)
NetworkInsightsAccessScopeId (string)
AnalysisStartTimeBegin (string)
AnalysisStartTimeEnd (string)
Filters (array)
MaxResults (integer)
DryRun (boolean)
NextToken (string)
ec2/describe_network_insights_access_scopesDescribes the specified Network Access Scopes.NetworkInsightsAccessScopeIds (array)
Filters (array)
MaxResults (integer)
DryRun (boolean)
NextToken (string)
ec2/describe_network_insights_analysesDescribes one or more of your network insights analyses.NetworkInsightsAnalysisIds (array)
NetworkInsightsPathId (string)
AnalysisStartTime (string)
AnalysisEndTime (string)
Filters (array)
MaxResults (integer)
DryRun (boolean)
NextToken (string)
ec2/describe_network_insights_pathsDescribes one or more of your paths.NetworkInsightsPathIds (array)
Filters (array)
MaxResults (integer)
DryRun (boolean)
NextToken (string)
ec2/describe_network_interface_attributeDescribes a network interface attribute. You can specify only one attribute at a time.DryRun (boolean)
NetworkInterfaceId (string) required
Attribute (string)
ec2/describe_network_interface_permissionsDescribes the permissions for your network interfaces.NetworkInterfacePermissionIds (array)
Filters (array)
NextToken (string)
MaxResults (integer)
ec2/describe_network_interfacesDescribes the specified network interfaces or all your network interfaces. If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: group-id, mac-address, private-dns-name, private-ip-address, subnet-id, or vpc-id. We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.NextToken (string)
MaxResults (integer)
DryRun (boolean)
NetworkInterfaceIds (array)
Filters (array)
ec2/describe_outpost_lagsDescribes the Outposts link aggregation groups LAGs. LAGs are only available for second-generation Outposts racks at this time.OutpostLagIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_placement_groupsDescribes the specified placement groups or all of your placement groups. To describe a specific placement group that is shared with your account, you must specify the ID of the placement group using the GroupId parameter. Specifying the name of a shared placement group using the GroupNames parameter will result in an error. For more information, see Placement groups in the Amazon EC2 User Guide.GroupIds (array)
DryRun (boolean)
GroupNames (array)
Filters (array)
ec2/describe_prefix_listsDescribes 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.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
PrefixListIds (array)
ec2/describe_principal_id_formatDescribes 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 |DryRun (boolean)
Resources (array)
MaxResults (integer)
NextToken (string)
ec2/describe_public_ipv4poolsDescribes the specified IPv4 address pools.PoolIds (array)
NextToken (string)
MaxResults (integer)
Filters (array)
ec2/describe_regionsDescribes the Regions that are enabled for your account, or all Regions. For a list of the Regions supported by Amazon EC2, see Amazon EC2 service endpoints. For information about enabling and disabling Regions for your account, see Specify which Amazon Web Services Regions your account can use in the Amazon Web Services Account Management Reference Guide. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elementsRegionNames (array)
AllRegions (boolean)
DryRun (boolean)
Filters (array)
ec2/describe_replace_root_volume_tasksDescribes a root volume replacement task. For more information, see Replace a root volume in the Amazon EC2 User Guide.ReplaceRootVolumeTaskIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_reserved_instancesDescribes 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. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.OfferingClass (string)
ReservedInstancesIds (array)
DryRun (boolean)
Filters (array)
OfferingType (string)
ec2/describe_reserved_instances_listingsDescribes 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 fReservedInstancesId (string)
ReservedInstancesListingId (string)
Filters (array)
ec2/describe_reserved_instances_modificationsDescribes 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 Modify Reserved Instances in the Amazon EC2 User Guide. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear iReservedInstancesModificationIds (array)
NextToken (string)
Filters (array)
ec2/describe_reserved_instances_offeringsDescribes 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 youAvailabilityZone (string)
IncludeMarketplace (boolean)
InstanceType (string)
MaxDuration (integer)
MaxInstanceCount (integer)
MinDuration (integer)
OfferingClass (string)
ProductDescription (string)
ReservedInstancesOfferingIds (array)
AvailabilityZoneId (string)
DryRun (boolean)
Filters (array)
InstanceTenancy (string)
OfferingType (string)
NextToken (string)
MaxResults (integer)
ec2/describe_route_server_endpointsDescribes one or more route server endpoints. A route server endpoint is an Amazon Web Services-managed component inside a subnet that facilitates BGP Border Gateway Protocol connections between your route server and your BGP peers. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.RouteServerEndpointIds (array)
NextToken (string)
MaxResults (integer)
Filters (array)
DryRun (boolean)
ec2/describe_route_server_peersDescribes one or more route server peers. A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services such as a firewall appliance or other network security function running on an EC2 instance. The device must meet these requirements: Have an elastic network interface in the VPC Support BGP Border Gateway Protocol Can initiate BGP sessions For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.RouteServerPeerIds (array)
NextToken (string)
MaxResults (integer)
Filters (array)
DryRun (boolean)
ec2/describe_route_serversDescribes one or more route servers. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with thiRouteServerIds (array)
NextToken (string)
MaxResults (integer)
Filters (array)
DryRun (boolean)
ec2/describe_route_tablesDescribes your route tables. The default is to describe all your route tables. Alternatively, you can specify specific route table IDs or filter the results to include only the route tables that match specific criteria. 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 RouNextToken (string)
MaxResults (integer)
DryRun (boolean)
RouteTableIds (array)
Filters (array)
ec2/describe_scheduled_instance_availabilityFinds 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.DryRun (boolean)
Filters (array)
FirstSlotStartTimeRange: {
. EarliestTime (string)
. LatestTime (string)
} (object) required
MaxResults (integer)
MaxSlotDurationInHours (integer)
MinSlotDurationInHours (integer)
NextToken (string)
Recurrence: {
. Frequency (string)
. Interval (integer)
. OccurrenceDays (array)
. OccurrenceRelativeToEnd (boolean)
. OccurrenceUnit (string)
} (object) required
ec2/describe_scheduled_instancesDescribes the specified Scheduled Instances or all your Scheduled Instances.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
ScheduledInstanceIds (array)
SlotStartTimeRange: {
. EarliestTime (string)
. LatestTime (string)
} (object)
ec2/describe_secondary_interfacesDescribes one or more of your secondary interfaces.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
SecondaryInterfaceIds (array)
ec2/describe_secondary_networksDescribes one or more secondary networks.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
SecondaryNetworkIds (array)
ec2/describe_secondary_subnetsDescribes one or more of your secondary subnets.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
SecondarySubnetIds (array)
ec2/describe_security_group_referencesDescribes the VPCs on the other side of a VPC peering or Transit Gateway connection that are referencing the security groups you've specified in this request.DryRun (boolean)
GroupId (array) required
ec2/describe_security_group_rulesDescribes one or more of your security group rules.Filters (array)
SecurityGroupRuleIds (array)
DryRun (boolean)
NextToken (string)
MaxResults (integer)
ec2/describe_security_groupsDescribes the specified security groups or all of your security groups.GroupIds (array)
GroupNames (array)
NextToken (string)
MaxResults (integer)
DryRun (boolean)
Filters (array)
ec2/describe_security_group_vpc_associationsDescribes security group VPC associations made with AssociateSecurityGroupVpc.Filters (array)
NextToken (string)
MaxResults (integer)
DryRun (boolean)
ec2/describe_service_link_virtual_interfacesDescribes the Outpost service link virtual interfaces.ServiceLinkVirtualInterfaceIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_snapshot_attributeDescribes 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 EBS User Guide.Attribute (string) required
SnapshotId (string) required
DryRun (boolean)
ec2/describe_snapshotsDescribes 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 ServiMaxResults (integer)
NextToken (string)
OwnerIds (array)
RestorableByUserIds (array)
SnapshotIds (array)
DryRun (boolean)
Filters (array)
ec2/describe_snapshot_tier_statusDescribes the storage tier status of one or more Amazon EBS snapshots.Filters (array)
DryRun (boolean)
NextToken (string)
MaxResults (integer)
ec2/describe_spot_datafeed_subscriptionDescribes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide.DryRun (boolean)
ec2/describe_spot_fleet_instancesDescribes the running instances for the specified Spot Fleet.DryRun (boolean)
SpotFleetRequestId (string) required
NextToken (string)
MaxResults (integer)
ec2/describe_spot_fleet_request_historyDescribes 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.DryRun (boolean)
SpotFleetRequestId (string) required
EventType (string)
StartTime (string) required
NextToken (string)
MaxResults (integer)
ec2/describe_spot_fleet_requestsDescribes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.DryRun (boolean)
SpotFleetRequestIds (array)
NextToken (string)
MaxResults (integer)
ec2/describe_spot_instance_requestsDescribes 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 items retNextToken (string)
MaxResults (integer)
DryRun (boolean)
SpotInstanceRequestIds (array)
Filters (array)
ec2/describe_spot_price_historyDescribes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide. 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.AvailabilityZoneId (string)
DryRun (boolean)
StartTime (string)
EndTime (string)
InstanceTypes (array)
ProductDescriptions (array)
Filters (array)
AvailabilityZone (string)
MaxResults (integer)
NextToken (string)
ec2/describe_stale_security_groupsDescribes the stale security group rules for security groups referenced across a VPC peering connection, transit gateway connection, or with a security group VPC association. Rules are stale when they reference a deleted security group. Rules can also be stale if they reference a security group in a peer VPC for which the VPC peering connection has been deleted, across a transit gateway where the transit gateway has been deleted or the transit gateway security group referencing feature has beenDryRun (boolean)
MaxResults (integer)
NextToken (string)
VpcId (string) required
ec2/describe_store_image_tasksDescribes 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 mustImageIds (array)
DryRun (boolean)
Filters (array)
NextToken (string)
MaxResults (integer)
ec2/describe_subnetsDescribes your subnets. The default is to describe all your subnets. Alternatively, you can specify specific subnet IDs or filter the results to include only the subnets that match specific criteria. For more information, see Subnets in the Amazon VPC User Guide.Filters (array)
SubnetIds (array)
NextToken (string)
MaxResults (integer)
DryRun (boolean)
ec2/describe_tagsDescribes 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. We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_traffic_mirror_filter_rulesDescribe traffic mirror filters that determine the traffic that is mirrored.TrafficMirrorFilterRuleIds (array)
TrafficMirrorFilterId (string)
DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_traffic_mirror_filtersDescribes one or more Traffic Mirror filters.TrafficMirrorFilterIds (array)
DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_traffic_mirror_sessionsDescribes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.TrafficMirrorSessionIds (array)
DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_traffic_mirror_targetsInformation about one or more Traffic Mirror targets.TrafficMirrorTargetIds (array)
DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_transit_gateway_attachmentsDescribes 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.TransitGatewayAttachmentIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_transit_gateway_connect_peersDescribes one or more Connect peers.TransitGatewayConnectPeerIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_transit_gateway_connectsDescribes one or more Connect attachments.TransitGatewayAttachmentIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_transit_gateway_metering_policiesDescribes one or more transit gateway metering policies.TransitGatewayMeteringPolicyIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_transit_gateway_multicast_domainsDescribes one or more transit gateway multicast domains.TransitGatewayMulticastDomainIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_transit_gateway_peering_attachmentsDescribes your transit gateway peering attachments.TransitGatewayAttachmentIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_transit_gateway_policy_tablesDescribes one or more transit gateway route policy tables.TransitGatewayPolicyTableIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_transit_gateway_route_table_announcementsDescribes one or more transit gateway route table advertisements.TransitGatewayRouteTableAnnouncementIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_transit_gateway_route_tablesDescribes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.TransitGatewayRouteTableIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_transit_gatewaysDescribes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.TransitGatewayIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_transit_gateway_vpc_attachmentsDescribes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.TransitGatewayAttachmentIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_trunk_interface_associationsDescribes one or more network interface trunk associations.AssociationIds (array)
DryRun (boolean)
Filters (array)
NextToken (string)
MaxResults (integer)
ec2/describe_verified_access_endpointsDescribes the specified Amazon Web Services Verified Access endpoints.VerifiedAccessEndpointIds (array)
VerifiedAccessInstanceId (string)
VerifiedAccessGroupId (string)
MaxResults (integer)
NextToken (string)
Filters (array)
DryRun (boolean)
ec2/describe_verified_access_groupsDescribes the specified Verified Access groups.VerifiedAccessGroupIds (array)
VerifiedAccessInstanceId (string)
MaxResults (integer)
NextToken (string)
Filters (array)
DryRun (boolean)
ec2/describe_verified_access_instance_logging_configurationsDescribes the specified Amazon Web Services Verified Access instances.VerifiedAccessInstanceIds (array)
MaxResults (integer)
NextToken (string)
Filters (array)
DryRun (boolean)
ec2/describe_verified_access_instancesDescribes the specified Amazon Web Services Verified Access instances.VerifiedAccessInstanceIds (array)
MaxResults (integer)
NextToken (string)
Filters (array)
DryRun (boolean)
ec2/describe_verified_access_trust_providersDescribes the specified Amazon Web Services Verified Access trust providers.VerifiedAccessTrustProviderIds (array)
MaxResults (integer)
NextToken (string)
Filters (array)
DryRun (boolean)
ec2/describe_volume_attributeDescribes 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 EBS User Guide.Attribute (string) required
VolumeId (string) required
DryRun (boolean)
ec2/describe_volumesDescribes 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. For more information, see Pagination. For more information about EBS volumes, see Amazon EBS volumes in the Amazon EBS User Guide. We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts. The order of the elements in the response, including those withinVolumeIds (array)
DryRun (boolean)
Filters (array)
NextToken (string)
MaxResults (integer)
ec2/describe_volumes_modificationsDescribes the most recent volume modification request for the specified EBS volumes. For more information, see Monitor the progress of volume modifications in the Amazon EBS User Guide.DryRun (boolean)
VolumeIds (array)
Filters (array)
NextToken (string)
MaxResults (integer)
ec2/describe_volume_statusDescribes 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 nMaxResults (integer)
NextToken (string)
VolumeIds (array)
DryRun (boolean)
Filters (array)
ec2/describe_vpc_attributeDescribes the specified attribute of the specified VPC. You can specify only one attribute at a time.Attribute (string) required
VpcId (string) required
DryRun (boolean)
ec2/describe_vpc_block_public_access_exclusionsDescribe VPC Block Public Access BPA exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC UsDryRun (boolean)
Filters (array)
ExclusionIds (array)
NextToken (string)
MaxResults (integer)
ec2/describe_vpc_block_public_access_optionsDescribe VPC Block Public Access BPA options. VPC Block Public Access BPA enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.DryRun (boolean)
ec2/describe_vpc_classic_linkThis action is deprecated. Describes the ClassicLink status of the specified VPCs.DryRun (boolean)
VpcIds (array)
Filters (array)
ec2/describe_vpc_classic_link_dns_supportThis action is deprecated. 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.VpcIds (array)
MaxResults (integer)
NextToken (string)
ec2/describe_vpc_encryption_controlsDescribes one or more VPC Encryption Control configurations. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements You can filter the results to return information about specific encryption controls or VPCs. For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.DryRun (boolean)
Filters (array)
VpcEncryptionControlIds (array)
VpcIds (array)
NextToken (string)
MaxResults (integer)
ec2/describe_vpc_endpoint_associationsDescribes the VPC resources, VPC endpoint services, Amazon Lattice services, or service networks associated with the VPC endpoint.DryRun (boolean)
VpcEndpointIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_vpc_endpoint_connection_notificationsDescribes the connection notifications for VPC endpoints and VPC endpoint services.DryRun (boolean)
ConnectionNotificationId (string)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_vpc_endpoint_connectionsDescribes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_vpc_endpointsDescribes your VPC endpoints. The default is to describe all your VPC endpoints. Alternatively, you can specify specific VPC endpoint IDs or filter the results to include only the VPC endpoints that match specific criteria.DryRun (boolean)
VpcEndpointIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_vpc_endpoint_service_configurationsDescribes the VPC endpoint service configurations in your account your services.DryRun (boolean)
ServiceIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_vpc_endpoint_service_permissionsDescribes the principals service consumers that are permitted to discover your VPC endpoint service. Principal ARNs with path components aren't supported.DryRun (boolean)
ServiceId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/describe_vpc_endpoint_servicesDescribes 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-eaDryRun (boolean)
ServiceNames (array)
Filters (array)
MaxResults (integer)
NextToken (string)
ServiceRegions (array)
ec2/describe_vpc_peering_connectionsDescribes your VPC peering connections. The default is to describe all your VPC peering connections. Alternatively, you can specify specific VPC peering connection IDs or filter the results to include only the VPC peering connections that match specific criteria.NextToken (string)
MaxResults (integer)
DryRun (boolean)
VpcPeeringConnectionIds (array)
Filters (array)
ec2/describe_vpcsDescribes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs that match specific criteria.Filters (array)
VpcIds (array)
NextToken (string)
MaxResults (integer)
DryRun (boolean)
ec2/describe_vpn_concentratorsDescribes one or more of your VPN concentrators.VpnConcentratorIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/describe_vpn_connectionsDescribes 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.Filters (array)
VpnConnectionIds (array)
DryRun (boolean)
ec2/describe_vpn_gatewaysDescribes 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.Filters (array)
VpnGatewayIds (array)
DryRun (boolean)
ec2/detach_classic_link_vpcThis action is deprecated. 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.DryRun (boolean)
InstanceId (string) required
VpcId (string) required
ec2/detach_internet_gatewayDetaches 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.DryRun (boolean)
InternetGatewayId (string) required
VpcId (string) required
ec2/detach_network_interfaceDetaches a network interface from an instance.DryRun (boolean)
AttachmentId (string) required
Force (boolean)
ec2/detach_verified_access_trust_providerDetaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.VerifiedAccessInstanceId (string) required
VerifiedAccessTrustProviderId (string) required
ClientToken (string)
DryRun (boolean)
ec2/detach_volumeDetaches 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 theDevice (string)
Force (boolean)
InstanceId (string)
VolumeId (string) required
DryRun (boolean)
ec2/detach_vpn_gatewayDetaches 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.VpcId (string) required
VpnGatewayId (string) required
DryRun (boolean)
ec2/disable_address_transferDisables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.AllocationId (string) required
DryRun (boolean)
ec2/disable_allowed_images_settingsDisables Allowed AMIs for your account in the specified Amazon Web Services Region. When set to disabled, the image criteria in your Allowed AMIs settings do not apply, and no restrictions are placed on AMI discoverability or usage. Users in your account can launch instances using any public AMI or AMI shared with your account. The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverablDryRun (boolean)
ec2/disable_aws_network_performance_metric_subscriptionDisables Infrastructure Performance metric subscriptions.Source (string)
Destination (string)
Metric (string)
Statistic (string)
DryRun (boolean)
ec2/disable_capacity_managerDisables EC2 Capacity Manager for your account. This stops data ingestion and removes access to capacity analytics and optimization recommendations. Previously collected data is retained but no new data will be processed.DryRun (boolean)
ClientToken (string)
ec2/disable_ebs_encryption_by_defaultDisables 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 EBS User Guide.DryRun (boolean)
ec2/disable_fast_launchDiscontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned snapshots. After you disable Windows fast launch, the AMI uses the standard launch process for each new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable Windows fast launch again. You can only change these settings for Windows AMIs that you own or that have been shared with you.ImageId (string) required
Force (boolean)
DryRun (boolean)
ec2/disable_fast_snapshot_restoresDisables fast snapshot restores for the specified snapshots in the specified Availability Zones.AvailabilityZones (array)
AvailabilityZoneIds (array)
SourceSnapshotIds (array) required
DryRun (boolean)
ec2/disable_imageSets the AMI state to disabled and removes all launch permissions from the AMI. A disabled AMI can't be used for instance launches. A disabled AMI can't be shared. If an AMI was public or previously shared, it is made private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational Unit, they lose access to the disabled AMI. A disabled AMI does not appear in DescribeImages API calls by default. Only the AMI owner can disable an AMI. You can re-enable a disabledImageId (string) required
DryRun (boolean)
ec2/disable_image_block_public_accessDisables block public access for AMIs at the account level in the specified Amazon Web Services Region. This removes the block public access restriction from your account. With the restriction removed, you can publicly share your AMIs in the specified Amazon Web Services Region. For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.DryRun (boolean)
ec2/disable_image_deprecationCancels the deprecation of the specified AMI. For more information, see Deprecate an Amazon EC2 AMI in the Amazon EC2 User Guide.ImageId (string) required
DryRun (boolean)
ec2/disable_image_deregistration_protectionDisables deregistration protection for an AMI. When deregistration protection is disabled, the AMI can be deregistered. If you chose to include a 24-hour cooldown period when you enabled deregistration protection for the AMI, then, when you disable deregistration protection, you won’t immediately be able to deregister the AMI. For more information, see Protect an Amazon EC2 AMI from deregistration in the Amazon EC2 User Guide.ImageId (string) required
DryRun (boolean)
ec2/disable_instance_sql_ha_standby_detectionsDisable Amazon EC2 instances running in an SQL Server High Availability cluster from SQL Server High Availability instance standby detection monitoring. Once disabled, Amazon Web Services no longer monitors the metadata for the instances to determine whether they are active or standby nodes in the SQL Server High Availability cluster.InstanceIds (array) required
DryRun (boolean)
ec2/disable_ipam_organization_admin_accountDisable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide.DryRun (boolean)
DelegatedAdminAccountId (string) required
ec2/disable_ipam_policyDisables an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individuaDryRun (boolean)
IpamPolicyId (string) required
OrganizationTargetId (string)
ec2/disable_route_server_propagationDisables route propagation from a route server to a specified route table. When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routeRouteServerId (string) required
RouteTableId (string) required
DryRun (boolean)
ec2/disable_serial_console_accessDisables 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.DryRun (boolean)
ec2/disable_snapshot_block_public_accessDisables the block public access for snapshots setting at the account level for the specified Amazon Web Services Region. After you disable block public access for snapshots in a Region, users can publicly share snapshots in that Region. Enabling block public access for snapshots in block-all-sharing mode does not change the permissions for snapshots that are already publicly shared. Instead, it prevents these snapshots from be publicly visible and publicly accessible. Therefore, the attributesDryRun (boolean)
ec2/disable_transit_gateway_route_table_propagationDisables the specified resource attachment from propagating routes to the specified propagation route table.TransitGatewayRouteTableId (string) required
TransitGatewayAttachmentId (string)
DryRun (boolean)
TransitGatewayRouteTableAnnouncementId (string)
ec2/disable_vgw_route_propagationDisables a virtual private gateway VGW from propagating routes to a specified route table of a VPC.GatewayId (string) required
RouteTableId (string) required
DryRun (boolean)
ec2/disable_vpc_classic_linkThis action is deprecated. Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.DryRun (boolean)
VpcId (string) required
ec2/disable_vpc_classic_link_dns_supportThis action is deprecated. 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. You must specify a VPC ID in the request.VpcId (string)
ec2/disassociate_addressDisassociates an Elastic IP address from the instance or network interface it's associated with. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. An address cannot be disassociated if the all of the following conditions are met: Network interface has a publicDualStackDnsName publicDnsName Public IPv4 address is the primary public IPv4 address Network interface only has one remaining public IPv4 addressAssociationId (string)
PublicIp (string)
DryRun (boolean)
ec2/disassociate_capacity_reservation_billing_ownerCancels a pending request to assign billing of the unused capacity of a Capacity Reservation to a consumer account, or revokes a request that has already been accepted. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.DryRun (boolean)
CapacityReservationId (string) required
UnusedReservationBillingOwnerId (string) required
ec2/disassociate_client_vpn_target_networkDisassociates 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-associateClientVpnEndpointId (string) required
AssociationId (string) required
DryRun (boolean)
ec2/disassociate_enclave_certificate_iam_roleDisassociates 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.CertificateArn (string) required
RoleArn (string) required
DryRun (boolean)
ec2/disassociate_iam_instance_profileDisassociates an IAM instance profile from a running or stopped instance. Use DescribeIamInstanceProfileAssociations to get the association ID.AssociationId (string) required
ec2/disassociate_instance_event_windowDisassociates one or more targets from an event window. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.DryRun (boolean)
InstanceEventWindowId (string) required
AssociationTarget: {
. InstanceIds (array)
. InstanceTags (array)
. DedicatedHostIds (array)
} (object) required
ec2/disassociate_ipam_byoasnRemove the association between your Autonomous System Number ASN and your BYOIP CIDR. You may want to use this action to disassociate an ASN from a CIDR or if you want to swap ASNs. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.DryRun (boolean)
Asn (string) required
Cidr (string) required
ec2/disassociate_ipam_resource_discoveryDisassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.DryRun (boolean)
IpamResourceDiscoveryAssociationId (string) required
ec2/disassociate_nat_gateway_addressDisassociates secondary Elastic IP addresses EIPs from a public NAT gateway. You cannot disassociate your primary EIP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide. While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway. An EIP is released only at the end of MaxDrainDurationSeconds. It stays associated and supports the existNatGatewayId (string) required
AssociationIds (array) required
MaxDrainDurationSeconds (integer)
DryRun (boolean)
ec2/disassociate_route_serverDisassociates a route server from a VPC. A route server association is the connection established between a route server and a VPC. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.RouteServerId (string) required
VpcId (string) required
DryRun (boolean)
ec2/disassociate_route_tableDisassociates 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 VPC User Guide.DryRun (boolean)
AssociationId (string) required
ec2/disassociate_security_group_vpcDisassociates a security group from a VPC. You cannot disassociate the security group if any Elastic network interfaces in the associated VPC are still associated with the security group. Note that the disassociation is asynchronous and you can check the status of the request with DescribeSecurityGroupVpcAssociations.GroupId (string) required
VpcId (string) required
DryRun (boolean)
ec2/disassociate_subnet_cidr_blockDisassociates 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.AssociationId (string) required
ec2/disassociate_transit_gateway_multicast_domainDisassociates the specified subnets from the transit gateway multicast domain.TransitGatewayMulticastDomainId (string) required
TransitGatewayAttachmentId (string) required
SubnetIds (array) required
DryRun (boolean)
ec2/disassociate_transit_gateway_policy_tableRemoves the association between an an attachment and a policy table.TransitGatewayPolicyTableId (string) required
TransitGatewayAttachmentId (string) required
DryRun (boolean)
ec2/disassociate_transit_gateway_route_tableDisassociates a resource attachment from a transit gateway route table.TransitGatewayRouteTableId (string) required
TransitGatewayAttachmentId (string) required
DryRun (boolean)
ec2/disassociate_trunk_interfaceRemoves an association between a branch network interface with a trunk network interface.AssociationId (string) required
ClientToken (string)
DryRun (boolean)
ec2/disassociate_vpc_cidr_blockDisassociates 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.AssociationId (string) required
ec2/enable_address_transferEnables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon VPC User Guide.AllocationId (string) required
TransferAccountId (string) required
DryRun (boolean)
ec2/enable_allowed_images_settingsEnables Allowed AMIs for your account in the specified Amazon Web Services Region. Two values are accepted: enabled: The image criteria in your Allowed AMIs settings are applied. As a result, only AMIs matching these criteria are discoverable and can be used by your account to launch instances. audit-mode: The image criteria in your Allowed AMIs settings are not applied. No restrictions are placed on AMI discoverability or usage. Users in your account can launch instances using any public AMI orAllowedImagesSettingsState (string) required
DryRun (boolean)
ec2/enable_aws_network_performance_metric_subscriptionEnables Infrastructure Performance subscriptions.Source (string)
Destination (string)
Metric (string)
Statistic (string)
DryRun (boolean)
ec2/enable_capacity_managerEnables EC2 Capacity Manager for your account. This starts data ingestion for your EC2 capacity usage across On-Demand, Spot, and Capacity Reservations. Initial data processing may take several hours to complete.OrganizationsAccess (boolean)
DryRun (boolean)
ClientToken (string)
ec2/enable_ebs_encryption_by_defaultEnables 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 EBS User Guide. 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 lauDryRun (boolean)
ec2/enable_fast_launchWhen you enable Windows fast launch 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. You can only change these settingsImageId (string) required
ResourceType (string)
SnapshotConfiguration: {
. TargetResourceCount (integer)
} (object)
LaunchTemplate: {
. LaunchTemplateId (string)
. LaunchTemplateName (string)
. Version (string)
} (object)
MaxParallelLaunches (integer)
DryRun (boolean)
ec2/enable_fast_snapshot_restoresEnables 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. For more information, see Amazon EBS fast snapshot restore in the Amazon EBS User Guide.AvailabilityZones (array)
AvailabilityZoneIds (array)
SourceSnapshotIds (array) required
DryRun (boolean)
ec2/enable_imageRe-enables a disabled AMI. The re-enabled AMI is marked as available and can be used for instance launches, appears in describe operations, and can be shared. Amazon Web Services accounts, organizations, and Organizational Units that lost access to the AMI when it was disabled do not regain access automatically. Once the AMI is available, it can be shared with them again. Only the AMI owner can re-enable a disabled AMI. For more information, see Disable an Amazon EC2 AMI in the Amazon EC2 User GImageId (string) required
DryRun (boolean)
ec2/enable_image_block_public_accessEnables block public access for AMIs at the account level in the specified Amazon Web Services Region. This prevents the public sharing of your AMIs. However, if you already have public AMIs, they will remain publicly available. The API can take up to 10 minutes to configure this setting. During this time, if you run GetImageBlockPublicAccessState, the response will be unblocked. When the API has completed the configuration, the response will be block-new-sharing. For more information, see BlockImageBlockPublicAccessState (string) required
DryRun (boolean)
ec2/enable_image_deprecationEnables deprecation of the specified AMI at the specified date and time. For more information, see Deprecate an AMI in the Amazon EC2 User Guide.ImageId (string) required
DeprecateAt (string) required
DryRun (boolean)
ec2/enable_image_deregistration_protectionEnables deregistration protection for an AMI. When deregistration protection is enabled, the AMI can't be deregistered. To allow the AMI to be deregistered, you must first disable deregistration protection. For more information, see Protect an Amazon EC2 AMI from deregistration in the Amazon EC2 User Guide.ImageId (string) required
WithCooldown (boolean)
DryRun (boolean)
ec2/enable_instance_sql_ha_standby_detectionsEnable Amazon EC2 instances running in an SQL Server High Availability cluster for SQL Server High Availability instance standby detection monitoring. Once enabled, Amazon Web Services monitors the metadata for the instances to determine whether they are active or standby nodes in the SQL Server High Availability cluster. If the instances are determined to be standby failover nodes, Amazon Web Services automatically applies SQL Server licensing fee waiver for those instances. To register an instInstanceIds (array) required
SqlServerCredentials (string)
DryRun (boolean)
ec2/enable_ipam_organization_admin_accountEnable 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.DryRun (boolean)
DelegatedAdminAccountId (string) required
ec2/enable_ipam_policyEnables an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individualDryRun (boolean)
IpamPolicyId (string) required
OrganizationTargetId (string)
ec2/enable_reachability_analyzer_organization_sharingEstablishes a trust relationship between Reachability Analyzer and Organizations. This operation must be performed by the management account for the organization. After you establish a trust relationship, a user in the management account or a delegated administrator account can run a cross-account analysis using resources from the member accounts.DryRun (boolean)
ec2/enable_route_server_propagationDefines which route tables the route server can update with routes. When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.RouteServerId (string) required
RouteTableId (string) required
DryRun (boolean)
ec2/enable_serial_console_accessEnables 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.DryRun (boolean)
ec2/enable_snapshot_block_public_accessEnables or modifies the block public access for snapshots setting at the account level for the specified Amazon Web Services Region. After you enable block public access for snapshots in a Region, users can no longer request public sharing for snapshots in that Region. Snapshots that are already publicly shared are either treated as private or they remain publicly shared, depending on the State that you specify. Enabling block public access for snapshots in block all sharing mode does not changeState (string) required
DryRun (boolean)
ec2/enable_transit_gateway_route_table_propagationEnables the specified attachment to propagate routes to the specified propagation route table.TransitGatewayRouteTableId (string) required
TransitGatewayAttachmentId (string)
DryRun (boolean)
TransitGatewayRouteTableAnnouncementId (string)
ec2/enable_vgw_route_propagationEnables a virtual private gateway VGW to propagate routes to the specified route table of a VPC.GatewayId (string) required
RouteTableId (string) required
DryRun (boolean)
ec2/enable_volume_ioEnables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.DryRun (boolean)
VolumeId (string) required
ec2/enable_vpc_classic_linkThis action is deprecated. 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.DryRun (boolean)
VpcId (string) required
ec2/enable_vpc_classic_link_dns_supportThis action is deprecated. 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. You must specify a VPC ID in the request.VpcId (string)
ec2/export_client_vpn_client_certificate_revocation_listDownloads the client certificate revocation list for the specified Client VPN endpoint.ClientVpnEndpointId (string) required
DryRun (boolean)
ec2/export_client_vpn_client_configurationDownloads 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.ClientVpnEndpointId (string) required
DryRun (boolean)
ec2/export_imageExports 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.ClientToken (string)
Description (string)
DiskImageFormat (string) required
DryRun (boolean)
ImageId (string) required
S3ExportLocation: {
. S3Bucket (string)
. S3Prefix (string)
} (object) required
RoleName (string)
TagSpecifications (array)
ec2/export_transit_gateway_routesExports 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 the Amazon Web Services Transit Gateways Guide.TransitGatewayRouteTableId (string) required
Filters (array)
S3Bucket (string) required
DryRun (boolean)
ec2/export_verified_access_instance_client_configurationExports the client configuration for a Verified Access instance.VerifiedAccessInstanceId (string) required
DryRun (boolean)
ec2/get_active_vpn_tunnel_statusReturns the currently negotiated security parameters for an active VPN tunnel, including IKE version, DH groups, encryption algorithms, and integrity algorithms.VpnConnectionId (string) required
VpnTunnelOutsideIpAddress (string) required
DryRun (boolean)
ec2/get_allowed_images_settingsGets the current state of the Allowed AMIs setting and the list of Allowed AMIs criteria at the account level in the specified Region. The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.DryRun (boolean)
ec2/get_associated_enclave_certificate_iam_rolesReturns 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.CertificateArn (string) required
DryRun (boolean)
ec2/get_associated_ipv6pool_cidrsGets information about the IPv6 CIDR block associations for a specified IPv6 address pool.PoolId (string) required
NextToken (string)
MaxResults (integer)
DryRun (boolean)
ec2/get_aws_network_performance_dataGets network performance data.DataQueries (array)
StartTime (string)
EndTime (string)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_capacity_manager_attributesRetrieves the current configuration and status of EC2 Capacity Manager for your account, including enablement status, Organizations access settings, and data ingestion status.DryRun (boolean)
ec2/get_capacity_manager_metric_dataRetrieves capacity usage metrics for your EC2 resources. Returns time-series data for metrics like unused capacity, utilization rates, and costs across On-Demand, Spot, and Capacity Reservations. Data can be grouped and filtered by various dimensions such as region, account, and instance family.MetricNames (array) required
StartTime (string) required
EndTime (string) required
Period (integer) required
GroupBy (array)
FilterBy (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_capacity_manager_metric_dimensionsRetrieves the available dimension values for capacity metrics within a specified time range. This is useful for discovering what accounts, regions, instance families, and other dimensions have data available for filtering and grouping.GroupBy (array) required
FilterBy (array)
StartTime (string) required
EndTime (string) required
MetricNames (array) required
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_capacity_reservation_usageGets 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.CapacityReservationId (string) required
NextToken (string)
MaxResults (integer)
DryRun (boolean)
ec2/get_coip_pool_usageDescribes the allocations from the specified customer-owned address pool.PoolId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_console_outputGets 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. For more information, see Instance console output in the Amazon EC2 User Guide.InstanceId (string) required
Latest (boolean)
DryRun (boolean)
ec2/get_console_screenshotRetrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded. For more information, see Instance console output in the Amazon EC2 User Guide.DryRun (boolean)
InstanceId (string) required
WakeUp (boolean)
ec2/get_declarative_policies_report_summaryRetrieves a summary of the account status report. To view the full report, download it from the Amazon S3 bucket where it was saved. Reports are accessible only when they have the complete status. Reports with other statuses running, cancelled, or error are not available in the S3 bucket. For more information about downloading objects from an S3 bucket, see Downloading objects in the Amazon Simple Storage Service User Guide. For more information, see Generating the account status report for declDryRun (boolean)
ReportId (string) required
ec2/get_default_credit_specificationDescribes 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.DryRun (boolean)
InstanceFamily (string) required
ec2/get_ebs_default_kms_key_idDescribes the default KMS key for EBS encryption by default for your account in this Region. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.DryRun (boolean)
ec2/get_ebs_encryption_by_defaultDescribes whether EBS encryption by default is enabled for your account in the current Region. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.DryRun (boolean)
ec2/get_enabled_ipam_policyGets the enabled IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an indiDryRun (boolean)
ec2/get_flow_logs_integration_templateGenerates 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 partitionedDryRun (boolean)
FlowLogId (string) required
ConfigDeliveryS3DestinationArn (string) required
IntegrateServices: {
. AthenaIntegrations (array)
} (object) required
ec2/get_groups_for_capacity_reservationLists the resource groups to which a Capacity Reservation has been added.CapacityReservationId (string) required
NextToken (string)
MaxResults (integer)
DryRun (boolean)
ec2/get_host_reservation_purchase_previewPreview 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.HostIdSet (array) required
OfferingId (string) required
ec2/get_image_ancestryRetrieves the ancestry chain of the specified AMI, tracing its lineage back to the root AMI. For more information, see AMI ancestry in Amazon EC2 User Guide.ImageId (string) required
DryRun (boolean)
ec2/get_image_block_public_access_stateGets the current state of block public access for AMIs at the account level in the specified Amazon Web Services Region. For more information, see Block public access to your AMIs in the Amazon EC2 User Guide.DryRun (boolean)
ec2/get_instance_metadata_defaultsGets the default instance metadata service IMDS settings that are set at the account level in the specified Amazon Web Services Region. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.DryRun (boolean)
ec2/get_instance_tpm_ek_pubGets the public endorsement key associated with the Nitro Trusted Platform Module NitroTPM for the specified instance.InstanceId (string) required
KeyType (string) required
KeyFormat (string) required
DryRun (boolean)
ec2/get_instance_types_from_instance_requirementsReturns 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 attributDryRun (boolean)
ArchitectureTypes (array) required
VirtualizationTypes (array) required
InstanceRequirements: {
. VCpuCount (object)
. MemoryMiB (object)
. CpuManufacturers (array)
. MemoryGiBPerVCpu (object)
. ExcludedInstanceTypes (array)
. InstanceGenerations (array)
. SpotMaxPricePercentageOverLowestPrice (integer)
. OnDemandMaxPricePercentageOverLowestPrice (integer)
. BareMetal (string)
. BurstablePerformance (string)
. RequireHibernateSupport (boolean)
. NetworkInterfaceCount (object)
. LocalStorage (string)
. LocalStorageTypes (array)
. TotalLocalStorageGB (object)
. BaselineEbsBandwidthMbps (object)
. AcceleratorTypes (array)
. AcceleratorCount (object)
. AcceleratorManufacturers (array)
. AcceleratorNames (array)
. AcceleratorTotalMemoryMiB (object)
. NetworkBandwidthGbps (object)
. AllowedInstanceTypes (array)
. MaxSpotPriceAsPercentageOfOptimalOnDemandPrice (integer)
. BaselinePerformanceFactors (object)
. RequireEncryptionInTransit (boolean)
} (object) required
MaxResults (integer)
NextToken (string)
Context (string)
ec2/get_instance_uefi_dataA 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 canInstanceId (string) required
DryRun (boolean)
ec2/get_ipam_address_historyRetrieve 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.DryRun (boolean)
Cidr (string) required
IpamScopeId (string) required
VpcId (string)
StartTime (string)
EndTime (string)
MaxResults (integer)
NextToken (string)
ec2/get_ipam_discovered_accountsGets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.DryRun (boolean)
IpamResourceDiscoveryId (string) required
DiscoveryRegion (string) required
Filters (array)
NextToken (string)
MaxResults (integer)
ec2/get_ipam_discovered_public_addressesGets the public IP addresses that have been discovered by IPAM.DryRun (boolean)
IpamResourceDiscoveryId (string) required
AddressRegion (string) required
Filters (array)
NextToken (string)
MaxResults (integer)
ec2/get_ipam_discovered_resource_cidrsReturns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses.DryRun (boolean)
IpamResourceDiscoveryId (string) required
ResourceRegion (string) required
Filters (array)
NextToken (string)
MaxResults (integer)
ec2/get_ipam_policy_allocation_rulesGets the allocation rules for an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be apDryRun (boolean)
IpamPolicyId (string) required
Filters (array)
Locale (string)
ResourceType (string)
MaxResults (integer)
NextToken (string)
ec2/get_ipam_policy_organization_targetsGets the Amazon Web Services Organizations targets for an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addrDryRun (boolean)
MaxResults (integer)
NextToken (string)
IpamPolicyId (string) required
Filters (array)
ec2/get_ipam_pool_allocationsGet a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. If you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.DryRun (boolean)
IpamPoolId (string) required
IpamPoolAllocationId (string)
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/get_ipam_pool_cidrsGet the CIDRs provisioned to an IPAM pool.DryRun (boolean)
IpamPoolId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/get_ipam_prefix_list_resolver_rulesRetrieves the CIDR selection rules for an IPAM prefix list resolver. Use this operation to view the business logic that determines which CIDRs are selected for synchronization with prefix lists.DryRun (boolean)
IpamPrefixListResolverId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
ec2/get_ipam_prefix_list_resolver_version_entriesRetrieves the CIDR entries for a specific version of an IPAM prefix list resolver. This shows the actual CIDRs that were selected and synchronized at a particular point in time.DryRun (boolean)
IpamPrefixListResolverId (string) required
IpamPrefixListResolverVersion (integer) required
MaxResults (integer)
NextToken (string)
ec2/get_ipam_prefix_list_resolver_versionsRetrieves version information for an IPAM prefix list resolver. Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes. Version example: Initial State Version 1 Production environment: vpc-prod-web 10.1.0.0/16 - tagged env=prod vpc-prod-db 10.2.0.0/16 - tagged env=prod Resolver rule: Include all VPCs tagged env=prod Version 1 CIDRs: 10.1.0.0/16, 10.2.0.0/16 Infrastructure ChaDryRun (boolean)
IpamPrefixListResolverId (string) required
IpamPrefixListResolverVersions (array)
MaxResults (integer)
Filters (array)
NextToken (string)
ec2/get_ipam_resource_cidrsReturns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.DryRun (boolean)
Filters (array)
MaxResults (integer)
NextToken (string)
IpamScopeId (string) required
IpamPoolId (string)
ResourceId (string)
ResourceType (string)
ResourceTag: {
. Key (string)
. Value (string)
} (object)
ResourceOwner (string)
ec2/get_launch_template_dataRetrieves 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, and DescribeInstanceAttribute. Or, you can allow describe depending on your instance requirements.DryRun (boolean)
InstanceId (string) required
ec2/get_managed_prefix_list_associationsGets information about the resources that are associated with the specified managed prefix list.DryRun (boolean)
PrefixListId (string) required
MaxResults (integer)
NextToken (string)
ec2/get_managed_prefix_list_entriesGets information about the entries for a specified managed prefix list.DryRun (boolean)
PrefixListId (string) required
TargetVersion (integer)
MaxResults (integer)
NextToken (string)
ec2/get_network_insights_access_scope_analysis_findingsGets the findings for the specified Network Access Scope analysis.NetworkInsightsAccessScopeAnalysisId (string) required
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_network_insights_access_scope_contentGets the content for the specified Network Access Scope.NetworkInsightsAccessScopeId (string) required
DryRun (boolean)
ec2/get_password_dataRetrieves 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 usinInstanceId (string) required
DryRun (boolean)
ec2/get_reserved_instances_exchange_quoteReturns 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.DryRun (boolean)
ReservedInstanceIds (array) required
TargetConfigurations (array)
ec2/get_route_server_associationsGets information about the associations for the specified route server. A route server association is the connection established between a route server and a VPC. For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.RouteServerId (string) required
DryRun (boolean)
ec2/get_route_server_propagationsGets information about the route propagations for the specified route server. When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 roRouteServerId (string) required
RouteTableId (string)
DryRun (boolean)
ec2/get_route_server_routing_databaseGets the routing database for the specified route server. The Routing Information Base RIB serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions. Amazon VPC RouRouteServerId (string) required
NextToken (string)
MaxResults (integer)
DryRun (boolean)
Filters (array)
ec2/get_security_groups_for_vpcGets security groups that can be associated by the Amazon Web Services account making the request with network interfaces in the specified VPC.VpcId (string) required
NextToken (string)
MaxResults (integer)
Filters (array)
DryRun (boolean)
ec2/get_serial_console_access_statusRetrieves 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.DryRun (boolean)
ec2/get_snapshot_block_public_access_stateGets the current state of block public access for snapshots setting for the account and Region. For more information, see Block public access for snapshots in the Amazon EBS User Guide.DryRun (boolean)
ec2/get_spot_placement_scoresCalculates 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.InstanceTypes (array)
TargetCapacity (integer) required
TargetCapacityUnitType (string)
SingleAvailabilityZone (boolean)
RegionNames (array)
InstanceRequirementsWithMetadata: {
. ArchitectureTypes (array)
. VirtualizationTypes (array)
. InstanceRequirements (object)
} (object)
DryRun (boolean)
MaxResults (integer)
NextToken (string)
ec2/get_subnet_cidr_reservationsGets information about the subnet CIDR reservations.Filters (array)
SubnetId (string) required
DryRun (boolean)
NextToken (string)
MaxResults (integer)
ec2/get_transit_gateway_attachment_propagationsLists the route tables to which the specified resource attachment propagates routes.TransitGatewayAttachmentId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_transit_gateway_metering_policy_entriesRetrieves the entries for a transit gateway metering policy.TransitGatewayMeteringPolicyId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_transit_gateway_multicast_domain_associationsGets information about the associations for the transit gateway multicast domain.TransitGatewayMulticastDomainId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_transit_gateway_policy_table_associationsGets a list of the transit gateway policy table associations.TransitGatewayPolicyTableId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_transit_gateway_policy_table_entriesReturns a list of transit gateway policy table entries.TransitGatewayPolicyTableId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_transit_gateway_prefix_list_referencesGets information about the prefix list references in a specified transit gateway route table.TransitGatewayRouteTableId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_transit_gateway_route_table_associationsGets information about the associations for the specified transit gateway route table.TransitGatewayRouteTableId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_transit_gateway_route_table_propagationsGets information about the route table propagations for the specified transit gateway route table.TransitGatewayRouteTableId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_verified_access_endpoint_policyGet the Verified Access policy associated with the endpoint.VerifiedAccessEndpointId (string) required
DryRun (boolean)
ec2/get_verified_access_endpoint_targetsGets the targets for the specified network CIDR endpoint for Verified Access.VerifiedAccessEndpointId (string) required
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_verified_access_group_policyShows the contents of the Verified Access policy associated with the group.VerifiedAccessGroupId (string) required
DryRun (boolean)
ec2/get_vpc_resources_blocking_encryption_enforcementGets information about resources in a VPC that are blocking encryption enforcement. For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.VpcId (string) required
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_vpn_connection_device_sample_configurationDownload an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.VpnConnectionId (string) required
VpnConnectionDeviceTypeId (string) required
InternetKeyExchangeVersion (string)
SampleType (string)
DryRun (boolean)
ec2/get_vpn_connection_device_typesObtain 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.MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/get_vpn_tunnel_replacement_statusGet details of available tunnel endpoint maintenance.VpnConnectionId (string) required
VpnTunnelOutsideIpAddress (string) required
DryRun (boolean)
ec2/import_client_vpn_client_certificate_revocation_listUploads 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.ClientVpnEndpointId (string) required
CertificateRevocationList (string) required
DryRun (boolean)
ec2/import_imageTo import your virtual machines VMs with a console-based experience, you can use the Import virtual machine images to Amazon Web Services template in the Migration Hub Orchestrator console. For more information, see the Migration Hub Orchestrator User Guide . 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 cArchitecture (string)
ClientData: {
. Comment (string)
. UploadEnd (string)
. UploadSize (number)
. UploadStart (string)
} (object)
ClientToken (string)
Description (string)
DiskContainers (array)
DryRun (boolean)
Encrypted (boolean)
Hypervisor (string)
KmsKeyId (string)
LicenseType (string)
Platform (string)
RoleName (string)
LicenseSpecifications (array)
TagSpecifications (array)
UsageOperation (string)
BootMode (string)
ec2/import_instanceWe recommend that you use the ImportImage API instead. For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide. 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. For information about the import manifest referenced by this API action, see VM Import Manifest. This API action is not supported by the Command Line IntDryRun (boolean)
Description (string)
LaunchSpecification: {
. Architecture (string)
. GroupNames (array)
. GroupIds (array)
. AdditionalInfo (string)
. UserData (object)
. InstanceType (string)
. Placement (object)
. Monitoring (boolean)
. SubnetId (string)
. InstanceInitiatedShutdownBehavior (string)
. PrivateIpAddress (string)
} (object)
DiskImages (array)
Platform (string) required
ec2/import_key_pairImports the public key from an RSA or ED25519 key pair that you created using a third-party tool. You give Amazon Web Services only the public key. The private key is never transferred between you and Amazon Web Services. For more information about the requirements for importing a key pair, see Create a key pair and import the public key to Amazon EC2 in the Amazon EC2 User Guide.TagSpecifications (array)
DryRun (boolean)
KeyName (string) required
PublicKeyMaterial (string) required
ec2/import_snapshotImports 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.ClientData: {
. Comment (string)
. UploadEnd (string)
. UploadSize (number)
. UploadStart (string)
} (object)
ClientToken (string)
Description (string)
DiskContainer: {
. Description (string)
. Format (string)
. Url (string)
. UserBucket (object)
} (object)
DryRun (boolean)
Encrypted (boolean)
KmsKeyId (string)
RoleName (string)
TagSpecifications (array)
ec2/import_volumeThis 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. Creates an import volume task using metadata from the specified disk image. For information about the import manifest referenced by this API action, see VM Import Manifest. This API action is not supported by the Command Line Interface CLI.AvailabilityZoneId (string)
DryRun (boolean)
AvailabilityZone (string)
Image: {
. Format (string)
. Bytes (integer)
. ImportManifestUrl (string)
} (object) required
Description (string)
Volume: {
. Size (integer)
} (object) required
ec2/list_images_in_recycle_binLists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.ImageIds (array)
NextToken (string)
MaxResults (integer)
DryRun (boolean)
ec2/list_snapshots_in_recycle_binLists one or more snapshots that are currently in the Recycle Bin.MaxResults (integer)
NextToken (string)
SnapshotIds (array)
DryRun (boolean)
ec2/list_volumes_in_recycle_binLists one or more volumes that are currently in the Recycle Bin.VolumeIds (array)
DryRun (boolean)
MaxResults (integer)
NextToken (string)
ec2/lock_snapshotLocks an Amazon EBS snapshot in either governance or compliance mode to protect it against accidental or malicious deletions for a specific duration. A locked snapshot can't be deleted. You can also use this action to modify the lock settings for a snapshot that is already locked. The allowed modifications depend on the lock mode and lock state: If the snapshot is locked in governance mode, you can modify the lock mode and the lock duration or lock expiration date. If the snapshot is locked in cSnapshotId (string) required
DryRun (boolean)
LockMode (string) required
CoolOffPeriod (integer)
LockDuration (integer)
ExpirationDate (string)
ec2/modify_address_attributeModifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.AllocationId (string) required
DomainName (string)
DryRun (boolean)
ec2/modify_availability_zone_groupChanges the opt-in status of the specified zone group for your account.GroupName (string) required
OptInStatus (string) required
DryRun (boolean)
ec2/modify_capacity_reservationModifies a Capacity Reservation's capacity, instance eligibility, and the conditions under which it is to be released. You can't modify a Capacity Reservation's instance type, EBS optimization, platform, instance store settings, Availability Zone, or tenancy. 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. For more information, see Modify an active Capacity Reservation. The allowed modifCapacityReservationId (string) required
InstanceCount (integer)
EndDate (string)
EndDateType (string)
Accept (boolean)
DryRun (boolean)
AdditionalInfo (string)
InstanceMatchCriteria (string)
ec2/modify_capacity_reservation_fleetModifies 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.CapacityReservationFleetId (string) required
TotalTargetCapacity (integer)
EndDate (string)
DryRun (boolean)
RemoveEndDate (boolean)
ec2/modify_client_vpn_endpointModifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.ClientVpnEndpointId (string) required
ServerCertificateArn (string)
ConnectionLogOptions: {
. Enabled (boolean)
. CloudwatchLogGroup (string)
. CloudwatchLogStream (string)
} (object)
DnsServers: {
. CustomDnsServers (array)
. Enabled (boolean)
} (object)
VpnPort (integer)
Description (string)
SplitTunnel (boolean)
DryRun (boolean)
SecurityGroupIds (array)
VpcId (string)
SelfServicePortal (string)
ClientConnectOptions: {
. Enabled (boolean)
. LambdaFunctionArn (string)
} (object)
SessionTimeoutHours (integer)
ClientLoginBannerOptions: {
. Enabled (boolean)
. BannerText (string)
} (object)
ClientRouteEnforcementOptions: {
. Enforced (boolean)
} (object)
DisconnectOnSessionTimeout (boolean)
ec2/modify_default_credit_specificationModifies 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 aDryRun (boolean)
InstanceFamily (string) required
CpuCredits (string) required
ec2/modify_ebs_default_kms_key_idChanges 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. 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 bKmsKeyId (string) required
DryRun (boolean)
ec2/modify_fleetModifies 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 diveDryRun (boolean)
ExcessCapacityTerminationPolicy (string)
LaunchTemplateConfigs (array)
FleetId (string) required
TargetCapacitySpecification: {
. TotalTargetCapacity (integer)
. OnDemandTargetCapacity (integer)
. SpotTargetCapacity (integer)
. DefaultTargetCapacityType (string)
. TargetCapacityUnitType (string)
} (object)
Context (string)
ec2/modify_fpga_image_attributeModifies the specified attribute of the specified Amazon FPGA Image AFI.DryRun (boolean)
FpgaImageId (string) required
Attribute (string)
OperationType (string)
UserIds (array)
UserGroups (array)
ProductCodes (array)
LoadPermission: {
. Add (array)
. Remove (array)
} (object)
Description (string)
Name (string)
ec2/modify_hostsModify 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 thiHostRecovery (string)
InstanceType (string)
InstanceFamily (string)
HostMaintenance (string)
HostIds (array) required
AutoPlacement (string)
ec2/modify_identity_id_formatModifies 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-Resource (string) required
UseLongIds (boolean) required
PrincipalArn (string) required
ec2/modify_id_formatModifies 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 | internetResource (string) required
UseLongIds (boolean) required
ec2/modify_image_attributeModifies the specified attribute of the specified AMI. You can specify only one attribute at a time. To specify the attribute, you can use the Attribute parameter, or one of the following parameters: Description, ImdsSupport, 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.Attribute (string)
Description: {
. Value (string)
} (object)
ImageId (string) required
LaunchPermission: {
. Add (array)
. Remove (array)
} (object)
OperationType (string)
ProductCodes (array)
UserGroups (array)
UserIds (array)
Value (string)
OrganizationArns (array)
OrganizationalUnitArns (array)
ImdsSupport: {
. Value (string)
} (object)
DryRun (boolean)
ec2/modify_instance_attributeModifies 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 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 insSourceDestCheck: {
. Value (boolean)
} (object)
DisableApiStop: {
. Value (boolean)
} (object)
DryRun (boolean)
InstanceId (string) required
Attribute (string)
Value (string)
BlockDeviceMappings (array)
DisableApiTermination: {
. Value (boolean)
} (object)
InstanceType: {
. Value (string)
} (object)
Kernel: {
. Value (string)
} (object)
Ramdisk: {
. Value (string)
} (object)
UserData: {
. Value (string)
} (object)
InstanceInitiatedShutdownBehavior: {
. Value (string)
} (object)
Groups (array)
EbsOptimized: {
. Value (boolean)
} (object)
SriovNetSupport: {
. Value (string)
} (object)
EnaSupport: {
. Value (boolean)
} (object)
ec2/modify_instance_capacity_reservation_attributesModifies 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, run in On-Demand Instance capacity, or only run in a Capacity Reservation.InstanceId (string) required
CapacityReservationSpecification: {
. CapacityReservationPreference (string)
. CapacityReservationTarget (object)
} (object) required
DryRun (boolean)
ec2/modify_instance_connect_endpointModifies the specified EC2 Instance Connect Endpoint. For more information, see Modify an EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.DryRun (boolean)
InstanceConnectEndpointId (string) required
IpAddressType (string)
SecurityGroupIds (array)
PreserveClientIp (boolean)
ec2/modify_instance_cpu_optionsBy default, all vCPUs for the instance type are active when you launch an instance. When you configure the number of active vCPUs for the instance, it can help you save on licensing costs and optimize performance. The base cost of the instance remains unchanged. The number of active vCPUs equals the number of threads per CPU core multiplied by the number of cores. The instance must be in a Stopped state before you make changes. Some instance type options do not support this capability. For moreInstanceId (string) required
CoreCount (integer)
ThreadsPerCore (integer)
NestedVirtualization (string)
DryRun (boolean)
ec2/modify_instance_credit_specificationModifies 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.DryRun (boolean)
ClientToken (string)
InstanceCreditSpecifications (array) required
ec2/modify_instance_event_start_timeModifies the start time for a scheduled Amazon EC2 instance event.DryRun (boolean)
InstanceId (string) required
InstanceEventId (string) required
NotBefore (string) required
ec2/modify_instance_event_windowModifies 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 UserDryRun (boolean)
Name (string)
InstanceEventWindowId (string) required
TimeRanges (array)
CronExpression (string)
ec2/modify_instance_maintenance_optionsModifies 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. Modifies the reboot migration behavior during a user-initiated reboot of an instance that has a pending system-reboot event. For more information, see Enable or disable reboot migration.InstanceId (string) required
AutoRecovery (string)
RebootMigration (string)
DryRun (boolean)
ec2/modify_instance_metadata_defaultsModifies the default instance metadata service IMDS settings at the account level in the specified Amazon Web Services Region. To remove a parameter's account-level default setting, specify no-preference. If an account-level setting is cleared with no-preference, then the instance launch considers the other instance metadata settings. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.HttpTokens (string)
HttpPutResponseHopLimit (integer)
HttpEndpoint (string)
InstanceMetadataTags (string)
DryRun (boolean)
ec2/modify_instance_metadata_optionsModify 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 metadInstanceId (string) required
HttpTokens (string)
HttpPutResponseHopLimit (integer)
HttpEndpoint (string)
DryRun (boolean)
HttpProtocolIpv6 (string)
InstanceMetadataTags (string)
ec2/modify_instance_network_performance_optionsChange the configuration of the network performance options for an existing instance.InstanceId (string) required
BandwidthWeighting (string) required
DryRun (boolean)
ec2/modify_instance_placementModifies 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 started, 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 instanceGroupName (string)
PartitionNumber (integer)
HostResourceGroupArn (string)
GroupId (string)
InstanceId (string) required
Tenancy (string)
Affinity (string)
HostId (string)
ec2/modify_ipamModify the configurations of an IPAM.DryRun (boolean)
IpamId (string) required
Description (string)
AddOperatingRegions (array)
RemoveOperatingRegions (array)
Tier (string)
EnablePrivateGua (boolean)
MeteredAccount (string)
ec2/modify_ipam_policy_allocation_rulesModifies the allocation rules in an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can beDryRun (boolean)
IpamPolicyId (string) required
Locale (string) required
ResourceType (string) required
AllocationRules (array)
ec2/modify_ipam_poolModify the configurations of an IPAM pool. For more information, see Modify a pool in the Amazon VPC IPAM User Guide.DryRun (boolean)
IpamPoolId (string) required
Description (string)
AutoImport (boolean)
AllocationMinNetmaskLength (integer)
AllocationMaxNetmaskLength (integer)
AllocationDefaultNetmaskLength (integer)
ClearAllocationDefaultNetmaskLength (boolean)
AddAllocationResourceTags (array)
RemoveAllocationResourceTags (array)
ec2/modify_ipam_prefix_list_resolverModifies an IPAM prefix list resolver. You can update the description and CIDR selection rules. Changes to rules will trigger re-evaluation and potential updates to associated prefix lists.DryRun (boolean)
IpamPrefixListResolverId (string) required
Description (string)
Rules (array)
ec2/modify_ipam_prefix_list_resolver_targetModifies an IPAM prefix list resolver target. You can update version tracking settings and the desired version of the target prefix list.DryRun (boolean)
IpamPrefixListResolverTargetId (string) required
DesiredVersion (integer)
TrackLatestVersion (boolean)
ClientToken (string)
ec2/modify_ipam_resource_cidrModify 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.DryRun (boolean)
ResourceId (string) required
ResourceCidr (string) required
ResourceRegion (string) required
CurrentIpamScopeId (string) required
DestinationIpamScopeId (string)
Monitored (boolean) required
ec2/modify_ipam_resource_discoveryModifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.DryRun (boolean)
IpamResourceDiscoveryId (string) required
Description (string)
AddOperatingRegions (array)
RemoveOperatingRegions (array)
AddOrganizationalUnitExclusions (array)
RemoveOrganizationalUnitExclusions (array)
ec2/modify_ipam_scopeModify an IPAM scope.DryRun (boolean)
IpamScopeId (string) required
Description (string)
ExternalAuthorityConfiguration: {
. Type (string)
. ExternalResourceIdentifier (string)
} (object)
RemoveExternalAuthorityConfiguration (boolean)
ec2/modify_launch_templateModifies 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.DryRun (boolean)
ClientToken (string)
LaunchTemplateId (string)
LaunchTemplateName (string)
DefaultVersion (string)
ec2/modify_local_gateway_routeModifies the specified local gateway route.DestinationCidrBlock (string)
LocalGatewayRouteTableId (string) required
LocalGatewayVirtualInterfaceGroupId (string)
NetworkInterfaceId (string)
DryRun (boolean)
DestinationPrefixListId (string)
ec2/modify_managed_prefix_listModifies 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.DryRun (boolean)
PrefixListId (string) required
CurrentVersion (integer)
PrefixListName (string)
AddEntries (array)
RemoveEntries (array)
MaxEntries (integer)
IpamPrefixListResolverSyncEnabled (boolean)
ec2/modify_network_interface_attributeModifies 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.EnaSrdSpecification: {
. EnaSrdEnabled (boolean)
. EnaSrdUdpSpecification (object)
} (object)
EnablePrimaryIpv6 (boolean)
ConnectionTrackingSpecification: {
. TcpEstablishedTimeout (integer)
. UdpStreamTimeout (integer)
. UdpTimeout (integer)
} (object)
AssociatePublicIpAddress (boolean)
AssociatedSubnetIds (array)
DryRun (boolean)
NetworkInterfaceId (string) required
Description: {
. Value (string)
} (object)
SourceDestCheck: {
. Value (boolean)
} (object)
Groups (array)
Attachment: {
. DefaultEnaQueueCount (boolean)
. EnaQueueCount (integer)
. AttachmentId (string)
. DeleteOnTermination (boolean)
} (object)
ec2/modify_private_dns_name_optionsModifies the options for instance hostnames for the specified instance.DryRun (boolean)
InstanceId (string) required
PrivateDnsHostnameType (string)
EnableResourceNameDnsARecord (boolean)
EnableResourceNameDnsAAAARecord (boolean)
ec2/modify_public_ip_dns_name_optionsModify public hostname options for a network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.NetworkInterfaceId (string) required
HostnameType (string) required
DryRun (boolean)
ec2/modify_reserved_instancesModifies 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 Modify Reserved Instances in the Amazon EC2 User Guide.ReservedInstancesIds (array) required
ClientToken (string)
TargetConfigurations (array) required
ec2/modify_route_serverModifies the configuration of an existing route server. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoRouteServerId (string) required
PersistRoutes (string)
PersistRoutesDuration (integer)
SnsNotificationsEnabled (boolean)
DryRun (boolean)
ec2/modify_security_group_rulesModifies the rules of a security group.GroupId (string) required
SecurityGroupRules (array) required
DryRun (boolean)
ec2/modify_snapshot_attributeAdds 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 puAttribute (string)
CreateVolumePermission: {
. Add (array)
. Remove (array)
} (object)
GroupNames (array)
OperationType (string)
SnapshotId (string) required
UserIds (array)
DryRun (boolean)
ec2/modify_snapshot_tierArchives 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 EBS User Guide.SnapshotId (string) required
StorageTier (string)
DryRun (boolean)
ec2/modify_spot_fleet_requestModifies 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 allocaLaunchTemplateConfigs (array)
OnDemandTargetCapacity (integer)
Context (string)
SpotFleetRequestId (string) required
TargetCapacity (integer)
ExcessCapacityTerminationPolicy (string)
ec2/modify_subnet_attributeModifies 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 racksAssignIpv6AddressOnCreation: {
. Value (boolean)
} (object)
MapPublicIpOnLaunch: {
. Value (boolean)
} (object)
SubnetId (string) required
MapCustomerOwnedIpOnLaunch: {
. Value (boolean)
} (object)
CustomerOwnedIpv4Pool (string)
EnableDns64: {
. Value (boolean)
} (object)
PrivateDnsHostnameTypeOnLaunch (string)
EnableResourceNameDnsARecordOnLaunch: {
. Value (boolean)
} (object)
EnableResourceNameDnsAAAARecordOnLaunch: {
. Value (boolean)
} (object)
EnableLniAtDeviceIndex (integer)
DisableLniAtDeviceIndex: {
. Value (boolean)
} (object)
ec2/modify_traffic_mirror_filter_network_servicesAllows 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.TrafficMirrorFilterId (string) required
AddNetworkServices (array)
RemoveNetworkServices (array)
DryRun (boolean)
ec2/modify_traffic_mirror_filter_ruleModifies the specified Traffic Mirror rule. DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.TrafficMirrorFilterRuleId (string) required
TrafficDirection (string)
RuleNumber (integer)
RuleAction (string)
DestinationPortRange: {
. FromPort (integer)
. ToPort (integer)
} (object)
SourcePortRange: {
. FromPort (integer)
. ToPort (integer)
} (object)
Protocol (integer)
DestinationCidrBlock (string)
SourceCidrBlock (string)
Description (string)
RemoveFields (array)
DryRun (boolean)
ec2/modify_traffic_mirror_sessionModifies a Traffic Mirror session.TrafficMirrorSessionId (string) required
TrafficMirrorTargetId (string)
TrafficMirrorFilterId (string)
PacketLength (integer)
SessionNumber (integer)
VirtualNetworkId (integer)
Description (string)
RemoveFields (array)
DryRun (boolean)
ec2/modify_transit_gatewayModifies 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.TransitGatewayId (string) required
Description (string)
Options: {
. AddTransitGatewayCidrBlocks (array)
. RemoveTransitGatewayCidrBlocks (array)
. VpnEcmpSupport (string)
. DnsSupport (string)
. SecurityGroupReferencingSupport (string)
. AutoAcceptSharedAttachments (string)
. DefaultRouteTableAssociation (string)
. AssociationDefaultRouteTableId (string)
. DefaultRouteTablePropagation (string)
. PropagationDefaultRouteTableId (string)
. AmazonSideAsn (integer)
. EncryptionSupport (string)
} (object)
DryRun (boolean)
ec2/modify_transit_gateway_metering_policyModifies a transit gateway metering policy.TransitGatewayMeteringPolicyId (string) required
AddMiddleboxAttachmentIds (array)
RemoveMiddleboxAttachmentIds (array)
DryRun (boolean)
ec2/modify_transit_gateway_prefix_list_referenceModifies a reference route to a prefix list in a specified transit gateway route table.TransitGatewayRouteTableId (string) required
PrefixListId (string) required
TransitGatewayAttachmentId (string)
Blackhole (boolean)
DryRun (boolean)
ec2/modify_transit_gateway_vpc_attachmentModifies the specified VPC attachment.TransitGatewayAttachmentId (string) required
AddSubnetIds (array)
RemoveSubnetIds (array)
Options: {
. DnsSupport (string)
. SecurityGroupReferencingSupport (string)
. Ipv6Support (string)
. ApplianceModeSupport (string)
} (object)
DryRun (boolean)
ec2/modify_verified_access_endpointModifies the configuration of the specified Amazon Web Services Verified Access endpoint.VerifiedAccessEndpointId (string) required
VerifiedAccessGroupId (string)
LoadBalancerOptions: {
. SubnetIds (array)
. Protocol (string)
. Port (integer)
. PortRanges (array)
} (object)
NetworkInterfaceOptions: {
. Protocol (string)
. Port (integer)
. PortRanges (array)
} (object)
Description (string)
ClientToken (string)
DryRun (boolean)
RdsOptions: {
. SubnetIds (array)
. Port (integer)
. RdsEndpoint (string)
} (object)
CidrOptions: {
. PortRanges (array)
} (object)
ec2/modify_verified_access_endpoint_policyModifies the specified Amazon Web Services Verified Access endpoint policy.VerifiedAccessEndpointId (string) required
PolicyEnabled (boolean)
PolicyDocument (string)
ClientToken (string)
DryRun (boolean)
SseSpecification: {
. CustomerManagedKeyEnabled (boolean)
. KmsKeyArn (string)
} (object)
ec2/modify_verified_access_groupModifies the specified Amazon Web Services Verified Access group configuration.VerifiedAccessGroupId (string) required
VerifiedAccessInstanceId (string)
Description (string)
ClientToken (string)
DryRun (boolean)
ec2/modify_verified_access_group_policyModifies the specified Amazon Web Services Verified Access group policy.VerifiedAccessGroupId (string) required
PolicyEnabled (boolean)
PolicyDocument (string)
ClientToken (string)
DryRun (boolean)
SseSpecification: {
. CustomerManagedKeyEnabled (boolean)
. KmsKeyArn (string)
} (object)
ec2/modify_verified_access_instanceModifies the configuration of the specified Amazon Web Services Verified Access instance.VerifiedAccessInstanceId (string) required
Description (string)
DryRun (boolean)
ClientToken (string)
CidrEndpointsCustomSubDomain (string)
ec2/modify_verified_access_instance_logging_configurationModifies the logging configuration for the specified Amazon Web Services Verified Access instance.VerifiedAccessInstanceId (string) required
AccessLogs: {
. S3 (object)
. CloudWatchLogs (object)
. KinesisDataFirehose (object)
. LogVersion (string)
. IncludeTrustContext (boolean)
} (object) required
DryRun (boolean)
ClientToken (string)
ec2/modify_verified_access_trust_providerModifies the configuration of the specified Amazon Web Services Verified Access trust provider.VerifiedAccessTrustProviderId (string) required
OidcOptions: {
. Issuer (string)
. AuthorizationEndpoint (string)
. TokenEndpoint (string)
. UserInfoEndpoint (string)
. ClientId (string)
. ClientSecret (string)
. Scope (string)
} (object)
DeviceOptions: {
. PublicSigningKeyUrl (string)
} (object)
Description (string)
DryRun (boolean)
ClientToken (string)
SseSpecification: {
. CustomerManagedKeyEnabled (boolean)
. KmsKeyArn (string)
} (object)
NativeApplicationOidcOptions: {
. PublicSigningKeyEndpoint (string)
. Issuer (string)
. AuthorizationEndpoint (string)
. TokenEndpoint (string)
. UserInfoEndpoint (string)
. ClientId (string)
. ClientSecret (string)
. Scope (string)
} (object)
ec2/modify_volumeYou 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 in the Amazon EBS User Guide. When you complete a resize operation on your volume, you need to extend the volume's file-systeDryRun (boolean)
VolumeId (string) required
Size (integer)
VolumeType (string)
Iops (integer)
Throughput (integer)
MultiAttachEnabled (boolean)
ec2/modify_volume_attributeModifies 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 dispoAutoEnableIO: {
. Value (boolean)
} (object)
VolumeId (string) required
DryRun (boolean)
ec2/modify_vpc_attributeModifies the specified attribute of the specified VPC.EnableDnsHostnames: {
. Value (boolean)
} (object)
EnableDnsSupport: {
. Value (boolean)
} (object)
VpcId (string) required
EnableNetworkAddressUsageMetrics: {
. Value (boolean)
} (object)
ec2/modify_vpc_block_public_access_exclusionModify VPC Block Public Access BPA exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on.DryRun (boolean)
ExclusionId (string) required
InternetGatewayExclusionMode (string) required
ec2/modify_vpc_block_public_access_optionsModify VPC Block Public Access BPA options. VPC Block Public Access BPA enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. To learn more about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.DryRun (boolean)
InternetGatewayBlockMode (string) required
ec2/modify_vpc_encryption_controlModifies the encryption control configuration for a VPC. You can update the encryption mode and exclusion settings for various gateway types and peering connections. For more information, see Enforce VPC encryption in transit in the Amazon VPC User Guide.DryRun (boolean)
VpcEncryptionControlId (string) required
Mode (string)
InternetGatewayExclusion (string)
EgressOnlyInternetGatewayExclusion (string)
NatGatewayExclusion (string)
VirtualPrivateGatewayExclusion (string)
VpcPeeringExclusion (string)
LambdaExclusion (string)
VpcLatticeExclusion (string)
ElasticFileSystemExclusion (string)
ec2/modify_vpc_endpointModifies 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.DryRun (boolean)
VpcEndpointId (string) required
ResetPolicy (boolean)
PolicyDocument (string)
AddRouteTableIds (array)
RemoveRouteTableIds (array)
AddSubnetIds (array)
RemoveSubnetIds (array)
AddSecurityGroupIds (array)
RemoveSecurityGroupIds (array)
IpAddressType (string)
DnsOptions: {
. DnsRecordIpType (string)
. PrivateDnsOnlyForInboundResolverEndpoint (boolean)
. PrivateDnsPreference (string)
. PrivateDnsSpecifiedDomains (array)
} (object)
PrivateDnsEnabled (boolean)
SubnetConfigurations (array)
ec2/modify_vpc_endpoint_connection_notificationModifies 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.DryRun (boolean)
ConnectionNotificationId (string) required
ConnectionNotificationArn (string)
ConnectionEvents (array)
ec2/modify_vpc_endpoint_service_configurationModifies the attributes of the specified VPC endpoint service configuration. If you set or modify the private DNS name, you must prove that you own the private DNS domain name.DryRun (boolean)
ServiceId (string) required
PrivateDnsName (string)
RemovePrivateDnsName (boolean)
AcceptanceRequired (boolean)
AddNetworkLoadBalancerArns (array)
RemoveNetworkLoadBalancerArns (array)
AddGatewayLoadBalancerArns (array)
RemoveGatewayLoadBalancerArns (array)
AddSupportedIpAddressTypes (array)
RemoveSupportedIpAddressTypes (array)
AddSupportedRegions (array)
RemoveSupportedRegions (array)
ec2/modify_vpc_endpoint_service_payer_responsibilityModifies the payer responsibility for your VPC endpoint service.DryRun (boolean)
ServiceId (string) required
PayerResponsibility (string) required
ec2/modify_vpc_endpoint_service_permissionsModifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers Amazon Web Services accounts, users, and IAM roles to connect to your endpoint service. Principal ARNs with path components aren't supported. 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.DryRun (boolean)
ServiceId (string) required
AddAllowedPrincipals (array)
RemoveAllowedPrincipals (array)
ec2/modify_vpc_peering_connection_optionsModifies the VPC peering connection options on one side of a VPC peering connection. 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 Amazon Web Services accounts or different Regions. For peered VPCs in different Amazon Web Services accounts, each Amazon Web ServAccepterPeeringConnectionOptions: {
. AllowDnsResolutionFromRemoteVpc (boolean)
. AllowEgressFromLocalClassicLinkToRemoteVpc (boolean)
. AllowEgressFromLocalVpcToRemoteClassicLink (boolean)
} (object)
DryRun (boolean)
RequesterPeeringConnectionOptions: {
. AllowDnsResolutionFromRemoteVpc (boolean)
. AllowEgressFromLocalClassicLinkToRemoteVpc (boolean)
. AllowEgressFromLocalVpcToRemoteClassicLink (boolean)
} (object)
VpcPeeringConnectionId (string) required
ec2/modify_vpc_tenancyModifies 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 EC2 User Guide.VpcId (string) required
InstanceTenancy (string) required
DryRun (boolean)
ec2/modify_vpn_connectionModifies 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 newVpnConnectionId (string) required
TransitGatewayId (string)
CustomerGatewayId (string)
VpnGatewayId (string)
DryRun (boolean)
ec2/modify_vpn_connection_optionsModifies 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.VpnConnectionId (string) required
LocalIpv4NetworkCidr (string)
RemoteIpv4NetworkCidr (string)
LocalIpv6NetworkCidr (string)
RemoteIpv6NetworkCidr (string)
DryRun (boolean)
ec2/modify_vpn_tunnel_certificateModifies the VPN tunnel endpoint certificate.VpnConnectionId (string) required
VpnTunnelOutsideIpAddress (string) required
DryRun (boolean)
ec2/modify_vpn_tunnel_optionsModifies 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.VpnConnectionId (string) required
VpnTunnelOutsideIpAddress (string) required
TunnelOptions: {
. TunnelInsideCidr (string)
. TunnelInsideIpv6Cidr (string)
. PreSharedKey (string)
. Phase1LifetimeSeconds (integer)
. Phase2LifetimeSeconds (integer)
. RekeyMarginTimeSeconds (integer)
. RekeyFuzzPercentage (integer)
. ReplayWindowSize (integer)
. DPDTimeoutSeconds (integer)
. DPDTimeoutAction (string)
. Phase1EncryptionAlgorithms (array)
. Phase2EncryptionAlgorithms (array)
. Phase1IntegrityAlgorithms (array)
. Phase2IntegrityAlgorithms (array)
. Phase1DHGroupNumbers (array)
. Phase2DHGroupNumbers (array)
. IKEVersions (array)
. StartupAction (string)
. LogOptions (object)
. EnableTunnelLifecycleControl (boolean)
} (object) required
DryRun (boolean)
SkipTunnelReplacement (boolean)
PreSharedKeyStorage (string)
ec2/monitor_instancesEnables 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.InstanceIds (array) required
DryRun (boolean)
ec2/move_address_to_vpcThis action is deprecated. 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. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.DryRun (boolean)
PublicIp (string) required
ec2/move_byoip_cidr_to_ipamMove a BYOIPv4 CIDR to IPAM from a public IPv4 pool. If you already have a BYOIPv4 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.DryRun (boolean)
Cidr (string) required
IpamPoolId (string) required
IpamPoolOwner (string) required
ec2/move_capacity_reservation_instancesMove available capacity from a source Capacity Reservation to a destination Capacity Reservation. The source Capacity Reservation and the destination Capacity Reservation must be active, owned by your Amazon Web Services account, and share the following: Instance type Platform Availability Zone Tenancy Placement group Capacity Reservation end time - At specific time or Manually.DryRun (boolean)
ClientToken (string)
SourceCapacityReservationId (string) required
DestinationCapacityReservationId (string) required
InstanceCount (integer) required
ec2/provision_byoip_cidrProvisions 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. 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 raCidr (string) required
CidrAuthorizationContext: {
. Message (string)
. Signature (string)
} (object)
PubliclyAdvertisable (boolean)
Description (string)
DryRun (boolean)
PoolTagSpecifications (array)
MultiRegion (boolean)
NetworkBorderGroup (string)
ec2/provision_ipam_byoasnProvisions your Autonomous System Number ASN for use in your Amazon Web Services account. This action requires authorization context for Amazon to bring the ASN to an Amazon Web Services account. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.DryRun (boolean)
IpamId (string) required
Asn (string) required
AsnAuthorizationContext: {
. Message (string)
. Signature (string)
} (object) required
ec2/provision_ipam_pool_cidrProvision 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.DryRun (boolean)
IpamPoolId (string) required
Cidr (string)
CidrAuthorizationContext: {
. Message (string)
. Signature (string)
} (object)
NetmaskLength (integer)
ClientToken (string)
VerificationMethod (string)
IpamExternalResourceVerificationTokenId (string)
ec2/provision_public_ipv4pool_cidrProvision a CIDR to a public IPv4 pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.DryRun (boolean)
IpamPoolId (string) required
PoolId (string) required
NetmaskLength (integer) required
NetworkBorderGroup (string)
ec2/purchase_capacity_blockPurchase the Capacity Block for use with your account. With Capacity Blocks you ensure GPU capacity is available for machine learning ML workloads. You must specify the ID of the Capacity Block offering you are purchasing.DryRun (boolean)
TagSpecifications (array)
CapacityBlockOfferingId (string) required
InstancePlatform (string) required
ec2/purchase_capacity_block_extensionPurchase the Capacity Block extension for use with your account. You must specify the ID of the Capacity Block extension offering you are purchasing.CapacityBlockExtensionOfferingId (string) required
CapacityReservationId (string) required
DryRun (boolean)
ec2/purchase_host_reservationPurchase 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.ClientToken (string)
CurrencyCode (string)
HostIdSet (array) required
LimitPrice (string)
OfferingId (string) required
TagSpecifications (array)
ec2/purchase_reserved_instances_offeringPurchases 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, tInstanceCount (integer) required
ReservedInstancesOfferingId (string) required
PurchaseTime (string)
DryRun (boolean)
LimitPrice: {
. Amount (number)
. CurrencyCode (string)
} (object)
ec2/purchase_scheduled_instancesYou 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 purClientToken (string)
DryRun (boolean)
PurchaseRequests (array) required
ec2/reboot_instancesRequests 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.InstanceIds (array) required
DryRun (boolean)
ec2/register_imageRegisters an AMI. When you're creating an instance-store backed AMI, registering the AMI is the final step in the creation process. For more information about creating AMIs, see Create an AMI from a snapshot and Create an instance-store backed AMI in the Amazon EC2 User Guide. 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 regImageLocation (string)
BillingProducts (array)
BootMode (string)
TpmSupport (string)
UefiData (string)
ImdsSupport (string)
TagSpecifications (array)
DryRun (boolean)
Name (string) required
Description (string)
Architecture (string)
KernelId (string)
RamdiskId (string)
RootDeviceName (string)
BlockDeviceMappings (array)
VirtualizationType (string)
SriovNetSupport (string)
EnaSupport (boolean)
ec2/register_instance_event_notification_attributesRegisters a set of tag keys to include in scheduled event notifications for your resources. To remove tags, use DeregisterInstanceEventNotificationAttributes.DryRun (boolean)
InstanceTagAttribute: {
. IncludeAllTagsOfInstance (boolean)
. InstanceTagKeys (array)
} (object) required
ec2/register_transit_gateway_multicast_group_membersRegisters 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 more information, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide. After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.TransitGatewayMulticastDomainId (string) required
GroupIpAddress (string)
NetworkInterfaceIds (array) required
DryRun (boolean)
ec2/register_transit_gateway_multicast_group_sourcesRegisters 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 more information about supported instances, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide. After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.TransitGatewayMulticastDomainId (string) required
GroupIpAddress (string)
NetworkInterfaceIds (array) required
DryRun (boolean)
ec2/reject_capacity_reservation_billing_ownershipRejects a request to assign billing of the available capacity of a shared Capacity Reservation to your account. For more information, see Billing assignment for shared Amazon EC2 Capacity Reservations.DryRun (boolean)
CapacityReservationId (string) required
ec2/reject_transit_gateway_multicast_domain_associationsRejects a request to associate cross-account subnets with a transit gateway multicast domain.TransitGatewayMulticastDomainId (string)
TransitGatewayAttachmentId (string)
SubnetIds (array)
DryRun (boolean)
ec2/reject_transit_gateway_peering_attachmentRejects a transit gateway peering attachment request.TransitGatewayAttachmentId (string) required
DryRun (boolean)
ec2/reject_transit_gateway_vpc_attachmentRejects 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.TransitGatewayAttachmentId (string) required
DryRun (boolean)
ec2/reject_vpc_endpoint_connectionsRejects VPC endpoint connection requests to your VPC endpoint service.DryRun (boolean)
ServiceId (string) required
VpcEndpointIds (array) required
ec2/reject_vpc_peering_connectionRejects 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.DryRun (boolean)
VpcPeeringConnectionId (string) required
ec2/release_addressReleases the specified Elastic IP address. Default VPC Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. Alternatively, you can disassociate an Elastic IP address without releasing it. Nondefault VPC You must 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 reAllocationId (string)
PublicIp (string)
NetworkBorderGroup (string)
DryRun (boolean)
ec2/release_hostsWhen 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 wheHostIds (array) required
ec2/release_ipam_pool_allocationRelease an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. 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. All EC2 API actions follow an evenDryRun (boolean)
IpamPoolId (string) required
Cidr (string) required
IpamPoolAllocationId (string) required
ec2/replace_iam_instance_profile_associationReplaces 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.IamInstanceProfile: {
. Arn (string)
. Name (string)
} (object) required
AssociationId (string) required
ec2/replace_image_criteria_in_allowed_images_settingsSets or replaces the criteria for Allowed AMIs. The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.ImageCriteria (array)
DryRun (boolean)
ec2/replace_network_acl_associationChanges 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 VPC User Guide. This is an idempotent operation.DryRun (boolean)
AssociationId (string) required
NetworkAclId (string) required
ec2/replace_network_acl_entryReplaces an entry rule in a network ACL. For more information, see Network ACLs in the Amazon VPC User Guide.DryRun (boolean)
NetworkAclId (string) required
RuleNumber (integer) required
Protocol (string) required
RuleAction (string) required
Egress (boolean) required
CidrBlock (string)
Ipv6CidrBlock (string)
IcmpTypeCode: {
. Code (integer)
. Type (integer)
} (object)
PortRange: {
. From (integer)
. To (integer)
} (object)
ec2/replace_routeReplaces 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 VPC User Guide.DestinationPrefixListId (string)
VpcEndpointId (string)
LocalTarget (boolean)
TransitGatewayId (string)
LocalGatewayId (string)
CarrierGatewayId (string)
CoreNetworkArn (string)
OdbNetworkArn (string)
DryRun (boolean)
RouteTableId (string) required
DestinationCidrBlock (string)
GatewayId (string)
DestinationIpv6CidrBlock (string)
EgressOnlyInternetGatewayId (string)
InstanceId (string)
NetworkInterfaceId (string)
VpcPeeringConnectionId (string)
NatGatewayId (string)
ec2/replace_route_table_associationChanges 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 VPC 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.DryRun (boolean)
AssociationId (string) required
RouteTableId (string) required
ec2/replace_transit_gateway_routeReplaces the specified route in the specified transit gateway route table.DestinationCidrBlock (string) required
TransitGatewayRouteTableId (string) required
TransitGatewayAttachmentId (string)
Blackhole (boolean)
DryRun (boolean)
ec2/replace_vpn_tunnelTrigger replacement of specified VPN tunnel.VpnConnectionId (string) required
VpnTunnelOutsideIpAddress (string) required
ApplyPendingMaintenance (boolean)
DryRun (boolean)
ec2/report_instance_statusSubmits 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.DryRun (boolean)
Instances (array) required
Status (string) required
StartTime (string)
EndTime (string)
ReasonCodes (array) required
Description (string)
ec2/request_spot_fleetCreates 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 unitDryRun (boolean)
SpotFleetRequestConfig: {
. AllocationStrategy (string)
. OnDemandAllocationStrategy (string)
. SpotMaintenanceStrategies (object)
. ClientToken (string)
. ExcessCapacityTerminationPolicy (string)
. FulfilledCapacity (number)
. OnDemandFulfilledCapacity (number)
. IamFleetRole (string)
. LaunchSpecifications (array)
. LaunchTemplateConfigs (array)
. SpotPrice (string)
. TargetCapacity (integer)
. OnDemandTargetCapacity (integer)
. OnDemandMaxTotalPrice (string)
. SpotMaxTotalPrice (string)
. TerminateInstancesWithExpiration (boolean)
. Type (string)
. ValidFrom (string)
. ValidUntil (string)
. ReplaceUnhealthyInstances (boolean)
. InstanceInterruptionBehavior (string)
. LoadBalancersConfig (object)
. InstancePoolsToUseCount (integer)
. Context (string)
. TargetCapacityUnitType (string)
. TagSpecifications (array)
} (object) required
ec2/request_spot_instancesCreates a Spot Instance request. For more information, see Work with Spot Instance in the Amazon EC2 User Guide. 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.LaunchSpecification: {
. SecurityGroupIds (array)
. SecurityGroups (array)
. AddressingType (string)
. BlockDeviceMappings (array)
. EbsOptimized (boolean)
. IamInstanceProfile (object)
. ImageId (string)
. InstanceType (string)
. KernelId (string)
. KeyName (string)
. Monitoring (object)
. NetworkInterfaces (array)
. Placement (object)
. RamdiskId (string)
. SubnetId (string)
. UserData (string)
} (object)
TagSpecifications (array)
InstanceInterruptionBehavior (string)
DryRun (boolean)
SpotPrice (string)
ClientToken (string)
InstanceCount (integer)
Type (string)
ValidFrom (string)
ValidUntil (string)
LaunchGroup (string)
AvailabilityZoneGroup (string)
BlockDurationMinutes (integer)
ec2/reset_address_attributeResets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.AllocationId (string) required
Attribute (string) required
DryRun (boolean)
ec2/reset_ebs_default_kms_key_idResets 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 EBS User Guide.DryRun (boolean)
ec2/reset_fpga_image_attributeResets the specified attribute of the specified Amazon FPGA Image AFI to its default value. You can only reset the load permission attribute.DryRun (boolean)
FpgaImageId (string) required
Attribute (string)
ec2/reset_image_attributeResets an attribute of an AMI to its default value.Attribute (string) required
ImageId (string) required
DryRun (boolean)
ec2/reset_instance_attributeResets 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.DryRun (boolean)
InstanceId (string) required
Attribute (string) required
ec2/reset_network_interface_attributeResets a network interface attribute. You can specify only one attribute at a time.DryRun (boolean)
NetworkInterfaceId (string) required
SourceDestCheck (string)
ec2/reset_snapshot_attributeResets permission settings for the specified snapshot. For more information about modifying snapshot permissions, see Share a snapshot in the Amazon EBS User Guide.Attribute (string) required
SnapshotId (string) required
DryRun (boolean)
ec2/restore_address_to_classicThis action is deprecated. 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.DryRun (boolean)
PublicIp (string) required
ec2/restore_image_from_recycle_binRestores an AMI from the Recycle Bin. For more information, see Recover deleted Amazon EBS snapshots and EBS-back AMIs with Recycle Bin in the Amazon EC2 User Guide.ImageId (string) required
DryRun (boolean)
ec2/restore_managed_prefix_list_versionRestores the entries from a previous version of a managed prefix list to a new version of the prefix list.DryRun (boolean)
PrefixListId (string) required
PreviousVersion (integer) required
CurrentVersion (integer) required
ec2/restore_snapshot_from_recycle_binRestores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon EBS User Guide.SnapshotId (string) required
DryRun (boolean)
ec2/restore_snapshot_tierRestores 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 EBS User Guide.SnapshotId (string) required
TemporaryRestoreDays (integer)
PermanentRestore (boolean)
DryRun (boolean)
ec2/restore_volume_from_recycle_binRestores a volume from the Recycle Bin. For more information, see Restore volumes from the Recycle Bin in the Amazon EBS User Guide.VolumeId (string) required
DryRun (boolean)
ec2/revoke_client_vpn_ingressRemoves an ingress authorization rule from a Client VPN endpoint.ClientVpnEndpointId (string) required
TargetNetworkCidr (string) required
AccessGroupId (string)
RevokeAllGroups (boolean)
DryRun (boolean)
ec2/revoke_security_group_egressRemoves the specified outbound egress rules from the specified 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 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,SecurityGroupRuleIds (array)
DryRun (boolean)
GroupId (string) required
SourceSecurityGroupName (string)
SourceSecurityGroupOwnerId (string)
IpProtocol (string)
FromPort (integer)
ToPort (integer)
CidrIp (string)
IpPermissions (array)
ec2/revoke_security_group_ingressRemoves 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 spCidrIp (string)
FromPort (integer)
GroupId (string)
GroupName (string)
IpPermissions (array)
IpProtocol (string)
SourceSecurityGroupName (string)
SourceSecurityGroupOwnerId (string)
ToPort (integer)
SecurityGroupRuleIds (array)
DryRun (boolean)
ec2/run_instancesLaunches 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: 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. 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 ofBlockDeviceMappings (array)
ImageId (string)
InstanceType (string)
Ipv6AddressCount (integer)
Ipv6Addresses (array)
KernelId (string)
KeyName (string)
MaxCount (integer) required
MinCount (integer) required
Monitoring: {
. Enabled (boolean)
} (object)
Placement: {
. AvailabilityZoneId (string)
. Affinity (string)
. GroupName (string)
. PartitionNumber (integer)
. HostId (string)
. Tenancy (string)
. SpreadDomain (string)
. HostResourceGroupArn (string)
. GroupId (string)
. AvailabilityZone (string)
} (object)
RamdiskId (string)
SecurityGroupIds (array)
SecurityGroups (array)
SubnetId (string)
UserData (string)
ElasticGpuSpecification (array)
ElasticInferenceAccelerators (array)
TagSpecifications (array)
LaunchTemplate: {
. LaunchTemplateId (string)
. LaunchTemplateName (string)
. Version (string)
} (object)
InstanceMarketOptions: {
. MarketType (string)
. SpotOptions (object)
} (object)
CreditSpecification: {
. CpuCredits (string)
} (object)
CpuOptions: {
. CoreCount (integer)
. ThreadsPerCore (integer)
. AmdSevSnp (string)
. NestedVirtualization (string)
} (object)
CapacityReservationSpecification: {
. CapacityReservationPreference (string)
. CapacityReservationTarget (object)
} (object)
HibernationOptions: {
. Configured (boolean)
} (object)
LicenseSpecifications (array)
MetadataOptions: {
. HttpTokens (string)
. HttpPutResponseHopLimit (integer)
. HttpEndpoint (string)
. HttpProtocolIpv6 (string)
. InstanceMetadataTags (string)
} (object)
EnclaveOptions: {
. Enabled (boolean)
} (object)
PrivateDnsNameOptions: {
. HostnameType (string)
. EnableResourceNameDnsARecord (boolean)
. EnableResourceNameDnsAAAARecord (boolean)
} (object)
MaintenanceOptions: {
. AutoRecovery (string)
} (object)
DisableApiStop (boolean)
EnablePrimaryIpv6 (boolean)
NetworkPerformanceOptions: {
. BandwidthWeighting (string)
} (object)
Operator: {
. Principal (string)
} (object)
SecondaryInterfaces (array)
DryRun (boolean)
DisableApiTermination (boolean)
InstanceInitiatedShutdownBehavior (string)
PrivateIpAddress (string)
ClientToken (string)
AdditionalInfo (string)
NetworkInterfaces (array)
IamInstanceProfile: {
. Arn (string)
. Name (string)
} (object)
EbsOptimized (boolean)
ec2/run_scheduled_instancesLaunches 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.ClientToken (string)
DryRun (boolean)
InstanceCount (integer)
LaunchSpecification: {
. BlockDeviceMappings (array)
. EbsOptimized (boolean)
. IamInstanceProfile (object)
. ImageId (string)
. InstanceType (string)
. KernelId (string)
. KeyName (string)
. Monitoring (object)
. NetworkInterfaces (array)
. Placement (object)
. RamdiskId (string)
. SecurityGroupIds (array)
. SubnetId (string)
. UserData (string)
} (object) required
ScheduledInstanceId (string) required
ec2/search_local_gateway_routesSearches for routes in the specified local gateway route table.LocalGatewayRouteTableId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/search_transit_gateway_multicast_groupsSearches one or more transit gateway multicast groups and returns the group membership information.TransitGatewayMulticastDomainId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
DryRun (boolean)
ec2/search_transit_gateway_routesSearches for routes in the specified transit gateway route table.TransitGatewayRouteTableId (string) required
Filters (array) required
MaxResults (integer)
DryRun (boolean)
NextToken (string)
ec2/send_diagnostic_interruptSends 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 secondaInstanceId (string) required
DryRun (boolean)
ec2/start_declarative_policies_reportGenerates an account status report. The report is generated asynchronously, and can take several hours to complete. The report provides the current status of all attributes supported by declarative policies for the accounts within the specified scope. The scope is determined by the specified TargetId, which can represent an individual account, or all the accounts that fall under the specified organizational unit OU or root the entire Amazon Web Services Organization. The report is saved to yourDryRun (boolean)
S3Bucket (string) required
S3Prefix (string)
TargetId (string) required
TagSpecifications (array)
ec2/start_instancesStarts 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 ECInstanceIds (array) required
AdditionalInfo (string)
DryRun (boolean)
ec2/start_network_insights_access_scope_analysisStarts analyzing the specified Network Access Scope.NetworkInsightsAccessScopeId (string) required
DryRun (boolean)
TagSpecifications (array)
ClientToken (string) required
ec2/start_network_insights_analysisStarts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.NetworkInsightsPathId (string) required
AdditionalAccounts (array)
FilterInArns (array)
FilterOutArns (array)
DryRun (boolean)
TagSpecifications (array)
ClientToken (string) required
ec2/start_vpc_endpoint_service_private_dns_verificationInitiates 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.DryRun (boolean)
ServiceId (string) required
ec2/stop_instancesStops an Amazon EBS-backed instance. You can restart your instance at any time using the StartInstances API. For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide. When you stop or hibernate an instance, we shut it down. By default, this includes a graceful operating system OS shutdown. To bypass the graceful shutdown, use the skipOsShutdown parameter; however, this might risk data integrity. You can use the StopInstances operation together with the HibernateInstanceIds (array) required
Hibernate (boolean)
SkipOsShutdown (boolean)
DryRun (boolean)
Force (boolean)
ec2/terminate_client_vpn_connectionsTerminates 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.ClientVpnEndpointId (string) required
ConnectionId (string)
Username (string)
DryRun (boolean)
ec2/terminate_instancesTerminates deletes the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds. Terminating an instance is permanent and irreversible. After you terminate an instance, you can no longer connect to it, and it can't be recovered. All attached Amazon EBS volumes that are configured to be deleted on termination are also permanently deleted and can't be recovered. All data stored on instance store volumes is permanently lost. For more informaInstanceIds (array) required
Force (boolean)
SkipOsShutdown (boolean)
DryRun (boolean)
ec2/unassign_ipv6addressesUnassigns the specified IPv6 addresses or Prefix Delegation prefixes from a network interface.Ipv6Prefixes (array)
NetworkInterfaceId (string) required
Ipv6Addresses (array)
ec2/unassign_private_ip_addressesUnassigns the specified secondary private IP addresses or IPv4 Prefix Delegation prefixes from a network interface.Ipv4Prefixes (array)
NetworkInterfaceId (string) required
PrivateIpAddresses (array)
ec2/unassign_private_nat_gateway_addressUnassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon VPC User Guide. While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway. A private IP address will only be released at the end of MaxDrainDurationSeconds. The private IP addresses staNatGatewayId (string) required
PrivateIpAddresses (array) required
MaxDrainDurationSeconds (integer)
DryRun (boolean)
ec2/unlock_snapshotUnlocks a snapshot that is locked in governance mode or that is locked in compliance mode but still in the cooling-off period. You can't unlock a snapshot that is locked in compliance mode after the cooling-off period has expired.SnapshotId (string) required
DryRun (boolean)
ec2/unmonitor_instancesDisables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.InstanceIds (array) required
DryRun (boolean)
ec2/update_capacity_manager_organizations_accessUpdates the Organizations access setting for EC2 Capacity Manager. This controls whether Capacity Manager can aggregate data from all accounts in your Amazon Web Services Organization or only from the current account.OrganizationsAccess (boolean) required
DryRun (boolean)
ClientToken (string)
ec2/update_interruptible_capacity_reservation_allocationModifies the number of instances allocated to an interruptible reservation, allowing you to add more capacity or reclaim capacity to your source Capacity Reservation.CapacityReservationId (string) required
TargetInstanceCount (integer) required
DryRun (boolean)
ec2/update_security_group_rule_descriptions_egressUpdates 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.DryRun (boolean)
GroupId (string)
GroupName (string)
IpPermissions (array)
SecurityGroupRuleDescriptions (array)
ec2/update_security_group_rule_descriptions_ingressUpdates 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.DryRun (boolean)
GroupId (string)
GroupName (string)
IpPermissions (array)
SecurityGroupRuleDescriptions (array)
ec2/withdraw_byoip_cidrStops 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.Cidr (string) required
DryRun (boolean)
ecr_public/batch_check_layer_availabilityChecks the availability of one or more image layers that are 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.registryId (string)
repositoryName (string) required
layerDigests (array) required
ecr_public/batch_delete_imageDeletes a list of specified images that are 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 digest of the image in your request.registryId (string)
repositoryName (string) required
imageIds (array) required
ecr_public/complete_layer_uploadInforms Amazon ECR that the image layer upload is complete 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 for each new image layer to verify that the upload is complete. 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 theregistryId (string)
repositoryName (string) required
uploadId (string) required
layerDigests (array) required
ecr_public/create_repositoryCreates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.repositoryName (string) required
catalogData: {
. description (string)
. architectures (array)
. operatingSystems (array)
. logoImageBlob (string)
. aboutText (string)
. usageText (string)
} (object)
tags (array)
ecr_public/delete_repositoryDeletes a repository in a public registry. If the repository contains images, you must either manually delete all images in the repository or use the force option. This option deletes all images on your behalf before deleting the repository.registryId (string)
repositoryName (string) required
force (boolean)
ecr_public/delete_repository_policyDeletes the repository policy that's associated with the specified repository.registryId (string)
repositoryName (string) required
ecr_public/describe_imagesReturns metadata that's related to 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. Therefore, it might return a larger image size than the image sizes that are returned by DescribeImages.registryId (string)
repositoryName (string) required
imageIds (array)
nextToken (string)
maxResults (integer)
ecr_public/describe_image_tagsReturns the image tag details for a repository in a public registry.registryId (string)
repositoryName (string) required
nextToken (string)
maxResults (integer)
ecr_public/describe_registriesReturns details for a public registry.nextToken (string)
maxResults (integer)
ecr_public/describe_repositoriesDescribes repositories that are in a public registry.registryId (string)
repositoryNames (array)
nextToken (string)
maxResults (integer)
ecr_public/get_authorization_tokenRetrieves an authorization token. An authorization token represents your IAM authentication credentials. You can use it 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.No parameters
ecr_public/get_registry_catalog_dataRetrieves catalog metadata for a public registry.No parameters
ecr_public/get_repository_catalog_dataRetrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.registryId (string)
repositoryName (string) required
ecr_public/get_repository_policyRetrieves the repository policy for the specified repository.registryId (string)
repositoryName (string) required
ecr_public/initiate_layer_uploadNotifies Amazon ECR that you intend to upload an image layer. When an image is pushed, the InitiateLayerUpload API is called once for each image layer that hasn't already been uploaded. Whether an image layer uploads 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.registryId (string)
repositoryName (string) required
ecr_public/list_tags_for_resourceList the tags for an Amazon ECR Public resource.resourceArn (string) required
ecr_public/put_imageCreates or updates the image manifest and tags that are 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 that are 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.registryId (string)
repositoryName (string) required
imageManifest (string) required
imageManifestMediaType (string)
imageTag (string)
imageDigest (string)
ecr_public/put_registry_catalog_dataCreate or update the catalog data for a public registry.displayName (string)
ecr_public/put_repository_catalog_dataCreates or updates the catalog data for a repository in a public registry.registryId (string)
repositoryName (string) required
catalogData: {
. description (string)
. architectures (array)
. operatingSystems (array)
. logoImageBlob (string)
. aboutText (string)
. usageText (string)
} (object) required
ecr_public/set_repository_policyApplies 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.registryId (string)
repositoryName (string) required
policyText (string) required
force (boolean)
ecr_public/tag_resourceAssociates 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.resourceArn (string) required
tags (array) required
ecr_public/untag_resourceDeletes specified tags from a resource.resourceArn (string) required
tagKeys (array) required
ecr_public/upload_layer_partUploads 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 about 20MB. The UploadLayerPart API is called once for 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.registryId (string)
repositoryName (string) required
uploadId (string) required
partFirstByte (integer) required
partLastByte (integer) required
layerPartBlob (string) required
ecr/batch_check_layer_availabilityChecks 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.registryId (string)
repositoryName (string) required
layerDigests (array) required
ecr/batch_delete_imageDeletes 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.registryId (string)
repositoryName (string) required
imageIds (array) required
ecr/batch_get_imageGets 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.registryId (string)
repositoryName (string) required
imageIds (array) required
acceptedMediaTypes (array)
ecr/batch_get_repository_scanning_configurationGets the scanning configuration for one or more repositories.repositoryNames (array) required
ecr/complete_layer_uploadInforms 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 docregistryId (string)
repositoryName (string) required
uploadId (string) required
layerDigests (array) required
ecr/create_pull_through_cache_ruleCreates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private registry. For more information, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.ecrRepositoryPrefix (string) required
upstreamRegistryUrl (string) required
registryId (string)
upstreamRegistry (string)
credentialArn (string)
customRoleArn (string)
upstreamRepositoryPrefix (string)
ecr/create_repositoryCreates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.registryId (string)
repositoryName (string) required
tags (array)
imageTagMutability (string)
imageTagMutabilityExclusionFilters (array)
imageScanningConfiguration: {
. scanOnPush (boolean)
} (object)
encryptionConfiguration: {
. encryptionType (string)
. kmsKey (string)
} (object)
ecr/create_repository_creation_templateCreates a repository creation template. This template is used to define the settings for repositories created by Amazon ECR on your behalf. For example, repositories created through pull through cache actions. For more information, see Private repository creation templates in the Amazon Elastic Container Registry User Guide.prefix (string) required
description (string)
encryptionConfiguration: {
. encryptionType (string)
. kmsKey (string)
} (object)
resourceTags (array)
imageTagMutability (string)
imageTagMutabilityExclusionFilters (array)
repositoryPolicy (string)
lifecyclePolicy (string)
appliedFor (array) required
customRoleArn (string)
ecr/delete_lifecycle_policyDeletes the lifecycle policy associated with the specified repository.registryId (string)
repositoryName (string) required
ecr/delete_pull_through_cache_ruleDeletes a pull through cache rule.ecrRepositoryPrefix (string) required
registryId (string)
ecr/delete_registry_policyDeletes the registry permissions policy.No parameters
ecr/delete_repositoryDeletes a repository. If the repository isn't empty, you must either delete the contents of the repository or use the force option to delete the repository and have Amazon ECR delete all of its contents on your behalf.registryId (string)
repositoryName (string) required
force (boolean)
ecr/delete_repository_creation_templateDeletes a repository creation template.prefix (string) required
ecr/delete_repository_policyDeletes the repository policy associated with the specified repository.registryId (string)
repositoryName (string) required
ecr/delete_signing_configurationDeletes the registry's signing configuration. Images pushed after deletion of the signing configuration will no longer be automatically signed. For more information, see Managed signing in the Amazon Elastic Container Registry User Guide. Deleting the signing configuration does not affect existing image signatures.No parameters
ecr/deregister_pull_time_update_exclusionRemoves a principal from the pull time update exclusion list for a registry. Once removed, Amazon ECR will resume updating the pull time if the specified principal pulls an image.principalArn (string) required
ecr/describe_image_replication_statusReturns the replication status for a specified image.repositoryName (string) required
imageId: {
. imageDigest (string)
. imageTag (string)
} (object) required
registryId (string)
ecr/describe_imagesReturns metadata about the images in a repository. Starting 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. Therefore, Docker might return a larger image than the image shown in the Amazon Web Services Management Console. The new version of Amazon ECR Basic Scanning doesn't use the ImageDetail$imageScanFindingsSummary and ImageDetail$imageScanStatus attributeregistryId (string)
repositoryName (string) required
imageIds (array)
nextToken (string)
maxResults (integer)
filter: {
. tagStatus (string)
. imageStatus (string)
} (object)
ecr/describe_image_scan_findingsReturns the scan findings for the specified image.registryId (string)
repositoryName (string) required
imageId: {
. imageDigest (string)
. imageTag (string)
} (object) required
nextToken (string)
maxResults (integer)
ecr/describe_image_signing_statusReturns the signing status for a specified image. If the image matched signing rules that reference different signing profiles, a status is returned for each profile. For more information, see Managed signing in the Amazon Elastic Container Registry User Guide.repositoryName (string) required
imageId: {
. imageDigest (string)
. imageTag (string)
} (object) required
registryId (string)
ecr/describe_pull_through_cache_rulesReturns the pull through cache rules for a registry.registryId (string)
ecrRepositoryPrefixes (array)
nextToken (string)
maxResults (integer)
ecr/describe_registryDescribes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.No parameters
ecr/describe_repositoriesDescribes image repositories in a registry.registryId (string)
repositoryNames (array)
nextToken (string)
maxResults (integer)
ecr/describe_repository_creation_templatesReturns details about the repository creation templates in a registry. The prefixes request parameter can be used to return the details for a specific repository creation template.prefixes (array)
nextToken (string)
maxResults (integer)
ecr/get_account_settingRetrieves the account setting value for the specified setting name.name (string) required
ecr/get_authorization_tokenRetrieves 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 RegistryregistryIds (array)
ecr/get_download_url_for_layerRetrieves 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.registryId (string)
repositoryName (string) required
layerDigest (string) required
ecr/get_lifecycle_policyRetrieves the lifecycle policy for the specified repository.registryId (string)
repositoryName (string) required
ecr/get_lifecycle_policy_previewRetrieves the results of the lifecycle policy preview request for the specified repository.registryId (string)
repositoryName (string) required
imageIds (array)
nextToken (string)
maxResults (integer)
filter: {
. tagStatus (string)
} (object)
ecr/get_registry_policyRetrieves the permissions policy for a registry.No parameters
ecr/get_registry_scanning_configurationRetrieves the scanning configuration for a registry.No parameters
ecr/get_repository_policyRetrieves the repository policy for the specified repository.registryId (string)
repositoryName (string) required
ecr/get_signing_configurationRetrieves the registry's signing configuration, which defines rules for automatically signing images using Amazon Web Services Signer. For more information, see Managed signing in the Amazon Elastic Container Registry User Guide.No parameters
ecr/initiate_layer_uploadNotifies 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.registryId (string)
repositoryName (string) required
ecr/list_image_referrersLists the artifacts associated with a specified subject image.registryId (string)
repositoryName (string) required
subjectId: {
. imageDigest (string)
} (object) required
filter: {
. artifactTypes (array)
. artifactStatus (string)
} (object)
nextToken (string)
maxResults (integer)
ecr/list_imagesLists 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.registryId (string)
repositoryName (string) required
nextToken (string)
maxResults (integer)
filter: {
. tagStatus (string)
. imageStatus (string)
} (object)
ecr/list_pull_time_update_exclusionsLists the IAM principals that are excluded from having their image pull times recorded.maxResults (integer)
nextToken (string)
ecr/list_tags_for_resourceList the tags for an Amazon ECR resource.resourceArn (string) required
ecr/put_account_settingAllows you to change the basic scan type version or registry policy scope.name (string) required
value (string) required
ecr/put_imageCreates 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.registryId (string)
repositoryName (string) required
imageManifest (string) required
imageManifestMediaType (string)
imageTag (string)
imageDigest (string)
ecr/put_image_scanning_configurationThe 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.registryId (string)
repositoryName (string) required
imageScanningConfiguration: {
. scanOnPush (boolean)
} (object) required
ecr/put_image_tag_mutabilityUpdates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.registryId (string)
repositoryName (string) required
imageTagMutability (string) required
imageTagMutabilityExclusionFilters (array)
ecr/put_lifecycle_policyCreates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.registryId (string)
repositoryName (string) required
lifecyclePolicyText (string) required
ecr/put_registry_policyCreates 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.policyText (string) required
ecr/put_registry_scanning_configurationCreates or updates the scanning configuration for your private registry.scanType (string)
rules (array)
ecr/put_replication_configurationCreates 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. For more information on the custom role for replication, sereplicationConfiguration: {
. rules (array)
} (object) required
ecr/put_signing_configurationCreates or updates the registry's signing configuration, which defines rules for automatically signing images with Amazon Web Services Signer. For more information, see Managed signing in the Amazon Elastic Container Registry User Guide. To successfully generate a signature, the IAM principal pushing images must have permission to sign payloads with the Amazon Web Services Signer signing profile referenced in the signing configuration.signingConfiguration: {
. rules (array)
} (object) required
ecr/register_pull_time_update_exclusionAdds an IAM principal to the pull time update exclusion list for a registry. Amazon ECR will not record the pull time if an excluded principal pulls an image.principalArn (string) required
ecr/set_repository_policyApplies 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.registryId (string)
repositoryName (string) required
policyText (string) required
force (boolean)
ecr/start_image_scanStarts a basic image vulnerability scan. A basic 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. You can start up to 100,000 basic scans per 24 hours. This limit includes both scans on initial push and scans initiated by the StartImageScan API. For more information, see Basic scanning in the Amazon Elastic Container Registry User Guide.registryId (string)
repositoryName (string) required
imageId: {
. imageDigest (string)
. imageTag (string)
} (object) required
ecr/start_lifecycle_policy_previewStarts 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.registryId (string)
repositoryName (string) required
lifecyclePolicyText (string)
ecr/tag_resourceAdds 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.resourceArn (string) required
tags (array) required
ecr/untag_resourceDeletes specified tags from a resource.resourceArn (string) required
tagKeys (array) required
ecr/update_image_storage_classTransitions an image between storage classes. You can transition images from Amazon ECR standard storage class to Amazon ECR archival storage class for long-term storage, or restore archived images back to Amazon ECR standard.registryId (string)
repositoryName (string) required
imageId: {
. imageDigest (string)
. imageTag (string)
} (object) required
targetStorageClass (string) required
ecr/update_pull_through_cache_ruleUpdates an existing pull through cache rule.registryId (string)
ecrRepositoryPrefix (string) required
credentialArn (string)
customRoleArn (string)
ecr/update_repository_creation_templateUpdates an existing repository creation template.prefix (string) required
description (string)
encryptionConfiguration: {
. encryptionType (string)
. kmsKey (string)
} (object)
resourceTags (array)
imageTagMutability (string)
imageTagMutabilityExclusionFilters (array)
repositoryPolicy (string)
lifecyclePolicy (string)
appliedFor (array)
customRoleArn (string)
ecr/upload_layer_partUploads 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.registryId (string)
repositoryName (string) required
uploadId (string) required
partFirstByte (integer) required
partLastByte (integer) required
layerPartBlob (string) required
ecr/validate_pull_through_cache_ruleValidates an existing pull through cache rule for an upstream registry that requires authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the syntax, and then validate that authentication to the upstream registry is successful.ecrRepositoryPrefix (string) required
registryId (string)
ecs/create_capacity_providerCreates a capacity provider. Capacity providers are associated with a cluster and are used in capacity provider strategies to facilitate cluster auto scaling. You can create capacity providers for Amazon ECS Managed Instances and EC2 instances. Fargate has the predefined FARGATE and FARGATE_SPOT capacity providers.name (string) required
cluster (string)
autoScalingGroupProvider: {
. autoScalingGroupArn (string)
. managedScaling (object)
. managedTerminationProtection (string)
. managedDraining (string)
} (object)
managedInstancesProvider: {
. infrastructureRoleArn (string)
. instanceLaunchTemplate (object)
. propagateTags (string)
. infrastructureOptimization (object)
} (object)
tags (array)
ecs/create_clusterCreates 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. 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 user that makes the call doesn't have permissions to creaclusterName (string)
tags (array)
settings (array)
configuration: {
. executeCommandConfiguration (object)
. managedStorageConfiguration (object)
} (object)
capacityProviders (array)
defaultCapacityProviderStrategy (array)
serviceConnectDefaults: {
. namespace (string)
} (object)
ecs/create_express_gateway_serviceCreates an Express service that simplifies deploying containerized web applications on Amazon ECS with managed Amazon Web Services infrastructure. This operation provisions and configures Application Load Balancers, target groups, security groups, and auto-scaling policies automatically. Specify a primary container configuration with your application image and basic settings. Amazon ECS creates the necessary Amazon Web Services resources for traffic distribution, health monitoring, network accesexecutionRoleArn (string) required
infrastructureRoleArn (string) required
serviceName (string)
cluster (string)
healthCheckPath (string)
primaryContainer: {
. image (string)
. containerPort (integer)
. awsLogsConfiguration (object)
. repositoryCredentials (object)
. command (array)
. environment (array)
. secrets (array)
} (object) required
taskRoleArn (string)
networkConfiguration: {
. securityGroups (array)
. subnets (array)
} (object)
cpu (string)
memory (string)
scalingTarget: {
. minTaskCount (integer)
. maxTaskCount (integer)
. autoScalingMetric (string)
. autoScalingTargetValue (integer)
} (object)
tags (array)
ecs/create_serviceRuns 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, use UpdateService. On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition. Amazocluster (string)
serviceName (string) required
taskDefinition (string)
availabilityZoneRebalancing (string)
loadBalancers (array)
serviceRegistries (array)
desiredCount (integer)
clientToken (string)
launchType (string)
capacityProviderStrategy (array)
platformVersion (string)
role (string)
deploymentConfiguration: {
. deploymentCircuitBreaker (object)
. maximumPercent (integer)
. minimumHealthyPercent (integer)
. alarms (object)
. strategy (string)
. bakeTimeInMinutes (integer)
. lifecycleHooks (array)
. linearConfiguration (object)
. canaryConfiguration (object)
} (object)
placementConstraints (array)
placementStrategy (array)
networkConfiguration: {
. awsvpcConfiguration (object)
} (object)
healthCheckGracePeriodSeconds (integer)
schedulingStrategy (string)
deploymentController: {
. type (string)
} (object)
tags (array)
enableECSManagedTags (boolean)
propagateTags (string)
enableExecuteCommand (boolean)
serviceConnectConfiguration: {
. enabled (boolean)
. namespace (string)
. services (array)
. logConfiguration (object)
. accessLogConfiguration (object)
} (object)
volumeConfigurations (array)
vpcLatticeConfigurations (array)
ecs/create_task_setCreate 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. On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition. For information about the maximum numservice (string) required
cluster (string) required
externalId (string)
taskDefinition (string) required
networkConfiguration: {
. awsvpcConfiguration (object)
} (object)
loadBalancers (array)
serviceRegistries (array)
launchType (string)
capacityProviderStrategy (array)
platformVersion (string)
scale: {
. value (number)
. unit (string)
} (object)
clientToken (string)
tags (array)
ecs/delete_account_settingDisables an account setting for a specified user, role, or the root user for an account.name (string) required
principalArn (string)
ecs/delete_attributesDeletes one or more custom attributes from an Amazon ECS resource.cluster (string)
attributes (array) required
ecs/delete_capacity_providerDeletes 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 PutClusterCapacityProviders 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 servcapacityProvider (string) required
cluster (string)
ecs/delete_clusterDeletes 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 Deregistecluster (string) required
ecs/delete_express_gateway_serviceDeletes an Express service and removes all associated Amazon Web Services resources. This operation stops service tasks, removes the Application Load Balancer, target groups, security groups, auto-scaling policies, and other managed infrastructure components. The service enters a DRAINING state where existing tasks complete current requests without starting new tasks. After all tasks stop, the service and infrastructure are permanently removed. This operation cannot be reversed. Back up importanserviceArn (string) required
ecs/delete_serviceDeletes 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 ocluster (string)
service (string) required
force (boolean)
ecs/delete_task_definitionsDeletes one or more task definitions. You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition. When you delete a task definition revision, it is immediately transitions from the INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that reference a DELETE_IN_PROGRESS task definition revision continue to run without disruption. Existing services that reference a DELETE_IN_PROGRESS task definition revision can still scale up ortaskDefinitions (array) required
ecs/delete_task_setDeletes 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.cluster (string) required
service (string) required
taskSet (string) required
force (boolean)
ecs/deregister_container_instanceDeregisters 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 fcluster (string)
containerInstance (string) required
force (boolean)
ecs/deregister_task_definitionDeregisters 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. If you want to delete a task definition revision, you must first deregister the task definition revision. You can't use an INACTIVE ttaskDefinition (string) required
ecs/describe_capacity_providersDescribes one or more of your capacity providers.capacityProviders (array)
cluster (string)
include (array)
maxResults (integer)
nextToken (string)
ecs/describe_clustersDescribes one or more of your clusters. For CLI examples, see describe-clusters.rst on GitHub.clusters (array)
include (array)
ecs/describe_container_instancesDescribes one or more container instances. Returns metadata about each container instance requested.cluster (string)
containerInstances (array) required
include (array)
ecs/describe_express_gateway_serviceRetrieves detailed information about an Express service, including current status, configuration, managed infrastructure, and service revisions. Returns comprehensive service details, active service revisions, ingress paths with endpoints, and managed Amazon Web Services resource status including load balancers and auto-scaling policies. Use the include parameter to retrieve additional information such as resource tags.serviceArn (string) required
include (array)
ecs/describe_service_deploymentsDescribes one or more of your service deployments. A service deployment happens when you release a software update for the service. For more information, see View service history using Amazon ECS service deployments.serviceDeploymentArns (array) required
ecs/describe_service_revisionsDescribes one or more service revisions. A service revision is a version of the service that includes the values for the Amazon ECS resources for example, task definition and the environment resources for example, load balancers, subnets, and security groups. For more information, see Amazon ECS service revisions. You can't describe a service revision that was created before October 25, 2024.serviceRevisionArns (array) required
ecs/describe_servicesDescribes the specified services running in your cluster.cluster (string)
services (array) required
include (array)
ecs/describe_task_definitionDescribes 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.taskDefinition (string) required
include (array)
ecs/describe_tasksDescribes a specified task or tasks. Currently, stopped tasks appear in the returned results for at least one hour. If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.cluster (string)
tasks (array) required
include (array)
ecs/describe_task_setsDescribes 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.cluster (string) required
service (string) required
taskSets (array)
include (array)
ecs/discover_poll_endpointThis 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.containerInstance (string)
cluster (string)
ecs/execute_commandRuns 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 receive an AccessDeniedException when there is a mismatch between the condition key value and the corresponding parameter value. For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.cluster (string)
container (string)
command (string) required
interactive (boolean) required
task (string) required
ecs/get_task_protectionRetrieves the protection status of tasks in an Amazon ECS service.cluster (string) required
tasks (array)
ecs/list_account_settingsLists the account settings for a specified principal.name (string)
value (string)
principalArn (string)
effectiveSettings (boolean)
nextToken (string)
maxResults (integer)
ecs/list_attributesLists 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.oscluster (string)
targetType (string) required
attributeName (string)
attributeValue (string)
nextToken (string)
maxResults (integer)
ecs/list_clustersReturns a list of existing clusters.nextToken (string)
maxResults (integer)
ecs/list_container_instancesReturns 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.cluster (string)
filter (string)
nextToken (string)
maxResults (integer)
status (string)
ecs/list_service_deploymentsThis operation lists all the service deployments that meet the specified filter criteria. A service deployment happens when you release a software update for the service. You route traffic from the running service revisions to the new service revison and control the number of running tasks. This API returns the values that you use for the request parameters in DescribeServiceRevisions.service (string) required
cluster (string)
status (array)
createdAt: {
. before (string)
. after (string)
} (object)
nextToken (string)
maxResults (integer)
ecs/list_servicesReturns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.cluster (string)
nextToken (string)
maxResults (integer)
launchType (string)
schedulingStrategy (string)
resourceManagementType (string)
ecs/list_services_by_namespaceThis operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast, ListServices can only list services in one cluster at a time. If you need to filter the list of services in a single cluster by various parameters, use ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.namespace (string) required
nextToken (string)
maxResults (integer)
ecs/list_tags_for_resourceList the tags for an Amazon ECS resource.resourceArn (string) required
ecs/list_task_definition_familiesReturns 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.familyPrefix (string)
status (string)
nextToken (string)
maxResults (integer)
ecs/list_task_definitionsReturns 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.familyPrefix (string)
status (string)
sort (string)
nextToken (string)
maxResults (integer)
ecs/list_tasksReturns 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.cluster (string)
containerInstance (string)
family (string)
nextToken (string)
maxResults (integer)
startedBy (string)
serviceName (string)
desiredStatus (string)
launchType (string)
ecs/put_account_settingModifies an account setting. Account settings are set on a per-Region basis. If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.name (string) required
value (string) required
principalArn (string)
ecs/put_account_setting_defaultModifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.name (string) required
value (string) required
ecs/put_attributesCreate 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.cluster (string)
attributes (array) required
ecs/put_cluster_capacity_providersModifies 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 PutClusterCapacityProvidecluster (string) required
capacityProviders (array) required
defaultCapacityProviderStrategy (array) required
ecs/register_container_instanceThis 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.cluster (string)
instanceIdentityDocument (string)
instanceIdentityDocumentSignature (string)
totalResources (array)
versionInfo: {
. agentVersion (string)
. agentHash (string)
. dockerVersion (string)
} (object)
containerInstanceArn (string)
attributes (array)
platformDevices (array)
tags (array)
ecs/register_task_definitionRegisters 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 a role for your task with the taskRoleArn parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to mfamily (string) required
taskRoleArn (string)
executionRoleArn (string)
networkMode (string)
containerDefinitions (array) required
volumes (array)
placementConstraints (array)
requiresCompatibilities (array)
cpu (string)
memory (string)
tags (array)
pidMode (string)
ipcMode (string)
proxyConfiguration: {
. type (string)
. containerName (string)
. properties (array)
} (object)
inferenceAccelerators (array)
ephemeralStorage: {
. sizeInGiB (integer)
} (object)
runtimePlatform: {
. cpuArchitecture (string)
. operatingSystemFamily (string)
} (object)
enableFaultInjection (boolean)
ecs/run_taskStarts a new task using the specified task definition. On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition. Amazon Elastic Inference EI is no longer available to customers. 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 mocapacityProviderStrategy (array)
cluster (string)
count (integer)
enableECSManagedTags (boolean)
enableExecuteCommand (boolean)
group (string)
launchType (string)
networkConfiguration: {
. awsvpcConfiguration (object)
} (object)
overrides: {
. containerOverrides (array)
. cpu (string)
. inferenceAcceleratorOverrides (array)
. executionRoleArn (string)
. memory (string)
. taskRoleArn (string)
. ephemeralStorage (object)
} (object)
placementConstraints (array)
placementStrategy (array)
platformVersion (string)
propagateTags (string)
referenceId (string)
startedBy (string)
tags (array)
taskDefinition (string) required
clientToken (string)
volumeConfigurations (array)
ecs/start_taskStarts a new task from the specified task definition on the specified container instance or instances. On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition. Amazon Elastic Inference EI is no longer available to customers. Alternatively, you can useRunTask to place tasks for you. For more information, see Scheduling Tasks in the Amcluster (string)
containerInstances (array) required
enableECSManagedTags (boolean)
enableExecuteCommand (boolean)
group (string)
networkConfiguration: {
. awsvpcConfiguration (object)
} (object)
overrides: {
. containerOverrides (array)
. cpu (string)
. inferenceAcceleratorOverrides (array)
. executionRoleArn (string)
. memory (string)
. taskRoleArn (string)
. ephemeralStorage (object)
} (object)
propagateTags (string)
referenceId (string)
startedBy (string)
tags (array)
taskDefinition (string) required
volumeConfigurations (array)
ecs/stop_service_deploymentStops an ongoing service deployment. The following stop types are avaiable: ROLLBACK - This option rolls back the service deployment to the previous service revision. You can use this option even if you didn't configure the service deployment for the rollback option. For more information, see Stopping Amazon ECS service deployments in the Amazon Elastic Container Service Developer Guide.serviceDeploymentArn (string) required
stopType (string)
ecs/stop_taskStops a running task. Any tags associated with the task will be deleted. When you call StopTask on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a stop signal value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. This signal can be defined in your container image with the STOPSIGNAL instruction and will default to SIGTERM. If the container handles the SIGTERM value gracefullycluster (string)
task (string) required
reason (string)
ecs/submit_attachment_state_changesThis 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.cluster (string)
attachments (array) required
ecs/submit_container_state_changeThis 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.cluster (string)
task (string)
containerName (string)
runtimeId (string)
status (string)
exitCode (integer)
reason (string)
networkBindings (array)
ecs/submit_task_state_changeThis 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.cluster (string)
task (string)
status (string)
reason (string)
containers (array)
attachments (array)
managedAgents (array)
pullStartedAt (string)
pullStoppedAt (string)
executionStoppedAt (string)
ecs/tag_resourceAssociates 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.resourceArn (string) required
tags (array) required
ecs/untag_resourceDeletes specified tags from a resource.resourceArn (string) required
tagKeys (array) required
ecs/update_capacity_providerModifies the parameters for a capacity provider. These changes only apply to new Amazon ECS Managed Instances, or EC2 instances, not existing ones.name (string) required
cluster (string)
autoScalingGroupProvider: {
. managedScaling (object)
. managedTerminationProtection (string)
. managedDraining (string)
} (object)
managedInstancesProvider: {
. infrastructureRoleArn (string)
. instanceLaunchTemplate (object)
. propagateTags (string)
. infrastructureOptimization (object)
} (object)
ecs/update_clusterUpdates the cluster.cluster (string) required
settings (array)
configuration: {
. executeCommandConfiguration (object)
. managedStorageConfiguration (object)
} (object)
serviceConnectDefaults: {
. namespace (string)
} (object)
ecs/update_cluster_settingsModifies the settings to use for a cluster.cluster (string) required
settings (array) required
ecs/update_container_agentUpdates 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 acluster (string)
containerInstance (string) required
ecs/update_container_instances_stateModifies 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 icluster (string)
containerInstances (array) required
status (string) required
ecs/update_express_gateway_serviceUpdates an existing Express service configuration. Modifies container settings, resource allocation, auto-scaling configuration, and other service parameters without recreating the service. Amazon ECS creates a new service revision with updated configuration and performs a rolling deployment to replace existing tasks. The service remains available during updates, ensuring zero-downtime deployments. Some parameters like the infrastructure role cannot be modified after service creation and requireserviceArn (string) required
executionRoleArn (string)
healthCheckPath (string)
primaryContainer: {
. image (string)
. containerPort (integer)
. awsLogsConfiguration (object)
. repositoryCredentials (object)
. command (array)
. environment (array)
. secrets (array)
} (object)
taskRoleArn (string)
networkConfiguration: {
. securityGroups (array)
. subnets (array)
} (object)
cpu (string)
memory (string)
scalingTarget: {
. minTaskCount (integer)
. maxTaskCount (integer)
. autoScalingMetric (string)
. autoScalingTargetValue (integer)
} (object)
ecs/update_serviceModifies the parameters of a service. On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition. 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 constraincluster (string)
service (string) required
desiredCount (integer)
taskDefinition (string)
capacityProviderStrategy (array)
deploymentConfiguration: {
. deploymentCircuitBreaker (object)
. maximumPercent (integer)
. minimumHealthyPercent (integer)
. alarms (object)
. strategy (string)
. bakeTimeInMinutes (integer)
. lifecycleHooks (array)
. linearConfiguration (object)
. canaryConfiguration (object)
} (object)
availabilityZoneRebalancing (string)
networkConfiguration: {
. awsvpcConfiguration (object)
} (object)
placementConstraints (array)
placementStrategy (array)
platformVersion (string)
forceNewDeployment (boolean)
healthCheckGracePeriodSeconds (integer)
deploymentController: {
. type (string)
} (object)
enableExecuteCommand (boolean)
enableECSManagedTags (boolean)
loadBalancers (array)
propagateTags (string)
serviceRegistries (array)
serviceConnectConfiguration: {
. enabled (boolean)
. namespace (string)
. services (array)
. logConfiguration (object)
. accessLogConfiguration (object)
} (object)
volumeConfigurations (array)
vpcLatticeConfigurations (array)
ecs/update_service_primary_task_setModifies 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.cluster (string) required
service (string) required
primaryTaskSet (string) required
ecs/update_task_protectionUpdates the protection status of a task. You can set protectionEnabled to true to protect your task from termination during scale-in events from Service Autoscaling or deployments. Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the protectionEnabled property making the task eligible for termination by a subsequent scale-in event. You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes 48 hours. To specify the customcluster (string) required
tasks (array) required
protectionEnabled (boolean) required
expiresInMinutes (integer)
ecs/update_task_setModifies 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.cluster (string) required
service (string) required
taskSet (string) required
scale: {
. value (number)
. unit (string)
} (object) required
efs/create_access_pointCreates 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 anyClientToken (string) required
Tags (array)
FileSystemId (string) required
PosixUser: {
. Uid (integer)
. Gid (integer)
. SecondaryGids (array)
} (object)
RootDirectory: {
. Path (string)
. CreationInfo (object)
} (object)
efs/create_file_systemCreates 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.CreationToken (string) required
PerformanceMode (string)
Encrypted (boolean)
KmsKeyId (string)
ThroughputMode (string)
ProvisionedThroughputInMibps (number)
AvailabilityZoneName (string)
Backup (boolean)
Tags (array)
efs/create_mount_targetCreates 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 thFileSystemId (string) required
SubnetId (string) required
IpAddress (string)
Ipv6Address (string)
IpAddressType (string)
SecurityGroups (array)
efs/create_replication_configurationCreates a replication configuration to either a new or existing EFS file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following: Source file system – The EFS file system that you want to replicate. Destination file system – The destination file system to which the source file system is replicated. There can only be one destination file system in a replication configuration. A file system can be part of only oneSourceFileSystemId (string) required
Destinations (array) required
efs/create_tagsDEPRECATED - 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 permisFileSystemId (string) required
Tags (array) required
efs/delete_access_pointDeletes 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.AccessPointId (string) required
efs/delete_file_systemDeletes 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 replicatFileSystemId (string) required
efs/delete_file_system_policyDeletes 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.FileSystemId (string) required
efs/delete_mount_targetDeletes 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 theMountTargetId (string) required
efs/delete_replication_configurationDeletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes Writeable and its replication overwrite protection is re-enabled. For more information, see Delete a replication configuration. This operation requires permissions for the elasticfilesystem:DeleteReplicationConfiguration action.SourceFileSystemId (string) required
DeletionMode (string)
efs/delete_tagsDEPRECATED - 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.FileSystemId (string) required
TagKeys (array) required
efs/describe_access_pointsReturns 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.MaxResults (integer)
NextToken (string)
AccessPointId (string)
FileSystemId (string)
efs/describe_account_preferencesReturns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.NextToken (string)
MaxResults (integer)
efs/describe_backup_policyReturns the backup policy for the specified EFS file system.FileSystemId (string) required
efs/describe_file_system_policyReturns the FileSystemPolicy for the specified EFS file system. This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.FileSystemId (string) required
efs/describe_file_systemsReturns 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. This number is automatically set to 100. IfMaxItems (integer)
Marker (string)
CreationToken (string)
FileSystemId (string)
efs/describe_lifecycle_configurationReturns the current LifecycleConfiguration object for the specified EFS file system. Lifecycle management uses the LifecycleConfiguration object to identify when to move files between storage classes. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response. This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.FileSystemId (string) required
efs/describe_mount_targetsReturns 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.MaxItems (integer)
Marker (string)
FileSystemId (string)
MountTargetId (string)
AccessPointId (string)
efs/describe_mount_target_security_groupsReturns 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.MountTargetId (string) required
efs/describe_replication_configurationsRetrieves 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.FileSystemId (string)
NextToken (string)
MaxResults (integer)
efs/describe_tagsDEPRECATED - 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.MaxItems (integer)
Marker (string)
FileSystemId (string) required
efs/list_tags_for_resourceLists 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.ResourceId (string) required
MaxResults (integer)
NextToken (string)
efs/modify_mount_target_security_groupsModifies 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.MountTargetId (string) required
SecurityGroups (array)
efs/put_account_preferencesUse 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 youResourceIdType (string) required
efs/put_backup_policyUpdates the file system's backup policy. Use this action to start or stop automatic backups of the file system.FileSystemId (string) required
BackupPolicy: {
. Status (string)
} (object) required
efs/put_file_system_policyApplies 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, seFileSystemId (string) required
Policy (string) required
BypassPolicyLockoutSafetyCheck (boolean)
efs/put_lifecycle_configurationUse this action to manage storage for your file system. A LifecycleConfiguration consists of one or more LifecyclePolicy objects that define the following: TransitionToIA – When to move files in the file system from primary storage Standard storage class into the Infrequent Access IA storage. TransitionToArchive – When to move files in the file system from their current storage class either IA or Standard storage into the Archive storage. File systems cannot transition into Archive storage beforFileSystemId (string) required
LifecyclePolicies (array) required
efs/tag_resourceCreates 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.ResourceId (string) required
Tags (array) required
efs/untag_resourceRemoves 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.ResourceId (string) required
TagKeys (array) required
efs/update_file_systemUpdates the throughput mode or the amount of provisioned throughput of an existing file system.FileSystemId (string) required
ThroughputMode (string)
ProvisionedThroughputInMibps (number)
efs/update_file_system_protectionUpdates protection on the file system. This operation requires permissions for the elasticfilesystem:UpdateFileSystemProtection action.FileSystemId (string) required
ReplicationOverwriteProtection (string)
eks_auth/assume_role_for_pod_identityThe Amazon EKS Auth API and the AssumeRoleForPodIdentity action are only used by the EKS Pod Identity Agent. We recommend that applications use the Amazon Web Services SDKs to connect to Amazon Web Services services; if credentials from an EKS Pod Identity association are available in the pod, the latest versions of the SDKs use them automatically.clusterName (string) required
token (string) required
eks/associate_access_policyAssociates an access policy and its scope to an access entry. For more information about associating access policies, see Associating and disassociating access policies to and from access entries in the Amazon EKS User Guide.clusterName (string) required
principalArn (string) required
policyArn (string) required
accessScope: {
. type (string)
. namespaces (array)
} (object) required
eks/associate_encryption_configAssociates an encryption configuration to an existing cluster. Use this API to enable encryption on existing clusters that don't already have encryption enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new Amazon EKS clusters.clusterName (string) required
encryptionConfig (array) required
clientRequestToken (string)
eks/associate_identity_provider_configAssociates 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 Role and ClusterRole objects, assign permissions to them, and then bind them to the identities using Kubernetes RoleBinding and ClusterRoleBinding objects. For more information see Using RBAC Authorization in the KclusterName (string) required
oidc: {
. identityProviderConfigName (string)
. issuerUrl (string)
. clientId (string)
. usernameClaim (string)
. usernamePrefix (string)
. groupsClaim (string)
. groupsPrefix (string)
. requiredClaims (object)
} (object) required
tags (object)
clientRequestToken (string)
eks/create_access_entryCreates an access entry. An access entry allows an IAM principal to access your cluster. Access entries can replace the need to maintain entries in the aws-auth ConfigMap for authentication. You have the following options for authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes role-based access control RBAC, Amazon EKS, or both. Kubernetes RBAC authorization requires you to create and manage Kubernetes Role, ClusterRole, RoleBinding, and ClusterRoleBinding objecclusterName (string) required
principalArn (string) required
kubernetesGroups (array)
tags (object)
clientRequestToken (string)
username (string)
type (string)
eks/create_addonCreates 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. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.clusterName (string) required
addonName (string) required
addonVersion (string)
serviceAccountRoleArn (string)
resolveConflicts (string)
clientRequestToken (string)
tags (object)
configurationValues (string)
podIdentityAssociations (array)
namespaceConfig: {
. namespace (string)
} (object)
eks/create_capabilityCreates a managed capability resource for an Amazon EKS cluster. Capabilities provide fully managed capabilities to build and scale with Kubernetes. When you create a capability, Amazon EKSprovisions and manages the infrastructure required to run the capability outside of your cluster. This approach reduces operational overhead and preserves cluster resources. You can only create one Capability of each type on a given Amazon EKS cluster. Valid types are Argo CD for declarative GitOps deployment,capabilityName (string) required
clusterName (string) required
clientRequestToken (string)
type (string) required
roleArn (string) required
configuration: {
. argoCd (object)
} (object)
tags (object)
deletePropagationPolicy (string) required
eks/create_clusterCreates 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 Zonename (string) required
version (string)
roleArn (string) required
resourcesVpcConfig: {
. subnetIds (array)
. securityGroupIds (array)
. endpointPublicAccess (boolean)
. endpointPrivateAccess (boolean)
. publicAccessCidrs (array)
} (object) required
kubernetesNetworkConfig: {
. serviceIpv4Cidr (string)
. ipFamily (string)
. elasticLoadBalancing (object)
} (object)
logging: {
. clusterLogging (array)
} (object)
clientRequestToken (string)
tags (object)
encryptionConfig (array)
outpostConfig: {
. outpostArns (array)
. controlPlaneInstanceType (string)
. controlPlanePlacement (object)
} (object)
accessConfig: {
. bootstrapClusterCreatorAdminPermissions (boolean)
. authenticationMode (string)
} (object)
bootstrapSelfManagedAddons (boolean)
upgradePolicy: {
. supportType (string)
} (object)
zonalShiftConfig: {
. enabled (boolean)
} (object)
remoteNetworkConfig: {
. remoteNodeNetworks (array)
. remotePodNetworks (array)
} (object)
computeConfig: {
. enabled (boolean)
. nodePools (array)
. nodeRoleArn (string)
} (object)
storageConfig: {
. blockStorage (object)
} (object)
deletionProtection (boolean)
controlPlaneScalingConfig: {
. tier (string)
} (object)
eks/create_eks_anywhere_subscriptionCreates an EKS Anywhere subscription. When a subscription is created, it is a contract agreement for the length of the term specified in the request. Licenses that are used to validate support are provisioned in Amazon Web Services License Manager and the caller account is granted access to EKS Anywhere Curated Packages.name (string) required
term: {
. duration (integer)
. unit (string)
} (object) required
licenseQuantity (integer)
licenseType (string)
autoRenew (boolean)
clientRequestToken (string)
tags (object)
eks/create_fargate_profileCreates 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 multiplefargateProfileName (string) required
clusterName (string) required
podExecutionRoleArn (string) required
subnets (array)
selectors (array)
clientRequestToken (string)
tags (object)
eks/create_nodegroupCreates 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 later updates, you will only be able to update a node group using a launch template only if it was originally deployed with a launch template. AdclusterName (string) required
nodegroupName (string) required
scalingConfig: {
. minSize (integer)
. maxSize (integer)
. desiredSize (integer)
} (object)
diskSize (integer)
subnets (array) required
instanceTypes (array)
amiType (string)
remoteAccess: {
. ec2SshKey (string)
. sourceSecurityGroups (array)
} (object)
nodeRole (string) required
labels (object)
taints (array)
tags (object)
clientRequestToken (string)
launchTemplate: {
. name (string)
. version (string)
. id (string)
} (object)
updateConfig: {
. maxUnavailable (integer)
. maxUnavailablePercentage (integer)
. updateStrategy (string)
} (object)
nodeRepairConfig: {
. enabled (boolean)
. maxUnhealthyNodeThresholdCount (integer)
. maxUnhealthyNodeThresholdPercentage (integer)
. maxParallelNodesRepairedCount (integer)
. maxParallelNodesRepairedPercentage (integer)
. nodeRepairConfigOverrides (array)
} (object)
capacityType (string)
version (string)
releaseVersion (string)
eks/create_pod_identity_associationCreates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to Pods and the credentials are rotated automatically. Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances. If a Pod uses a service account that has an association, AmaclusterName (string) required
namespace (string) required
serviceAccount (string) required
roleArn (string) required
clientRequestToken (string)
tags (object)
disableSessionTags (boolean)
targetRoleArn (string)
policy (string)
eks/delete_access_entryDeletes an access entry. Deleting an access entry of a type other than Standard can cause your cluster to function improperly. If you delete an access entry in error, you can recreate it.clusterName (string) required
principalArn (string) required
eks/delete_addonDeletes an Amazon EKS add-on. When you remove an add-on, it's deleted from the cluster. You can always manually start an add-on on the cluster using the Kubernetes API.clusterName (string) required
addonName (string) required
preserve (boolean)
eks/delete_capabilityDeletes a managed capability from your Amazon EKS cluster. When you delete a capability, Amazon EKS removes the capability infrastructure but retains all resources that were managed by the capability. Before deleting a capability, you should delete all Kubernetes resources that were created by the capability. After the capability is deleted, these resources become difficult to manage because the controller that managed them is no longer available. To delete resources before removing the capabiliclusterName (string) required
capabilityName (string) required
eks/delete_clusterDeletes an Amazon EKS cluster control plane. If you have active services and ingress resources 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 attacname (string) required
eks/delete_eks_anywhere_subscriptionDeletes an expired or inactive subscription. Deleting inactive subscriptions removes them from the Amazon Web Services Management Console view and from list/describe API responses. Subscriptions can only be cancelled within 7 days of creation and are cancelled by creating a ticket in the Amazon Web Services Support Center.id (string) required
eks/delete_fargate_profileDeletes an Fargate profile. When you delete a Fargate profile, any Pod running on Fargate that was created with the profile is deleted. If the Pod matches another Fargate profile, then it is scheduled on Fargate with that profile. If it no longer matches any Fargate profiles, then it's not scheduled on Fargate and 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 deleclusterName (string) required
fargateProfileName (string) required
eks/delete_nodegroupDeletes a managed node group.clusterName (string) required
nodegroupName (string) required
eks/delete_pod_identity_associationDeletes a EKS Pod Identity association. The temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console.clusterName (string) required
associationId (string) required
eks/deregister_clusterDeregisters a connected cluster to remove it from the Amazon EKS control plane. A connected cluster is a Kubernetes cluster that you've connected to your control plane using the Amazon EKS Connector.name (string) required
eks/describe_access_entryDescribes an access entry.clusterName (string) required
principalArn (string) required
eks/describe_addonDescribes an Amazon EKS add-on.clusterName (string) required
addonName (string) required
eks/describe_addon_configurationReturns configuration options.addonName (string) required
addonVersion (string) required
eks/describe_addon_versionsDescribes the versions for an add-on. Information such as the Kubernetes versions that you can use the add-on with, the owner, publisher, and the type of the add-on are returned.kubernetesVersion (string)
maxResults (integer)
nextToken (string)
addonName (string)
types (array)
publishers (array)
owners (array)
eks/describe_capabilityReturns detailed information about a specific managed capability in your Amazon EKS cluster, including its current status, configuration, health information, and any issues that may be affecting its operation.clusterName (string) required
capabilityName (string) required
eks/describe_clusterDescribes 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 Creating or updating a kubeconfig file for an Amazon EKS cluster. The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.name (string) required
eks/describe_cluster_versionsLists available Kubernetes versions for Amazon EKS clusters.clusterType (string)
maxResults (integer)
nextToken (string)
defaultOnly (boolean)
includeAll (boolean)
clusterVersions (array)
status (string)
versionStatus (string)
eks/describe_eks_anywhere_subscriptionReturns descriptive information about a subscription.id (string) required
eks/describe_fargate_profileDescribes an Fargate profile.clusterName (string) required
fargateProfileName (string) required
eks/describe_identity_provider_configDescribes an identity provider configuration.clusterName (string) required
identityProviderConfig: {
. type (string)
. name (string)
} (object) required
eks/describe_insightReturns details about an insight that you specify using its ID.clusterName (string) required
id (string) required
eks/describe_insights_refreshReturns the status of the latest on-demand cluster insights refresh operation.clusterName (string) required
eks/describe_nodegroupDescribes a managed node group.clusterName (string) required
nodegroupName (string) required
eks/describe_pod_identity_associationReturns descriptive information about an EKS Pod Identity association. This action requires the ID of the association. You can get the ID from the response to the CreatePodIdentityAssocation for newly created associations. Or, you can list the IDs for associations with ListPodIdentityAssociations and filter the list by namespace or service account.clusterName (string) required
associationId (string) required
eks/describe_updateDescribes an update to an Amazon EKS resource. When the status of the update is Successful, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.name (string) required
updateId (string) required
nodegroupName (string)
addonName (string)
capabilityName (string)
eks/disassociate_access_policyDisassociates an access policy from an access entry.clusterName (string) required
principalArn (string) required
policyArn (string) required
eks/disassociate_identity_provider_configDisassociates 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 IAM principals.clusterName (string) required
identityProviderConfig: {
. type (string)
. name (string)
} (object) required
clientRequestToken (string)
eks/list_access_entriesLists the access entries for your cluster.clusterName (string) required
associatedPolicyArn (string)
maxResults (integer)
nextToken (string)
eks/list_access_policiesLists the available access policies.maxResults (integer)
nextToken (string)
eks/list_addonsLists the installed add-ons.clusterName (string) required
maxResults (integer)
nextToken (string)
eks/list_associated_access_policiesLists the access policies associated with an access entry.clusterName (string) required
principalArn (string) required
maxResults (integer)
nextToken (string)
eks/list_capabilitiesLists all managed capabilities in your Amazon EKS cluster. You can use this operation to get an overview of all capabilities and their current status.clusterName (string) required
nextToken (string)
maxResults (integer)
eks/list_clustersLists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region.maxResults (integer)
nextToken (string)
include (array)
eks/list_eks_anywhere_subscriptionsDisplays the full description of the subscription.maxResults (integer)
nextToken (string)
includeStatus (array)
eks/list_fargate_profilesLists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region.clusterName (string) required
maxResults (integer)
nextToken (string)
eks/list_identity_provider_configsLists the identity provider configurations for your cluster.clusterName (string) required
maxResults (integer)
nextToken (string)
eks/list_insightsReturns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status. The default filter lists all categories and every status. The following lists the available categories: UPGRADE_READINESS: Amazon EKS identifies issues that could impact your ability to upgrade to new versions of Kubernetes. These are called upgrade insights. MISCONFIGURATION: Amazon EKS identifies misconfiguration in your EKclusterName (string) required
filter: {
. categories (array)
. kubernetesVersions (array)
. statuses (array)
} (object)
maxResults (integer)
nextToken (string)
eks/list_nodegroupsLists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node groups aren't listed.clusterName (string) required
maxResults (integer)
nextToken (string)
eks/list_pod_identity_associationsList the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the association is in or the service account that the association uses.clusterName (string) required
namespace (string)
serviceAccount (string)
maxResults (integer)
nextToken (string)
eks/list_tags_for_resourceList the tags for an Amazon EKS resource.resourceArn (string) required
eks/list_updatesLists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.name (string) required
nodegroupName (string)
addonName (string)
capabilityName (string)
nextToken (string)
maxResults (integer)
eks/register_clusterConnects 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 updname (string) required
connectorConfig: {
. roleArn (string)
. provider (string)
} (object) required
clientRequestToken (string)
tags (object)
eks/start_insights_refreshInitiates an on-demand refresh operation for cluster insights, getting the latest analysis outside of the standard refresh schedule.clusterName (string) required
eks/tag_resourceAssociates the specified tags to an Amazon EKS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EKS resources don't propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag doesn't automatically propagate to the subnets and nresourceArn (string) required
tags (object) required
eks/untag_resourceDeletes specified tags from an Amazon EKS resource.resourceArn (string) required
tagKeys (array) required
eks/update_access_entryUpdates an access entry.clusterName (string) required
principalArn (string) required
kubernetesGroups (array)
clientRequestToken (string)
username (string)
eks/update_addonUpdates an Amazon EKS add-on.clusterName (string) required
addonName (string) required
addonVersion (string)
serviceAccountRoleArn (string)
resolveConflicts (string)
clientRequestToken (string)
configurationValues (string)
podIdentityAssociations (array)
eks/update_capabilityUpdates the configuration of a managed capability in your Amazon EKS cluster. You can update the IAM role, configuration settings, and delete propagation policy for a capability. When you update a capability, Amazon EKS applies the changes and may restart capability components as needed. The capability remains available during the update process, but some operations may be temporarily unavailable.clusterName (string) required
capabilityName (string) required
roleArn (string)
configuration: {
. argoCd (object)
} (object)
clientRequestToken (string)
deletePropagationPolicy (string)
eks/update_cluster_configUpdates 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 DescribeUpdate. You can use this operation to do the following actions: 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 inforname (string) required
resourcesVpcConfig: {
. subnetIds (array)
. securityGroupIds (array)
. endpointPublicAccess (boolean)
. endpointPrivateAccess (boolean)
. publicAccessCidrs (array)
} (object)
logging: {
. clusterLogging (array)
} (object)
clientRequestToken (string)
accessConfig: {
. authenticationMode (string)
} (object)
upgradePolicy: {
. supportType (string)
} (object)
zonalShiftConfig: {
. enabled (boolean)
} (object)
computeConfig: {
. enabled (boolean)
. nodePools (array)
. nodeRoleArn (string)
} (object)
kubernetesNetworkConfig: {
. serviceIpv4Cidr (string)
. ipFamily (string)
. elasticLoadBalancing (object)
} (object)
storageConfig: {
. blockStorage (object)
} (object)
remoteNetworkConfig: {
. remoteNodeNetworks (array)
. remotePodNetworks (array)
} (object)
deletionProtection (boolean)
controlPlaneScalingConfig: {
. tier (string)
} (object)
eks/update_cluster_versionUpdates 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 Successfulname (string) required
version (string) required
clientRequestToken (string)
force (boolean)
eks/update_eks_anywhere_subscriptionUpdate an EKS Anywhere Subscription. Only auto renewal and tags can be updated after subscription creation.id (string) required
autoRenew (boolean) required
clientRequestToken (string)
eks/update_nodegroup_configUpdates 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. You can update the Kubernetes labels and taints for a node group and the scaling and version update configuration.clusterName (string) required
nodegroupName (string) required
labels: {
. addOrUpdateLabels (object)
. removeLabels (array)
} (object)
taints: {
. addOrUpdateTaints (array)
. removeTaints (array)
} (object)
scalingConfig: {
. minSize (integer)
. maxSize (integer)
. desiredSize (integer)
} (object)
updateConfig: {
. maxUnavailable (integer)
. maxUnavailablePercentage (integer)
. updateStrategy (string)
} (object)
nodeRepairConfig: {
. enabled (boolean)
. maxUnhealthyNodeThresholdCount (integer)
. maxUnhealthyNodeThresholdPercentage (integer)
. maxParallelNodesRepairedCount (integer)
. maxParallelNodesRepairedPercentage (integer)
. nodeRepairConfigOverrides (array)
} (object)
clientRequestToken (string)
eks/update_nodegroup_versionUpdates 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. Additionally, the launch template ID or name must match what was used when the node group was created. You can update the launch template version with necessary changes. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, spclusterName (string) required
nodegroupName (string) required
version (string)
releaseVersion (string)
launchTemplate: {
. name (string)
. version (string)
. id (string)
} (object)
force (boolean)
clientRequestToken (string)
eks/update_pod_identity_associationUpdates a EKS Pod Identity association. In an update, you can change the IAM role, the target IAM role, or disableSessionTags. You must change at least one of these in an update. An association can't be moved between clusters, namespaces, or service accounts. If you need to edit the namespace or service account, you need to delete the association and then create a new association with your desired settings. Similar to Amazon Web Services IAM behavior, EKS Pod Identity associations are eventuallyclusterName (string) required
associationId (string) required
roleArn (string)
clientRequestToken (string)
disableSessionTags (boolean)
targetRoleArn (string)
policy (string)
elastic_beanstalk/abort_environment_updateCancels in-progress environment configuration update or application version deployment.EnvironmentId (string)
EnvironmentName (string)
elastic_beanstalk/apply_environment_managed_actionApplies 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.EnvironmentName (string)
EnvironmentId (string)
ActionId (string) required
elastic_beanstalk/associate_environment_operations_roleAdd 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.EnvironmentName (string) required
OperationsRole (string) required
elastic_beanstalk/check_dnsavailabilityChecks if the specified CNAME is available.CNAMEPrefix (string) required
elastic_beanstalk/compose_environmentsCreate 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.ApplicationName (string)
GroupName (string)
VersionLabels (array)
elastic_beanstalk/create_applicationCreates an application that has one configuration template named default and no application versions.ApplicationName (string) required
Description (string)
ResourceLifecycleConfig: {
. ServiceRole (string)
. VersionLifecycleConfig (object)
} (object)
Tags (array)
elastic_beanstalk/create_application_versionCreates 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 saApplicationName (string) required
VersionLabel (string) required
Description (string)
SourceBuildInformation: {
. SourceType (string)
. SourceRepository (string)
. SourceLocation (string)
} (object)
SourceBundle: {
. S3Bucket (string)
. S3Key (string)
} (object)
BuildConfiguration: {
. ArtifactName (string)
. CodeBuildServiceRole (string)
. ComputeType (string)
. Image (string)
. TimeoutInMinutes (integer)
} (object)
AutoCreateApplication (boolean)
Process (boolean)
Tags (array)
elastic_beanstalk/create_configuration_templateCreates 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 LisApplicationName (string) required
TemplateName (string) required
SolutionStackName (string)
PlatformArn (string)
SourceConfiguration: {
. ApplicationName (string)
. TemplateName (string)
} (object)
EnvironmentId (string)
Description (string)
OptionSettings (array)
Tags (array)
elastic_beanstalk/create_environmentLaunches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.ApplicationName (string) required
EnvironmentName (string)
GroupName (string)
Description (string)
CNAMEPrefix (string)
Tier: {
. Name (string)
. Type (string)
. Version (string)
} (object)
Tags (array)
VersionLabel (string)
TemplateName (string)
SolutionStackName (string)
PlatformArn (string)
OptionSettings (array)
OptionsToRemove (array)
OperationsRole (string)
elastic_beanstalk/create_platform_versionCreate a new version of your custom platform.PlatformName (string) required
PlatformVersion (string) required
PlatformDefinitionBundle: {
. S3Bucket (string)
. S3Key (string)
} (object) required
EnvironmentName (string)
OptionSettings (array)
Tags (array)
elastic_beanstalk/create_storage_locationCreates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.No parameters
elastic_beanstalk/delete_applicationDeletes 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.ApplicationName (string) required
TerminateEnvByForce (boolean)
elastic_beanstalk/delete_application_versionDeletes the specified version from the specified application. You cannot delete an application version that is associated with a running environment.ApplicationName (string) required
VersionLabel (string) required
DeleteSourceBundle (boolean)
elastic_beanstalk/delete_configuration_templateDeletes 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.ApplicationName (string) required
TemplateName (string) required
elastic_beanstalk/delete_environment_configurationDeletes 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.ApplicationName (string) required
EnvironmentName (string) required
elastic_beanstalk/delete_platform_versionDeletes the specified version of a custom platform.PlatformArn (string)
elastic_beanstalk/describe_account_attributesReturns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account. The result currently has one set of attributes—resource quotas.No parameters
elastic_beanstalk/describe_applicationsReturns the descriptions of existing applications.ApplicationNames (array)
elastic_beanstalk/describe_application_versionsRetrieve a list of application versions.ApplicationName (string)
VersionLabels (array)
MaxRecords (integer)
NextToken (string)
elastic_beanstalk/describe_configuration_optionsDescribes 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.ApplicationName (string)
TemplateName (string)
EnvironmentName (string)
SolutionStackName (string)
PlatformArn (string)
Options (array)
elastic_beanstalk/describe_configuration_settingsReturns 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.ApplicationName (string) required
TemplateName (string)
EnvironmentName (string)
elastic_beanstalk/describe_environment_healthReturns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.EnvironmentName (string)
EnvironmentId (string)
AttributeNames (array)
elastic_beanstalk/describe_environment_managed_action_historyLists an environment's completed and failed managed actions.EnvironmentId (string)
EnvironmentName (string)
NextToken (string)
MaxItems (integer)
elastic_beanstalk/describe_environment_managed_actionsLists an environment's upcoming and in-progress managed actions.EnvironmentName (string)
EnvironmentId (string)
Status (string)
elastic_beanstalk/describe_environment_resourcesReturns AWS resources for this environment.EnvironmentId (string)
EnvironmentName (string)
elastic_beanstalk/describe_environmentsReturns descriptions for existing environments.ApplicationName (string)
VersionLabel (string)
EnvironmentIds (array)
EnvironmentNames (array)
IncludeDeleted (boolean)
IncludedDeletedBackTo (string)
MaxRecords (integer)
NextToken (string)
elastic_beanstalk/describe_eventsReturns 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.ApplicationName (string)
VersionLabel (string)
TemplateName (string)
EnvironmentId (string)
EnvironmentName (string)
PlatformArn (string)
RequestId (string)
Severity (string)
StartTime (string)
EndTime (string)
MaxRecords (integer)
NextToken (string)
elastic_beanstalk/describe_instances_healthRetrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.EnvironmentName (string)
EnvironmentId (string)
AttributeNames (array)
NextToken (string)
elastic_beanstalk/describe_platform_versionDescribes 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.PlatformArn (string)
elastic_beanstalk/disassociate_environment_operations_roleDisassociate 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.EnvironmentName (string) required
elastic_beanstalk/list_available_solution_stacksReturns a list of the available solution stack names, with the public version first and then in reverse chronological order.No parameters
elastic_beanstalk/list_platform_branchesLists 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.Filters (array)
MaxRecords (integer)
NextToken (string)
elastic_beanstalk/list_platform_versionsLists 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.Filters (array)
MaxRecords (integer)
NextToken (string)
elastic_beanstalk/list_tags_for_resourceReturn 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.ResourceArn (string) required
elastic_beanstalk/rebuild_environmentDeletes and recreates all of the AWS resources for example: the Auto Scaling group, load balancer, etc. for a specified environment and forces a restart.EnvironmentId (string)
EnvironmentName (string)
elastic_beanstalk/request_environment_infoInitiates 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 RetrieveEnvironmeEnvironmentId (string)
EnvironmentName (string)
InfoType (string) required
elastic_beanstalk/restart_app_serverCauses the environment to restart the application container server running on each Amazon EC2 instance.EnvironmentId (string)
EnvironmentName (string)
elastic_beanstalk/retrieve_environment_infoRetrieves the compiled information from a RequestEnvironmentInfo request. Related Topics RequestEnvironmentInfoEnvironmentId (string)
EnvironmentName (string)
InfoType (string) required
elastic_beanstalk/swap_environment_cnamesSwaps the CNAMEs of two environments.SourceEnvironmentId (string)
SourceEnvironmentName (string)
DestinationEnvironmentId (string)
DestinationEnvironmentName (string)
elastic_beanstalk/terminate_environmentTerminates the specified environment.EnvironmentId (string)
EnvironmentName (string)
TerminateResources (boolean)
ForceTerminate (boolean)
elastic_beanstalk/update_applicationUpdates 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.ApplicationName (string) required
Description (string)
elastic_beanstalk/update_application_resource_lifecycleModifies lifecycle settings for an application.ApplicationName (string) required
ResourceLifecycleConfig: {
. ServiceRole (string)
. VersionLifecycleConfig (object)
} (object) required
elastic_beanstalk/update_application_versionUpdates 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.ApplicationName (string) required
VersionLabel (string) required
Description (string)
elastic_beanstalk/update_configuration_templateUpdates 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 DescribeConfigurationOptionsApplicationName (string) required
TemplateName (string) required
Description (string)
OptionSettings (array)
OptionsToRemove (array)
elastic_beanstalk/update_environmentUpdates 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 DescribeConfiApplicationName (string)
EnvironmentId (string)
EnvironmentName (string)
GroupName (string)
Description (string)
Tier: {
. Name (string)
. Type (string)
. Version (string)
} (object)
VersionLabel (string)
TemplateName (string)
SolutionStackName (string)
PlatformArn (string)
OptionSettings (array)
OptionsToRemove (array)
elastic_beanstalk/update_tags_for_resourceUpdate 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 toResourceArn (string) required
TagsToAdd (array)
TagsToRemove (array)
elastic_beanstalk/validate_configuration_settingsTakes 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.ApplicationName (string) required
TemplateName (string)
EnvironmentName (string)
OptionSettings (array) required
elastic_load_balancing_v2/add_listener_certificatesAdds 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 SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.ListenerArn (string) required
Certificates (array) required
elastic_load_balancing_v2/add_tagsAdds 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, trust stores, 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.ResourceArns (array) required
Tags (array) required
elastic_load_balancing_v2/add_trust_store_revocationsAdds the specified revocation file to the specified trust store.TrustStoreArn (string) required
RevocationContents (array)
elastic_load_balancing_v2/create_listenerCreates 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.LoadBalancerArn (string) required
Protocol (string)
Port (integer)
SslPolicy (string)
Certificates (array)
DefaultActions (array) required
AlpnPolicy (array)
Tags (array)
MutualAuthentication: {
. Mode (string)
. TrustStoreArn (string)
. IgnoreClientCertificateExpiry (boolean)
. TrustStoreAssociationStatus (string)
. AdvertiseTrustStoreCaNames (string)
} (object)
elastic_load_balancing_v2/create_load_balancerCreates 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.Name (string) required
Subnets (array)
SubnetMappings (array)
SecurityGroups (array)
Scheme (string)
Tags (array)
Type (string)
IpAddressType (string)
CustomerOwnedIpv4Pool (string)
EnablePrefixForIpv6SourceNat (string)
IpamPools: {
. Ipv4IpamPoolId (string)
} (object)
elastic_load_balancing_v2/create_ruleCreates 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, one or more conditions, and up to two optional transforms. 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 rulListenerArn (string) required
Conditions (array) required
Priority (integer) required
Actions (array) required
Tags (array)
Transforms (array)
elastic_load_balancing_v2/create_target_groupCreates 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.Name (string) required
Protocol (string)
ProtocolVersion (string)
Port (integer)
VpcId (string)
HealthCheckProtocol (string)
HealthCheckPort (string)
HealthCheckEnabled (boolean)
HealthCheckPath (string)
HealthCheckIntervalSeconds (integer)
HealthCheckTimeoutSeconds (integer)
HealthyThresholdCount (integer)
UnhealthyThresholdCount (integer)
Matcher: {
. HttpCode (string)
. GrpcCode (string)
} (object)
TargetType (string)
Tags (array)
IpAddressType (string)
TargetControlPort (integer)
elastic_load_balancing_v2/create_trust_storeCreates a trust store. For more information, see Mutual TLS for Application Load Balancers.Name (string) required
CaCertificatesBundleS3Bucket (string) required
CaCertificatesBundleS3Key (string) required
CaCertificatesBundleS3ObjectVersion (string)
Tags (array)
elastic_load_balancing_v2/delete_listenerDeletes the specified listener. Alternatively, your listener is deleted when you delete the load balancer to which it is attached.ListenerArn (string) required
elastic_load_balancing_v2/delete_load_balancerDeletes 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 insLoadBalancerArn (string) required
elastic_load_balancing_v2/delete_ruleDeletes the specified rule. You can't delete the default rule.RuleArn (string) required
elastic_load_balancing_v2/delete_shared_trust_store_associationDeletes a shared trust store association.TrustStoreArn (string) required
ResourceArn (string) required
elastic_load_balancing_v2/delete_target_groupDeletes 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.TargetGroupArn (string) required
elastic_load_balancing_v2/delete_trust_storeDeletes a trust store.TrustStoreArn (string) required
elastic_load_balancing_v2/deregister_targetsDeregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer. The load balancer stops sending requests to targets that are deregistering, but uses connection draining to ensure that in-flight traffic completes on the existing connections. This deregistration delay is configured by default but can be updated for each target group. For more information, see the following: Deregistration delay in the AppTargetGroupArn (string) required
Targets (array) required
elastic_load_balancing_v2/describe_account_limitsDescribes 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 BalancersMarker (string)
PageSize (integer)
elastic_load_balancing_v2/describe_capacity_reservationDescribes the capacity reservation status for the specified load balancer.LoadBalancerArn (string) required
elastic_load_balancing_v2/describe_listener_attributesDescribes the attributes for the specified listener.ListenerArn (string) required
elastic_load_balancing_v2/describe_listener_certificatesDescribes 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.ListenerArn (string) required
Marker (string)
PageSize (integer)
elastic_load_balancing_v2/describe_listenersDescribes 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.LoadBalancerArn (string)
ListenerArns (array)
Marker (string)
PageSize (integer)
elastic_load_balancing_v2/describe_load_balancer_attributesDescribes 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 GuideLoadBalancerArn (string) required
elastic_load_balancing_v2/describe_load_balancersDescribes the specified load balancers or all of your load balancers.LoadBalancerArns (array)
Names (array)
Marker (string)
PageSize (integer)
elastic_load_balancing_v2/describe_rulesDescribes the specified rules or the rules for the specified listener. You must specify either a listener or rules.ListenerArn (string)
RuleArns (array)
Marker (string)
PageSize (integer)
elastic_load_balancing_v2/describe_sslpoliciesDescribes the specified policies or all policies used for SSL negotiation. For more information, see Security policies in the Application Load Balancers Guide and Security policies in the Network Load Balancers Guide.Names (array)
Marker (string)
PageSize (integer)
LoadBalancerType (string)
elastic_load_balancing_v2/describe_tagsDescribes 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.ResourceArns (array) required
elastic_load_balancing_v2/describe_target_group_attributesDescribes 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 GuideTargetGroupArn (string) required
elastic_load_balancing_v2/describe_target_groupsDescribes 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.LoadBalancerArn (string)
TargetGroupArns (array)
Names (array)
Marker (string)
PageSize (integer)
elastic_load_balancing_v2/describe_target_healthDescribes the health of the specified targets or all of your targets.TargetGroupArn (string) required
Targets (array)
Include (array)
elastic_load_balancing_v2/describe_trust_store_associationsDescribes all resources associated with the specified trust store.TrustStoreArn (string) required
Marker (string)
PageSize (integer)
elastic_load_balancing_v2/describe_trust_store_revocationsDescribes the revocation files in use by the specified trust store or revocation files.TrustStoreArn (string) required
RevocationIds (array)
Marker (string)
PageSize (integer)
elastic_load_balancing_v2/describe_trust_storesDescribes all trust stores for the specified account.TrustStoreArns (array)
Names (array)
Marker (string)
PageSize (integer)
elastic_load_balancing_v2/get_resource_policyRetrieves the resource policy for a specified resource.ResourceArn (string) required
elastic_load_balancing_v2/get_trust_store_ca_certificates_bundleRetrieves the ca certificate bundle. This action returns a pre-signed S3 URI which is active for ten minutes.TrustStoreArn (string) required
elastic_load_balancing_v2/get_trust_store_revocation_contentRetrieves the specified revocation file. This action returns a pre-signed S3 URI which is active for ten minutes.TrustStoreArn (string) required
RevocationId (integer) required
elastic_load_balancing_v2/modify_capacity_reservationModifies the capacity reservation of the specified load balancer. When modifying capacity reservation, you must include at least one MinimumLoadBalancerCapacity or ResetCapacityReservation.LoadBalancerArn (string) required
MinimumLoadBalancerCapacity: {
. CapacityUnits (integer)
} (object)
ResetCapacityReservation (boolean)
elastic_load_balancing_v2/modify_ip_poolsApplication Load Balancers Modify the IP pool associated to a load balancer.LoadBalancerArn (string) required
IpamPools: {
. Ipv4IpamPoolId (string)
} (object)
RemoveIpamPools (array)
elastic_load_balancing_v2/modify_listenerReplaces 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. ForListenerArn (string) required
Port (integer)
Protocol (string)
SslPolicy (string)
Certificates (array)
DefaultActions (array)
AlpnPolicy (array)
MutualAuthentication: {
. Mode (string)
. TrustStoreArn (string)
. IgnoreClientCertificateExpiry (boolean)
. TrustStoreAssociationStatus (string)
. AdvertiseTrustStoreCaNames (string)
} (object)
elastic_load_balancing_v2/modify_listener_attributesModifies the specified attributes of the specified listener.ListenerArn (string) required
Attributes (array) required
elastic_load_balancing_v2/modify_load_balancer_attributesModifies 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.LoadBalancerArn (string) required
Attributes (array) required
elastic_load_balancing_v2/modify_ruleReplaces 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.RuleArn (string) required
Conditions (array)
Actions (array)
Transforms (array)
ResetTransforms (boolean)
elastic_load_balancing_v2/modify_target_groupModifies the health checks used when evaluating the health state of the targets in the specified target group.TargetGroupArn (string) required
HealthCheckProtocol (string)
HealthCheckPort (string)
HealthCheckPath (string)
HealthCheckEnabled (boolean)
HealthCheckIntervalSeconds (integer)
HealthCheckTimeoutSeconds (integer)
HealthyThresholdCount (integer)
UnhealthyThresholdCount (integer)
Matcher: {
. HttpCode (string)
. GrpcCode (string)
} (object)
elastic_load_balancing_v2/modify_target_group_attributesModifies the specified attributes of the specified target group.TargetGroupArn (string) required
Attributes (array) required
elastic_load_balancing_v2/modify_trust_storeUpdate the ca certificate bundle for the specified trust store.TrustStoreArn (string) required
CaCertificatesBundleS3Bucket (string) required
CaCertificatesBundleS3Key (string) required
CaCertificatesBundleS3ObjectVersion (string)
elastic_load_balancing_v2/register_targetsRegisters 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. For more information, see the followingTargetGroupArn (string) required
Targets (array) required
elastic_load_balancing_v2/remove_listener_certificatesRemoves the specified certificate from the certificate list for the specified HTTPS or TLS listener.ListenerArn (string) required
Certificates (array) required
elastic_load_balancing_v2/remove_tagsRemoves 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.ResourceArns (array) required
TagKeys (array) required
elastic_load_balancing_v2/remove_trust_store_revocationsRemoves the specified revocation file from the specified trust store.TrustStoreArn (string) required
RevocationIds (array) required
elastic_load_balancing_v2/set_ip_address_typeSets the type of IP addresses used by the subnets of the specified load balancer.LoadBalancerArn (string) required
IpAddressType (string) required
elastic_load_balancing_v2/set_rule_prioritiesSets 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.RulePriorities (array) required
elastic_load_balancing_v2/set_security_groupsAssociates the specified security groups with the specified Application Load Balancer or Network Load Balancer. The specified security groups override the previously associated security groups. You can't perform this operation on a Network Load Balancer unless you specified a security group for the load balancer when you created it. You can't associate a security group with a Gateway Load Balancer.LoadBalancerArn (string) required
SecurityGroups (array) required
EnforceSecurityGroupInboundRulesOnPrivateLinkTraffic (string)
elastic_load_balancing_v2/set_subnetsEnables the Availability Zones for the specified public subnets for the specified Application Load Balancer, Network Load Balancer or Gateway Load Balancer. The specified subnets replace the previously enabled subnets.LoadBalancerArn (string) required
Subnets (array)
SubnetMappings (array)
IpAddressType (string)
EnablePrefixForIpv6SourceNat (string)
elastic_load_balancing/add_tagsAdds 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.LoadBalancerNames (array) required
Tags (array) required
elastic_load_balancing/apply_security_groups_to_load_balancerAssociates 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.LoadBalancerName (string) required
SecurityGroups (array) required
elastic_load_balancing/attach_load_balancer_to_subnetsAdds 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.LoadBalancerName (string) required
Subnets (array) required
elastic_load_balancing/configure_health_checkSpecifies 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.LoadBalancerName (string) required
HealthCheck: {
. Target (string)
. Interval (integer)
. Timeout (integer)
. UnhealthyThreshold (integer)
. HealthyThreshold (integer)
} (object) required
elastic_load_balancing/create_app_cookie_stickiness_policyGenerates 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 applicLoadBalancerName (string) required
PolicyName (string) required
CookieName (string) required
elastic_load_balancing/create_lbcookie_stickiness_policyGenerates 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 applicatLoadBalancerName (string) required
PolicyName (string) required
CookieExpirationPeriod (integer)
elastic_load_balancing/create_load_balancerCreates 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 requestLoadBalancerName (string) required
Listeners (array) required
AvailabilityZones (array)
Subnets (array)
SecurityGroups (array)
Scheme (string)
Tags (array)
elastic_load_balancing/create_load_balancer_listenersCreates 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.LoadBalancerName (string) required
Listeners (array) required
elastic_load_balancing/create_load_balancer_policyCreates 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.LoadBalancerName (string) required
PolicyName (string) required
PolicyTypeName (string) required
PolicyAttributes (array)
elastic_load_balancing/delete_load_balancerDeletes 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.LoadBalancerName (string) required
elastic_load_balancing/delete_load_balancer_listenersDeletes the specified listeners from the specified load balancer.LoadBalancerName (string) required
LoadBalancerPorts (array) required
elastic_load_balancing/delete_load_balancer_policyDeletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.LoadBalancerName (string) required
PolicyName (string) required
elastic_load_balancing/deregister_instances_from_load_balancerDeregisters 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.LoadBalancerName (string) required
Instances (array) required
elastic_load_balancing/describe_account_limitsDescribes 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.Marker (string)
PageSize (integer)
elastic_load_balancing/describe_instance_healthDescribes 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.LoadBalancerName (string) required
Instances (array)
elastic_load_balancing/describe_load_balancer_attributesDescribes the attributes for the specified load balancer.LoadBalancerName (string) required
elastic_load_balancing/describe_load_balancer_policiesDescribes 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.LoadBalancerName (string)
PolicyNames (array)
elastic_load_balancing/describe_load_balancer_policy_typesDescribes 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 SetLoadBalancerPoliciesOPolicyTypeNames (array)
elastic_load_balancing/describe_load_balancersDescribes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.LoadBalancerNames (array)
Marker (string)
PageSize (integer)
elastic_load_balancing/describe_tagsDescribes the tags associated with the specified load balancers.LoadBalancerNames (array) required
elastic_load_balancing/detach_load_balancer_from_subnetsRemoves 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.LoadBalancerName (string) required
Subnets (array) required
elastic_load_balancing/disable_availability_zones_for_load_balancerRemoves 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 attemptLoadBalancerName (string) required
AvailabilityZones (array) required
elastic_load_balancing/enable_availability_zones_for_load_balancerAdds 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.LoadBalancerName (string) required
AvailabilityZones (array) required
elastic_load_balancing/modify_load_balancer_attributesModifies 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 TimeouLoadBalancerName (string) required
LoadBalancerAttributes: {
. CrossZoneLoadBalancing (object)
. AccessLog (object)
. ConnectionDraining (object)
. ConnectionSettings (object)
. AdditionalAttributes (array)
} (object) required
elastic_load_balancing/register_instances_with_load_balancerAdds 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 regLoadBalancerName (string) required
Instances (array) required
elastic_load_balancing/remove_tagsRemoves one or more tags from the specified load balancer.LoadBalancerNames (array) required
Tags (array) required
elastic_load_balancing/set_load_balancer_listener_sslcertificateSets 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.LoadBalancerName (string) required
LoadBalancerPort (integer) required
SSLCertificateId (string) required
elastic_load_balancing/set_load_balancer_policies_for_backend_serverReplaces 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 DescribeLoadBalancerName (string) required
InstancePort (integer) required
PolicyNames (array) required
elastic_load_balancing/set_load_balancer_policies_of_listenerReplaces 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.LoadBalancerName (string) required
LoadBalancerPort (integer) required
PolicyNames (array) required
elasticache/add_tags_to_resourceA 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-seResourceName (string) required
Tags (array) required
elasticache/authorize_cache_security_group_ingressAllows 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.CacheSecurityGroupName (string) required
EC2SecurityGroupName (string) required
EC2SecurityGroupOwnerId (string) required
elasticache/batch_apply_update_actionApply the service update. For more information on service updates and applying them, see Applying Service Updates.ReplicationGroupIds (array)
CacheClusterIds (array)
ServiceUpdateName (string) required
elasticache/batch_stop_update_actionStop the service update. For more information on service updates and stopping them, see Stopping Service Updates.ReplicationGroupIds (array)
CacheClusterIds (array)
ServiceUpdateName (string) required
elasticache/complete_migrationComplete the migration of data.ReplicationGroupId (string) required
Force (boolean)
elasticache/copy_serverless_cache_snapshotCreates a copy of an existing serverless cache’s snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.SourceServerlessCacheSnapshotName (string) required
TargetServerlessCacheSnapshotName (string) required
KmsKeyId (string)
Tags (array)
elasticache/copy_snapshotMakes a copy of an existing snapshot. This operation is valid for Valkey or Redis OSS 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 and Access Control. YoSourceSnapshotName (string) required
TargetSnapshotName (string) required
TargetBucket (string)
KmsKeyId (string)
Tags (array)
elasticache/create_cache_clusterCreates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached, Valkey or Redis OSS. This operation is not supported for Valkey or Redis OSS cluster mode enabled clusters.CacheClusterId (string) required
ReplicationGroupId (string)
AZMode (string)
PreferredAvailabilityZone (string)
PreferredAvailabilityZones (array)
NumCacheNodes (integer)
CacheNodeType (string)
Engine (string)
EngineVersion (string)
CacheParameterGroupName (string)
CacheSubnetGroupName (string)
CacheSecurityGroupNames (array)
SecurityGroupIds (array)
Tags (array)
SnapshotArns (array)
SnapshotName (string)
PreferredMaintenanceWindow (string)
Port (integer)
NotificationTopicArn (string)
AutoMinorVersionUpgrade (boolean)
SnapshotRetentionLimit (integer)
SnapshotWindow (string)
AuthToken (string)
OutpostMode (string)
PreferredOutpostArn (string)
PreferredOutpostArns (array)
LogDeliveryConfigurations (array)
TransitEncryptionEnabled (boolean)
NetworkType (string)
IpDiscovery (string)
elasticache/create_cache_parameter_groupCreates 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: ModiCacheParameterGroupName (string) required
CacheParameterGroupFamily (string) required
Description (string) required
Tags (array)
elasticache/create_cache_security_groupCreates 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.CacheSecurityGroupName (string) required
Description (string) required
Tags (array)
elasticache/create_cache_subnet_groupCreates a new cache subnet group. Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud Amazon VPC.CacheSubnetGroupName (string) required
CacheSubnetGroupDescription (string) required
SubnetIds (array) required
Tags (array)
elasticache/create_global_replication_groupGlobal Datastore offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore with Valkey or Redis OSS, you can create cross-region read replica clusters for ElastiCache 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 aGlobalReplicationGroupIdSuffix (string) required
GlobalReplicationGroupDescription (string)
PrimaryReplicationGroupId (string) required
elasticache/create_replication_groupCreates a Valkey or Redis OSS cluster mode disabled or a Valkey or Redis OSS 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 Valkey or Redis OSS cluster mode disabled replication group is a collection of nodes, where one of the nodes is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.ReplicationGroupId (string) required
ReplicationGroupDescription (string) required
GlobalReplicationGroupId (string)
PrimaryClusterId (string)
AutomaticFailoverEnabled (boolean)
MultiAZEnabled (boolean)
NumCacheClusters (integer)
PreferredCacheClusterAZs (array)
NumNodeGroups (integer)
ReplicasPerNodeGroup (integer)
NodeGroupConfiguration (array)
CacheNodeType (string)
Engine (string)
EngineVersion (string)
CacheParameterGroupName (string)
CacheSubnetGroupName (string)
CacheSecurityGroupNames (array)
SecurityGroupIds (array)
Tags (array)
SnapshotArns (array)
SnapshotName (string)
PreferredMaintenanceWindow (string)
Port (integer)
NotificationTopicArn (string)
AutoMinorVersionUpgrade (boolean)
SnapshotRetentionLimit (integer)
SnapshotWindow (string)
AuthToken (string)
TransitEncryptionEnabled (boolean)
AtRestEncryptionEnabled (boolean)
KmsKeyId (string)
UserGroupIds (array)
LogDeliveryConfigurations (array)
DataTieringEnabled (boolean)
NetworkType (string)
IpDiscovery (string)
TransitEncryptionMode (string)
ClusterMode (string)
ServerlessCacheSnapshotName (string)
elasticache/create_serverless_cacheCreates a serverless cache.ServerlessCacheName (string) required
Description (string)
Engine (string) required
MajorEngineVersion (string)
CacheUsageLimits: {
. DataStorage (object)
. ECPUPerSecond (object)
} (object)
KmsKeyId (string)
SecurityGroupIds (array)
SnapshotArnsToRestore (array)
Tags (array)
UserGroupId (string)
SubnetIds (array)
SnapshotRetentionLimit (integer)
DailySnapshotTime (string)
elasticache/create_serverless_cache_snapshotThis API creates a copy of an entire ServerlessCache at a specific moment in time. Available for Valkey, Redis OSS and Serverless Memcached only.ServerlessCacheSnapshotName (string) required
ServerlessCacheName (string) required
KmsKeyId (string)
Tags (array)
elasticache/create_snapshotCreates a copy of an entire cluster or replication group at a specific moment in time. This operation is valid for Valkey or Redis OSS only.ReplicationGroupId (string)
CacheClusterId (string)
SnapshotName (string) required
KmsKeyId (string)
Tags (array)
elasticache/create_userFor Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user. For more information, see Using Role Based Access Control RBAC.UserId (string) required
UserName (string) required
Engine (string) required
Passwords (array)
AccessString (string) required
NoPasswordRequired (boolean)
Tags (array)
AuthenticationMode: {
. Type (string)
. Passwords (array)
} (object)
elasticache/create_user_groupFor Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user group. For more information, see Using Role Based Access Control RBACUserGroupId (string) required
Engine (string) required
UserIds (array)
Tags (array)
elasticache/decrease_node_groups_in_global_replication_groupDecreases the number of node groups in a Global datastoreGlobalReplicationGroupId (string) required
NodeGroupCount (integer) required
GlobalNodeGroupsToRemove (array)
GlobalNodeGroupsToRetain (array)
ApplyImmediately (boolean) required
elasticache/decrease_replica_countDynamically decreases the number of replicas in a Valkey or Redis OSS cluster mode disabled replication group or the number of replica nodes in one or more node groups shards of a Valkey or Redis OSS cluster mode enabled replication group. This operation is performed with no cluster down time.ReplicationGroupId (string) required
NewReplicaCount (integer)
ReplicaConfiguration (array)
ReplicasToRemove (array)
ApplyImmediately (boolean) required
elasticache/delete_cache_clusterDeletes 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: Valkey or Redis OSS cluster mode enabled clusters Valkey or Redis OSS cluster mode disabled clusters A cluster that is the last read replica of a replication group A cCacheClusterId (string) required
FinalSnapshotIdentifier (string)
elasticache/delete_cache_parameter_groupDeletes 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.CacheParameterGroupName (string) required
elasticache/delete_cache_security_groupDeletes a cache security group. You cannot delete a cache security group if it is associated with any clusters.CacheSecurityGroupName (string) required
elasticache/delete_cache_subnet_groupDeletes a cache subnet group. You cannot delete a default cache subnet group or one that is associated with any clusters.CacheSubnetGroupName (string) required
elasticache/delete_global_replication_groupDeleting 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 primaryGlobalReplicationGroupId (string) required
RetainPrimaryReplicationGroup (boolean) required
elasticache/delete_replication_groupDeletes 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 operatiReplicationGroupId (string) required
RetainPrimaryCluster (boolean)
FinalSnapshotIdentifier (string)
elasticache/delete_serverless_cacheDeletes a specified existing serverless cache. CreateServerlessCacheSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.ServerlessCacheName (string) required
FinalSnapshotName (string)
elasticache/delete_serverless_cache_snapshotDeletes an existing serverless cache snapshot. Available for Valkey, Redis OSS and Serverless Memcached only.ServerlessCacheSnapshotName (string) required
elasticache/delete_snapshotDeletes 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 Valkey or Redis OSS only.SnapshotName (string) required
elasticache/delete_userFor Valkey engine version 7.2 onwards and Redis OSS 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.UserId (string) required
elasticache/delete_user_groupFor Valkey engine version 7.2 onwards and Redis OSS 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.UserGroupId (string) required
elasticache/describe_cache_clustersReturns 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 inCacheClusterId (string)
MaxRecords (integer)
Marker (string)
ShowCacheNodeInfo (boolean)
ShowCacheClustersNotInReplicationGroups (boolean)
elasticache/describe_cache_engine_versionsReturns a list of the available cache engines and their versions.Engine (string)
EngineVersion (string)
CacheParameterGroupFamily (string)
MaxRecords (integer)
Marker (string)
DefaultOnly (boolean)
elasticache/describe_cache_parameter_groupsReturns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.CacheParameterGroupName (string)
MaxRecords (integer)
Marker (string)
elasticache/describe_cache_parametersReturns the detailed parameter list for a particular cache parameter group.CacheParameterGroupName (string) required
Source (string)
MaxRecords (integer)
Marker (string)
elasticache/describe_cache_security_groupsReturns 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 setupCacheSecurityGroupName (string)
MaxRecords (integer)
Marker (string)
elasticache/describe_cache_subnet_groupsReturns 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.CacheSubnetGroupName (string)
MaxRecords (integer)
Marker (string)
elasticache/describe_engine_default_parametersReturns the default engine and system parameter information for the specified cache engine.CacheParameterGroupFamily (string) required
MaxRecords (integer)
Marker (string)
elasticache/describe_eventsReturns 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.SourceIdentifier (string)
SourceType (string)
StartTime (string)
EndTime (string)
Duration (integer)
MaxRecords (integer)
Marker (string)
elasticache/describe_global_replication_groupsReturns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.GlobalReplicationGroupId (string)
MaxRecords (integer)
Marker (string)
ShowMemberInfo (boolean)
elasticache/describe_replication_groupsReturns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups. This operation is valid for Valkey or Redis OSS only.ReplicationGroupId (string)
MaxRecords (integer)
Marker (string)
elasticache/describe_reserved_cache_nodesReturns information about reserved cache nodes for this account, or about a specified reserved cache node.ReservedCacheNodeId (string)
ReservedCacheNodesOfferingId (string)
CacheNodeType (string)
Duration (string)
ProductDescription (string)
OfferingType (string)
MaxRecords (integer)
Marker (string)
elasticache/describe_reserved_cache_nodes_offeringsLists available reserved cache node offerings.ReservedCacheNodesOfferingId (string)
CacheNodeType (string)
Duration (string)
ProductDescription (string)
OfferingType (string)
MaxRecords (integer)
Marker (string)
elasticache/describe_serverless_cachesReturns information about a specific serverless cache. If no identifier is specified, then the API returns information on all the serverless caches belonging to this Amazon Web Services account.ServerlessCacheName (string)
MaxResults (integer)
NextToken (string)
elasticache/describe_serverless_cache_snapshotsReturns information about serverless cache snapshots. By default, this API lists all of the customer’s serverless cache snapshots. It can also describe a single serverless cache snapshot, or the snapshots associated with a particular serverless cache. Available for Valkey, Redis OSS and Serverless Memcached only.ServerlessCacheName (string)
ServerlessCacheSnapshotName (string)
SnapshotType (string)
NextToken (string)
MaxResults (integer)
elasticache/describe_service_updatesReturns details of the service updatesServiceUpdateName (string)
ServiceUpdateStatus (array)
MaxRecords (integer)
Marker (string)
elasticache/describe_snapshotsReturns 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 Valkey or Redis OSS only.ReplicationGroupId (string)
CacheClusterId (string)
SnapshotName (string)
SnapshotSource (string)
Marker (string)
MaxRecords (integer)
ShowNodeGroupConfig (boolean)
elasticache/describe_update_actionsReturns details of the update actionsServiceUpdateName (string)
ReplicationGroupIds (array)
CacheClusterIds (array)
Engine (string)
ServiceUpdateStatus (array)
ServiceUpdateTimeRange: {
. StartTime (string)
. EndTime (string)
} (object)
UpdateActionStatus (array)
ShowNodeLevelUpdateStatus (boolean)
MaxRecords (integer)
Marker (string)
elasticache/describe_user_groupsReturns a list of user groups.UserGroupId (string)
MaxRecords (integer)
Marker (string)
elasticache/describe_usersReturns a list of users.Engine (string)
UserId (string)
Filters (array)
MaxRecords (integer)
Marker (string)
elasticache/disassociate_global_replication_groupRemove 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.GlobalReplicationGroupId (string) required
ReplicationGroupId (string) required
ReplicationGroupRegion (string) required
elasticache/export_serverless_cache_snapshotProvides the functionality to export the serverless cache snapshot data to Amazon S3. Available for Valkey and Redis OSS only.ServerlessCacheSnapshotName (string) required
S3BucketName (string) required
elasticache/failover_global_replication_groupUsed to failover the primary region to a secondary region. The secondary region will become primary, and all other clusters will become secondary.GlobalReplicationGroupId (string) required
PrimaryRegion (string) required
PrimaryReplicationGroupId (string) required
elasticache/increase_node_groups_in_global_replication_groupIncrease the number of node groups in the Global datastoreGlobalReplicationGroupId (string) required
NodeGroupCount (integer) required
RegionalConfigurations (array)
ApplyImmediately (boolean) required
elasticache/increase_replica_countDynamically increases the number of replicas in a Valkey or Redis OSS cluster mode disabled replication group or the number of replica nodes in one or more node groups shards of a Valkey or Redis OSS cluster mode enabled replication group. This operation is performed with no cluster down time.ReplicationGroupId (string) required
NewReplicaCount (integer)
ReplicaConfiguration (array)
ApplyImmediately (boolean) required
elasticache/list_allowed_node_type_modificationsLists all available node types that you can scale with your cluster's 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.CacheClusterId (string)
ReplicationGroupId (string)
elasticache/list_tags_for_resourceLists 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.ResourceName (string) required
elasticache/modify_cache_clusterModifies 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.CacheClusterId (string) required
NumCacheNodes (integer)
CacheNodeIdsToRemove (array)
AZMode (string)
NewAvailabilityZones (array)
CacheSecurityGroupNames (array)
SecurityGroupIds (array)
PreferredMaintenanceWindow (string)
NotificationTopicArn (string)
CacheParameterGroupName (string)
NotificationTopicStatus (string)
ApplyImmediately (boolean)
Engine (string)
EngineVersion (string)
AutoMinorVersionUpgrade (boolean)
SnapshotRetentionLimit (integer)
SnapshotWindow (string)
CacheNodeType (string)
AuthToken (string)
AuthTokenUpdateStrategy (string)
LogDeliveryConfigurations (array)
IpDiscovery (string)
ScaleConfig: {
. ScalePercentage (integer)
. ScaleIntervalMinutes (integer)
} (object)
elasticache/modify_cache_parameter_groupModifies 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.CacheParameterGroupName (string) required
ParameterNameValues (array) required
elasticache/modify_cache_subnet_groupModifies an existing cache subnet group.CacheSubnetGroupName (string) required
CacheSubnetGroupDescription (string)
SubnetIds (array)
elasticache/modify_global_replication_groupModifies the settings for a Global datastore.GlobalReplicationGroupId (string) required
ApplyImmediately (boolean) required
CacheNodeType (string)
Engine (string)
EngineVersion (string)
CacheParameterGroupName (string)
GlobalReplicationGroupDescription (string)
AutomaticFailoverEnabled (boolean)
elasticache/modify_replication_groupModifies the settings for a replication group. This is limited to Valkey and Redis OSS 7 and above. Scaling for Valkey or Redis OSS cluster mode enabled in the ElastiCache User Guide ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference This operation is valid for Valkey or Redis OSS only.ReplicationGroupId (string) required
ReplicationGroupDescription (string)
PrimaryClusterId (string)
SnapshottingClusterId (string)
AutomaticFailoverEnabled (boolean)
MultiAZEnabled (boolean)
NodeGroupId (string)
CacheSecurityGroupNames (array)
SecurityGroupIds (array)
PreferredMaintenanceWindow (string)
NotificationTopicArn (string)
CacheParameterGroupName (string)
NotificationTopicStatus (string)
ApplyImmediately (boolean)
Engine (string)
EngineVersion (string)
AutoMinorVersionUpgrade (boolean)
SnapshotRetentionLimit (integer)
SnapshotWindow (string)
CacheNodeType (string)
AuthToken (string)
AuthTokenUpdateStrategy (string)
UserGroupIdsToAdd (array)
UserGroupIdsToRemove (array)
RemoveUserGroups (boolean)
LogDeliveryConfigurations (array)
IpDiscovery (string)
TransitEncryptionEnabled (boolean)
TransitEncryptionMode (string)
ClusterMode (string)
elasticache/modify_replication_group_shard_configurationModifies a replication group's shards node groups by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.ReplicationGroupId (string) required
NodeGroupCount (integer) required
ApplyImmediately (boolean) required
ReshardingConfiguration (array)
NodeGroupsToRemove (array)
NodeGroupsToRetain (array)
elasticache/modify_serverless_cacheThis API modifies the attributes of a serverless cache.ServerlessCacheName (string) required
Description (string)
CacheUsageLimits: {
. DataStorage (object)
. ECPUPerSecond (object)
} (object)
RemoveUserGroup (boolean)
UserGroupId (string)
SecurityGroupIds (array)
SnapshotRetentionLimit (integer)
DailySnapshotTime (string)
Engine (string)
MajorEngineVersion (string)
elasticache/modify_userChanges user passwords and/or access string.UserId (string) required
AccessString (string)
AppendAccessString (string)
Passwords (array)
NoPasswordRequired (boolean)
AuthenticationMode: {
. Type (string)
. Passwords (array)
} (object)
Engine (string)
elasticache/modify_user_groupChanges the list of users that belong to the user group.UserGroupId (string) required
UserIdsToAdd (array)
UserIdsToRemove (array)
Engine (string)
elasticache/purchase_reserved_cache_nodes_offeringAllows 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.ReservedCacheNodesOfferingId (string) required
ReservedCacheNodeId (string)
CacheNodeCount (integer)
Tags (array)
elasticache/rebalance_slots_in_global_replication_groupRedistribute slots to ensure uniform distribution across existing shards in the cluster.GlobalReplicationGroupId (string) required
ApplyImmediately (boolean) required
elasticache/reboot_cache_clusterReboots 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 supportedCacheClusterId (string) required
CacheNodeIdsToReboot (array) required
elasticache/remove_tags_from_resourceRemoves 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.ResourceName (string) required
TagKeys (array) required
elasticache/reset_cache_parameter_groupModifies 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.CacheParameterGroupName (string) required
ResetAllParameters (boolean)
ParameterNameValues (array)
elasticache/revoke_cache_security_group_ingressRevokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.CacheSecurityGroupName (string) required
EC2SecurityGroupName (string) required
EC2SecurityGroupOwnerId (string) required
elasticache/start_migrationStart the migration of data.ReplicationGroupId (string) required
CustomerNodeEndpointList (array) required
elasticache/test_failoverRepresents the input of a TestFailover operation which tests 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 blockReplicationGroupId (string) required
NodeGroupId (string) required
elasticache/test_migrationAsync API to test connection between source and target replication group.ReplicationGroupId (string) required
CustomerNodeEndpointList (array) required
elasticsearch_service/accept_inbound_cross_cluster_search_connectionAllows the destination domain owner to accept an inbound cross-cluster search connection request.CrossClusterSearchConnectionId (string) required
elasticsearch_service/add_tagsAttaches 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.ARN (string) required
TagList (array) required
elasticsearch_service/associate_packageAssociates a package with an Amazon ES domain.PackageID (string) required
DomainName (string) required
elasticsearch_service/authorize_vpc_endpoint_accessProvides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.DomainName (string) required
Account (string) required
elasticsearch_service/cancel_domain_config_changeCancels a pending configuration change on an Amazon OpenSearch Service domain.DomainName (string) required
DryRun (boolean)
elasticsearch_service/cancel_elasticsearch_service_software_updateCancels 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.DomainName (string) required
elasticsearch_service/create_elasticsearch_domainCreates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.DomainName (string) required
ElasticsearchVersion (string)
ElasticsearchClusterConfig: {
. InstanceType (string)
. InstanceCount (integer)
. DedicatedMasterEnabled (boolean)
. ZoneAwarenessEnabled (boolean)
. ZoneAwarenessConfig (object)
. DedicatedMasterType (string)
. DedicatedMasterCount (integer)
. WarmEnabled (boolean)
. WarmType (string)
. WarmCount (integer)
. ColdStorageOptions (object)
} (object)
EBSOptions: {
. EBSEnabled (boolean)
. VolumeType (string)
. VolumeSize (integer)
. Iops (integer)
. Throughput (integer)
} (object)
AccessPolicies (string)
SnapshotOptions: {
. AutomatedSnapshotStartHour (integer)
} (object)
VPCOptions: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object)
CognitoOptions: {
. Enabled (boolean)
. UserPoolId (string)
. IdentityPoolId (string)
. RoleArn (string)
} (object)
EncryptionAtRestOptions: {
. Enabled (boolean)
. KmsKeyId (string)
} (object)
NodeToNodeEncryptionOptions: {
. Enabled (boolean)
} (object)
AdvancedOptions (object)
LogPublishingOptions (object)
DomainEndpointOptions: {
. EnforceHTTPS (boolean)
. TLSSecurityPolicy (string)
. CustomEndpointEnabled (boolean)
. CustomEndpoint (string)
. CustomEndpointCertificateArn (string)
} (object)
AdvancedSecurityOptions: {
. Enabled (boolean)
. InternalUserDatabaseEnabled (boolean)
. MasterUserOptions (object)
. SAMLOptions (object)
. AnonymousAuthEnabled (boolean)
} (object)
AutoTuneOptions: {
. DesiredState (string)
. MaintenanceSchedules (array)
} (object)
TagList (array)
elasticsearch_service/create_outbound_cross_cluster_search_connectionCreates a new cross-cluster search connection from a source domain to a destination domain.SourceDomainInfo: {
. OwnerId (string)
. DomainName (string)
. Region (string)
} (object) required
DestinationDomainInfo: {
. OwnerId (string)
. DomainName (string)
. Region (string)
} (object) required
ConnectionAlias (string) required
elasticsearch_service/create_packageCreate a package for use with Amazon ES domains.PackageName (string) required
PackageType (string) required
PackageDescription (string)
PackageSource: {
. S3BucketName (string)
. S3Key (string)
} (object) required
elasticsearch_service/create_vpc_endpointCreates an Amazon OpenSearch Service-managed VPC endpoint.DomainArn (string) required
VpcOptions: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object) required
ClientToken (string)
elasticsearch_service/delete_elasticsearch_domainPermanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.DomainName (string) required
elasticsearch_service/delete_elasticsearch_service_roleDeletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.No parameters
elasticsearch_service/delete_inbound_cross_cluster_search_connectionAllows the destination domain owner to delete an existing inbound cross-cluster search connection.CrossClusterSearchConnectionId (string) required
elasticsearch_service/delete_outbound_cross_cluster_search_connectionAllows the source domain owner to delete an existing outbound cross-cluster search connection.CrossClusterSearchConnectionId (string) required
elasticsearch_service/delete_packageDelete the package.PackageID (string) required
elasticsearch_service/delete_vpc_endpointDeletes an Amazon OpenSearch Service-managed interface VPC endpoint.VpcEndpointId (string) required
elasticsearch_service/describe_domain_auto_tunesProvides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.DomainName (string) required
MaxResults (integer)
NextToken (string)
elasticsearch_service/describe_domain_change_progressReturns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.DomainName (string) required
ChangeId (string)
elasticsearch_service/describe_elasticsearch_domainReturns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.DomainName (string) required
elasticsearch_service/describe_elasticsearch_domain_configProvides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.DomainName (string) required
elasticsearch_service/describe_elasticsearch_domainsReturns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.DomainNames (array) required
elasticsearch_service/describe_elasticsearch_instance_type_limitsDescribe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.DomainName (string)
InstanceType (string) required
ElasticsearchVersion (string) required
elasticsearch_service/describe_inbound_cross_cluster_search_connectionsLists all the inbound cross-cluster search connections for a destination domain.Filters (array)
MaxResults (integer)
NextToken (string)
elasticsearch_service/describe_outbound_cross_cluster_search_connectionsLists all the outbound cross-cluster search connections for a source domain.Filters (array)
MaxResults (integer)
NextToken (string)
elasticsearch_service/describe_packagesDescribes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.Filters (array)
MaxResults (integer)
NextToken (string)
elasticsearch_service/describe_reserved_elasticsearch_instance_offeringsLists available reserved Elasticsearch instance offerings.ReservedElasticsearchInstanceOfferingId (string)
MaxResults (integer)
NextToken (string)
elasticsearch_service/describe_reserved_elasticsearch_instancesReturns information about reserved Elasticsearch instances for this account.ReservedElasticsearchInstanceId (string)
MaxResults (integer)
NextToken (string)
elasticsearch_service/describe_vpc_endpointsDescribes one or more Amazon OpenSearch Service-managed VPC endpoints.VpcEndpointIds (array) required
elasticsearch_service/dissociate_packageDissociates a package from the Amazon ES domain.PackageID (string) required
DomainName (string) required
elasticsearch_service/get_compatible_elasticsearch_versionsReturns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.DomainName (string)
elasticsearch_service/get_package_version_historyReturns a list of versions of the package, along with their creation time and commit message.PackageID (string) required
MaxResults (integer)
NextToken (string)
elasticsearch_service/get_upgrade_historyRetrieves the complete history of the last 10 upgrades that were performed on the domain.DomainName (string) required
MaxResults (integer)
NextToken (string)
elasticsearch_service/get_upgrade_statusRetrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.DomainName (string) required
elasticsearch_service/list_domain_namesReturns the name of all Elasticsearch domains owned by the current user's account.EngineType (string)
elasticsearch_service/list_domains_for_packageLists all Amazon ES domains associated with the package.PackageID (string) required
MaxResults (integer)
NextToken (string)
elasticsearch_service/list_elasticsearch_instance_typesList all Elasticsearch instance types that are supported for given ElasticsearchVersionElasticsearchVersion (string) required
DomainName (string)
MaxResults (integer)
NextToken (string)
elasticsearch_service/list_elasticsearch_versionsList all supported Elasticsearch versionsMaxResults (integer)
NextToken (string)
elasticsearch_service/list_packages_for_domainLists all packages associated with the Amazon ES domain.DomainName (string) required
MaxResults (integer)
NextToken (string)
elasticsearch_service/list_tagsReturns all tags for the given Elasticsearch domain.ARN (string) required
elasticsearch_service/list_vpc_endpoint_accessRetrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.DomainName (string) required
NextToken (string)
elasticsearch_service/list_vpc_endpointsRetrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.NextToken (string)
elasticsearch_service/list_vpc_endpoints_for_domainRetrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.DomainName (string) required
NextToken (string)
elasticsearch_service/purchase_reserved_elasticsearch_instance_offeringAllows you to purchase reserved Elasticsearch instances.ReservedElasticsearchInstanceOfferingId (string) required
ReservationName (string) required
InstanceCount (integer)
elasticsearch_service/reject_inbound_cross_cluster_search_connectionAllows the destination domain owner to reject an inbound cross-cluster search connection request.CrossClusterSearchConnectionId (string) required
elasticsearch_service/remove_tagsRemoves the specified set of tags from the specified Elasticsearch domain.ARN (string) required
TagKeys (array) required
elasticsearch_service/revoke_vpc_endpoint_accessRevokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.DomainName (string) required
Account (string) required
elasticsearch_service/start_elasticsearch_service_software_updateSchedules a service software update for an Amazon ES domain.DomainName (string) required
elasticsearch_service/update_elasticsearch_domain_configModifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.DomainName (string) required
ElasticsearchClusterConfig: {
. InstanceType (string)
. InstanceCount (integer)
. DedicatedMasterEnabled (boolean)
. ZoneAwarenessEnabled (boolean)
. ZoneAwarenessConfig (object)
. DedicatedMasterType (string)
. DedicatedMasterCount (integer)
. WarmEnabled (boolean)
. WarmType (string)
. WarmCount (integer)
. ColdStorageOptions (object)
} (object)
EBSOptions: {
. EBSEnabled (boolean)
. VolumeType (string)
. VolumeSize (integer)
. Iops (integer)
. Throughput (integer)
} (object)
SnapshotOptions: {
. AutomatedSnapshotStartHour (integer)
} (object)
VPCOptions: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object)
CognitoOptions: {
. Enabled (boolean)
. UserPoolId (string)
. IdentityPoolId (string)
. RoleArn (string)
} (object)
AdvancedOptions (object)
AccessPolicies (string)
LogPublishingOptions (object)
DomainEndpointOptions: {
. EnforceHTTPS (boolean)
. TLSSecurityPolicy (string)
. CustomEndpointEnabled (boolean)
. CustomEndpoint (string)
. CustomEndpointCertificateArn (string)
} (object)
AdvancedSecurityOptions: {
. Enabled (boolean)
. InternalUserDatabaseEnabled (boolean)
. MasterUserOptions (object)
. SAMLOptions (object)
. AnonymousAuthEnabled (boolean)
} (object)
NodeToNodeEncryptionOptions: {
. Enabled (boolean)
} (object)
EncryptionAtRestOptions: {
. Enabled (boolean)
. KmsKeyId (string)
} (object)
AutoTuneOptions: {
. DesiredState (string)
. RollbackOnDisable (string)
. MaintenanceSchedules (array)
} (object)
DryRun (boolean)
elasticsearch_service/update_packageUpdates a package for use with Amazon ES domains.PackageID (string) required
PackageSource: {
. S3BucketName (string)
. S3Key (string)
} (object) required
PackageDescription (string)
CommitMessage (string)
elasticsearch_service/update_vpc_endpointModifies an Amazon OpenSearch Service-managed interface VPC endpoint.VpcEndpointId (string) required
VpcOptions: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object) required
elasticsearch_service/upgrade_elasticsearch_domainAllows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.DomainName (string) required
TargetVersion (string) required
PerformCheckOnly (boolean)
emr_containers/cancel_job_runCancels 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.id (string) required
virtualClusterId (string) required
emr_containers/create_job_templateCreates a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.name (string) required
clientToken (string) required
jobTemplateData: {
. executionRoleArn (string)
. releaseLabel (string)
. configurationOverrides (object)
. jobDriver (object)
. parameterConfiguration (object)
. jobTags (object)
} (object) required
tags (object)
kmsKeyArn (string)
emr_containers/create_managed_endpointCreates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.name (string) required
virtualClusterId (string) required
type (string) required
releaseLabel (string) required
executionRoleArn (string) required
certificateArn (string)
configurationOverrides: {
. applicationConfiguration (array)
. monitoringConfiguration (object)
} (object)
clientToken (string) required
tags (object)
emr_containers/create_security_configurationCreates a security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.clientToken (string) required
name (string) required
containerProvider: {
. type (string)
. id (string)
. info
} (object)
securityConfigurationData: {
. authorizationConfiguration (object)
} (object) required
tags (object)
emr_containers/create_virtual_clusterCreates 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.name (string) required
containerProvider: {
. type (string)
. id (string)
. info
} (object) required
clientToken (string) required
tags (object)
securityConfigurationId (string)
emr_containers/delete_job_templateDeletes a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.id (string) required
emr_containers/delete_managed_endpointDeletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.id (string) required
virtualClusterId (string) required
emr_containers/delete_virtual_clusterDeletes 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.id (string) required
emr_containers/describe_job_runDisplays 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.id (string) required
virtualClusterId (string) required
emr_containers/describe_job_templateDisplays detailed information about a specified job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.id (string) required
emr_containers/describe_managed_endpointDisplays detailed information about a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.id (string) required
virtualClusterId (string) required
emr_containers/describe_security_configurationDisplays detailed information about a specified security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.id (string) required
emr_containers/describe_virtual_clusterDisplays 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.id (string) required
emr_containers/get_managed_endpoint_session_credentialsGenerate a session token to connect to a managed endpoint.endpointIdentifier (string) required
virtualClusterIdentifier (string) required
executionRoleArn (string) required
credentialType (string) required
durationInSeconds (integer)
logContext (string)
clientToken (string)
emr_containers/list_job_runsLists 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.virtualClusterId (string) required
createdBefore (string)
createdAfter (string)
name (string)
states (array)
maxResults (integer)
nextToken (string)
emr_containers/list_job_templatesLists job templates based on a set of parameters. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.createdAfter (string)
createdBefore (string)
maxResults (integer)
nextToken (string)
emr_containers/list_managed_endpointsLists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.virtualClusterId (string) required
createdBefore (string)
createdAfter (string)
types (array)
states (array)
maxResults (integer)
nextToken (string)
emr_containers/list_security_configurationsLists security configurations based on a set of parameters. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.createdAfter (string)
createdBefore (string)
maxResults (integer)
nextToken (string)
emr_containers/list_tags_for_resourceLists the tags assigned to the resources.resourceArn (string) required
emr_containers/list_virtual_clustersLists 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.containerProviderId (string)
containerProviderType (string)
createdAfter (string)
createdBefore (string)
states (array)
maxResults (integer)
nextToken (string)
eksAccessEntryIntegrated (boolean)
emr_containers/start_job_runStarts 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.name (string)
virtualClusterId (string) required
clientToken (string) required
executionRoleArn (string)
releaseLabel (string)
jobDriver: {
. sparkSubmitJobDriver (object)
. sparkSqlJobDriver (object)
} (object)
configurationOverrides: {
. applicationConfiguration (array)
. monitoringConfiguration (object)
} (object)
tags (object)
jobTemplateId (string)
jobTemplateParameters (object)
retryPolicyConfiguration: {
. maxAttempts (integer)
} (object)
emr_containers/tag_resourceAssigns tags to resources. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your Amazon Web Services 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 clusterresourceArn (string) required
tags (object) required
emr_containers/untag_resourceRemoves tags from resources.resourceArn (string) required
tagKeys (array) required
emr_serverless/list_tags_for_resourceLists the tags assigned to the resources.resourceArn (string) required
emr_serverless/tag_resourceAssigns tags to resources. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your Amazon Web Services 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.resourceArn (string) required
tags (object) required
emr_serverless/untag_resourceRemoves tags from resources.resourceArn (string) required
tagKeys (array) required
emr_serverless/start_applicationStarts a specified application and initializes initial capacity if configured.applicationId (string) required
emr_serverless/stop_applicationStops a specified application and releases initial capacity if configured. All scheduled and running jobs must be completed or cancelled before stopping an application.applicationId (string) required
emr_serverless/create_applicationCreates an application.name (string)
releaseLabel (string) required
type (string) required
clientToken (string) required
initialCapacity (object)
maximumCapacity: {
. cpu (string)
. memory (string)
. disk (string)
} (object)
tags (object)
autoStartConfiguration: {
. enabled (boolean)
} (object)
autoStopConfiguration: {
. enabled (boolean)
. idleTimeoutMinutes (integer)
} (object)
networkConfiguration: {
. subnetIds (array)
. securityGroupIds (array)
} (object)
architecture (string)
imageConfiguration: {
. imageUri (string)
} (object)
workerTypeSpecifications (object)
runtimeConfiguration (array)
monitoringConfiguration: {
. s3MonitoringConfiguration (object)
. managedPersistenceMonitoringConfiguration (object)
. cloudWatchLoggingConfiguration (object)
. prometheusMonitoringConfiguration (object)
} (object)
diskEncryptionConfiguration: {
. encryptionContext (object)
. encryptionKeyArn (string)
} (object)
interactiveConfiguration: {
. studioEnabled (boolean)
. livyEndpointEnabled (boolean)
} (object)
schedulerConfiguration: {
. queueTimeoutMinutes (integer)
. maxConcurrentRuns (integer)
} (object)
identityCenterConfiguration: {
. identityCenterInstanceArn (string)
. userBackgroundSessionsEnabled (boolean)
} (object)
jobLevelCostAllocationConfiguration: {
. enabled (boolean)
} (object)
emr_serverless/get_applicationDisplays detailed information about a specified application.applicationId (string) required
emr_serverless/update_applicationUpdates a specified application. An application has to be in a stopped or created state in order to be updated.applicationId (string) required
clientToken (string) required
initialCapacity (object)
maximumCapacity: {
. cpu (string)
. memory (string)
. disk (string)
} (object)
autoStartConfiguration: {
. enabled (boolean)
} (object)
autoStopConfiguration: {
. enabled (boolean)
. idleTimeoutMinutes (integer)
} (object)
networkConfiguration: {
. subnetIds (array)
. securityGroupIds (array)
} (object)
architecture (string)
imageConfiguration: {
. imageUri (string)
} (object)
workerTypeSpecifications (object)
interactiveConfiguration: {
. studioEnabled (boolean)
. livyEndpointEnabled (boolean)
} (object)
releaseLabel (string)
runtimeConfiguration (array)
monitoringConfiguration: {
. s3MonitoringConfiguration (object)
. managedPersistenceMonitoringConfiguration (object)
. cloudWatchLoggingConfiguration (object)
. prometheusMonitoringConfiguration (object)
} (object)
diskEncryptionConfiguration: {
. encryptionContext (object)
. encryptionKeyArn (string)
} (object)
schedulerConfiguration: {
. queueTimeoutMinutes (integer)
. maxConcurrentRuns (integer)
} (object)
identityCenterConfiguration: {
. identityCenterInstanceArn (string)
. userBackgroundSessionsEnabled (boolean)
} (object)
jobLevelCostAllocationConfiguration: {
. enabled (boolean)
} (object)
emr_serverless/delete_applicationDeletes an application. An application has to be in a stopped or created state in order to be deleted.applicationId (string) required
emr_serverless/list_applicationsLists applications based on a set of parameters.nextToken (string)
maxResults (integer)
states (array)
emr_serverless/get_dashboard_for_job_runCreates and returns a URL that you can use to access the application UIs for a job run. For jobs in a running state, the application UI is a live user interface such as the Spark or Tez web UI. For completed jobs, the application UI is a persistent application user interface such as the Spark History Server or persistent Tez UI. The URL is valid for one hour after you generate it. To access the application UI after that hour elapses, you must invoke the API again to generate a new URL.applicationId (string) required
jobRunId (string) required
attempt (integer)
accessSystemProfileLogs (boolean)
emr_serverless/list_job_run_attemptsLists all attempt of a job run.applicationId (string) required
jobRunId (string) required
nextToken (string)
maxResults (integer)
emr_serverless/start_job_runStarts a job run.applicationId (string) required
clientToken (string) required
executionRoleArn (string) required
executionIamPolicy: {
. policy (string)
. policyArns (array)
} (object)
jobDriver (undefined)
configurationOverrides: {
. applicationConfiguration (array)
. monitoringConfiguration (object)
. diskEncryptionConfiguration (object)
} (object)
tags (object)
executionTimeoutMinutes (integer)
name (string)
mode (string)
retryPolicy: {
. maxAttempts (integer)
. maxFailedAttemptsPerHour (integer)
} (object)
emr_serverless/get_job_runDisplays detailed information about a job run.applicationId (string) required
jobRunId (string) required
attempt (integer)
emr_serverless/cancel_job_runCancels a job run.applicationId (string) required
jobRunId (string) required
shutdownGracePeriodInSeconds (integer)
emr_serverless/list_job_runsLists job runs based on a set of parameters.applicationId (string) required
nextToken (string)
maxResults (integer)
createdAtAfter (string)
createdAtBefore (string)
states (array)
mode (string)
emr/add_instance_fleetAdds an instance fleet to a running cluster. The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x.ClusterId (string) required
InstanceFleet: {
. Name (string)
. InstanceFleetType (string)
. TargetOnDemandCapacity (integer)
. TargetSpotCapacity (integer)
. InstanceTypeConfigs (array)
. LaunchSpecifications (object)
. ResizeSpecifications (object)
. Context (string)
} (object) required
emr/add_instance_groupsAdds one or more instance groups to a running cluster.InstanceGroups (array) required
JobFlowId (string) required
emr/add_job_flow_stepsAddJobFlowSteps 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. A step specifies the location of a JAR file stored eithJobFlowId (string) required
Steps (array) required
ExecutionRoleArn (string)
emr/add_tagsAdds 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.ResourceId (string) required
Tags (array) required
emr/cancel_stepsCancels 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 releases 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 onlyClusterId (string) required
StepIds (array) required
StepCancellationOption (string)
emr/create_persistent_app_uiCreates a persistent application user interface.TargetResourceArn (string) required
EMRContainersConfig: {
. JobRunId (string)
} (object)
Tags (array)
XReferer (string)
ProfilerType (string)
emr/create_security_configurationCreates a security configuration, which is stored in the service and can be specified when a cluster is created.Name (string) required
SecurityConfiguration (string) required
emr/create_studioCreates a new Amazon EMR Studio.Name (string) required
Description (string)
AuthMode (string) required
VpcId (string) required
SubnetIds (array) required
ServiceRole (string) required
UserRole (string)
WorkspaceSecurityGroupId (string) required
EngineSecurityGroupId (string) required
DefaultS3Location (string) required
IdpAuthUrl (string)
IdpRelayStateParameterName (string)
Tags (array)
TrustedIdentityPropagationEnabled (boolean)
IdcUserAssignment (string)
IdcInstanceArn (string)
EncryptionKeyArn (string)
emr/create_studio_session_mappingMaps 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 IAM Identity Center 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.StudioId (string) required
IdentityId (string)
IdentityName (string)
IdentityType (string) required
SessionPolicyArn (string) required
emr/delete_security_configurationDeletes a security configuration.Name (string) required
emr/delete_studioRemoves an Amazon EMR Studio from the Studio metadata store.StudioId (string) required
emr/delete_studio_session_mappingRemoves a user or group from an Amazon EMR Studio.StudioId (string) required
IdentityId (string)
IdentityName (string)
IdentityType (string) required
emr/describe_clusterProvides cluster-level details including status, hardware and software configuration, VPC settings, and so on.ClusterId (string) required
emr/describe_job_flowsThis 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 parameCreatedAfter (string)
CreatedBefore (string)
JobFlowIds (array)
JobFlowStates (array)
emr/describe_notebook_executionProvides details of a notebook execution.NotebookExecutionId (string) required
emr/describe_persistent_app_uiDescribes a persistent application user interface.PersistentAppUIId (string) required
emr/describe_release_labelProvides Amazon EMR release label details, such as the releases available the Region where the API request is run, and the available applications for a specific Amazon EMR release label. Can also list Amazon EMR releases that support a specified version of Spark.ReleaseLabel (string)
NextToken (string)
MaxResults (integer)
emr/describe_security_configurationProvides the details of a security configuration by returning the configuration JSON.Name (string) required
emr/describe_stepProvides more detail about the cluster step.ClusterId (string) required
StepId (string) required
emr/describe_studioReturns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.StudioId (string) required
emr/get_auto_termination_policyReturns the auto-termination policy for an Amazon EMR cluster.ClusterId (string) required
emr/get_block_public_access_configurationReturns 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.No parameters
emr/get_cluster_session_credentialsProvides temporary, HTTP basic credentials that are associated with a given runtime IAM role and used by a cluster with fine-grained access control activated. You can use these credentials to connect to cluster endpoints that support username and password authentication.ClusterId (string) required
ExecutionRoleArn (string)
emr/get_managed_scaling_policyFetches the attached managed scaling policy for an Amazon EMR cluster.ClusterId (string) required
emr/get_on_cluster_app_uipresigned_urlThe presigned URL properties for the cluster's application user interface.ClusterId (string) required
OnClusterAppUIType (string)
ApplicationId (string)
DryRun (boolean)
ExecutionRoleArn (string)
emr/get_persistent_app_uipresigned_urlThe presigned URL properties for the cluster's application user interface.PersistentAppUIId (string) required
PersistentAppUIType (string)
ApplicationId (string)
AuthProxyCall (boolean)
ExecutionRoleArn (string)
emr/get_studio_session_mappingFetches mapping details for the specified Amazon EMR Studio and identity user or group.StudioId (string) required
IdentityId (string)
IdentityName (string)
IdentityType (string) required
emr/list_bootstrap_actionsProvides information about the bootstrap actions associated with a cluster.ClusterId (string) required
Marker (string)
emr/list_clustersProvides 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.CreatedAfter (string)
CreatedBefore (string)
ClusterStates (array)
Marker (string)
emr/list_instance_fleetsLists all available details about the instance fleets in a cluster. The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.ClusterId (string) required
Marker (string)
emr/list_instance_groupsProvides all available details about the instance groups in a cluster.ClusterId (string) required
Marker (string)
emr/list_instancesProvides information for all active Amazon EC2 instances and Amazon EC2 instances terminated in the last 30 days, up to a maximum of 2,000. Amazon EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.ClusterId (string) required
InstanceGroupId (string)
InstanceGroupTypes (array)
InstanceFleetId (string)
InstanceFleetType (string)
InstanceStates (array)
Marker (string)
emr/list_notebook_executionsProvides 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 ListNotebookExecutions calls.EditorId (string)
Status (string)
From (string)
To (string)
Marker (string)
ExecutionEngineId (string)
emr/list_release_labelsRetrieves release labels of Amazon EMR services in the Region where the API is called.Filters: {
. Prefix (string)
. Application (string)
} (object)
NextToken (string)
MaxResults (integer)
emr/list_security_configurationsLists 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.Marker (string)
emr/list_stepsProvides 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.ClusterId (string) required
StepStates (array)
StepIds (array)
Marker (string)
emr/list_studiosReturns 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.Marker (string)
emr/list_studio_session_mappingsReturns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId.StudioId (string)
IdentityType (string)
Marker (string)
emr/list_supported_instance_typesA list of the instance types that Amazon EMR supports. You can filter the list by Amazon Web Services Region and Amazon EMR release.ReleaseLabel (string) required
Marker (string)
emr/modify_clusterModifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.ClusterId (string) required
StepConcurrencyLevel (integer)
ExtendedSupport (boolean)
emr/modify_instance_fleetModifies 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 releases 4.8.0 and later, excluding 5.0.x versions.ClusterId (string) required
InstanceFleet: {
. InstanceFleetId (string)
. TargetOnDemandCapacity (integer)
. TargetSpotCapacity (integer)
. ResizeSpecifications (object)
. InstanceTypeConfigs (array)
. Context (string)
} (object) required
emr/modify_instance_groupsModifyInstanceGroups 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.ClusterId (string)
InstanceGroups (array)
emr/put_auto_scaling_policyCreates 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 Amazon EC2 instances in response to the value of a CloudWatch metric.ClusterId (string) required
InstanceGroupId (string) required
AutoScalingPolicy: {
. Constraints (object)
. Rules (array)
} (object) required
emr/put_auto_termination_policyAuto-termination is supported in Amazon EMR releases 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.ClusterId (string) required
AutoTerminationPolicy: {
. IdleTimeout (integer)
} (object)
emr/put_block_public_access_configurationCreates 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.BlockPublicAccessConfiguration: {
. BlockPublicSecurityGroupRules (boolean)
. PermittedPublicSecurityGroupRuleRanges (array)
. Classification (string)
. Configurations (array)
. Properties (object)
} (object) required
emr/put_managed_scaling_policyCreates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policy defines the limits for resources, such as Amazon 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.ClusterId (string) required
ManagedScalingPolicy: {
. ComputeLimits (object)
. UtilizationPerformanceIndex (integer)
. ScalingStrategy (string)
} (object) required
emr/remove_auto_scaling_policyRemoves an automatic scaling policy from a specified instance group within an Amazon EMR cluster.ClusterId (string) required
InstanceGroupId (string) required
emr/remove_auto_termination_policyRemoves an auto-termination policy from an Amazon EMR cluster.ClusterId (string) required
emr/remove_managed_scaling_policyRemoves a managed scaling policy from a specified Amazon EMR cluster.ClusterId (string) required
emr/remove_tagsRemoves 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:ResourceId (string) required
TagKeys (array) required
emr/run_job_flowRunJobFlow 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 thName (string) required
LogUri (string)
LogEncryptionKmsKeyId (string)
AdditionalInfo (string)
AmiVersion (string)
ReleaseLabel (string)
Instances: {
. MasterInstanceType (string)
. SlaveInstanceType (string)
. InstanceCount (integer)
. InstanceGroups (array)
. InstanceFleets (array)
. Ec2KeyName (string)
. Placement (object)
. KeepJobFlowAliveWhenNoSteps (boolean)
. TerminationProtected (boolean)
. UnhealthyNodeReplacement (boolean)
. HadoopVersion (string)
. Ec2SubnetId (string)
. Ec2SubnetIds (array)
. EmrManagedMasterSecurityGroup (string)
. EmrManagedSlaveSecurityGroup (string)
. ServiceAccessSecurityGroup (string)
. AdditionalMasterSecurityGroups (array)
. AdditionalSlaveSecurityGroups (array)
} (object) required
Steps (array)
BootstrapActions (array)
SupportedProducts (array)
NewSupportedProducts (array)
Applications (array)
Configurations (array)
VisibleToAllUsers (boolean)
JobFlowRole (string)
ServiceRole (string)
Tags (array)
SecurityConfiguration (string)
AutoScalingRole (string)
ScaleDownBehavior (string)
CustomAmiId (string)
EbsRootVolumeSize (integer)
RepoUpgradeOnBoot (string)
KerberosAttributes: {
. Realm (string)
. KdcAdminPassword (string)
. CrossRealmTrustPrincipalPassword (string)
. ADDomainJoinUser (string)
. ADDomainJoinPassword (string)
} (object)
StepConcurrencyLevel (integer)
ManagedScalingPolicy: {
. ComputeLimits (object)
. UtilizationPerformanceIndex (integer)
. ScalingStrategy (string)
} (object)
PlacementGroupConfigs (array)
AutoTerminationPolicy: {
. IdleTimeout (integer)
} (object)
OSReleaseLabel (string)
EbsRootVolumeIops (integer)
EbsRootVolumeThroughput (integer)
ExtendedSupport (boolean)
MonitoringConfiguration: {
. CloudWatchLogConfiguration (object)
} (object)
emr/set_keep_job_flow_alive_when_no_stepsYou can use the SetKeepJobFlowAliveWhenNoSteps to configure a cluster job flow to terminate after the step execution, i.e., all your steps are executed. If you want a transient cluster that shuts down after the last of the current executing steps are completed, you can configure SetKeepJobFlowAliveWhenNoSteps to false. If you want a long running cluster, configure SetKeepJobFlowAliveWhenNoSteps to true. For more information, see Managing Cluster Termination in the Amazon EMR Management Guide.JobFlowIds (array) required
KeepJobFlowAliveWhenNoSteps (boolean) required
emr/set_termination_protectionSetTerminationProtection locks a cluster job flow so the Amazon 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 Amazon EC2 instances in a cluster. SetTerminationProtection is used to prevent accidental termination of a cluster and to ensJobFlowIds (array) required
TerminationProtected (boolean) required
emr/set_unhealthy_node_replacementSpecify whether to enable unhealthy node replacement, which lets Amazon EMR gracefully replace core nodes on a cluster if any nodes become unhealthy. For example, a node becomes unhealthy if disk usage is above 90%. If unhealthy node replacement is on and TerminationProtected are off, Amazon EMR immediately terminates the unhealthy core nodes. To use unhealthy node replacement and retain unhealthy core nodes, use to turn on termination protection. In such cases, Amazon EMR adds the unhealthy nodJobFlowIds (array) required
UnhealthyNodeReplacement (boolean) required
emr/set_visible_to_all_usersThe 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 Amazon EMR. Sets the Cluster$VisibleToAllUsers value for an Amazon EMR cluster. When true, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web ServicJobFlowIds (array) required
VisibleToAllUsers (boolean) required
emr/start_notebook_executionStarts a notebook execution.EditorId (string)
RelativePath (string)
NotebookExecutionName (string)
NotebookParams (string)
ExecutionEngine: {
. Id (string)
. Type (string)
. MasterInstanceSecurityGroupId (string)
. ExecutionRoleArn (string)
} (object) required
ServiceRole (string) required
NotebookInstanceSecurityGroupId (string)
Tags (array)
NotebookS3Location: {
. Bucket (string)
. Key (string)
} (object)
OutputNotebookS3Location: {
. Bucket (string)
. Key (string)
} (object)
OutputNotebookFormat (string)
EnvironmentVariables (object)
emr/stop_notebook_executionStops a notebook execution.NotebookExecutionId (string) required
emr/terminate_job_flowsTerminateJobFlows shuts a list of clusters job flows down. When a job flow is shut down, any step not yet completed is canceled and the Amazon 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 clusteJobFlowIds (array) required
emr/update_studioUpdates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.StudioId (string) required
Name (string)
Description (string)
SubnetIds (array)
DefaultS3Location (string)
EncryptionKeyArn (string)
emr/update_studio_session_mappingUpdates the session policy attached to the user or group for the specified Amazon EMR Studio.StudioId (string) required
IdentityId (string)
IdentityName (string)
IdentityType (string) required
SessionPolicyArn (string) required
entityresolution/add_policy_statementAdds a policy statement object. To retrieve a list of existing policy statements, use the GetPolicy API.arn (string) required
statementId (string) required
effect (string) required
action (array) required
principal (array) required
condition (string)
entityresolution/batch_delete_unique_idDeletes multiple unique IDs in a matching workflow.workflowName (string) required
inputSource (string)
uniqueIds (array) required
entityresolution/create_id_mapping_workflowCreates an IdMappingWorkflow object which stores the configuration of the data processing job to be run. Each IdMappingWorkflow must have a unique workflow name. To modify an existing workflow, use the UpdateIdMappingWorkflow API. Incremental processing is not supported for ID mapping workflows.workflowName (string) required
description (string)
inputSourceConfig (array) required
outputSourceConfig (array)
idMappingTechniques: {
. idMappingType (string)
. ruleBasedProperties (object)
. providerProperties (object)
} (object) required
incrementalRunConfig: {
. incrementalRunType (string)
} (object)
roleArn (string)
tags (object)
entityresolution/create_id_namespaceCreates an ID namespace object which will help customers provide metadata explaining their dataset and how to use it. Each ID namespace must have a unique name. To modify an existing ID namespace, use the UpdateIdNamespace API.idNamespaceName (string) required
description (string)
inputSourceConfig (array)
idMappingWorkflowProperties (array)
type (string) required
roleArn (string)
tags (object)
entityresolution/create_matching_workflowCreates a matching workflow that defines the configuration for a data processing job. The workflow name must be unique. To modify an existing workflow, use UpdateMatchingWorkflow. For workflows where resolutionType is ML_MATCHING or PROVIDER, incremental processing is not supported.workflowName (string) required
description (string)
inputSourceConfig (array) required
outputSourceConfig (array) required
resolutionTechniques: {
. resolutionType (string)
. ruleBasedProperties (object)
. ruleConditionProperties (object)
. providerProperties (object)
} (object) required
incrementalRunConfig: {
. incrementalRunType (string)
} (object)
roleArn (string) required
tags (object)
entityresolution/create_schema_mappingCreates a schema mapping, which defines the schema of the input customer records table. The SchemaMapping also provides Entity Resolution with some metadata about the table, such as the attribute types of the columns and which columns to match on.schemaName (string) required
description (string)
mappedInputFields (array) required
tags (object)
entityresolution/delete_id_mapping_workflowDeletes the IdMappingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.workflowName (string) required
entityresolution/delete_id_namespaceDeletes the IdNamespace with a given name.idNamespaceName (string) required
entityresolution/delete_matching_workflowDeletes the MatchingWorkflow with a given name. This operation will succeed even if a workflow with the given name does not exist.workflowName (string) required
entityresolution/delete_policy_statementDeletes the policy statement.arn (string) required
statementId (string) required
entityresolution/delete_schema_mappingDeletes the SchemaMapping with a given name. This operation will succeed even if a schema with the given name does not exist. This operation will fail if there is a MatchingWorkflow object that references the SchemaMapping in the workflow's InputSourceConfig.schemaName (string) required
entityresolution/generate_match_idGenerates or retrieves Match IDs for records using a rule-based matching workflow. When you call this operation, it processes your records against the workflow's matching rules to identify potential matches. For existing records, it retrieves their Match IDs and associated rules. For records without matches, it generates new Match IDs. The operation saves results to Amazon S3. The processing type processingType you choose affects both the accuracy and response time of the operation. Additional cworkflowName (string) required
records (array) required
processingType (string)
entityresolution/get_id_mapping_jobReturns the status, metrics, and errors if there are any that are associated with a job.workflowName (string) required
jobId (string) required
entityresolution/get_id_mapping_workflowReturns the IdMappingWorkflow with a given name, if it exists.workflowName (string) required
entityresolution/get_id_namespaceReturns the IdNamespace with a given name, if it exists.idNamespaceName (string) required
entityresolution/get_match_idReturns the corresponding Match ID of a customer record if the record has been processed in a rule-based matching workflow. You can call this API as a dry run of an incremental load on the rule-based matching workflow.workflowName (string) required
record (object) required
applyNormalization (boolean)
entityresolution/get_matching_jobReturns the status, metrics, and errors if there are any that are associated with a job.workflowName (string) required
jobId (string) required
entityresolution/get_matching_workflowReturns the MatchingWorkflow with a given name, if it exists.workflowName (string) required
entityresolution/get_policyReturns the resource-based policy.arn (string) required
entityresolution/get_provider_serviceReturns the ProviderService of a given name.providerName (string) required
providerServiceName (string) required
entityresolution/get_schema_mappingReturns the SchemaMapping of a given name.schemaName (string) required
entityresolution/list_id_mapping_jobsLists all ID mapping jobs for a given workflow.workflowName (string) required
nextToken (string)
maxResults (integer)
entityresolution/list_id_mapping_workflowsReturns a list of all the IdMappingWorkflows that have been created for an Amazon Web Services account.nextToken (string)
maxResults (integer)
entityresolution/list_id_namespacesReturns a list of all ID namespaces.nextToken (string)
maxResults (integer)
entityresolution/list_matching_jobsLists all jobs for a given workflow.workflowName (string) required
nextToken (string)
maxResults (integer)
entityresolution/list_matching_workflowsReturns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.nextToken (string)
maxResults (integer)
entityresolution/list_provider_servicesReturns a list of all the ProviderServices that are available in this Amazon Web Services Region.nextToken (string)
maxResults (integer)
providerName (string)
entityresolution/list_schema_mappingsReturns a list of all the SchemaMappings that have been created for an Amazon Web Services account.nextToken (string)
maxResults (integer)
entityresolution/list_tags_for_resourceDisplays the tags associated with an Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.resourceArn (string) required
entityresolution/put_policyUpdates the resource-based policy.arn (string) required
token (string)
policy (string) required
entityresolution/start_id_mapping_jobStarts the IdMappingJob of a workflow. The workflow must have previously been created using the CreateIdMappingWorkflow endpoint.workflowName (string) required
outputSourceConfig (array)
jobType (string)
entityresolution/start_matching_jobStarts the MatchingJob of a workflow. The workflow must have previously been created using the CreateMatchingWorkflow endpoint.workflowName (string) required
entityresolution/tag_resourceAssigns one or more tags key-value pairs to the specified Entity Resolution 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 Entity Resolution, SchemaMapping and MatchingWorkflow 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 actresourceArn (string) required
tags (object) required
entityresolution/untag_resourceRemoves one or more tags from the specified Entity Resolution resource. In Entity Resolution, SchemaMapping, and MatchingWorkflow can be tagged.resourceArn (string) required
tagKeys (array) required
entityresolution/update_id_mapping_workflowUpdates an existing IdMappingWorkflow. This method is identical to CreateIdMappingWorkflow, except it uses an HTTP PUT request instead of a POST request, and the IdMappingWorkflow must already exist for the method to succeed. Incremental processing is not supported for ID mapping workflows.workflowName (string) required
description (string)
inputSourceConfig (array) required
outputSourceConfig (array)
idMappingTechniques: {
. idMappingType (string)
. ruleBasedProperties (object)
. providerProperties (object)
} (object) required
incrementalRunConfig: {
. incrementalRunType (string)
} (object)
roleArn (string)
entityresolution/update_id_namespaceUpdates an existing ID namespace.idNamespaceName (string) required
description (string)
inputSourceConfig (array)
idMappingWorkflowProperties (array)
roleArn (string)
entityresolution/update_matching_workflowUpdates an existing matching workflow. The workflow must already exist for this operation to succeed. For workflows where resolutionType is ML_MATCHING or PROVIDER, incremental processing is not supported.workflowName (string) required
description (string)
inputSourceConfig (array) required
outputSourceConfig (array) required
resolutionTechniques: {
. resolutionType (string)
. ruleBasedProperties (object)
. ruleConditionProperties (object)
. providerProperties (object)
} (object) required
incrementalRunConfig: {
. incrementalRunType (string)
} (object)
roleArn (string) required
entityresolution/update_schema_mappingUpdates a schema mapping. A schema is immutable if it is being used by a workflow. Therefore, you can't update a schema mapping if it's associated with a workflow.schemaName (string) required
description (string)
mappedInputFields (array) required
eventbridge/activate_event_sourceActivates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.Name (string) required
eventbridge/cancel_replayCancels the specified replay.ReplayName (string) required
eventbridge/create_api_destinationCreates an API destination, which is an HTTP invocation endpoint configured as a target for events. API destinations do not support private destinations, such as interface VPC endpoints. For more information, see API destinations in the EventBridge User Guide.Name (string) required
Description (string)
ConnectionArn (string) required
InvocationEndpoint (string) required
HttpMethod (string) required
InvocationRateLimitPerSecond (integer)
eventbridge/create_archiveCreates 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. If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we stronglArchiveName (string) required
EventSourceArn (string) required
Description (string)
EventPattern (string)
RetentionDays (integer)
KmsKeyIdentifier (string)
eventbridge/create_connectionCreates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint. For more information, see Connections for endpoint targets in the Amazon EventBridge User Guide.Name (string) required
Description (string)
AuthorizationType (string) required
AuthParameters: {
. BasicAuthParameters (object)
. OAuthParameters (object)
. ApiKeyAuthParameters (object)
. InvocationHttpParameters (object)
. ConnectivityParameters (object)
} (object) required
InvocationConnectivityParameters: {
. ResourceParameters (object)
} (object)
KmsKeyIdentifier (string)
eventbridge/create_endpointCreates 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.Name (string) required
Description (string)
RoutingConfig: {
. FailoverConfig (object)
} (object) required
ReplicationConfig: {
. State (string)
} (object)
EventBuses (array) required
RoleArn (string)
eventbridge/create_event_busCreates 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.Name (string) required
EventSourceName (string)
Description (string)
KmsKeyIdentifier (string)
DeadLetterConfig: {
. Arn (string)
} (object)
LogConfig: {
. IncludeDetail (string)
. Level (string)
} (object)
Tags (array)
eventbridge/create_partner_event_sourceCalled 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 applicName (string) required
Account (string) required
eventbridge/deactivate_event_sourceYou 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.Name (string) required
eventbridge/deauthorize_connectionRemoves 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.Name (string) required
eventbridge/delete_api_destinationDeletes the specified API destination.Name (string) required
eventbridge/delete_archiveDeletes the specified archive.ArchiveName (string) required
eventbridge/delete_connectionDeletes a connection.Name (string) required
eventbridge/delete_endpointDelete 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 .Name (string) required
eventbridge/delete_event_busDeletes 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.Name (string) required
eventbridge/delete_partner_event_sourceThis 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.Name (string) required
Account (string) required
eventbridge/delete_ruleDeletes 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 WebName (string) required
EventBusName (string)
Force (boolean)
eventbridge/describe_api_destinationRetrieves details about an API destination.Name (string) required
eventbridge/describe_archiveRetrieves details about an archive.ArchiveName (string) required
eventbridge/describe_connectionRetrieves details about a connection.Name (string) required
eventbridge/describe_endpointGet 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 .Name (string) required
HomeRegion (string)
eventbridge/describe_event_busDisplays 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.Name (string)
eventbridge/describe_event_sourceThis operation lists details about a partner event source that is shared with your account.Name (string) required
eventbridge/describe_partner_event_sourceAn 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.Name (string) required
eventbridge/describe_replayRetrieves 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 progreReplayName (string) required
eventbridge/describe_ruleDescribes the specified rule. DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.Name (string) required
EventBusName (string)
eventbridge/disable_ruleDisables 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.Name (string) required
EventBusName (string)
eventbridge/enable_ruleEnables 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.Name (string) required
EventBusName (string)
eventbridge/list_api_destinationsRetrieves a list of API destination in the account in the current Region.NamePrefix (string)
ConnectionArn (string)
NextToken (string)
Limit (integer)
eventbridge/list_archivesLists 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.NamePrefix (string)
EventSourceArn (string)
State (string)
NextToken (string)
Limit (integer)
eventbridge/list_connectionsRetrieves a list of connections from the account.NamePrefix (string)
ConnectionState (string)
NextToken (string)
Limit (integer)
eventbridge/list_endpointsList 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 .NamePrefix (string)
HomeRegion (string)
NextToken (string)
MaxResults (integer)
eventbridge/list_event_busesLists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.NamePrefix (string)
NextToken (string)
Limit (integer)
eventbridge/list_event_sourcesYou 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.NamePrefix (string)
NextToken (string)
Limit (integer)
eventbridge/list_partner_event_source_accountsAn 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.EventSourceName (string) required
NextToken (string)
Limit (integer)
eventbridge/list_partner_event_sourcesAn 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.NamePrefix (string) required
NextToken (string)
Limit (integer)
eventbridge/list_replaysLists 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.NamePrefix (string)
State (string)
EventSourceArn (string)
NextToken (string)
Limit (integer)
eventbridge/list_rule_names_by_targetLists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account. The maximum number of results per page for requests is 100.TargetArn (string) required
EventBusName (string)
NextToken (string)
Limit (integer)
eventbridge/list_rulesLists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names. The maximum number of results per page for requests is 100. ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.NamePrefix (string)
EventBusName (string)
NextToken (string)
Limit (integer)
eventbridge/list_tags_for_resourceDisplays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.ResourceARN (string) required
eventbridge/list_targets_by_ruleLists the targets assigned to the specified rule. The maximum number of results per page for requests is 100.Rule (string) required
EventBusName (string)
NextToken (string)
Limit (integer)
eventbridge/put_eventsSends custom events to Amazon EventBridge so that they can be matched to rules. You can batch multiple event entries into one request for efficiency. However, the total entry size must be less than 256KB. You can calculate the entry size before you send the events. For more information, see Calculating PutEvents event entry size in the Amazon EventBridge User Guide . PutEvents accepts the data in JSON format. For the JSON number integer data type, the constraints are: a minimum value of -9,223,3Entries (array) required
EndpointId (string)
eventbridge/put_partner_eventsThis is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation. For information on calculating event batch size, see Calculating EventBridge PutEvents event entry size in the EventBridge User Guide.Entries (array) required
eventbridge/put_permissionRunning PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge 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 PutPeEventBusName (string)
Action (string)
Principal (string)
StatementId (string)
Condition: {
. Type (string)
. Key (string)
. Value (string)
} (object)
Policy (string)
eventbridge/put_ruleCreates 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 orName (string) required
ScheduleExpression (string)
EventPattern (string)
State (string)
Description (string)
RoleArn (string)
Tags (array)
EventBusName (string)
eventbridge/put_targetsAdds 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. The maximum number of entries per request is 10. Each rule can have up to five 5 targets associated with it at one time. For a list of services you can configure as targets for events, see EventBridge targets in the Amazon EventBridge User Guide . Creating rules with built-in targets is supported only in the AmRule (string) required
EventBusName (string)
Targets (array) required
eventbridge/remove_permissionRevokes 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.StatementId (string)
RemoveAllPermissions (boolean)
EventBusName (string)
eventbridge/remove_targetsRemoves 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 targets 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 areRule (string) required
EventBusName (string)
Ids (array) required
Force (boolean)
eventbridge/start_replayStarts 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 theReplayName (string) required
Description (string)
EventSourceArn (string) required
EventStartTime (string) required
EventEndTime (string) required
Destination: {
. Arn (string)
. FilterArns (array)
} (object) required
eventbridge/tag_resourceAssigns 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 thatResourceARN (string) required
Tags (array) required
eventbridge/test_event_patternTests 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.EventPattern (string) required
Event (string) required
eventbridge/untag_resourceRemoves one or more tags from the specified EventBridge resource. In Amazon EventBridge, rules and event buses can be tagged.ResourceARN (string) required
TagKeys (array) required
eventbridge/update_api_destinationUpdates an API destination.Name (string) required
Description (string)
ConnectionArn (string)
InvocationEndpoint (string)
HttpMethod (string)
InvocationRateLimitPerSecond (integer)
eventbridge/update_archiveUpdates the specified archive.ArchiveName (string) required
Description (string)
EventPattern (string)
RetentionDays (integer)
KmsKeyIdentifier (string)
eventbridge/update_connectionUpdates settings for a connection.Name (string) required
Description (string)
AuthorizationType (string)
AuthParameters: {
. BasicAuthParameters (object)
. OAuthParameters (object)
. ApiKeyAuthParameters (object)
. InvocationHttpParameters (object)
. ConnectivityParameters (object)
} (object)
InvocationConnectivityParameters: {
. ResourceParameters (object)
} (object)
KmsKeyIdentifier (string)
eventbridge/update_endpointUpdate 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 .Name (string) required
Description (string)
RoutingConfig: {
. FailoverConfig (object)
} (object)
ReplicationConfig: {
. State (string)
} (object)
EventBuses (array)
RoleArn (string)
eventbridge/update_event_busUpdates the specified event bus.Name (string)
KmsKeyIdentifier (string)
Description (string)
DeadLetterConfig: {
. Arn (string)
} (object)
LogConfig: {
. IncludeDetail (string)
. Level (string)
} (object)
evs/get_versionsReturns information about VCF versions, ESX versions and EC2 instance types provided by Amazon EVS. For each VCF version, the response also includes the default ESX version and provided EC2 instance types.No parameters
evs/list_tags_for_resourceLists the tags for an Amazon EVS resource.resourceArn (string) required
evs/tag_resourceAssociates the specified tags to an Amazon EVS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EVS resources don't propagate to any other resources associated with the environment. For example, if you tag an environment with this operation, that tag doesn't automatically propagate to the VLANresourceArn (string) required
tags (object) required
evs/untag_resourceDeletes specified tags from an Amazon EVS resource.resourceArn (string) required
tagKeys (array) required
evs/associate_eip_to_vlanAssociates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.clientToken (string)
environmentId (string) required
vlanName (string) required
allocationId (string) required
evs/create_environment_hostCreates an ESX host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment. This action can only be used after the Amazon EVS environment is deployed. You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESX host creation. You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into. If you don't specify an ESX version when adding hosts using CreateEnvironmentHost actioclientToken (string)
environmentId (string) required
host: {
. hostName (string)
. keyName (string)
. instanceType (string)
. placementGroupId (string)
. dedicatedHostId (string)
} (object) required
esxVersion (string)
evs/delete_environment_hostDeletes a host from an Amazon EVS environment. Before deleting a host, you must unassign and decommission the host from within the SDDC Manager user interface. Not doing so could impact the availability of your virtual machines or result in data loss.clientToken (string)
environmentId (string) required
hostName (string) required
evs/disassociate_eip_from_vlanDisassociates an Elastic IP address from a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.clientToken (string)
environmentId (string) required
vlanName (string) required
associationId (string) required
evs/list_environment_hostsList the hosts within an environment.nextToken (string)
maxResults (integer)
environmentId (string) required
evs/list_environment_vlansLists environment VLANs that are associated with the specified environment.nextToken (string)
maxResults (integer)
environmentId (string) required
evs/create_environmentCreates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server. During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF. It can take several hours to create an environment. After the deployment completes, you can configure VCF in the vSphere user interface according to your needs. When creating a new environment, the default ESX version for the selecteclientToken (string)
environmentName (string)
kmsKeyId (string)
tags (object)
serviceAccessSecurityGroups: {
. securityGroups (array)
} (object)
vpcId (string) required
serviceAccessSubnetId (string) required
vcfVersion (string) required
termsAccepted (boolean) required
licenseInfo (array) required
initialVlans: {
. vmkManagement (object)
. vmManagement (object)
. vMotion (object)
. vSan (object)
. vTep (object)
. edgeVTep (object)
. nsxUplink (object)
. hcx (object)
. expansionVlan1 (object)
. expansionVlan2 (object)
. isHcxPublic (boolean)
. hcxNetworkAclId (string)
} (object) required
hosts (array) required
connectivityInfo: {
. privateRouteServerPeerings (array)
} (object) required
vcfHostnames: {
. vCenter (string)
. nsx (string)
. nsxManager1 (string)
. nsxManager2 (string)
. nsxManager3 (string)
. nsxEdge1 (string)
. nsxEdge2 (string)
. sddcManager (string)
. cloudBuilder (string)
} (object) required
siteId (string) required
evs/get_environmentReturns a description of the specified environment.environmentId (string) required
evs/delete_environmentDeletes an Amazon EVS environment. Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the DeleteEnvironmentHost action. Environment deletion also deletes the associated Amazon EVS VLAN subnets and Amazon Web Services Secrets Manager secrets that Amazon EVS created. Amazon Web Services resources that you create are not deleted. These resources may continue to incur costs.clientToken (string)
environmentId (string) required
evs/list_environmentsLists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.nextToken (string)
maxResults (integer)
state (array)
finspace_data/associate_user_to_permission_groupAdds a user to a permission group to grant permissions for actions a user can perform in FinSpace.permissionGroupId (string) required
userId (string) required
clientToken (string)
finspace_data/create_changesetCreates a new Changeset in a FinSpace Dataset.clientToken (string)
datasetId (string) required
changeType (string) required
sourceParams (object) required
formatParams (object) required
finspace_data/create_datasetCreates a new FinSpace Dataset.clientToken (string)
datasetTitle (string) required
kind (string) required
datasetDescription (string)
ownerInfo: {
. name (string)
. phoneNumber (string)
. email (string)
} (object)
permissionGroupParams: {
. permissionGroupId (string)
. datasetPermissions (array)
} (object) required
alias (string)
schemaDefinition: {
. tabularSchemaConfig (object)
} (object)
finspace_data/create_data_viewCreates a Dataview for a Dataset.clientToken (string)
datasetId (string) required
autoUpdate (boolean)
sortColumns (array)
partitionColumns (array)
asOfTimestamp (integer)
destinationTypeParams: {
. destinationType (string)
. s3DestinationExportFileFormat (string)
. s3DestinationExportFileFormatOptions (object)
} (object) required
finspace_data/create_permission_groupCreates a group of permissions for various actions that a user can perform in FinSpace.name (string) required
description (string)
applicationPermissions (array) required
clientToken (string)
finspace_data/create_userCreates a new user in FinSpace.emailAddress (string) required
type (string) required
firstName (string)
lastName (string)
apiAccess (string)
apiAccessPrincipalArn (string)
clientToken (string)
finspace_data/delete_datasetDeletes a FinSpace Dataset.clientToken (string)
datasetId (string) required
finspace_data/delete_permission_groupDeletes a permission group. This action is irreversible.permissionGroupId (string) required
clientToken (string)
finspace_data/disable_userDenies access to the FinSpace web application and API for the specified user.userId (string) required
clientToken (string)
finspace_data/disassociate_user_from_permission_groupRemoves a user from a permission group.permissionGroupId (string) required
userId (string) required
clientToken (string)
finspace_data/enable_userAllows the specified user to access the FinSpace web application and API.userId (string) required
clientToken (string)
finspace_data/get_changesetGet information about a Changeset.datasetId (string) required
changesetId (string) required
finspace_data/get_datasetReturns information about a Dataset.datasetId (string) required
finspace_data/get_data_viewGets information about a Dataview.dataViewId (string) required
datasetId (string) required
finspace_data/get_external_data_view_access_detailsReturns 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.dataViewId (string) required
datasetId (string) required
finspace_data/get_permission_groupRetrieves the details of a specific permission group.permissionGroupId (string) required
finspace_data/get_programmatic_access_credentialsRequest programmatic credentials to use with FinSpace SDK. For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.durationInMinutes (integer)
environmentId (string) required
finspace_data/get_userRetrieves details for a specific user.userId (string) required
finspace_data/get_working_locationA 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.locationType (string)
finspace_data/list_changesetsLists the FinSpace Changesets for a Dataset.datasetId (string) required
maxResults (integer)
nextToken (string)
finspace_data/list_datasetsLists all of the active Datasets that a user has access to.nextToken (string)
maxResults (integer)
finspace_data/list_data_viewsLists all available Dataviews for a Dataset.datasetId (string) required
nextToken (string)
maxResults (integer)
finspace_data/list_permission_groupsLists all available permission groups in FinSpace.nextToken (string)
maxResults (integer) required
finspace_data/list_permission_groups_by_userLists all the permission groups that are associated with a specific user.userId (string) required
nextToken (string)
maxResults (integer) required
finspace_data/list_usersLists all available users in FinSpace.nextToken (string)
maxResults (integer) required
finspace_data/list_users_by_permission_groupLists details of all the users in a specific permission group.permissionGroupId (string) required
nextToken (string)
maxResults (integer) required
finspace_data/reset_user_passwordResets 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.userId (string) required
clientToken (string)
finspace_data/update_changesetUpdates a FinSpace Changeset.clientToken (string)
datasetId (string) required
changesetId (string) required
sourceParams (object) required
formatParams (object) required
finspace_data/update_datasetUpdates a FinSpace Dataset.clientToken (string)
datasetId (string) required
datasetTitle (string) required
kind (string) required
datasetDescription (string)
alias (string)
schemaDefinition: {
. tabularSchemaConfig (object)
} (object)
finspace_data/update_permission_groupModifies the details of a permission group. You cannot modify a permissionGroupID.permissionGroupId (string) required
name (string)
description (string)
applicationPermissions (array)
clientToken (string)
finspace_data/update_userModifies the details of the specified user. You cannot update the userId for a user.userId (string) required
type (string)
firstName (string)
lastName (string)
apiAccess (string)
apiAccessPrincipalArn (string)
clientToken (string)
finspace/create_environmentCreate a new FinSpace environment.name (string) required
description (string)
kmsKeyId (string)
tags (object)
federationMode (string)
federationParameters: {
. samlMetadataDocument (string)
. samlMetadataURL (string)
. applicationCallBackURL (string)
. federationURN (string)
. federationProviderName (string)
. attributeMap (object)
} (object)
superuserParameters: {
. emailAddress (string)
. firstName (string)
. lastName (string)
} (object)
dataBundles (array)
finspace/create_kx_changesetCreates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.environmentId (string) required
databaseName (string) required
changeRequests (array) required
clientToken (string) required
finspace/create_kx_clusterCreates a new kdb cluster.clientToken (string)
environmentId (string) required
clusterName (string) required
clusterType (string) required
tickerplantLogConfiguration: {
. tickerplantLogVolumes (array)
} (object)
databases (array)
cacheStorageConfigurations (array)
autoScalingConfiguration: {
. minNodeCount (integer)
. maxNodeCount (integer)
. autoScalingMetric (string)
. metricTarget (number)
. scaleInCooldownSeconds (number)
. scaleOutCooldownSeconds (number)
} (object)
clusterDescription (string)
capacityConfiguration: {
. nodeType (string)
. nodeCount (integer)
} (object)
releaseLabel (string) required
vpcConfiguration: {
. vpcId (string)
. securityGroupIds (array)
. subnetIds (array)
. ipAddressType (string)
} (object) required
initializationScript (string)
commandLineArguments (array)
code: {
. s3Bucket (string)
. s3Key (string)
. s3ObjectVersion (string)
} (object)
executionRole (string)
savedownStorageConfiguration: {
. type (string)
. size (integer)
. volumeName (string)
} (object)
azMode (string) required
availabilityZoneId (string)
tags (object)
scalingGroupConfiguration: {
. scalingGroupName (string)
. memoryLimit (integer)
. memoryReservation (integer)
. nodeCount (integer)
. cpu (number)
} (object)
finspace/create_kx_databaseCreates a new kdb database in the environment.environmentId (string) required
databaseName (string) required
description (string)
tags (object)
clientToken (string) required
finspace/create_kx_dataviewCreates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.environmentId (string) required
databaseName (string) required
dataviewName (string) required
azMode (string) required
availabilityZoneId (string)
changesetId (string)
segmentConfigurations (array)
autoUpdate (boolean)
readWrite (boolean)
description (string)
tags (object)
clientToken (string) required
finspace/create_kx_environmentCreates a managed kdb environment for the account.name (string) required
description (string)
kmsKeyId (string) required
tags (object)
clientToken (string)
finspace/create_kx_scaling_groupCreates a new scaling group.clientToken (string) required
environmentId (string) required
scalingGroupName (string) required
hostType (string) required
availabilityZoneId (string) required
tags (object)
finspace/create_kx_userCreates a user in FinSpace kdb environment with an associated IAM role.environmentId (string) required
userName (string) required
iamRole (string) required
tags (object)
clientToken (string)
finspace/create_kx_volumeCreates a new volume with a specific amount of throughput and storage capacity.clientToken (string)
environmentId (string) required
volumeType (string) required
volumeName (string) required
description (string)
nas1Configuration: {
. type (string)
. size (integer)
} (object)
azMode (string) required
availabilityZoneIds (array) required
tags (object)
finspace/delete_environmentDelete an FinSpace environment.environmentId (string) required
finspace/delete_kx_clusterDeletes a kdb cluster.environmentId (string) required
clusterName (string) required
clientToken (string)
finspace/delete_kx_cluster_nodeDeletes the specified nodes from a cluster.environmentId (string) required
clusterName (string) required
nodeId (string) required
finspace/delete_kx_databaseDeletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.environmentId (string) required
databaseName (string) required
clientToken (string) required
finspace/delete_kx_dataviewDeletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.environmentId (string) required
databaseName (string) required
dataviewName (string) required
clientToken (string) required
finspace/delete_kx_environmentDeletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.environmentId (string) required
clientToken (string)
finspace/delete_kx_scaling_groupDeletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.environmentId (string) required
scalingGroupName (string) required
clientToken (string)
finspace/delete_kx_userDeletes a user in the specified kdb environment.userName (string) required
environmentId (string) required
clientToken (string)
finspace/delete_kx_volumeDeletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.environmentId (string) required
volumeName (string) required
clientToken (string)
finspace/get_environmentReturns the FinSpace environment object.environmentId (string) required
finspace/get_kx_changesetReturns information about a kdb changeset.environmentId (string) required
databaseName (string) required
changesetId (string) required
finspace/get_kx_clusterRetrieves information about a kdb cluster.environmentId (string) required
clusterName (string) required
finspace/get_kx_connection_stringRetrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.userArn (string) required
environmentId (string) required
clusterName (string) required
finspace/get_kx_databaseReturns database information for the specified environment ID.environmentId (string) required
databaseName (string) required
finspace/get_kx_dataviewRetrieves details of the dataview.environmentId (string) required
databaseName (string) required
dataviewName (string) required
finspace/get_kx_environmentRetrieves all the information for the specified kdb environment.environmentId (string) required
finspace/get_kx_scaling_groupRetrieves details of a scaling group.environmentId (string) required
scalingGroupName (string) required
finspace/get_kx_userRetrieves information about the specified kdb user.userName (string) required
environmentId (string) required
finspace/get_kx_volumeRetrieves the information about the volume.environmentId (string) required
volumeName (string) required
finspace/list_environmentsA list of all of your FinSpace environments.nextToken (string)
maxResults (integer)
finspace/list_kx_changesetsReturns a list of all the changesets for a database.environmentId (string) required
databaseName (string) required
nextToken (string)
maxResults (integer)
finspace/list_kx_cluster_nodesLists all the nodes in a kdb cluster.environmentId (string) required
clusterName (string) required
nextToken (string)
maxResults (integer)
finspace/list_kx_clustersReturns a list of clusters.environmentId (string) required
clusterType (string)
maxResults (integer)
nextToken (string)
finspace/list_kx_databasesReturns a list of all the databases in the kdb environment.environmentId (string) required
nextToken (string)
maxResults (integer)
finspace/list_kx_dataviewsReturns a list of all the dataviews in the database.environmentId (string) required
databaseName (string) required
nextToken (string)
maxResults (integer)
finspace/list_kx_environmentsReturns a list of kdb environments created in an account.nextToken (string)
maxResults (integer)
finspace/list_kx_scaling_groupsReturns a list of scaling groups in a kdb environment.environmentId (string) required
maxResults (integer)
nextToken (string)
finspace/list_kx_usersLists all the users in a kdb environment.environmentId (string) required
nextToken (string)
maxResults (integer)
finspace/list_kx_volumesLists all the volumes in a kdb environment.environmentId (string) required
maxResults (integer)
nextToken (string)
volumeType (string)
finspace/list_tags_for_resourceA list of all tags for a resource.resourceArn (string) required
finspace/tag_resourceAdds metadata tags to a FinSpace resource.resourceArn (string) required
tags (object) required
finspace/untag_resourceRemoves metadata tags from a FinSpace resource.resourceArn (string) required
tagKeys (array) required
finspace/update_environmentUpdate your FinSpace environment.environmentId (string) required
name (string)
description (string)
federationMode (string)
federationParameters: {
. samlMetadataDocument (string)
. samlMetadataURL (string)
. applicationCallBackURL (string)
. federationURN (string)
. federationProviderName (string)
. attributeMap (object)
} (object)
finspace/update_kx_cluster_code_configurationAllows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.environmentId (string) required
clusterName (string) required
clientToken (string)
code: {
. s3Bucket (string)
. s3Key (string)
. s3ObjectVersion (string)
} (object) required
initializationScript (string)
commandLineArguments (array)
deploymentConfiguration: {
. deploymentStrategy (string)
} (object)
finspace/update_kx_cluster_databasesUpdates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one. Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.environmentId (string) required
clusterName (string) required
clientToken (string)
databases (array) required
deploymentConfiguration: {
. deploymentStrategy (string)
} (object)
finspace/update_kx_databaseUpdates information for the given kdb database.environmentId (string) required
databaseName (string) required
description (string)
clientToken (string) required
finspace/update_kx_dataviewUpdates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurationsenvironmentId (string) required
databaseName (string) required
dataviewName (string) required
description (string)
changesetId (string)
segmentConfigurations (array)
clientToken (string) required
finspace/update_kx_environmentUpdates information for the given kdb environment.environmentId (string) required
name (string)
description (string)
clientToken (string)
finspace/update_kx_environment_networkUpdates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers. Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.environmentId (string) required
transitGatewayConfiguration: {
. transitGatewayID (string)
. routableCIDRSpace (string)
. attachmentNetworkAclConfiguration (array)
} (object)
customDNSConfiguration (array)
clientToken (string)
finspace/update_kx_userUpdates the user details. You can only update the IAM role associated with a user.environmentId (string) required
userName (string) required
iamRole (string) required
clientToken (string)
finspace/update_kx_volumeUpdates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.environmentId (string) required
volumeName (string) required
description (string)
clientToken (string)
nas1Configuration: {
. type (string)
. size (integer)
} (object)
firehose/create_delivery_streamCreates a Firehose stream. By default, you can create up to 5,000 Firehose streams per Amazon Web Services Region. This is an asynchronous operation that immediately returns. The initial status of the Firehose stream is CREATING. After the Firehose stream is created, its status is ACTIVE and it now accepts data. If the Firehose 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 checkDeliveryStreamName (string) required
DeliveryStreamType (string)
DirectPutSourceConfiguration: {
. ThroughputHintInMBs (integer)
} (object)
KinesisStreamSourceConfiguration: {
. KinesisStreamARN (string)
. RoleARN (string)
} (object)
DeliveryStreamEncryptionConfigurationInput: {
. KeyARN (string)
. KeyType (string)
} (object)
S3DestinationConfiguration: {
. RoleARN (string)
. BucketARN (string)
. Prefix (string)
. ErrorOutputPrefix (string)
. BufferingHints (object)
. CompressionFormat (string)
. EncryptionConfiguration (object)
. CloudWatchLoggingOptions (object)
} (object)
ExtendedS3DestinationConfiguration: {
. RoleARN (string)
. BucketARN (string)
. Prefix (string)
. ErrorOutputPrefix (string)
. BufferingHints (object)
. CompressionFormat (string)
. EncryptionConfiguration (object)
. CloudWatchLoggingOptions (object)
. ProcessingConfiguration (object)
. S3BackupMode (string)
. S3BackupConfiguration (object)
. DataFormatConversionConfiguration (object)
. DynamicPartitioningConfiguration (object)
. FileExtension (string)
. CustomTimeZone (string)
} (object)
RedshiftDestinationConfiguration: {
. RoleARN (string)
. ClusterJDBCURL (string)
. CopyCommand (object)
. Username (string)
. Password (string)
. RetryOptions (object)
. S3Configuration (object)
. ProcessingConfiguration (object)
. S3BackupMode (string)
. S3BackupConfiguration (object)
. CloudWatchLoggingOptions (object)
. SecretsManagerConfiguration (object)
} (object)
ElasticsearchDestinationConfiguration: {
. RoleARN (string)
. DomainARN (string)
. ClusterEndpoint (string)
. IndexName (string)
. TypeName (string)
. IndexRotationPeriod (string)
. BufferingHints (object)
. RetryOptions (object)
. S3BackupMode (string)
. S3Configuration (object)
. ProcessingConfiguration (object)
. CloudWatchLoggingOptions (object)
. VpcConfiguration (object)
. DocumentIdOptions (object)
} (object)
AmazonopensearchserviceDestinationConfiguration: {
. RoleARN (string)
. DomainARN (string)
. ClusterEndpoint (string)
. IndexName (string)
. TypeName (string)
. IndexRotationPeriod (string)
. BufferingHints (object)
. RetryOptions (object)
. S3BackupMode (string)
. S3Configuration (object)
. ProcessingConfiguration (object)
. CloudWatchLoggingOptions (object)
. VpcConfiguration (object)
. DocumentIdOptions (object)
} (object)
SplunkDestinationConfiguration: {
. HECEndpoint (string)
. HECEndpointType (string)
. HECToken (string)
. HECAcknowledgmentTimeoutInSeconds (integer)
. RetryOptions (object)
. S3BackupMode (string)
. S3Configuration (object)
. ProcessingConfiguration (object)
. CloudWatchLoggingOptions (object)
. BufferingHints (object)
. SecretsManagerConfiguration (object)
} (object)
HttpEndpointDestinationConfiguration: {
. EndpointConfiguration (object)
. BufferingHints (object)
. CloudWatchLoggingOptions (object)
. RequestConfiguration (object)
. ProcessingConfiguration (object)
. RoleARN (string)
. RetryOptions (object)
. S3BackupMode (string)
. S3Configuration (object)
. SecretsManagerConfiguration (object)
} (object)
Tags (array)
AmazonOpenSearchServerlessDestinationConfiguration: {
. RoleARN (string)
. CollectionEndpoint (string)
. IndexName (string)
. BufferingHints (object)
. RetryOptions (object)
. S3BackupMode (string)
. S3Configuration (object)
. ProcessingConfiguration (object)
. CloudWatchLoggingOptions (object)
. VpcConfiguration (object)
} (object)
MSKSourceConfiguration: {
. MSKClusterARN (string)
. TopicName (string)
. AuthenticationConfiguration (object)
. ReadFromTimestamp (string)
} (object)
SnowflakeDestinationConfiguration: {
. AccountUrl (string)
. PrivateKey (string)
. KeyPassphrase (string)
. User (string)
. Database (string)
. Schema (string)
. Table (string)
. SnowflakeRoleConfiguration (object)
. DataLoadingOption (string)
. MetaDataColumnName (string)
. ContentColumnName (string)
. SnowflakeVpcConfiguration (object)
. CloudWatchLoggingOptions (object)
. ProcessingConfiguration (object)
. RoleARN (string)
. RetryOptions (object)
. S3BackupMode (string)
. S3Configuration (object)
. SecretsManagerConfiguration (object)
. BufferingHints (object)
} (object)
IcebergDestinationConfiguration: {
. DestinationTableConfigurationList (array)
. SchemaEvolutionConfiguration (object)
. TableCreationConfiguration (object)
. BufferingHints (object)
. CloudWatchLoggingOptions (object)
. ProcessingConfiguration (object)
. S3BackupMode (string)
. RetryOptions (object)
. RoleARN (string)
. AppendOnly (boolean)
. CatalogConfiguration (object)
. S3Configuration (object)
} (object)
DatabaseSourceConfiguration: {
. Type (string)
. Endpoint (string)
. Port (integer)
. SSLMode (string)
. Databases (object)
. Tables (object)
. Columns (object)
. SurrogateKeys (array)
. SnapshotWatermarkTable (string)
. DatabaseSourceAuthenticationConfiguration (object)
. DatabaseSourceVPCConfiguration (object)
} (object)
firehose/delete_delivery_streamDeletes a Firehose stream and its data. You can delete a Firehose stream only if it is in one of the following states: ACTIVE, DELETING, CREATING_FAILED, or DELETING_FAILED. You can't delete a Firehose stream that is in the CREATING state. To check the state of a Firehose stream, use DescribeDeliveryStream. DeleteDeliveryStream is an asynchronous API. When an API request to DeleteDeliveryStream succeeds, the Firehose stream is marked for deletion, and it goes into the DELETING state.While the FiDeliveryStreamName (string) required
AllowForceDelete (boolean)
firehose/describe_delivery_streamDescribes the specified Firehose stream and its status. For example, after your Firehose stream is created, call DescribeDeliveryStream to see whether the Firehose stream is ACTIVE and therefore ready for data to be sent to it. If the status of a Firehose 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 iDeliveryStreamName (string) required
Limit (integer)
ExclusiveStartDestinationId (string)
firehose/list_delivery_streamsLists your Firehose streams in alphabetical order of their names. The number of Firehose streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of Firehose 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 Firehose streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeLimit (integer)
DeliveryStreamType (string)
ExclusiveStartDeliveryStreamName (string)
firehose/list_tags_for_delivery_streamLists the tags for the specified Firehose stream. This operation has a limit of five transactions per second per account.DeliveryStreamName (string) required
ExclusiveStartTagKey (string)
Limit (integer)
firehose/put_recordWrites a single data record into an Firehose stream. To write multiple data records into a Firehose stream, use PutRecordBatch. Applications using these operations are referred to as producers. By default, each Firehose 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 Firehose stream. For more information about limits and how to request anDeliveryStreamName (string) required
Record: {
. Data (string)
} (object) required
firehose/put_record_batchWrites multiple data records into a Firehose stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a Firehose stream, use PutRecord. Applications using these operations are referred to as producers. Firehose accumulates and publishes a particular metric for a customer account in one minute intervals. It is possible that the bursts of incoming bytes/records ingested to a Firehose stream last only for a few secDeliveryStreamName (string) required
Records (array) required
firehose/start_delivery_stream_encryptionEnables server-side encryption SSE for the Firehose stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a Firehose 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 Firehose stream while the encryption statusDeliveryStreamName (string) required
DeliveryStreamEncryptionConfigurationInput: {
. KeyARN (string)
. KeyType (string)
} (object)
firehose/stop_delivery_stream_encryptionDisables server-side encryption SSE for the Firehose stream. This operation is asynchronous. It returns immediately. When you invoke it, 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 Firehose stream are no longer subject to encryption. To find out whether aDeliveryStreamName (string) required
firehose/tag_delivery_streamAdds or updates tags for the specified Firehose stream. A tag is a key-value pair 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. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the Amazon WeDeliveryStreamName (string) required
Tags (array) required
firehose/untag_delivery_streamRemoves tags from the specified Firehose 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.DeliveryStreamName (string) required
TagKeys (array) required
firehose/update_destinationUpdates the specified destination of the specified Firehose 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 Firehose stream remains active while the configurations are updated, so data writes to the Firehose stream can continue during this procDeliveryStreamName (string) required
CurrentDeliveryStreamVersionId (string) required
DestinationId (string) required
S3DestinationUpdate: {
. RoleARN (string)
. BucketARN (string)
. Prefix (string)
. ErrorOutputPrefix (string)
. BufferingHints (object)
. CompressionFormat (string)
. EncryptionConfiguration (object)
. CloudWatchLoggingOptions (object)
} (object)
ExtendedS3DestinationUpdate: {
. RoleARN (string)
. BucketARN (string)
. Prefix (string)
. ErrorOutputPrefix (string)
. BufferingHints (object)
. CompressionFormat (string)
. EncryptionConfiguration (object)
. CloudWatchLoggingOptions (object)
. ProcessingConfiguration (object)
. S3BackupMode (string)
. S3BackupUpdate (object)
. DataFormatConversionConfiguration (object)
. DynamicPartitioningConfiguration (object)
. FileExtension (string)
. CustomTimeZone (string)
} (object)
RedshiftDestinationUpdate: {
. RoleARN (string)
. ClusterJDBCURL (string)
. CopyCommand (object)
. Username (string)
. Password (string)
. RetryOptions (object)
. S3Update (object)
. ProcessingConfiguration (object)
. S3BackupMode (string)
. S3BackupUpdate (object)
. CloudWatchLoggingOptions (object)
. SecretsManagerConfiguration (object)
} (object)
ElasticsearchDestinationUpdate: {
. RoleARN (string)
. DomainARN (string)
. ClusterEndpoint (string)
. IndexName (string)
. TypeName (string)
. IndexRotationPeriod (string)
. BufferingHints (object)
. RetryOptions (object)
. S3Update (object)
. ProcessingConfiguration (object)
. CloudWatchLoggingOptions (object)
. DocumentIdOptions (object)
} (object)
AmazonopensearchserviceDestinationUpdate: {
. RoleARN (string)
. DomainARN (string)
. ClusterEndpoint (string)
. IndexName (string)
. TypeName (string)
. IndexRotationPeriod (string)
. BufferingHints (object)
. RetryOptions (object)
. S3Update (object)
. ProcessingConfiguration (object)
. CloudWatchLoggingOptions (object)
. DocumentIdOptions (object)
} (object)
SplunkDestinationUpdate: {
. HECEndpoint (string)
. HECEndpointType (string)
. HECToken (string)
. HECAcknowledgmentTimeoutInSeconds (integer)
. RetryOptions (object)
. S3BackupMode (string)
. S3Update (object)
. ProcessingConfiguration (object)
. CloudWatchLoggingOptions (object)
. BufferingHints (object)
. SecretsManagerConfiguration (object)
} (object)
HttpEndpointDestinationUpdate: {
. EndpointConfiguration (object)
. BufferingHints (object)
. CloudWatchLoggingOptions (object)
. RequestConfiguration (object)
. ProcessingConfiguration (object)
. RoleARN (string)
. RetryOptions (object)
. S3BackupMode (string)
. S3Update (object)
. SecretsManagerConfiguration (object)
} (object)
AmazonOpenSearchServerlessDestinationUpdate: {
. RoleARN (string)
. CollectionEndpoint (string)
. IndexName (string)
. BufferingHints (object)
. RetryOptions (object)
. S3Update (object)
. ProcessingConfiguration (object)
. CloudWatchLoggingOptions (object)
} (object)
SnowflakeDestinationUpdate: {
. AccountUrl (string)
. PrivateKey (string)
. KeyPassphrase (string)
. User (string)
. Database (string)
. Schema (string)
. Table (string)
. SnowflakeRoleConfiguration (object)
. DataLoadingOption (string)
. MetaDataColumnName (string)
. ContentColumnName (string)
. CloudWatchLoggingOptions (object)
. ProcessingConfiguration (object)
. RoleARN (string)
. RetryOptions (object)
. S3BackupMode (string)
. S3Update (object)
. SecretsManagerConfiguration (object)
. BufferingHints (object)
} (object)
IcebergDestinationUpdate: {
. DestinationTableConfigurationList (array)
. SchemaEvolutionConfiguration (object)
. TableCreationConfiguration (object)
. BufferingHints (object)
. CloudWatchLoggingOptions (object)
. ProcessingConfiguration (object)
. S3BackupMode (string)
. RetryOptions (object)
. RoleARN (string)
. AppendOnly (boolean)
. CatalogConfiguration (object)
. S3Configuration (object)
} (object)
fis/create_experiment_templateCreates 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 triggeredclientToken (string) required
description (string) required
stopConditions (array) required
targets (object)
actions (object) required
roleArn (string) required
tags (object)
logConfiguration: {
. cloudWatchLogsConfiguration (object)
. s3Configuration (object)
. logSchemaVersion (integer)
} (object)
experimentOptions: {
. accountTargeting (string)
. emptyTargetResolutionMode (string)
} (object)
experimentReportConfiguration: {
. outputs (object)
. dataSources (object)
. preExperimentDuration (string)
. postExperimentDuration (string)
} (object)
fis/create_target_account_configurationCreates a target account configuration for the experiment template. A target account configuration is required when accountTargeting of experimentOptions is set to multi-account. For more information, see experiment options in the Fault Injection Service User Guide.clientToken (string)
experimentTemplateId (string) required
accountId (string) required
roleArn (string) required
description (string)
fis/delete_experiment_templateDeletes the specified experiment template.id (string) required
fis/delete_target_account_configurationDeletes the specified target account configuration of the experiment template.experimentTemplateId (string) required
accountId (string) required
fis/get_actionGets information about the specified FIS action.id (string) required
fis/get_experimentGets information about the specified experiment.id (string) required
fis/get_experiment_target_account_configurationGets information about the specified target account configuration of the experiment.experimentId (string) required
accountId (string) required
fis/get_experiment_templateGets information about the specified experiment template.id (string) required
fis/get_safety_leverGets information about the specified safety lever.id (string) required
fis/get_target_account_configurationGets information about the specified target account configuration of the experiment template.experimentTemplateId (string) required
accountId (string) required
fis/get_target_resource_typeGets information about the specified resource type.resourceType (string) required
fis/list_actionsLists the available FIS actions.maxResults (integer)
nextToken (string)
fis/list_experiment_resolved_targetsLists the resolved targets information of the specified experiment.experimentId (string) required
maxResults (integer)
nextToken (string)
targetName (string)
fis/list_experimentsLists your experiments.maxResults (integer)
nextToken (string)
experimentTemplateId (string)
fis/list_experiment_target_account_configurationsLists the target account configurations of the specified experiment.experimentId (string) required
nextToken (string)
fis/list_experiment_templatesLists your experiment templates.maxResults (integer)
nextToken (string)
fis/list_tags_for_resourceLists the tags for the specified resource.resourceArn (string) required
fis/list_target_account_configurationsLists the target account configurations of the specified experiment template.experimentTemplateId (string) required
maxResults (integer)
nextToken (string)
fis/list_target_resource_typesLists the target resource types.maxResults (integer)
nextToken (string)
fis/start_experimentStarts running an experiment from the specified experiment template.clientToken (string) required
experimentTemplateId (string) required
experimentOptions: {
. actionsMode (string)
} (object)
tags (object)
fis/stop_experimentStops the specified experiment.id (string) required
fis/tag_resourceApplies the specified tags to the specified resource.resourceArn (string) required
tags (object) required
fis/untag_resourceRemoves the specified tags from the specified resource.resourceArn (string) required
tagKeys (array)
fis/update_experiment_templateUpdates the specified experiment template.id (string) required
description (string)
stopConditions (array)
targets (object)
actions (object)
roleArn (string)
logConfiguration: {
. cloudWatchLogsConfiguration (object)
. s3Configuration (object)
. logSchemaVersion (integer)
} (object)
experimentOptions: {
. emptyTargetResolutionMode (string)
} (object)
experimentReportConfiguration: {
. outputs (object)
. dataSources (object)
. preExperimentDuration (string)
. postExperimentDuration (string)
} (object)
fis/update_safety_lever_stateUpdates the specified safety lever state.id (string) required
state: {
. status (string)
. reason (string)
} (object) required
fis/update_target_account_configurationUpdates the target account configuration for the specified experiment template.experimentTemplateId (string) required
accountId (string) required
roleArn (string)
description (string)
fms/associate_admin_accountSets a Firewall Manager default administrator account. The Firewall Manager default administrator account can manage third-party firewalls and has full administrative scope that allows administration of all policy types, accounts, organizational units, and Regions. This account must be a member account of the organization in Organizations whose resources you want to protect. For information about working with Firewall Manager administrator accounts, see Managing Firewall Manager administrators iAdminAccount (string) required
fms/associate_third_party_firewallSets 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.ThirdPartyFirewall (string) required
fms/batch_associate_resourceAssociate resources to a Firewall Manager resource set.ResourceSetIdentifier (string) required
Items (array) required
fms/batch_disassociate_resourceDisassociates resources from a Firewall Manager resource set.ResourceSetIdentifier (string) required
Items (array) required
fms/delete_apps_listPermanently deletes an Firewall Manager applications list.ListId (string) required
fms/delete_notification_channelDeletes 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.No parameters
fms/delete_policyPermanently deletes an Firewall Manager policy.PolicyId (string) required
DeleteAllPolicyResources (boolean)
fms/delete_protocols_listPermanently deletes an Firewall Manager protocols list.ListId (string) required
fms/delete_resource_setDeletes the specified ResourceSet.Identifier (string) required
fms/disassociate_admin_accountDisassociates an Firewall Manager administrator account. To set a different account as an Firewall Manager administrator, submit a PutAdminAccount request. To set an account as a default administrator account, you must submit an AssociateAdminAccount request. Disassociation of the default administrator account follows the first in, last out principle. If you are the default administrator, all Firewall Manager administrators within the organization must first disassociate their accounts before yoNo parameters
fms/disassociate_third_party_firewallDisassociates 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.ThirdPartyFirewall (string) required
fms/get_admin_accountReturns the Organizations account that is associated with Firewall Manager as the Firewall Manager default administrator.No parameters
fms/get_admin_scopeReturns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.AdminAccount (string) required
fms/get_apps_listReturns information about the specified Firewall Manager applications list.ListId (string) required
DefaultList (boolean)
fms/get_compliance_detailReturns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. The reasons for resources being considered compliant depend on the Firewall Manager policy type.PolicyId (string) required
MemberAccount (string) required
fms/get_notification_channelInformation about the Amazon Simple Notification Service SNS topic that is used to record Firewall Manager SNS logs.No parameters
fms/get_policyReturns information about the specified Firewall Manager policy.PolicyId (string) required
fms/get_protection_statusIf 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.PolicyId (string) required
MemberAccountId (string)
StartTime (string)
EndTime (string)
NextToken (string)
MaxResults (integer)
fms/get_protocols_listReturns information about the specified Firewall Manager protocols list.ListId (string) required
DefaultList (boolean)
fms/get_resource_setGets information about a specific resource set.Identifier (string) required
fms/get_third_party_firewall_association_statusThe onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant.ThirdPartyFirewall (string) required
fms/get_violation_detailsRetrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.PolicyId (string) required
MemberAccount (string) required
ResourceId (string) required
ResourceType (string) required
fms/list_admin_accounts_for_organizationReturns a AdminAccounts object that lists the Firewall Manager administrators within the organization that are onboarded to Firewall Manager by AssociateAdminAccount. This operation can be called only from the organization's management account.NextToken (string)
MaxResults (integer)
fms/list_admins_managing_accountLists the accounts that are managing the specified Organizations member account. This is useful for any member account so that they can view the accounts who are managing their account. This operation only returns the managing administrators that have the requested account within their AdminScope.NextToken (string)
MaxResults (integer)
fms/list_apps_listsReturns an array of AppsListDataSummary objects.DefaultLists (boolean)
NextToken (string)
MaxResults (integer) required
fms/list_compliance_statusReturns an array of PolicyComplianceStatus objects. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.PolicyId (string) required
NextToken (string)
MaxResults (integer)
fms/list_discovered_resourcesReturns an array of resources in the organization's accounts that are available to be associated with a resource set.MemberAccountIds (array) required
ResourceType (string) required
MaxResults (integer)
NextToken (string)
fms/list_member_accountsReturns a MemberAccounts object that lists the member accounts in the administrator's Amazon Web Services organization. Either an Firewall Manager administrator or the organization's management account can make this request.NextToken (string)
MaxResults (integer)
fms/list_policiesReturns an array of PolicySummary objects.NextToken (string)
MaxResults (integer)
fms/list_protocols_listsReturns an array of ProtocolsListDataSummary objects.DefaultLists (boolean)
NextToken (string)
MaxResults (integer) required
fms/list_resource_set_resourcesReturns an array of resources that are currently associated to a resource set.Identifier (string) required
MaxResults (integer)
NextToken (string)
fms/list_resource_setsReturns an array of ResourceSetSummary objects.NextToken (string)
MaxResults (integer)
fms/list_tags_for_resourceRetrieves the list of tags for the specified Amazon Web Services resource.ResourceArn (string) required
fms/list_third_party_firewall_firewall_policiesRetrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.ThirdPartyFirewall (string) required
NextToken (string)
MaxResults (integer) required
fms/put_admin_accountCreates or updates an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. Only the organization's management account can create an Firewall Manager administrator account. When you create an Firewall Manager administrator account, the service checks to see if the account is already a delegated administrator within Organizations. If the account isn't a delegated administrator, Firewall Manager calAdminAccount (string) required
AdminScope: {
. AccountScope (object)
. OrganizationalUnitScope (object)
. RegionScope (object)
. PolicyTypeScope (object)
} (object)
fms/put_apps_listCreates an Firewall Manager applications list.AppsList: {
. ListId (string)
. ListName (string)
. ListUpdateToken (string)
. CreateTime (string)
. LastUpdateTime (string)
. AppsList (array)
. PreviousAppsList (object)
} (object) required
TagList (array)
fms/put_notification_channelDesignates 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 first configure the SNS topic's access policy to allow the SnsRoleName to publish SNS logs. If the SnsRoleName provided is a role other than the AWSServiceRoleForFMS service-linked role, this role must have a trust relationship configured to allow the Firewall Manager service principal fms.amazonaws.com to assume this roleSnsTopicArn (string) required
SnsRoleName (string) required
fms/put_policyCreates an Firewall Manager policy. A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type. If you add a new account to an organization that you created with Organizations, Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy. Firewall Manager provides the following types oPolicy: {
. PolicyId (string)
. PolicyName (string)
. PolicyUpdateToken (string)
. SecurityServicePolicyData (object)
. ResourceType (string)
. ResourceTypeList (array)
. ResourceTags (array)
. ExcludeResourceTags (boolean)
. RemediationEnabled (boolean)
. DeleteUnusedFMManagedResources (boolean)
. IncludeMap (object)
. ExcludeMap (object)
. ResourceSetIds (array)
. PolicyDescription (string)
. PolicyStatus (string)
. ResourceTagLogicalOperator (string)
} (object) required
TagList (array)
fms/put_protocols_listCreates an Firewall Manager protocols list.ProtocolsList: {
. ListId (string)
. ListName (string)
. ListUpdateToken (string)
. CreateTime (string)
. LastUpdateTime (string)
. ProtocolsList (array)
. PreviousProtocolsList (object)
} (object) required
TagList (array)
fms/put_resource_setCreates the resource set. An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.ResourceSet: {
. Id (string)
. Name (string)
. Description (string)
. UpdateToken (string)
. ResourceTypeList (array)
. LastUpdateTime (string)
. ResourceSetStatus (string)
} (object) required
TagList (array)
fms/tag_resourceAdds one or more tags to an Amazon Web Services resource.ResourceArn (string) required
TagList (array) required
fms/untag_resourceRemoves one or more tags from an Amazon Web Services resource.ResourceArn (string) required
TagKeys (array) required
forecast/create_auto_predictorCreates 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 prePredictorName (string) required
ForecastHorizon (integer)
ForecastTypes (array)
ForecastDimensions (array)
ForecastFrequency (string)
DataConfig: {
. DatasetGroupArn (string)
. AttributeConfigs (array)
. AdditionalDatasets (array)
} (object)
EncryptionConfig: {
. RoleArn (string)
. KMSKeyArn (string)
} (object)
ReferencePredictorArn (string)
OptimizationMetric (string)
ExplainPredictor (boolean)
Tags (array)
MonitorConfig: {
. MonitorName (string)
} (object)
TimeAlignmentBoundary: {
. Month (string)
. DayOfMonth (integer)
. DayOfWeek (string)
. Hour (integer)
} (object)
forecast/create_datasetCreates 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 theDatasetName (string) required
Domain (string) required
DatasetType (string) required
DataFrequency (string)
Schema: {
. Attributes (array)
} (object) required
EncryptionConfig: {
. RoleArn (string)
. KMSKeyArn (string)
} (object)
Tags (array)
forecast/create_dataset_groupCreates 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 datDatasetGroupName (string) required
Domain (string) required
DatasetArns (array)
Tags (array)
forecast/create_dataset_import_jobImports 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 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 Amazon Web Services system. For moDatasetImportJobName (string) required
DatasetArn (string) required
DataSource: {
. S3Config (object)
} (object) required
TimestampFormat (string)
TimeZone (string)
UseGeolocationForTimeZone (boolean)
GeolocationFormat (string)
Tags (array)
Format (string)
ImportMode (string)
forecast/create_explainabilityExplainability 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 thExplainabilityName (string) required
ResourceArn (string) required
ExplainabilityConfig: {
. TimeSeriesGranularity (string)
. TimePointGranularity (string)
} (object) required
DataSource: {
. S3Config (object)
} (object)
Schema: {
. Attributes (array)
} (object)
EnableVisualization (boolean)
StartDateTime (string)
EndDateTime (string)
Tags (array)
forecast/create_explainability_exportExports 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 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 buckExplainabilityExportName (string) required
ExplainabilityArn (string) required
Destination: {
. S3Config (object)
} (object) required
Tags (array)
Format (string)
forecast/create_forecastCreates 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 rForecastName (string) required
PredictorArn (string) required
ForecastTypes (array)
Tags (array)
TimeSeriesSelector: {
. TimeSeriesIdentifiers (object)
} (object)
forecast/create_forecast_export_jobExports 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: __ where the component is in Java SimpleDateFormat yyyy-MM-ddTHH-mm-ssZ. You must specify a DataDestination object that includes an 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-fForecastExportJobName (string) required
ForecastArn (string) required
Destination: {
. S3Config (object)
} (object) required
Tags (array)
Format (string)
forecast/create_monitorCreates 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.MonitorName (string) required
ResourceArn (string) required
Tags (array)
forecast/create_predictorThis 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 ForecastPredictorName (string) required
AlgorithmArn (string)
ForecastHorizon (integer) required
ForecastTypes (array)
PerformAutoML (boolean)
AutoMLOverrideStrategy (string)
PerformHPO (boolean)
TrainingParameters (object)
EvaluationParameters: {
. NumberOfBacktestWindows (integer)
. BackTestWindowOffset (integer)
} (object)
HPOConfig: {
. ParameterRanges (object)
} (object)
InputDataConfig: {
. DatasetGroupArn (string)
. SupplementaryFeatures (array)
} (object) required
FeaturizationConfig: {
. ForecastFrequency (string)
. ForecastDimensions (array)
. Featurizations (array)
} (object) required
EncryptionConfig: {
. RoleArn (string)
. KMSKeyArn (string)
} (object)
Tags (array)
OptimizationMetric (string)
forecast/create_predictor_backtest_export_jobExports 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: __.csv The 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 Identity and Access Management IAM role that Amazon Forecast can assume to access tPredictorBacktestExportJobName (string) required
PredictorArn (string) required
Destination: {
. S3Config (object)
} (object) required
Tags (array)
Format (string)
forecast/create_what_if_analysisWhat-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 crWhatIfAnalysisName (string) required
ForecastArn (string) required
TimeSeriesSelector: {
. TimeSeriesIdentifiers (object)
} (object)
Tags (array)
forecast/create_what_if_forecastA 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.WhatIfForecastName (string) required
WhatIfAnalysisArn (string) required
TimeSeriesTransformations (array)
TimeSeriesReplacementsDataSource: {
. S3Config (object)
. Schema (object)
. Format (string)
. TimestampFormat (string)
} (object)
Tags (array)
forecast/create_what_if_forecast_exportExports 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: ≈__ The component is in Java SimpleDateFormat yyyy-MM-ddTHH-mm-ssZ. You must specify a DataDestination object that includes an 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-WhatIfForecastExportName (string) required
WhatIfForecastArns (array) required
Destination: {
. S3Config (object)
} (object) required
Tags (array)
Format (string)
forecast/delete_datasetDeletes 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.DatasetArn (string) required
forecast/delete_dataset_groupDeletes 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.DatasetGroupArn (string) required
forecast/delete_dataset_import_jobDeletes 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.DatasetImportJobArn (string) required
forecast/delete_explainabilityDeletes 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.ExplainabilityArn (string) required
forecast/delete_explainability_exportDeletes an Explainability export.ExplainabilityExportArn (string) required
forecast/delete_forecastDeletes 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.ForecastArn (string) required
forecast/delete_forecast_export_jobDeletes 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.ForecastExportJobArn (string) required
forecast/delete_monitorDeletes a monitor resource. You can only delete a monitor resource with a status of ACTIVE, ACTIVE_STOPPED, CREATE_FAILED, or CREATE_STOPPED.MonitorArn (string) required
forecast/delete_predictorDeletes 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.PredictorArn (string) required
forecast/delete_predictor_backtest_export_jobDeletes a predictor backtest export job.PredictorBacktestExportJobArn (string) required
forecast/delete_resource_treeDeletes 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, forecResourceArn (string) required
forecast/delete_what_if_analysisDeletes 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.WhatIfAnalysisArn (string) required
forecast/delete_what_if_forecastDeletes 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.WhatIfForecastArn (string) required
forecast/delete_what_if_forecast_exportDeletes 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.WhatIfForecastExportArn (string) required
forecast/describe_auto_predictorDescribes a predictor created using the CreateAutoPredictor operation.PredictorArn (string) required
forecast/describe_datasetDescribes 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 StatusDatasetArn (string) required
forecast/describe_dataset_groupDescribes 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 StatusDatasetGroupArn (string) required
forecast/describe_dataset_import_jobDescribes 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.DatasetImportJobArn (string) required
forecast/describe_explainabilityDescribes an Explainability resource created using the CreateExplainability operation.ExplainabilityArn (string) required
forecast/describe_explainability_exportDescribes an Explainability export created using the CreateExplainabilityExport operation.ExplainabilityExportArn (string) required
forecast/describe_forecastDescribes 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.ForecastArn (string) required
forecast/describe_forecast_export_jobDescribes 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.ForecastExportJobArn (string) required
forecast/describe_monitorDescribes 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 StatusMonitorArn (string) required
forecast/describe_predictorThis 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.PredictorArn (string) required
forecast/describe_predictor_backtest_export_jobDescribes 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 occurredPredictorBacktestExportJobArn (string) required
forecast/describe_what_if_analysisDescribes 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. StatusWhatIfAnalysisArn (string) required
forecast/describe_what_if_forecastDescribes 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. StatusWhatIfForecastArn (string) required
forecast/describe_what_if_forecast_exportDescribes 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. StatusWhatIfForecastExportArn (string) required
forecast/get_accuracy_metricsProvides 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 requPredictorArn (string) required
forecast/list_dataset_groupsReturns 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.NextToken (string)
MaxResults (integer)
forecast/list_dataset_import_jobsReturns 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.NextToken (string)
MaxResults (integer)
Filters (array)
forecast/list_datasetsReturns 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.NextToken (string)
MaxResults (integer)
forecast/list_explainabilitiesReturns 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.NextToken (string)
MaxResults (integer)
Filters (array)
forecast/list_explainability_exportsReturns 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.NextToken (string)
MaxResults (integer)
Filters (array)
forecast/list_forecast_export_jobsReturns 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.NextToken (string)
MaxResults (integer)
Filters (array)
forecast/list_forecastsReturns 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.NextToken (string)
MaxResults (integer)
Filters (array)
forecast/list_monitor_evaluationsReturns 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.NextToken (string)
MaxResults (integer)
MonitorArn (string) required
Filters (array)
forecast/list_monitorsReturns 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.NextToken (string)
MaxResults (integer)
Filters (array)
forecast/list_predictor_backtest_export_jobsReturns 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.NextToken (string)
MaxResults (integer)
Filters (array)
forecast/list_predictorsReturns 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.NextToken (string)
MaxResults (integer)
Filters (array)
forecast/list_tags_for_resourceLists the tags for an Amazon Forecast resource.ResourceArn (string) required
forecast/list_what_if_analysesReturns 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.NextToken (string)
MaxResults (integer)
Filters (array)
forecast/list_what_if_forecast_exportsReturns 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.NextToken (string)
MaxResults (integer)
Filters (array)
forecast/list_what_if_forecastsReturns 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.NextToken (string)
MaxResults (integer)
Filters (array)
forecast/resume_resourceResumes a stopped monitor resource.ResourceArn (string) required
forecast/stop_resourceStops 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 JobResourceArn (string) required
forecast/tag_resourceAssociates 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.ResourceArn (string) required
Tags (array) required
forecast/untag_resourceDeletes the specified tags from a resource.ResourceArn (string) required
TagKeys (array) required
forecast/update_dataset_groupReplaces 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.DatasetGroupArn (string) required
DatasetArns (array) required
forecastquery/query_forecastRetrieves 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 operationForecastArn (string) required
StartDate (string)
EndDate (string)
Filters (object) required
NextToken (string)
forecastquery/query_what_if_forecastRetrieves a what-if forecast.WhatIfForecastArn (string) required
StartDate (string)
EndDate (string)
Filters (object) required
NextToken (string)
frauddetector/batch_create_variableCreates a batch of variables.variableEntries (array) required
tags (array)
frauddetector/batch_get_variableGets a batch of variables.names (array) required
frauddetector/cancel_batch_import_jobCancels an in-progress batch import job.jobId (string) required
frauddetector/cancel_batch_prediction_jobCancels the specified batch prediction job.jobId (string) required
frauddetector/create_batch_import_jobCreates a batch import job.jobId (string) required
inputPath (string) required
outputPath (string) required
eventTypeName (string) required
iamRoleArn (string) required
tags (array)
frauddetector/create_batch_prediction_jobCreates a batch prediction job.jobId (string) required
inputPath (string) required
outputPath (string) required
eventTypeName (string) required
detectorName (string) required
detectorVersion (string)
iamRoleArn (string) required
tags (array)
frauddetector/create_detector_versionCreates a detector version. The detector version starts in a DRAFT status.detectorId (string) required
description (string)
externalModelEndpoints (array)
rules (array) required
modelVersions (array)
ruleExecutionMode (string)
tags (array)
frauddetector/create_listCreates a list. List is a set of input data for a variable in your event dataset. You use the input data in a rule that's associated with your detector. For more information, see Lists.name (string) required
elements (array)
variableType (string)
description (string)
tags (array)
frauddetector/create_modelCreates a model using the specified model type.modelId (string) required
modelType (string) required
description (string)
eventTypeName (string) required
tags (array)
frauddetector/create_model_versionCreates a version of the model using the specified model type and model id.modelId (string) required
modelType (string) required
trainingDataSource (string) required
trainingDataSchema: {
. modelVariables (array)
. labelSchema (object)
} (object) required
externalEventsDetail: {
. dataLocation (string)
. dataAccessRoleArn (string)
} (object)
ingestedEventsDetail: {
. ingestedEventsTimeWindow (object)
} (object)
tags (array)
frauddetector/create_ruleCreates a rule for use with the specified detector.ruleId (string) required
detectorId (string) required
description (string)
expression (string) required
language (string) required
outcomes (array) required
tags (array)
frauddetector/create_variableCreates a variable.name (string) required
dataType (string) required
dataSource (string) required
defaultValue (string) required
description (string)
variableType (string)
tags (array)
frauddetector/delete_batch_import_jobDeletes the specified batch import job ID record. This action does not delete the data that was batch imported.jobId (string) required
frauddetector/delete_batch_prediction_jobDeletes a batch prediction job.jobId (string) required
frauddetector/delete_detectorDeletes 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.detectorId (string) required
frauddetector/delete_detector_versionDeletes 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.detectorId (string) required
detectorVersionId (string) required
frauddetector/delete_entity_typeDeletes 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.name (string) required
frauddetector/delete_eventDeletes 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. If deleteAuditHistory is True, event data is available through search for up to 30 seconds after the delete operation is completed.eventId (string) required
eventTypeName (string) required
deleteAuditHistory (boolean)
frauddetector/delete_events_by_event_typeDeletes all events of a particular event type.eventTypeName (string) required
frauddetector/delete_event_typeDeletes 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.name (string) required
frauddetector/delete_external_modelRemoves 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.modelEndpoint (string) required
frauddetector/delete_labelDeletes 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.name (string) required
frauddetector/delete_listDeletes the list, provided it is not used in a rule. When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements in the list.name (string) required
frauddetector/delete_modelDeletes 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.modelId (string) required
modelType (string) required
frauddetector/delete_model_versionDeletes 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.modelId (string) required
modelType (string) required
modelVersionNumber (string) required
frauddetector/delete_outcomeDeletes 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.name (string) required
frauddetector/delete_ruleDeletes 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.rule: {
. detectorId (string)
. ruleId (string)
. ruleVersion (string)
} (object) required
frauddetector/delete_variableDeletes 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.name (string) required
frauddetector/describe_detectorGets all versions for a specified detector.detectorId (string) required
nextToken (string)
maxResults (integer)
frauddetector/describe_model_versionsGets 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.modelId (string)
modelVersionNumber (string)
modelType (string)
nextToken (string)
maxResults (integer)
frauddetector/get_batch_import_jobsGets 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.jobId (string)
maxResults (integer)
nextToken (string)
frauddetector/get_batch_prediction_jobsGets 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.jobId (string)
maxResults (integer)
nextToken (string)
frauddetector/get_delete_events_by_event_type_statusRetrieves the status of a DeleteEventsByEventType action.eventTypeName (string) required
frauddetector/get_detectorsGets 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.detectorId (string)
nextToken (string)
maxResults (integer)
frauddetector/get_detector_versionGets a particular detector version.detectorId (string) required
detectorVersionId (string) required
frauddetector/get_entity_typesGets 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.name (string)
nextToken (string)
maxResults (integer)
frauddetector/get_eventRetrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.eventId (string) required
eventTypeName (string) required
frauddetector/get_event_predictionEvaluates an event against a detector version. If a version ID is not provided, the detector’s ACTIVE version is used.detectorId (string) required
detectorVersionId (string)
eventId (string) required
eventTypeName (string) required
entities (array) required
eventTimestamp (string) required
eventVariables (object) required
externalModelEndpointDataBlobs (object)
frauddetector/get_event_prediction_metadataGets 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.eventId (string) required
eventTypeName (string) required
detectorId (string) required
detectorVersionId (string) required
predictionTimestamp (string) required
frauddetector/get_event_typesGets 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.name (string)
nextToken (string)
maxResults (integer)
frauddetector/get_external_modelsGets 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.modelEndpoint (string)
nextToken (string)
maxResults (integer)
frauddetector/get_kmsencryption_keyGets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.No parameters
frauddetector/get_labelsGets 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.name (string)
nextToken (string)
maxResults (integer)
frauddetector/get_list_elementsGets all the elements in the specified list.name (string) required
nextToken (string)
maxResults (integer)
frauddetector/get_lists_metadataGets the metadata of either all the lists under the account or the specified list.name (string)
nextToken (string)
maxResults (integer)
frauddetector/get_modelsGets 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 gemodelId (string)
modelType (string)
nextToken (string)
maxResults (integer)
frauddetector/get_model_versionGets the details of the specified model version.modelId (string) required
modelType (string) required
modelVersionNumber (string) required
frauddetector/get_outcomesGets 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.name (string)
nextToken (string)
maxResults (integer)
frauddetector/get_rulesGet 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.ruleId (string)
detectorId (string) required
ruleVersion (string)
nextToken (string)
maxResults (integer)
frauddetector/get_variablesGets 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.name (string)
nextToken (string)
maxResults (integer)
frauddetector/list_event_predictionsGets 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 beteventId: {
. value (string)
} (object)
eventType: {
. value (string)
} (object)
detectorId: {
. value (string)
} (object)
detectorVersionId: {
. value (string)
} (object)
predictionTimeRange: {
. startTime (string)
. endTime (string)
} (object)
nextToken (string)
maxResults (integer)
frauddetector/list_tags_for_resourceLists 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.resourceARN (string) required
nextToken (string)
maxResults (integer)
frauddetector/put_detectorCreates or updates a detector.detectorId (string) required
description (string)
eventTypeName (string) required
tags (array)
frauddetector/put_entity_typeCreates 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.name (string) required
description (string)
tags (array)
frauddetector/put_event_typeCreates 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.name (string) required
description (string)
eventVariables (array) required
labels (array)
entityTypes (array) required
eventIngestion (string)
tags (array)
eventOrchestration: {
. eventBridgeEnabled (boolean)
} (object)
frauddetector/put_external_modelCreates 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.modelEndpoint (string) required
modelSource (string) required
invokeModelEndpointRoleArn (string) required
inputConfiguration: {
. eventTypeName (string)
. format (string)
. useEventVariables (boolean)
. jsonInputTemplate (string)
. csvInputTemplate (string)
} (object) required
outputConfiguration: {
. format (string)
. jsonKeyToVariableMap (object)
. csvIndexToVariableMap (object)
} (object) required
modelEndpointStatus (string) required
tags (array)
frauddetector/put_kmsencryption_keySpecifies the KMS key to be used to encrypt content in Amazon Fraud Detector.kmsEncryptionKeyArn (string) required
frauddetector/put_labelCreates 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.name (string) required
description (string)
tags (array)
frauddetector/put_outcomeCreates or updates an outcome.name (string) required
description (string)
tags (array)
frauddetector/send_eventStores 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.eventId (string) required
eventTypeName (string) required
eventTimestamp (string) required
eventVariables (object) required
assignedLabel (string)
labelTimestamp (string)
entities (array) required
frauddetector/tag_resourceAssigns tags to a resource.resourceARN (string) required
tags (array) required
frauddetector/untag_resourceRemoves tags from a resource.resourceARN (string) required
tagKeys (array) required
frauddetector/update_detector_versionUpdates 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.detectorId (string) required
detectorVersionId (string) required
externalModelEndpoints (array) required
rules (array) required
description (string)
modelVersions (array)
ruleExecutionMode (string)
frauddetector/update_detector_version_metadataUpdates the detector version's description. You can update the metadata for any detector version DRAFT, ACTIVE, or INACTIVE.detectorId (string) required
detectorVersionId (string) required
description (string) required
frauddetector/update_detector_version_statusUpdates 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.detectorId (string) required
detectorVersionId (string) required
status (string) required
frauddetector/update_event_labelUpdates the specified event with a new label.eventId (string) required
eventTypeName (string) required
assignedLabel (string) required
labelTimestamp (string) required
frauddetector/update_listUpdates a list.name (string) required
elements (array)
description (string)
updateMode (string)
variableType (string)
frauddetector/update_modelUpdates model description.modelId (string) required
modelType (string) required
description (string)
frauddetector/update_model_versionUpdates 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.modelId (string) required
modelType (string) required
majorVersionNumber (string) required
externalEventsDetail: {
. dataLocation (string)
. dataAccessRoleArn (string)
} (object)
ingestedEventsDetail: {
. ingestedEventsTimeWindow (object)
} (object)
tags (array)
frauddetector/update_model_version_statusUpdates 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.modelId (string) required
modelType (string) required
modelVersionNumber (string) required
status (string) required
frauddetector/update_rule_metadataUpdates a rule's metadata. The description attribute can be updated.rule: {
. detectorId (string)
. ruleId (string)
. ruleVersion (string)
} (object) required
description (string) required
frauddetector/update_rule_versionUpdates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version version 1, 2, 3 ....rule: {
. detectorId (string)
. ruleId (string)
. ruleVersion (string)
} (object) required
description (string)
expression (string) required
language (string) required
outcomes (array) required
tags (array)
frauddetector/update_variableUpdates a variable.name (string) required
defaultValue (string)
description (string)
variableType (string)
freetier/get_account_activityReturns a specific activity record that is available to the customer.activityId (string) required
languageCode (string)
freetier/get_account_plan_stateThis returns all of the information related to the state of the account plan related to Free Tier.No parameters
freetier/get_free_tier_usageReturns a list of all Free Tier usage objects that match your filters.filter: {
. Or (array)
. And (array)
. Not (object)
. Dimensions (object)
} (object)
maxResults (integer)
nextToken (string)
freetier/list_account_activitiesReturns a list of activities that are available. This operation supports pagination and filtering by status.filterActivityStatuses (array)
nextToken (string)
maxResults (integer)
languageCode (string)
freetier/upgrade_account_planThe account plan type for the Amazon Web Services account.accountPlanType (string) required
fsx/associate_file_system_aliasesUse 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 stepClientRequestToken (string)
FileSystemId (string) required
Aliases (array) required
fsx/cancel_data_repository_taskCancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel an export 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. For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have alreadyTaskId (string) required
fsx/copy_backupCopies 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 restClientRequestToken (string)
SourceBackupId (string) required
SourceRegion (string)
KmsKeyId (string)
CopyTags (boolean)
Tags (array)
fsx/copy_snapshot_and_update_volumeUpdates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see on-demand data replication in the Amazon FSx for OpenZFS User Guide.ClientRequestToken (string)
VolumeId (string) required
SourceSnapshotARN (string) required
CopyStrategy (string)
Options (array)
fsx/create_and_attach_s3access_pointCreates an S3 access point and attaches it to an Amazon FSx volume. For FSx for OpenZFS file systems, the volume must be hosted on a high-availability file system, either Single-AZ or Multi-AZ. For more information, see Accessing your data using Amazon S3 access points. in the Amazon FSx for OpenZFS User Guide. The requester requires the following permissions to perform these actions: fsx:CreateAndAttachS3AccessPoint s3:CreateAccessPoint s3:GetAccessPoint s3:PutAccessPointPolicy s3:DeleteAccessPClientRequestToken (string)
Name (string) required
Type (string) required
OpenZFSConfiguration: {
. VolumeId (string)
. FileSystemIdentity (object)
} (object)
OntapConfiguration: {
. VolumeId (string)
. FileSystemIdentity (object)
} (object)
S3AccessPoint: {
. VpcConfiguration (object)
. Policy (string)
} (object)
fsx/create_backupCreates 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 tFileSystemId (string)
ClientRequestToken (string)
Tags (array)
VolumeId (string)
fsx/create_data_repository_associationCreates 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 on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type. Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefFileSystemId (string) required
FileSystemPath (string)
DataRepositoryPath (string) required
BatchImportMetaDataOnCreate (boolean)
ImportedFileChunkSize (integer)
S3: {
. AutoImportPolicy (object)
. AutoExportPolicy (object)
} (object)
ClientRequestToken (string)
Tags (array)
fsx/create_data_repository_taskCreates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system. You use import and export data repository tasks to perform bulk operations between your FSx for Lustre 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 lType (string) required
Paths (array)
FileSystemId (string) required
Report: {
. Enabled (boolean)
. Path (string)
. Format (string)
. Scope (string)
} (object) required
ClientRequestToken (string)
Tags (array)
CapacityToRelease (integer)
ReleaseConfiguration: {
. DurationSinceLastAccess (object)
} (object)
fsx/create_file_cacheCreates 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 requClientRequestToken (string)
FileCacheType (string) required
FileCacheTypeVersion (string) required
StorageCapacity (integer) required
SubnetIds (array) required
SecurityGroupIds (array)
Tags (array)
CopyTagsToDataRepositoryAssociations (boolean)
KmsKeyId (string)
LustreConfiguration: {
. PerUnitStorageThroughput (integer)
. DeploymentType (string)
. WeeklyMaintenanceStartTime (string)
. MetadataConfiguration (object)
} (object)
DataRepositoryAssociations (array)
fsx/create_file_systemCreates 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 oClientRequestToken (string)
FileSystemType (string) required
StorageCapacity (integer)
StorageType (string)
SubnetIds (array) required
SecurityGroupIds (array)
Tags (array)
KmsKeyId (string)
WindowsConfiguration: {
. ActiveDirectoryId (string)
. SelfManagedActiveDirectoryConfiguration (object)
. DeploymentType (string)
. PreferredSubnetId (string)
. ThroughputCapacity (integer)
. WeeklyMaintenanceStartTime (string)
. DailyAutomaticBackupStartTime (string)
. AutomaticBackupRetentionDays (integer)
. CopyTagsToBackups (boolean)
. Aliases (array)
. AuditLogConfiguration (object)
. DiskIopsConfiguration (object)
. FsrmConfiguration (object)
} (object)
LustreConfiguration: {
. WeeklyMaintenanceStartTime (string)
. ImportPath (string)
. ExportPath (string)
. ImportedFileChunkSize (integer)
. DeploymentType (string)
. AutoImportPolicy (string)
. PerUnitStorageThroughput (integer)
. DailyAutomaticBackupStartTime (string)
. AutomaticBackupRetentionDays (integer)
. CopyTagsToBackups (boolean)
. DriveCacheType (string)
. DataCompressionType (string)
. EfaEnabled (boolean)
. LogConfiguration (object)
. RootSquashConfiguration (object)
. MetadataConfiguration (object)
. ThroughputCapacity (integer)
. DataReadCacheConfiguration (object)
} (object)
OntapConfiguration: {
. AutomaticBackupRetentionDays (integer)
. DailyAutomaticBackupStartTime (string)
. DeploymentType (string)
. EndpointIpAddressRange (string)
. FsxAdminPassword (string)
. DiskIopsConfiguration (object)
. PreferredSubnetId (string)
. RouteTableIds (array)
. ThroughputCapacity (integer)
. WeeklyMaintenanceStartTime (string)
. HAPairs (integer)
. ThroughputCapacityPerHAPair (integer)
. EndpointIpv6AddressRange (string)
} (object)
FileSystemTypeVersion (string)
OpenZFSConfiguration: {
. AutomaticBackupRetentionDays (integer)
. CopyTagsToBackups (boolean)
. CopyTagsToVolumes (boolean)
. DailyAutomaticBackupStartTime (string)
. DeploymentType (string)
. ThroughputCapacity (integer)
. WeeklyMaintenanceStartTime (string)
. DiskIopsConfiguration (object)
. RootVolumeConfiguration (object)
. PreferredSubnetId (string)
. EndpointIpAddressRange (string)
. EndpointIpv6AddressRange (string)
. RouteTableIds (array)
. ReadCacheConfiguration (object)
} (object)
NetworkType (string)
fsx/create_file_system_from_backupCreates 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 doesnBackupId (string) required
ClientRequestToken (string)
SubnetIds (array) required
SecurityGroupIds (array)
Tags (array)
WindowsConfiguration: {
. ActiveDirectoryId (string)
. SelfManagedActiveDirectoryConfiguration (object)
. DeploymentType (string)
. PreferredSubnetId (string)
. ThroughputCapacity (integer)
. WeeklyMaintenanceStartTime (string)
. DailyAutomaticBackupStartTime (string)
. AutomaticBackupRetentionDays (integer)
. CopyTagsToBackups (boolean)
. Aliases (array)
. AuditLogConfiguration (object)
. DiskIopsConfiguration (object)
. FsrmConfiguration (object)
} (object)
LustreConfiguration: {
. WeeklyMaintenanceStartTime (string)
. ImportPath (string)
. ExportPath (string)
. ImportedFileChunkSize (integer)
. DeploymentType (string)
. AutoImportPolicy (string)
. PerUnitStorageThroughput (integer)
. DailyAutomaticBackupStartTime (string)
. AutomaticBackupRetentionDays (integer)
. CopyTagsToBackups (boolean)
. DriveCacheType (string)
. DataCompressionType (string)
. EfaEnabled (boolean)
. LogConfiguration (object)
. RootSquashConfiguration (object)
. MetadataConfiguration (object)
. ThroughputCapacity (integer)
. DataReadCacheConfiguration (object)
} (object)
StorageType (string)
KmsKeyId (string)
FileSystemTypeVersion (string)
OpenZFSConfiguration: {
. AutomaticBackupRetentionDays (integer)
. CopyTagsToBackups (boolean)
. CopyTagsToVolumes (boolean)
. DailyAutomaticBackupStartTime (string)
. DeploymentType (string)
. ThroughputCapacity (integer)
. WeeklyMaintenanceStartTime (string)
. DiskIopsConfiguration (object)
. RootVolumeConfiguration (object)
. PreferredSubnetId (string)
. EndpointIpAddressRange (string)
. EndpointIpv6AddressRange (string)
. RouteTableIds (array)
. ReadCacheConfiguration (object)
} (object)
StorageCapacity (integer)
NetworkType (string)
fsx/create_snapshotCreates 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 wClientRequestToken (string)
Name (string) required
VolumeId (string) required
Tags (array)
fsx/create_storage_virtual_machineCreates a storage virtual machine SVM for an Amazon FSx for ONTAP file system.ActiveDirectoryConfiguration: {
. NetBiosName (string)
. SelfManagedActiveDirectoryConfiguration (object)
} (object)
ClientRequestToken (string)
FileSystemId (string) required
Name (string) required
SvmAdminPassword (string)
Tags (array)
RootVolumeSecurityStyle (string)
fsx/create_volumeCreates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.ClientRequestToken (string)
VolumeType (string) required
Name (string) required
OntapConfiguration: {
. JunctionPath (string)
. SecurityStyle (string)
. SizeInMegabytes (integer)
. StorageEfficiencyEnabled (boolean)
. StorageVirtualMachineId (string)
. TieringPolicy (object)
. OntapVolumeType (string)
. SnapshotPolicy (string)
. CopyTagsToBackups (boolean)
. SnaplockConfiguration (object)
. VolumeStyle (string)
. AggregateConfiguration (object)
. SizeInBytes (integer)
} (object)
Tags (array)
OpenZFSConfiguration: {
. ParentVolumeId (string)
. StorageCapacityReservationGiB (integer)
. StorageCapacityQuotaGiB (integer)
. RecordSizeKiB (integer)
. DataCompressionType (string)
. CopyTagsToSnapshots (boolean)
. OriginSnapshot (object)
. ReadOnly (boolean)
. NfsExports (array)
. UserAndGroupQuotas (array)
} (object)
fsx/create_volume_from_backupCreates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.BackupId (string) required
ClientRequestToken (string)
Name (string) required
OntapConfiguration: {
. JunctionPath (string)
. SecurityStyle (string)
. SizeInMegabytes (integer)
. StorageEfficiencyEnabled (boolean)
. StorageVirtualMachineId (string)
. TieringPolicy (object)
. OntapVolumeType (string)
. SnapshotPolicy (string)
. CopyTagsToBackups (boolean)
. SnaplockConfiguration (object)
. VolumeStyle (string)
. AggregateConfiguration (object)
. SizeInBytes (integer)
} (object)
Tags (array)
fsx/delete_backupDeletes 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.BackupId (string) required
ClientRequestToken (string)
fsx/delete_data_repository_associationDeletes 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 on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.AssociationId (string) required
ClientRequestToken (string)
DeleteDataInFileSystem (boolean)
fsx/delete_file_cacheDeletes 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 byFileCacheId (string) required
ClientRequestToken (string)
fsx/delete_file_systemDeletes 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 DeleteFileSystem operation. Before deleting an Amazon FSx for OpenZFS file system, make sure that there aren't any Amazon S3 access points attached to any volume. FFileSystemId (string) required
ClientRequestToken (string)
WindowsConfiguration: {
. SkipFinalBackup (boolean)
. FinalBackupTags (array)
} (object)
LustreConfiguration: {
. SkipFinalBackup (boolean)
. FinalBackupTags (array)
} (object)
OpenZFSConfiguration: {
. SkipFinalBackup (boolean)
. FinalBackupTags (array)
. Options (array)
} (object)
fsx/delete_snapshotDeletes 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.ClientRequestToken (string)
SnapshotId (string) required
fsx/delete_storage_virtual_machineDeletes 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.ClientRequestToken (string)
StorageVirtualMachineId (string) required
fsx/delete_volumeDeletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.ClientRequestToken (string)
VolumeId (string) required
OntapConfiguration: {
. SkipFinalBackup (boolean)
. FinalBackupTags (array)
. BypassSnaplockEnterpriseRetention (boolean)
} (object)
OpenZFSConfiguration: {
. Options (array)
} (object)
fsx/describe_backupsReturns 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 tBackupIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
fsx/describe_data_repository_associationsReturns 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 on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding scratch_1 deployment type. You can use filters to narrow the response to include just data repository associations for specific file systems use the fiAssociationIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
fsx/describe_data_repository_tasksReturns 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 callinTaskIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
fsx/describe_file_cachesReturns 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 inFileCacheIds (array)
MaxResults (integer)
NextToken (string)
fsx/describe_file_system_aliasesReturns 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.ClientRequestToken (string)
FileSystemId (string) required
MaxResults (integer)
NextToken (string)
fsx/describe_file_systemsReturns 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 NFileSystemIds (array)
MaxResults (integer)
NextToken (string)
fsx/describe_s3access_point_attachmentsDescribes one or more S3 access points attached to Amazon FSx volumes. The requester requires the following permission to perform this action: fsx:DescribeS3AccessPointAttachmentsNames (array)
Filters (array)
MaxResults (integer)
NextToken (string)
fsx/describe_shared_vpc_configurationIndicates whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud VPC owner. For more information, see Creating FSx for ONTAP file systems in shared subnets.No parameters
fsx/describe_snapshotsReturns 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 latSnapshotIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
IncludeShared (boolean)
fsx/describe_storage_virtual_machinesDescribes one or more Amazon FSx for NetApp ONTAP storage virtual machines SVMs.StorageVirtualMachineIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
fsx/describe_volumesDescribes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.VolumeIds (array)
Filters (array)
MaxResults (integer)
NextToken (string)
fsx/detach_and_delete_s3access_pointDetaches an S3 access point from an Amazon FSx volume and deletes the S3 access point. The requester requires the following permission to perform this action: fsx:DetachAndDeleteS3AccessPoint s3:DeleteAccessPointClientRequestToken (string)
Name (string) required
fsx/disassociate_file_system_aliasesUse 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 an HTTP status code 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 monitorClientRequestToken (string)
FileSystemId (string) required
Aliases (array) required
fsx/list_tags_for_resourceLists 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. ThResourceARN (string) required
MaxResults (integer)
NextToken (string)
fsx/release_file_system_nfs_v3locksReleases the file system lock from an Amazon FSx for OpenZFS file system.FileSystemId (string) required
ClientRequestToken (string)
fsx/restore_volume_from_snapshotReturns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.ClientRequestToken (string)
VolumeId (string) required
SnapshotId (string) required
Options (array)
fsx/start_misconfigured_state_recoveryAfter performing steps to repair the Active Directory configuration of an FSx for Windows File Server file system, use this action to initiate the process of Amazon FSx attempting to reconnect to the file system.ClientRequestToken (string)
FileSystemId (string) required
fsx/tag_resourceTags an Amazon FSx resource.ResourceARN (string) required
Tags (array) required
fsx/untag_resourceThis action removes a tag from an Amazon FSx resource.ResourceARN (string) required
TagKeys (array) required
fsx/update_data_repository_associationUpdates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.AssociationId (string) required
ClientRequestToken (string)
ImportedFileChunkSize (integer)
S3: {
. AutoImportPolicy (object)
. AutoExportPolicy (object)
} (object)
fsx/update_file_cacheUpdates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.FileCacheId (string) required
ClientRequestToken (string)
LustreConfiguration: {
. WeeklyMaintenanceStartTime (string)
} (object)
fsx/update_file_systemUse this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request. For FSx for Windows File Server file systems, you can update the following properties: AuditLogConfiguration AutomaticBackupRetentionDays DailyAutomaticBackupStartTime DiskIopsConfiguration SelfManagedActiveDirectoryConfiguration StorageCapacity StorageType ThroughputCapacity WeeklyMaintenanceStartTime For FSx for Lustre file systems, you can update the foFileSystemId (string) required
ClientRequestToken (string)
StorageCapacity (integer)
WindowsConfiguration: {
. WeeklyMaintenanceStartTime (string)
. DailyAutomaticBackupStartTime (string)
. AutomaticBackupRetentionDays (integer)
. ThroughputCapacity (integer)
. SelfManagedActiveDirectoryConfiguration (object)
. AuditLogConfiguration (object)
. DiskIopsConfiguration (object)
. FsrmConfiguration (object)
} (object)
LustreConfiguration: {
. WeeklyMaintenanceStartTime (string)
. DailyAutomaticBackupStartTime (string)
. AutomaticBackupRetentionDays (integer)
. AutoImportPolicy (string)
. DataCompressionType (string)
. LogConfiguration (object)
. RootSquashConfiguration (object)
. PerUnitStorageThroughput (integer)
. MetadataConfiguration (object)
. ThroughputCapacity (integer)
. DataReadCacheConfiguration (object)
} (object)
OntapConfiguration: {
. AutomaticBackupRetentionDays (integer)
. DailyAutomaticBackupStartTime (string)
. FsxAdminPassword (string)
. WeeklyMaintenanceStartTime (string)
. DiskIopsConfiguration (object)
. ThroughputCapacity (integer)
. AddRouteTableIds (array)
. RemoveRouteTableIds (array)
. ThroughputCapacityPerHAPair (integer)
. HAPairs (integer)
. EndpointIpv6AddressRange (string)
} (object)
OpenZFSConfiguration: {
. AutomaticBackupRetentionDays (integer)
. CopyTagsToBackups (boolean)
. CopyTagsToVolumes (boolean)
. DailyAutomaticBackupStartTime (string)
. ThroughputCapacity (integer)
. WeeklyMaintenanceStartTime (string)
. DiskIopsConfiguration (object)
. AddRouteTableIds (array)
. RemoveRouteTableIds (array)
. ReadCacheConfiguration (object)
. EndpointIpv6AddressRange (string)
} (object)
StorageType (string)
FileSystemTypeVersion (string)
NetworkType (string)
fsx/update_shared_vpc_configurationConfigures whether participant accounts in your organization can create Amazon FSx for NetApp ONTAP Multi-AZ file systems in subnets that are shared by a virtual private cloud VPC owner. For more information, see the Amazon FSx for NetApp ONTAP User Guide. We strongly recommend that participant-created Multi-AZ file systems in the shared VPC are deleted before you disable this feature. Once the feature is disabled, these file systems will enter a MISCONFIGURED state and behave like Single-AZ filEnableFsxRouteTableUpdatesFromParticipantAccounts (string)
ClientRequestToken (string)
fsx/update_snapshotUpdates the name of an Amazon FSx for OpenZFS snapshot.ClientRequestToken (string)
Name (string) required
SnapshotId (string) required
fsx/update_storage_virtual_machineUpdates an FSx for ONTAP storage virtual machine SVM.ActiveDirectoryConfiguration: {
. SelfManagedActiveDirectoryConfiguration (object)
. NetBiosName (string)
} (object)
ClientRequestToken (string)
StorageVirtualMachineId (string) required
SvmAdminPassword (string)
fsx/update_volumeUpdates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.ClientRequestToken (string)
VolumeId (string) required
OntapConfiguration: {
. JunctionPath (string)
. SecurityStyle (string)
. SizeInMegabytes (integer)
. StorageEfficiencyEnabled (boolean)
. TieringPolicy (object)
. SnapshotPolicy (string)
. CopyTagsToBackups (boolean)
. SnaplockConfiguration (object)
. SizeInBytes (integer)
} (object)
Name (string)
OpenZFSConfiguration: {
. StorageCapacityReservationGiB (integer)
. StorageCapacityQuotaGiB (integer)
. RecordSizeKiB (integer)
. DataCompressionType (string)
. NfsExports (array)
. UserAndGroupQuotas (array)
. ReadOnly (boolean)
} (object)
gamelift/accept_matchThis API works with the following fleet types: EC2, Anywhere, Container 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 triTicketId (string) required
PlayerIds (array) required
AcceptanceType (string) required
gamelift/claim_game_serverThis API works with the following fleet types: EC2 FleetIQ 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, Amazon GameLift Servers 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 cGameServerGroupName (string) required
GameServerId (string)
GameServerData (string)
FilterOption: {
. InstanceStatuses (array)
} (object)
gamelift/create_aliasThis API works with the following fleet types: EC2, Anywhere, Container 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 Servers supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is useName (string) required
Description (string)
RoutingStrategy: {
. Type (string)
. FleetId (string)
. Message (string)
} (object) required
Tags (array)
gamelift/create_buildThis API works with the following fleet types: EC2, Anywhere Creates a new Amazon GameLift Servers build resource for your game server binary files. Combine game server binaries into a zip file for use with Amazon GameLift Servers. When setting up a new game build for Amazon GameLift Servers, we recommend using the CLI command upload-build . This helper command combines two tasks: 1 it uploads your build files from a file directory to an Amazon GameLift Servers Amazon S3 location, and 2 it creatName (string)
Version (string)
StorageLocation: {
. Bucket (string)
. Key (string)
. RoleArn (string)
. ObjectVersion (string)
} (object)
OperatingSystem (string)
Tags (array)
ServerSdkVersion (string)
gamelift/create_container_fleetThis API works with the following fleet types: Container Creates a managed fleet of Amazon Elastic Compute Cloud Amazon EC2 instances to host your containerized game servers. Use this operation to define how to deploy a container architecture onto each fleet instance and configure fleet settings. You can create a container fleet in any Amazon Web Services Regions that Amazon GameLift Servers supports for multi-location fleets. A container fleet can be deployed to a single location or multiple loFleetRoleArn (string) required
Description (string)
GameServerContainerGroupDefinitionName (string)
PerInstanceContainerGroupDefinitionName (string)
InstanceConnectionPortRange: {
. FromPort (integer)
. ToPort (integer)
} (object)
InstanceInboundPermissions (array)
GameServerContainerGroupsPerInstance (integer)
InstanceType (string)
BillingType (string)
Locations (array)
MetricGroups (array)
NewGameSessionProtectionPolicy (string)
GameSessionCreationLimitPolicy: {
. NewGameSessionsPerCreator (integer)
. PolicyPeriodInMinutes (integer)
} (object)
LogConfiguration: {
. LogDestination (string)
. S3BucketName (string)
. LogGroupArn (string)
} (object)
Tags (array)
gamelift/create_container_group_definitionThis API works with the following fleet types: Container Creates a ContainerGroupDefinition that describes a set of containers for hosting your game server with Amazon GameLift Servers managed containers hosting. An Amazon GameLift Servers container group is similar to a container task or pod. Use container group definitions when you create a container fleet with CreateContainerFleet. A container group definition determines how Amazon GameLift Servers deploys your containers to each instance inName (string) required
ContainerGroupType (string)
TotalMemoryLimitMebibytes (integer) required
TotalVcpuLimit (number) required
GameServerContainerDefinition: {
. ContainerName (string)
. DependsOn (array)
. MountPoints (array)
. EnvironmentOverride (array)
. ImageUri (string)
. PortConfiguration (object)
. ServerSdkVersion (string)
} (object)
SupportContainerDefinitions (array)
OperatingSystem (string) required
VersionDescription (string)
Tags (array)
gamelift/create_fleetThis API works with the following fleet types: EC2, Anywhere, Container Creates a fleet of compute resources to host your game servers. Use this operation to set up a fleet for the following compute types: Managed EC2 fleet An EC2 fleet is a set of Amazon Elastic Compute Cloud Amazon EC2 instances. Your game server build is deployed to each fleet instance. Amazon GameLift Servers manages the fleet's instances and controls the lifecycle of game server processes, which host game sessions for playeName (string) required
Description (string)
BuildId (string)
ScriptId (string)
ServerLaunchPath (string)
ServerLaunchParameters (string)
LogPaths (array)
EC2InstanceType (string)
EC2InboundPermissions (array)
NewGameSessionProtectionPolicy (string)
RuntimeConfiguration: {
. ServerProcesses (array)
. MaxConcurrentGameSessionActivations (integer)
. GameSessionActivationTimeoutSeconds (integer)
} (object)
ResourceCreationLimitPolicy: {
. NewGameSessionsPerCreator (integer)
. PolicyPeriodInMinutes (integer)
} (object)
MetricGroups (array)
PeerVpcAwsAccountId (string)
PeerVpcId (string)
FleetType (string)
InstanceRoleArn (string)
CertificateConfiguration: {
. CertificateType (string)
} (object)
Locations (array)
Tags (array)
ComputeType (string)
AnywhereConfiguration: {
. Cost (string)
} (object)
InstanceRoleCredentialsProvider (string)
gamelift/create_fleet_locationsThis API works with the following fleet types: EC2, Container Adds remote locations to an EC2 and begins populating the new locations with instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings. You can't add remote locations to a fleet that resides in an Amazon Web Services Region that doesn't support multiple locations. Fleets created prior to March 2021 can't support multiple locations. To add fleet locations, specify the fleet to beFleetId (string) required
Locations (array) required
gamelift/create_game_server_groupThis API works with the following fleet types: EC2 FleetIQ Creates a Amazon GameLift Servers 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 Amazon GameLift Servers console. Game server group metrics anGameServerGroupName (string) required
RoleArn (string) required
MinSize (integer) required
MaxSize (integer) required
LaunchTemplate: {
. LaunchTemplateId (string)
. LaunchTemplateName (string)
. Version (string)
} (object) required
InstanceDefinitions (array) required
AutoScalingPolicy: {
. EstimatedInstanceWarmup (integer)
. TargetTrackingConfiguration (object)
} (object)
BalancingStrategy (string)
GameServerProtectionPolicy (string)
VpcSubnets (array)
Tags (array)
gamelift/create_game_sessionThis API works with the following fleet types: EC2, Anywhere, Container 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 Amazon GameLift Servers game session placement feature with StartGameSessionPlacement, which uses the FleetIQ algorithm and queues to optimize the placement process. When creaFleetId (string)
AliasId (string)
MaximumPlayerSessionCount (integer) required
Name (string)
GameProperties (array)
CreatorId (string)
GameSessionId (string)
IdempotencyToken (string)
GameSessionData (string)
Location (string)
gamelift/create_game_session_queueThis API works with the following fleet types: EC2, Anywhere, Container Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to locate the best available placement locations for a new game session, and then prompts the game server process to start a new game session. A game session queue is configured with a set of destinations Amazon GameLift Servers fleets or aliases that determine where the queue can place new game sessions. These destinatioName (string) required
TimeoutInSeconds (integer)
PlayerLatencyPolicies (array)
Destinations (array)
FilterConfiguration: {
. AllowedLocations (array)
} (object)
PriorityConfiguration: {
. PriorityOrder (array)
. LocationOrder (array)
} (object)
CustomEventData (string)
NotificationTarget (string)
Tags (array)
gamelift/create_locationThis API works with the following fleet types: Anywhere Creates a custom location for use in an Anywhere fleet.LocationName (string) required
Tags (array)
gamelift/create_matchmaking_configurationThis API works with the following fleet types: EC2, Anywhere, Container Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with Amazon GameLift Servers hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using Amazon GameLift Servers hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to haName (string) required
Description (string)
GameSessionQueueArns (array)
RequestTimeoutSeconds (integer) required
AcceptanceTimeoutSeconds (integer)
AcceptanceRequired (boolean) required
RuleSetName (string) required
NotificationTarget (string)
AdditionalPlayerCount (integer)
CustomEventData (string)
GameProperties (array)
GameSessionData (string)
BackfillMode (string)
FlexMatchMode (string)
Tags (array)
gamelift/create_matchmaking_rule_setThis API works with the following fleet types: EC2, Anywhere, Container 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. 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 theyName (string) required
RuleSetBody (string) required
Tags (array)
gamelift/create_player_sessionThis API works with the following fleet types: EC2, Anywhere, Container 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 theGameSessionId (string) required
PlayerId (string) required
PlayerData (string)
gamelift/create_player_sessionsThis API works with the following fleet types: EC2, Anywhere, Container 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,GameSessionId (string) required
PlayerIds (array) required
PlayerDataMap (object)
gamelift/create_scriptThis API works with the following fleet types: EC2, Anywhere Creates a new script record for your Amazon GameLift Servers Realtime 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 Amazon GameLift Servers Realtime 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 files.Name (string)
Version (string)
StorageLocation: {
. Bucket (string)
. Key (string)
. RoleArn (string)
. ObjectVersion (string)
} (object)
ZipFile (string)
Tags (array)
NodeJsVersion (string)
gamelift/create_vpc_peering_authorizationThis API works with the following fleet types: EC2 Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift Servers 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. After you've received authorization, use CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering withGameLiftAwsAccountId (string) required
PeerVpcId (string) required
gamelift/create_vpc_peering_connectionThis API works with the following fleet types: EC2 Establishes a VPC peering connection between a virtual private cloud VPC in an Amazon Web Services account with the VPC for your Amazon GameLift Servers 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 Servers fleets. You canFleetId (string) required
PeerVpcAwsAccountId (string) required
PeerVpcId (string) required
gamelift/delete_aliasThis API works with the following fleet types: EC2, Anywhere, Container 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 All APIs by taskAliasId (string) required
gamelift/delete_buildThis API works with the following fleet types: EC2 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 All APIs by taskBuildId (string) required
gamelift/delete_container_fleetThis API works with the following fleet types: Container Deletes all resources and information related to a container fleet and shuts down currently running fleet instances, including those in remote locations. The container fleet must be in ACTIVE status to be deleted. To delete a fleet, specify the fleet ID to be terminated. During the deletion process, the fleet status is changed to DELETING. Learn more Setting up Amazon GameLift Servers FleetsFleetId (string) required
gamelift/delete_container_group_definitionThis API works with the following fleet types: Container Request options: Deletes a container group definition. Delete an entire container group definition, including all versions. Specify the container group definition name, or use an ARN value without the version number. Delete a particular version. Specify the container group definition name and a version number, or use an ARN value that includes the version number. Keep the newest versions and delete all older versions. Specify the containerName (string) required
VersionNumber (integer)
VersionCountToRetain (integer)
gamelift/delete_fleetThis API works with the following fleet types: EC2, Anywhere, Container Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations. 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 don't need to explicitly delete the VPC peering connection. To delete a fleet, specify the fleet ID to be terminateFleetId (string) required
gamelift/delete_fleet_locationsThis API works with the following fleet types: EC2, Container 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. WhFleetId (string) required
Locations (array) required
gamelift/delete_game_server_groupThis API works with the following fleet types: EC2 FleetIQ 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 theGameServerGroupName (string) required
DeleteOption (string)
gamelift/delete_game_session_queueThis API works with the following fleet types: EC2, Anywhere, Container 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.Name (string) required
gamelift/delete_locationThis API works with the following fleet types: Anywhere Deletes a custom location. Before deleting a custom location, review any fleets currently using the custom location and deregister the location if it is in use. For more information, see DeregisterCompute.LocationName (string) required
gamelift/delete_matchmaking_configurationThis API works with the following fleet types: EC2, Anywhere, Container 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.Name (string) required
gamelift/delete_matchmaking_rule_setThis API works with the following fleet types: EC2, Anywhere, Container 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 setName (string) required
gamelift/delete_scaling_policyThis API works with the following fleet types: EC2 Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and Amazon GameLift Servers 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, use StopFleetActions. This operation suspends all policies for the fleet.Name (string) required
FleetId (string) required
gamelift/delete_scriptThis API works with the following fleet types: EC2 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 goScriptId (string) required
gamelift/delete_vpc_peering_authorizationThis API works with the following fleet types: EC2 Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection. Related actions All APIs by taskGameLiftAwsAccountId (string) required
PeerVpcId (string) required
gamelift/delete_vpc_peering_connectionThis API works with the following fleet types: EC2 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.. Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift Servers fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed. Related actions All APIs by taskFleetId (string) required
VpcPeeringConnectionId (string) required
gamelift/deregister_computeThis API works with the following fleet types: Anywhere Removes a compute resource from an Anywhere fleet. Deregistered computes can no longer host game sessions through Amazon GameLift Servers. Use this operation with an Anywhere fleet that doesn't use the Amazon GameLift Servers Agent For Anywhere fleets with the Agent, the Agent handles all compute registry tasks for you. To deregister a compute, call this operation from the compute that's being deregistered and specify the compute name and tFleetId (string) required
ComputeName (string) required
gamelift/deregister_game_serverThis API works with the following fleet types: EC2 FleetIQ 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 Amazon GameLift Servers FleetIQ GuideGameServerGroupName (string) required
GameServerId (string) required
gamelift/describe_aliasThis API works with the following fleet types: EC2, Anywhere, Container 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 All APIs by taskAliasId (string) required
gamelift/describe_buildThis API works with the following fleet types: EC2 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 All APIs by taskBuildId (string) required
gamelift/describe_computeThis API works with the following fleet types: EC2, Anywhere, Container Retrieves properties for a specific compute resource in an Amazon GameLift Servers fleet. You can list all computes in a fleet by calling ListCompute. Request options Provide the fleet ID and compute name. The compute name varies depending on the type of fleet. For a compute in a managed EC2 fleet, provide an instance ID. Each instance in the fleet is a compute. For a compute in a managed container fleet, provide a compute nFleetId (string) required
ComputeName (string) required
gamelift/describe_container_fleetThis API works with the following fleet types: Container Retrieves the properties for a container fleet. When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. Request options Get container fleet properties for a single fleet. Provide either the fleet ID or ARN value. Results If successful, a ContainerFleet object is returned. This object includes the fleet properties, including information about the most recent deployment.FleetId (string) required
gamelift/describe_container_group_definitionThis API works with the following fleet types: Container Retrieves the properties of a container group definition, including all container definitions in the group. Request options: Retrieve the latest version of a container group definition. Specify the container group definition name only, or use an ARN value without a version number. Retrieve a particular version. Specify the container group definition name and a version number, or use an ARN value that includes the version number. Results: IName (string) required
VersionNumber (integer)
gamelift/describe_ec2instance_limitsThis API works with the following fleet types: EC2 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 yoEC2InstanceType (string)
Location (string)
gamelift/describe_fleet_attributesThis API works with the following fleet types: EC2, Anywhere, Container Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing hardware and deployment configuration for instances in the fleet. You can use this operation in the following ways: To get attributes for 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 fleetsFleetIds (array)
Limit (integer)
NextToken (string)
gamelift/describe_fleet_capacityThis API works with the following fleet types: EC2, Container Retrieves the resource capacity settings for one or more fleets. For a container fleet, this operation also returns counts for game server container groups. With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html. This operation can be used in the following wFleetIds (array)
Limit (integer)
NextToken (string)
gamelift/describe_fleet_deploymentThis API works with the following fleet types: Container Retrieves information about a managed container fleet deployment. Request options Get information about the latest deployment for a specific fleet. Provide the fleet ID or ARN. Get information about a specific deployment. Provide the fleet ID or ARN and the deployment ID. Results If successful, a FleetDeployment object is returned.FleetId (string) required
DeploymentId (string)
gamelift/describe_fleet_eventsThis API works with the following fleet types: EC2, Anywhere, Container 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 successfuFleetId (string) required
StartTime (string)
EndTime (string)
Limit (integer)
NextToken (string)
gamelift/describe_fleet_location_attributesThis API works with the following fleet types: EC2, Container 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 requeFleetId (string) required
Locations (array)
Limit (integer)
NextToken (string)
gamelift/describe_fleet_location_capacityThis API works with the following fleet types: EC2, Container 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. For a managed container fleet, this operation also returns counts for game server container groups. Use this operation to retrieve capacity information for a fleet's remote location or home Region you can also retrieve home Region capacity byFleetId (string) required
Location (string) required
gamelift/describe_fleet_location_utilizationThis API works with the following fleet types: EC2, Anywhere, Container 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 obFleetId (string) required
Location (string) required
gamelift/describe_fleet_port_settingsThis API works with the following fleet types: EC2, Container Retrieves a fleet's inbound connection permissions. Connection permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range. Use this operation in the following ways: To retrieve the port settings for a fleet, identify the fleet's unique identifier. To check the status of recentFleetId (string) required
Location (string)
gamelift/describe_fleet_utilizationThis API works with the following fleet types: EC2, Container 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 orFleetIds (array)
Limit (integer)
NextToken (string)
gamelift/describe_game_serverThis API works with the following fleet types: EC2 FleetIQ 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 Amazon GameLift Servers FleetIQ GuideGameServerGroupName (string) required
GameServerId (string) required
gamelift/describe_game_server_groupThis API works with the following fleet types: EC2 FleetIQ Retrieves information on a game server group. This operation returns only properties related to Amazon GameLift Servers 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 isGameServerGroupName (string) required
gamelift/describe_game_server_instancesThis API works with the following fleet types: EC2 FleetIQ Retrieves status information about the Amazon EC2 instances associated with a Amazon GameLift Servers FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers. 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 paGameServerGroupName (string) required
InstanceIds (array)
Limit (integer)
NextToken (string)
gamelift/describe_game_session_detailsThis API works with the following fleet types: EC2, Anywhere, Container 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. 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 optionaFleetId (string)
GameSessionId (string)
AliasId (string)
Location (string)
StatusFilter (string)
Limit (integer)
NextToken (string)
gamelift/describe_game_session_placementThis API works with the following fleet types: EC2, Anywhere, Container 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 an Amazon Simple Notification Service SNS topic to receive notifications from FlePlacementId (string) required
gamelift/describe_game_session_queuesThis API works with the following fleet types: EC2, Anywhere, Container 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. When specifying a list of queues, objects are returned only for queues that currently exist in the Region. Learn more View Your QueuesNames (array)
Limit (integer)
NextToken (string)
gamelift/describe_game_sessionsThis API works with the following fleet types: EC2, Anywhere, Container 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. 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 locaFleetId (string)
GameSessionId (string)
AliasId (string)
Location (string)
StatusFilter (string)
Limit (integer)
NextToken (string)
gamelift/describe_instancesThis API works with the following fleet types: EC2 Retrieves information about the EC2 instances in an Amazon GameLift Servers managed fleet, including instance ID, connection data, and status. You can use this operation with a multi-location fleet to get location-specific instance information. As an alternative, use the operations https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute and https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeCompute to retrieveFleetId (string) required
InstanceId (string)
Limit (integer)
NextToken (string)
Location (string)
gamelift/describe_matchmakingThis API works with the following fleet types: EC2, Anywhere, Container 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 calledTicketIds (array) required
gamelift/describe_matchmaking_configurationsThis API works with the following fleet types: EC2, Anywhere, Container 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 eNames (array)
RuleSetName (string)
Limit (integer)
NextToken (string)
gamelift/describe_matchmaking_rule_setsThis API works with the following fleet types: EC2, Anywhere, Container 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 setNames (array)
Limit (integer)
NextToken (string)
gamelift/describe_player_sessionsThis API works with the following fleet types: EC2, Anywhere, Container 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 plGameSessionId (string)
PlayerId (string)
PlayerSessionId (string)
PlayerSessionStatusFilter (string)
Limit (integer)
NextToken (string)
gamelift/describe_runtime_configurationThis API works with the following fleet types: EC2 Retrieves a fleet's runtime configuration settings. The runtime configuration determines which server processes run, and how, on computes in the fleet. For managed EC2 fleets, the runtime configuration describes server processes that run on each fleet instance. You can update a fleet's runtime configuration at any time using UpdateRuntimeConfiguration. To get the current runtime configuration for a fleet, provide the fleet ID. If successful, a RFleetId (string) required
gamelift/describe_scaling_policiesThis API works with the following fleet types: EC2 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. This operation does not affect the staFleetId (string) required
StatusFilter (string)
Limit (integer)
NextToken (string)
Location (string)
gamelift/describe_scriptThis API works with the following fleet types: EC2 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 Servers Amazon GameLift Servers Realtime Related actions All APIs by taskScriptId (string) required
gamelift/describe_vpc_peering_authorizationsThis API works with the following fleet types: EC2 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 All APIs by taskNo parameters
gamelift/describe_vpc_peering_connectionsThis API works with the following fleet types: EC2 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 Servers fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pendinFleetId (string)
gamelift/get_compute_accessThis API works with the following fleet types: EC2, Container Requests authorization to remotely connect to a hosting resource in a Amazon GameLift Servers managed fleet. This operation is not used with Amazon GameLift Servers Anywhere fleets. Request options Provide the fleet ID and compute name. The compute name varies depending on the type of fleet. For a compute in a managed EC2 fleet, provide an instance ID. Each instance in the fleet is a compute. For a compute in a managed container fleetFleetId (string) required
ComputeName (string) required
gamelift/get_compute_auth_tokenThis API works with the following fleet types: EC2, Anywhere, Container Requests an authentication token from Amazon GameLift Servers for a compute resource in an Amazon GameLift Servers fleet. Game servers that are running on the compute use this token to communicate with the Amazon GameLift Servers service, such as when calling the Amazon GameLift Servers server SDK action InitSDK. Authentication tokens are valid for a limited time span, so you need to request a fresh token before the currentFleetId (string) required
ComputeName (string) required
gamelift/get_game_session_log_urlThis API works with the following fleet types: EC2 Retrieves the location of stored game session logs for a specified game session on Amazon GameLift Servers managed fleets. When a game session is terminated, Amazon GameLift Servers 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. All APIs by taskGameSessionId (string) required
gamelift/get_instance_accessThis API works with the following fleet types: EC2 Requests authorization to remotely connect to an instance in an Amazon GameLift Servers managed fleet. Use this operation to connect to instances with game servers that use Amazon GameLift Servers server SDK 4.x or earlier. To connect to instances with game servers that use server SDK 5.x or later, call https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetComputeAccess. To request access to an instance, specify IDs for the instance anFleetId (string) required
InstanceId (string) required
gamelift/list_aliasesThis API works with the following fleet types: EC2, Anywhere, Container 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 All APIs by taskRoutingStrategyType (string)
Name (string)
Limit (integer)
NextToken (string)
gamelift/list_buildsThis API works with the following fleet types: EC2 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 Build resources are not listed in any particular order. Learn more Upload a Custom Server Build All APIs by taskStatus (string)
Limit (integer)
NextToken (string)
gamelift/list_computeThis API works with the following fleet types: EC2, Anywhere, Container Retrieves information on the compute resources in an Amazon GameLift Servers fleet. Use the pagination parameters to retrieve results in a set of sequential pages. Request options Retrieve a list of all computes in a fleet. Specify a fleet ID. Retrieve a list of all computes in a specific fleet location. Specify a fleet ID and location. Results If successful, this operation returns information on a set of computes. DependingFleetId (string) required
Location (string)
ContainerGroupDefinitionName (string)
ComputeStatus (string)
Limit (integer)
NextToken (string)
gamelift/list_container_fleetsThis API works with the following fleet types: Container Retrieves a collection of container fleet resources in an Amazon Web Services Region. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only. Request options Get a list of all fleets. Call this operation without specifying a container group definition. Get a list of fleets filtered by container group definition. Provide the container group definition name or ARN value. To get a list of allContainerGroupDefinitionName (string)
Limit (integer)
NextToken (string)
gamelift/list_container_group_definitionsThis API works with the following fleet types: Container Retrieves container group definitions for the Amazon Web Services account and Amazon Web Services Region. Use the pagination parameters to retrieve results in a set of sequential pages. This operation returns only the latest version of each definition. To retrieve all versions of a container group definition, use ListContainerGroupDefinitionVersions. Request options: Retrieve the most recent versions of all container group definitions. RetContainerGroupType (string)
Limit (integer)
NextToken (string)
gamelift/list_container_group_definition_versionsThis API works with the following fleet types: Container Retrieves all versions of a container group definition. Use the pagination parameters to retrieve results in a set of sequential pages. Request options: Get all versions of a specified container group definition. Specify the container group definition name or ARN value. If the ARN value has a version number, it's ignored. Results: If successful, this operation returns the complete properties of a set of container group definition versionsName (string) required
Limit (integer)
NextToken (string)
gamelift/list_fleet_deploymentsThis API works with the following fleet types: Container Retrieves a collection of container fleet deployments in an Amazon Web Services Region. Use the pagination parameters to retrieve results as a set of sequential pages. Request options Get a list of all deployments. Call this operation without specifying a fleet ID. Get a list of all deployments for a fleet. Specify the container fleet ID or ARN value. Results If successful, this operation returns a list of deployments that match the requesFleetId (string)
Limit (integer)
NextToken (string)
gamelift/list_fleetsThis API works with the following fleet types: EC2, Anywhere, Container Retrieves a collection of fleet resources in an Amazon Web Services Region. 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. You can use operation in the following ways: To get a list of all fleets in a Region, don't provide a build or script identifier. To get aBuildId (string)
ScriptId (string)
Limit (integer)
NextToken (string)
gamelift/list_game_server_groupsThis API works with the following fleet types: EC2 FleetIQ Lists a game server groups.Limit (integer)
NextToken (string)
gamelift/list_game_serversThis API works with the following fleet types: EC2 FleetIQ 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 Amazon GameLift Servers FleetIQ GuideGameServerGroupName (string) required
SortOrder (string)
Limit (integer)
NextToken (string)
gamelift/list_locationsThis API works with the following fleet types: Anywhere Lists all custom and Amazon Web Services locations where Amazon GameLift Servers can host game servers. Note that if you call this API using a location that doesn't have a service endpoint, such as one that can only be a remote location in a multi-location fleet, the API returns an error. Consult the table of supported locations in Amazon GameLift Servers service locations to identify home Regions that support single and multi-location fleeFilters (array)
Limit (integer)
NextToken (string)
gamelift/list_scriptsThis API works with the following fleet types: EC2 Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use. Learn more Amazon GameLift Servers Amazon GameLift Servers Realtime Related actions All APIs by taskLimit (integer)
NextToken (string)
gamelift/list_tags_for_resourceThis API works with the following fleet types: EC2, Anywhere, Container Retrieves all tags assigned to a Amazon GameLift Servers resource. Use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift Servers resources that support tagging. 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 ServicesResourceARN (string) required
gamelift/put_scaling_policyThis API works with the following fleet types: EC2 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 Servers 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 fleetName (string) required
FleetId (string) required
ScalingAdjustment (integer)
ScalingAdjustmentType (string)
Threshold (number)
ComparisonOperator (string)
EvaluationPeriods (integer)
MetricName (string) required
PolicyType (string)
TargetConfiguration: {
. TargetValue (number)
} (object)
gamelift/register_computeThis API works with the following fleet types: Anywhere, Container Registers a compute resource in an Amazon GameLift Servers Anywhere fleet. For an Anywhere fleet that's running the Amazon GameLift Servers Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to register fleet computes. To register a compute, give the compute a name must be unique within the fleet and specify the compute resource's DNS name or IP addreFleetId (string) required
ComputeName (string) required
CertificatePath (string)
DnsName (string)
IpAddress (string)
Location (string)
gamelift/register_game_serverThis API works with the following fleet types: EC2 FleetIQ Creates a new game server resource and notifies Amazon GameLift Servers 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 Amazon GameLift Servers FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session. To register aGameServerGroupName (string) required
GameServerId (string) required
InstanceId (string) required
ConnectionInfo (string)
GameServerData (string)
gamelift/request_upload_credentialsThis API works with the following fleet types: EC2 Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift Servers'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 FiBuildId (string) required
gamelift/resolve_aliasThis API works with the following fleet types: EC2, Anywhere, Container Attempts to retrieve a fleet ID that is associated with an alias. Specify a unique alias identifier. If the alias has a SIMPLE routing strategy, Amazon GameLift Servers returns a fleet ID. If the alias has a TERMINAL routing strategy, the result is a TerminalRoutingStrategyException. Related actions All APIs by taskAliasId (string) required
gamelift/resume_game_server_groupThis API works with the following fleet types: EC2 FleetIQ Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by the SuspendGameServerGroup 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 isGameServerGroupName (string) required
ResumeActions (array) required
gamelift/search_game_sessionsThis API works with the following fleet types: EC2, Anywhere, Container 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 continually track game session status because that practice can cause you to exceed your API limit and generate errors. Instead, configure an Amazon Simple Notification Service Amazon SNS topic to receive notifications from a matchmaker or a game session placement queue. When searchiFleetId (string)
AliasId (string)
Location (string)
FilterExpression (string)
SortExpression (string)
Limit (integer)
NextToken (string)
gamelift/start_fleet_actionsThis API works with the following fleet types: EC2, Container 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 actionFleetId (string) required
Actions (array) required
Location (string)
gamelift/start_game_session_placementThis API works with the following fleet types: EC2, Anywhere, Container Makes a request to start a new game session using a game session queue. When processing a placement request, Amazon GameLift Servers looks for the best possible available resource to host the game session, based on how the queue is configured to prioritize factors such as resource cost, latency, and location. After selecting an available resource, Amazon GameLift Servers prompts the resource to start a game session. A placemPlacementId (string) required
GameSessionQueueName (string) required
GameProperties (array)
MaximumPlayerSessionCount (integer) required
GameSessionName (string)
PlayerLatencies (array)
DesiredPlayerSessions (array)
GameSessionData (string)
PriorityConfigurationOverride: {
. PlacementFallbackStrategy (string)
. LocationOrder (array)
} (object)
gamelift/start_match_backfillThis API works with the following fleet types: EC2, Anywhere, Container 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 thTicketId (string)
ConfigurationName (string) required
GameSessionArn (string)
Players (array) required
gamelift/start_matchmakingThis API works with the following fleet types: EC2, Anywhere, Container Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use Amazon GameLift Servers managed hosting, this operation also triggers Amazon GameLift Servers 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 multipTicketId (string)
ConfigurationName (string) required
Players (array) required
gamelift/stop_fleet_actionsThis API works with the following fleet types: EC2, Container 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,FleetId (string) required
Actions (array) required
Location (string)
gamelift/stop_game_session_placementThis API works with the following fleet types: EC2, Anywhere, Container Cancels a game session placement that's in PENDING status. To stop a placement, provide the placement ID value. Results If successful, this operation removes the placement request from the queue and moves the GameSessionPlacement to CANCELLED status. This operation results in an InvalidRequestExecption 400 error if a game session has already been created for this placement. You can clean up an unneeded game session by callinPlacementId (string) required
gamelift/stop_matchmakingThis API works with the following fleet types: EC2, Anywhere, Container 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 backfilTicketId (string) required
gamelift/suspend_game_server_groupThis API works with the following fleet types: EC2 FleetIQ 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, whiGameServerGroupName (string) required
SuspendActions (array) required
gamelift/tag_resourceThis API works with the following fleet types: EC2, Anywhere, Container Assigns a tag to an Amazon GameLift Servers resource. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, and more. This operation handles the permissions necessary to manage tags for Amazon GameLift Servers resources that support tagging. To add a tag to a resource, specify the unique ARN value for the resource and prResourceARN (string) required
Tags (array) required
gamelift/terminate_game_sessionThis API works with the following fleet types: EC2, Anywhere, Container Ends a game session that's currently in progress. Use this action to terminate any game session that isn't in ERROR status. Terminating a game session is the most efficient way to free up a server process when it's hosting a game session that's in a bad state or not ending properly. You can use this action to terminate a game session that's being hosted on any type of Amazon GameLift Servers fleet compute, including computesGameSessionId (string) required
TerminationMode (string) required
gamelift/untag_resourceThis API works with the following fleet types: EC2, Anywhere, Container Removes a tag assigned to a Amazon GameLift Servers resource. You can use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift Servers resources that support tagging. 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 remove. ThisResourceARN (string) required
TagKeys (array) required
gamelift/update_aliasThis API works with the following fleet types: EC2, Anywhere, Container Updates properties for an alias. Specify the unique identifier of the alias to be updated and the new property values. When reassigning an alias to a new fleet, provide an updated routing strategy. If successful, the updated alias record is returned. Related actions All APIs by taskAliasId (string) required
Name (string)
Description (string)
RoutingStrategy: {
. Type (string)
. FleetId (string)
. Message (string)
} (object)
gamelift/update_buildThis API works with the following fleet types: EC2 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 All APIs by taskBuildId (string) required
Name (string)
Version (string)
gamelift/update_container_fleetThis API works with the following fleet types: Container Updates the properties of a managed container fleet. Depending on the properties being updated, this operation might initiate a fleet deployment. You can track deployments for a fleet using https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetDeployment.html. A managed fleet's runtime environment, which depends on the fleet's Amazon Machine Image AMI version, can't be updated. You must create a new fleet. As a best praFleetId (string) required
GameServerContainerGroupDefinitionName (string)
PerInstanceContainerGroupDefinitionName (string)
GameServerContainerGroupsPerInstance (integer)
InstanceConnectionPortRange: {
. FromPort (integer)
. ToPort (integer)
} (object)
InstanceInboundPermissionAuthorizations (array)
InstanceInboundPermissionRevocations (array)
DeploymentConfiguration: {
. ProtectionStrategy (string)
. MinimumHealthyPercentage (integer)
. ImpairmentStrategy (string)
} (object)
Description (string)
MetricGroups (array)
NewGameSessionProtectionPolicy (string)
GameSessionCreationLimitPolicy: {
. NewGameSessionsPerCreator (integer)
. PolicyPeriodInMinutes (integer)
} (object)
LogConfiguration: {
. LogDestination (string)
. S3BucketName (string)
. LogGroupArn (string)
} (object)
RemoveAttributes (array)
gamelift/update_container_group_definitionThis API works with the following fleet types: Container Updates properties in an existing container group definition. This operation doesn't replace the definition. Instead, it creates a new version of the definition and saves it separately. You can access all versions that you choose to retain. The only property you can't update is the container group type. Request options: Update based on the latest version of the container group definition. Specify the container group definition name only, oName (string) required
GameServerContainerDefinition: {
. ContainerName (string)
. DependsOn (array)
. MountPoints (array)
. EnvironmentOverride (array)
. ImageUri (string)
. PortConfiguration (object)
. ServerSdkVersion (string)
} (object)
SupportContainerDefinitions (array)
TotalMemoryLimitMebibytes (integer)
TotalVcpuLimit (number)
VersionDescription (string)
SourceVersionNumber (integer)
OperatingSystem (string)
gamelift/update_fleet_attributesThis API works with the following fleet types: EC2, Anywhere, Container Updates a fleet's mutable attributes, such as 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, Amazon GameLift Servers returns the identifiers for the updated fleet. A managed fleet's runtime environment, which depends on the fleet's Amazon Machine Image AMI version, can't be updated. You must create a new flFleetId (string) required
Name (string)
Description (string)
NewGameSessionProtectionPolicy (string)
ResourceCreationLimitPolicy: {
. NewGameSessionsPerCreator (integer)
. PolicyPeriodInMinutes (integer)
} (object)
MetricGroups (array)
AnywhereConfiguration: {
. Cost (string)
} (object)
gamelift/update_fleet_capacityThis API works with the following fleet types: EC2, Container Updates capacity settings for a managed EC2 fleet or managed container fleet. For these fleets, you adjust capacity by changing the number of instances in the fleet. Fleet capacity determines the number of game sessions and players that the fleet can host based on its configuration. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Minimum/maximum size: Set hard limits onFleetId (string) required
DesiredInstances (integer)
MinSize (integer)
MaxSize (integer)
Location (string)
ManagedCapacityConfiguration: {
. ZeroCapacityStrategy (string)
. ScaleInAfterInactivityMinutes (integer)
} (object)
gamelift/update_fleet_port_settingsThis API works with the following fleet types: EC2, Container Updates permissions that allow inbound traffic to connect to game sessions 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 isFleetId (string) required
InboundPermissionAuthorizations (array)
InboundPermissionRevocations (array)
gamelift/update_game_serverThis API works with the following fleet types: EC2 FleetIQ Updates information about a registered game server to help Amazon GameLift Servers FleetIQ 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 from AVAILABLE when the gameGameServerGroupName (string) required
GameServerId (string) required
GameServerData (string)
UtilizationStatus (string)
HealthCheck (string)
gamelift/update_game_server_groupThis API works with the following fleet types: EC2 FleetIQ Updates Amazon GameLift Servers 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 AmaGameServerGroupName (string) required
RoleArn (string)
InstanceDefinitions (array)
GameServerProtectionPolicy (string)
BalancingStrategy (string)
gamelift/update_game_sessionThis API works with the following fleet types: EC2, Anywhere, Container 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. All APIs by taskGameSessionId (string) required
MaximumPlayerSessionCount (integer)
Name (string)
PlayerSessionCreationPolicy (string)
ProtectionPolicy (string)
GameProperties (array)
gamelift/update_game_session_queueThis API works with the following fleet types: EC2, Anywhere, Container 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 QueuesName (string) required
TimeoutInSeconds (integer)
PlayerLatencyPolicies (array)
Destinations (array)
FilterConfiguration: {
. AllowedLocations (array)
} (object)
PriorityConfiguration: {
. PriorityOrder (array)
. LocationOrder (array)
} (object)
CustomEventData (string)
NotificationTarget (string)
gamelift/update_matchmaking_configurationThis API works with the following fleet types: EC2, Anywhere, Container 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 matchmakerName (string) required
Description (string)
GameSessionQueueArns (array)
RequestTimeoutSeconds (integer)
AcceptanceTimeoutSeconds (integer)
AcceptanceRequired (boolean)
RuleSetName (string)
NotificationTarget (string)
AdditionalPlayerCount (integer)
CustomEventData (string)
GameProperties (array)
GameSessionData (string)
BackfillMode (string)
FlexMatchMode (string)
gamelift/update_runtime_configurationThis API works with the following fleet types: EC2 Updates the runtime configuration for the specified fleet. The runtime configuration tells Amazon GameLift Servers how to launch server processes on computes in managed EC2 and Anywhere fleets. 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 processFleetId (string) required
RuntimeConfiguration: {
. ServerProcesses (array)
. MaxConcurrentGameSessionActivations (integer)
. GameSessionActivationTimeoutSeconds (integer)
} (object) required
gamelift/update_scriptThis API works with the following fleet types: EC2 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 metadataScriptId (string) required
Name (string)
Version (string)
StorageLocation: {
. Bucket (string)
. Key (string)
. RoleArn (string)
. ObjectVersion (string)
} (object)
ZipFile (string)
gamelift/validate_matchmaking_rule_setThis API works with the following fleet types: EC2, Anywhere, Container 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 setRuleSetBody (string) required
gameliftstreams/add_stream_group_locationsAdd locations that can host stream sessions. To add a location, the stream group must be in ACTIVE status. You configure locations and their corresponding capacity for each stream group. Creating a stream group in a location that's nearest to your end users can help minimize latency and improve quality. This operation provisions stream capacity at the specified locations. By default, all locations have 1 or 2 capacity, depending on the stream class option: 2 for 'High' and 1 for 'Ultra' and 'WinIdentifier (string) required
LocationConfigurations (array) required
gameliftstreams/associate_applicationsWhen you associate, or link, an application with a stream group, then Amazon GameLift Streams can launch the application using the stream group's allocated compute resources. The stream group must be in ACTIVE status. You can reverse this action by using DisassociateApplications. If a stream group does not already have a linked application, Amazon GameLift Streams will automatically assign the first application provided in ApplicationIdentifiers as the default.Identifier (string) required
ApplicationIdentifiers (array) required
gameliftstreams/create_stream_session_connectionEnables clients to reconnect to a stream session while preserving all session state and data in the disconnected session. This reconnection process can be initiated when a stream session is in either PENDING_CLIENT_RECONNECTION or ACTIVE status. The process works as follows: Initial disconnect: When a client disconnects or loses connection, the stream session transitions from CONNECTED to PENDING_CLIENT_RECONNECTION Reconnection time window: Clients have ConnectionTimeoutSeconds defined in StartClientToken (string)
Identifier (string) required
StreamSessionIdentifier (string) required
SignalRequest (string) required
gameliftstreams/disassociate_applicationsWhen you disassociate, or unlink, an application from a stream group, you can no longer stream this application by using that stream group's allocated compute resources. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams in the stream group using the disassociated application. The disassociate action does not affect the stream capacity of a stream group. To disassociate an applicatiIdentifier (string) required
ApplicationIdentifiers (array) required
gameliftstreams/export_stream_session_filesExport the files that your application modifies or generates in a stream session, which can help you debug or verify your application. When your application runs, it generates output files such as logs, diagnostic information, crash dumps, save files, user data, screenshots, and so on. The files can be defined by the engine or frameworks that your application uses, or information that you've programmed your application to output. You can only call this action on a stream session that is in progrIdentifier (string) required
StreamSessionIdentifier (string) required
OutputUri (string) required
gameliftstreams/get_stream_sessionRetrieves properties for a Amazon GameLift Streams stream session resource. Specify the Amazon Resource Name ARN of the stream session that you want to retrieve and its stream group ARN. If the operation is successful, it returns properties for the requested resource.Identifier (string) required
StreamSessionIdentifier (string) required
gameliftstreams/list_stream_sessionsRetrieves a list of Amazon GameLift Streams stream sessions that a stream group is hosting. To retrieve stream sessions, specify the stream group, and optionally filter by stream session status. You can paginate the results as needed. This operation returns the requested stream sessions in no particular order.Status (string)
ExportFilesStatus (string)
NextToken (string)
MaxResults (integer)
Identifier (string) required
gameliftstreams/list_stream_sessions_by_accountRetrieves a list of Amazon GameLift Streams stream sessions that this user account has access to. In the returned list of stream sessions, the ExportFilesMetadata property only shows the Status value. To get the OutpurUri and StatusReason values, use GetStreamSession. We don't recommend using this operation to regularly check stream session statuses because it's costly. Instead, to check status updates for a specific stream session, use GetStreamSession.Status (string)
ExportFilesStatus (string)
NextToken (string)
MaxResults (integer)
gameliftstreams/list_tags_for_resourceRetrieves all tags assigned to a Amazon GameLift Streams resource. To list tags for a resource, specify the ARN value for the resource. Learn more Tagging Amazon Web Services Resources in the Amazon Web Services General Reference Amazon Web Services Tagging StrategiesResourceArn (string) required
gameliftstreams/remove_stream_group_locationsRemoves a set of remote locations from this stream group. To remove a location, the stream group must be in ACTIVE status. When you remove a location, Amazon GameLift Streams releases allocated compute resources in that location. Stream sessions can no longer start from removed locations in a stream group. Amazon GameLift Streams also deletes the content files of all associated applications that were in Amazon GameLift Streams's internal Amazon S3 bucket at this location. You cannot remove the AIdentifier (string) required
Locations (array) required
gameliftstreams/start_stream_sessionThis action initiates a new stream session and outputs connection information that clients can use to access the stream. A stream session refers to an instance of a stream that Amazon GameLift Streams transmits from the server to the end-user. A stream session runs on a compute resource that a stream group has allocated. The start stream session process works as follows: Prerequisites: You must have a stream group in ACTIVE status You must have idle or on-demand capacity in a stream group in theClientToken (string)
Description (string)
Identifier (string) required
Protocol (string) required
SignalRequest (string) required
ApplicationIdentifier (string) required
UserId (string)
Locations (array)
ConnectionTimeoutSeconds (integer)
SessionLengthSeconds (integer)
AdditionalLaunchArgs (array)
AdditionalEnvironmentVariables (object)
PerformanceStatsConfiguration: {
. SharedWithClient (boolean)
} (object)
gameliftstreams/tag_resourceAssigns one or more tags to a Amazon GameLift Streams resource. Use tags to organize Amazon Web Services resources for a range of purposes. You can assign tags to the following Amazon GameLift Streams resource types: Application StreamGroup Learn more Tagging Amazon Web Services Resources in the Amazon Web Services General Reference Amazon Web Services Tagging StrategiesResourceArn (string) required
Tags (object) required
gameliftstreams/terminate_stream_sessionPermanently terminates an active stream session. When called, the stream session status changes to TERMINATING. You can terminate a stream session in any status except ACTIVATING. If the stream session is in ACTIVATING status, an exception is thrown.Identifier (string) required
StreamSessionIdentifier (string) required
gameliftstreams/untag_resourceRemoves one or more tags from a Amazon GameLift Streams resource. To remove tags, specify the Amazon GameLift Streams resource and a list of one or more tags to remove.ResourceArn (string) required
TagKeys (array) required
gameliftstreams/create_applicationCreates an application resource in Amazon GameLift Streams, which specifies the application content you want to stream, such as a game build or other software, and configures the settings to run it. Before you create an application, upload your application content files to an Amazon Simple Storage Service Amazon S3 bucket. For more information, see Getting Started in the Amazon GameLift Streams Developer Guide. Make sure that your files in the Amazon S3 bucket are the correct version you want toDescription (string) required
RuntimeEnvironment: {
. Type (string)
. Version (string)
} (object) required
ExecutablePath (string) required
ApplicationSourceUri (string) required
ApplicationLogPaths (array)
ApplicationLogOutputUri (string)
Tags (object)
ClientToken (string)
gameliftstreams/get_applicationRetrieves properties for an Amazon GameLift Streams application resource. Specify the ID of the application that you want to retrieve. If the operation is successful, it returns properties for the requested application.Identifier (string) required
gameliftstreams/update_applicationUpdates the mutable configuration settings for a Amazon GameLift Streams application resource. You can change the Description, ApplicationLogOutputUri, and ApplicationLogPaths. To update application settings, specify the application ID and provide the new values. If the operation is successful, it returns the complete updated set of settings for the application.Identifier (string) required
Description (string)
ApplicationLogPaths (array)
ApplicationLogOutputUri (string)
gameliftstreams/delete_applicationPermanently deletes an Amazon GameLift Streams application resource. This also deletes the application content files stored with Amazon GameLift Streams. However, this does not delete the original files that you uploaded to your Amazon S3 bucket; you can delete these any time after Amazon GameLift Streams creates an application, which is the only time Amazon GameLift Streams accesses your Amazon S3 bucket. You can only delete an application that meets the following conditions: The application isIdentifier (string) required
gameliftstreams/list_applicationsRetrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. This operation returns applications in all statuses, in no particular order. You can paginate the results as needed.NextToken (string)
MaxResults (integer)
gameliftstreams/create_stream_groupStream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs. Within a stream group, you specify an application to stream, streaming locations and their capacity, and the stream class you want to use when streaming applications to your end-users. A stream class defines the hardware configuration of the compute resources that Amazon GameLift Streams will use when streaming, such as the CPU, GPU, and memoDescription (string) required
StreamClass (string) required
DefaultApplicationIdentifier (string)
LocationConfigurations (array)
Tags (object)
ClientToken (string)
gameliftstreams/get_stream_groupRetrieves properties for a Amazon GameLift Streams stream group resource. Specify the ID of the stream group that you want to retrieve. If the operation is successful, it returns properties for the requested stream group.Identifier (string) required
gameliftstreams/update_stream_groupUpdates the configuration settings for an Amazon GameLift Streams stream group resource. To update a stream group, it must be in ACTIVE status. You can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group. Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. The following capacity settingIdentifier (string) required
LocationConfigurations (array)
Description (string)
DefaultApplicationIdentifier (string)
gameliftstreams/delete_stream_groupPermanently deletes all compute resources and information related to a stream group. To delete a stream group, specify the unique stream group identifier. During the deletion process, the stream group's status is DELETING. This operation stops streams in progress and prevents new streams from starting. As a best practice, before deleting the stream group, call ListStreamSessions to check for streams in progress and take action to stop them. When you delete a stream group, any application associaIdentifier (string) required
gameliftstreams/list_stream_groupsRetrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. This operation returns stream groups in all statuses, in no particular order. You can paginate the results as needed.NextToken (string)
MaxResults (integer)
geo_maps/get_glyphsGetGlyphs returns the map's glyphs. For more information, see Style labels with glyphs in the Amazon Location Service Developer Guide.FontStack (string) required
FontUnicodeRange (string) required
geo_maps/get_spritesGetSprites returns the map's sprites. For more information, see Style iconography with sprites in the Amazon Location Service Developer Guide.FileName (string) required
Style (string) required
ColorScheme (string) required
Variant (string) required
geo_maps/get_static_mapGetStaticMap provides high-quality static map images with customizable options. You can modify the map's appearance and overlay additional information. It's an ideal solution for applications requiring tailored static map snapshots. For more information, see the following topics in the Amazon Location Service Developer Guide: Static maps Customize static maps Overlay on the static mapBoundingBox (string)
BoundedPositions (string)
Center (string)
ColorScheme (string)
CompactOverlay (string)
CropLabels (boolean)
GeoJsonOverlay (string)
Height (integer) required
Key (string)
LabelSize (string)
Language (string)
Padding (integer)
PoliticalView (string)
PointsOfInterests (string)
Radius (integer)
FileName (string) required
ScaleBarUnit (string)
Style (string)
Width (integer) required
Zoom (number)
geo_maps/get_style_descriptorGetStyleDescriptor returns information about the style. For more information, see Style dynamic maps in the Amazon Location Service Developer Guide.Style (string) required
ColorScheme (string)
PoliticalView (string)
Terrain (string)
ContourDensity (string)
Traffic (string)
TravelModes (array)
Buildings (string)
Key (string)
geo_maps/get_tileGetTile returns a tile. 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. For more information, see Tiles in the Amazon Location Service Developer Guide.AdditionalFeatures (array)
Tileset (string) required
Z (string) required
X (string) required
Y (string) required
Key (string)
geo_places/autocompleteAutocomplete completes potential places and addresses as the user types, based on the partial input. The API enhances the efficiency and accuracy of address by completing query based on a few entered keystrokes. It helps you by completing partial queries with valid address completion. Also, the API supports the filtering of results based on geographic location, country, or specific place types, and can be tailored using optional parameters like language and political views. For more information,QueryText (string) required
MaxResults (integer)
BiasPosition (array)
Filter: {
. BoundingBox (array)
. Circle (object)
. IncludeCountries (array)
. IncludePlaceTypes (array)
} (object)
PostalCodeMode (string)
AdditionalFeatures (array)
Language (string)
PoliticalView (string)
IntendedUse (string)
Key (string)
geo_places/geocodeGeocode converts a textual address or place into geographic coordinates. You can obtain geographic coordinates, address component, and other related information. It supports flexible queries, including free-form text or structured queries with components like street names, postal codes, and regions. The Geocode API can also provide additional features such as time zone information and the inclusion of political views. For more information, see Geocode in the Amazon Location Service Developer GuiQueryText (string)
QueryComponents: {
. Country (string)
. Region (string)
. SubRegion (string)
. Locality (string)
. District (string)
. Street (string)
. AddressNumber (string)
. PostalCode (string)
} (object)
MaxResults (integer)
BiasPosition (array)
Filter: {
. IncludeCountries (array)
. IncludePlaceTypes (array)
} (object)
AdditionalFeatures (array)
Language (string)
PoliticalView (string)
IntendedUse (string)
Key (string)
geo_places/get_placeGetPlace finds a place by its unique ID. A PlaceId is returned by other place operations. For more information, see GetPlace in the Amazon Location Service Developer Guide.PlaceId (string) required
AdditionalFeatures (array)
Language (string)
PoliticalView (string)
IntendedUse (string)
Key (string)
geo_places/reverse_geocodeReverseGeocode converts geographic coordinates into a human-readable address or place. You can obtain address component, and other related information such as place type, category, street information. The Reverse Geocode API supports filtering to on place type so that you can refine result based on your need. Also, The Reverse Geocode API can also provide additional features such as time zone information and the inclusion of political views. For more information, see Reverse Geocode in the AmazoQueryPosition (array) required
QueryRadius (integer)
MaxResults (integer)
Filter: {
. IncludePlaceTypes (array)
} (object)
AdditionalFeatures (array)
Language (string)
PoliticalView (string)
IntendedUse (string)
Key (string)
Heading (number)
geo_places/search_nearbySearchNearby queries for points of interest within a radius from a central coordinates, returning place results with optional filters such as categories, business chains, food types and more. The API returns details such as a place name, address, phone, category, food type, contact, opening hours. Also, the API can return phonemes, time zones and more based on requested parameters. For more information, see Search Nearby in the Amazon Location Service Developer Guide.QueryPosition (array) required
QueryRadius (integer)
MaxResults (integer)
Filter: {
. BoundingBox (array)
. IncludeCountries (array)
. IncludeCategories (array)
. ExcludeCategories (array)
. IncludeBusinessChains (array)
. ExcludeBusinessChains (array)
. IncludeFoodTypes (array)
. ExcludeFoodTypes (array)
} (object)
AdditionalFeatures (array)
Language (string)
PoliticalView (string)
IntendedUse (string)
NextToken (string)
Key (string)
geo_places/search_textSearchText searches for geocode and place information. You can then complete a follow-up query suggested from the Suggest API via a query id. For more information, see Search Text in the Amazon Location Service Developer Guide.QueryText (string)
QueryId (string)
MaxResults (integer)
BiasPosition (array)
Filter: {
. BoundingBox (array)
. Circle (object)
. IncludeCountries (array)
} (object)
AdditionalFeatures (array)
Language (string)
PoliticalView (string)
IntendedUse (string)
NextToken (string)
Key (string)
geo_places/suggestSuggest provides intelligent predictions or recommendations based on the user's input or context, such as relevant places, points of interest, query terms or search category. It is designed to help users find places or point of interests candidates or identify a follow on query based on incomplete or misspelled queries. It returns a list of possible matches or refinements that can be used to formulate a more accurate query. Users can select the most appropriate suggestion and use it for furtherQueryText (string) required
MaxResults (integer)
MaxQueryRefinements (integer)
BiasPosition (array)
Filter: {
. BoundingBox (array)
. Circle (object)
. IncludeCountries (array)
} (object)
AdditionalFeatures (array)
Language (string)
PoliticalView (string)
IntendedUse (string)
Key (string)
geo_routes/calculate_isolinesUse the CalculateIsolines action to find service areas that can be reached in a given threshold of time, distance.Allow: {
. Hot (boolean)
. Hov (boolean)
} (object)
ArrivalTime (string)
Avoid: {
. Areas (array)
. CarShuttleTrains (boolean)
. ControlledAccessHighways (boolean)
. DirtRoads (boolean)
. Ferries (boolean)
. SeasonalClosure (boolean)
. TollRoads (boolean)
. TollTransponders (boolean)
. TruckRoadTypes (array)
. Tunnels (boolean)
. UTurns (boolean)
. ZoneCategories (array)
} (object)
DepartNow (boolean)
DepartureTime (string)
Destination (array)
DestinationOptions: {
. AvoidActionsForDistance (integer)
. Heading (number)
. Matching (object)
. SideOfStreet (object)
} (object)
IsolineGeometryFormat (string)
IsolineGranularity: {
. MaxPoints (integer)
. MaxResolution (integer)
} (object)
Key (string)
OptimizeIsolineFor (string)
OptimizeRoutingFor (string)
Origin (array)
OriginOptions: {
. AvoidActionsForDistance (integer)
. Heading (number)
. Matching (object)
. SideOfStreet (object)
} (object)
Thresholds: {
. Distance (array)
. Time (array)
} (object) required
Traffic: {
. FlowEventThresholdOverride (integer)
. Usage (string)
} (object)
TravelMode (string)
TravelModeOptions: {
. Car (object)
. Scooter (object)
. Truck (object)
} (object)
geo_routes/calculate_route_matrixUse CalculateRouteMatrix to compute results for all pairs of Origins to Destinations. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions.Allow: {
. Hot (boolean)
. Hov (boolean)
} (object)
Avoid: {
. Areas (array)
. CarShuttleTrains (boolean)
. ControlledAccessHighways (boolean)
. DirtRoads (boolean)
. Ferries (boolean)
. TollRoads (boolean)
. TollTransponders (boolean)
. TruckRoadTypes (array)
. Tunnels (boolean)
. UTurns (boolean)
. ZoneCategories (array)
} (object)
DepartNow (boolean)
DepartureTime (string)
Destinations (array) required
Exclude: {
. Countries (array)
} (object)
Key (string)
OptimizeRoutingFor (string)
Origins (array) required
RoutingBoundary: {
. Geometry (object)
. Unbounded (boolean)
} (object) required
Traffic: {
. FlowEventThresholdOverride (integer)
. Usage (string)
} (object)
TravelMode (string)
TravelModeOptions: {
. Car (object)
. Scooter (object)
. Truck (object)
} (object)
geo_routes/calculate_routesCalculateRoutes computes routes given the following required parameters: Origin and Destination.Allow: {
. Hot (boolean)
. Hov (boolean)
} (object)
ArrivalTime (string)
Avoid: {
. Areas (array)
. CarShuttleTrains (boolean)
. ControlledAccessHighways (boolean)
. DirtRoads (boolean)
. Ferries (boolean)
. SeasonalClosure (boolean)
. TollRoads (boolean)
. TollTransponders (boolean)
. TruckRoadTypes (array)
. Tunnels (boolean)
. UTurns (boolean)
. ZoneCategories (array)
} (object)
DepartNow (boolean)
DepartureTime (string)
Destination (array) required
DestinationOptions: {
. AvoidActionsForDistance (integer)
. AvoidUTurns (boolean)
. Heading (number)
. Matching (object)
. SideOfStreet (object)
. StopDuration (integer)
} (object)
Driver: {
. Schedule (array)
} (object)
Exclude: {
. Countries (array)
} (object)
InstructionsMeasurementSystem (string)
Key (string)
Languages (array)
LegAdditionalFeatures (array)
LegGeometryFormat (string)
MaxAlternatives (integer)
OptimizeRoutingFor (string)
Origin (array) required
OriginOptions: {
. AvoidActionsForDistance (integer)
. AvoidUTurns (boolean)
. Heading (number)
. Matching (object)
. SideOfStreet (object)
} (object)
SpanAdditionalFeatures (array)
Tolls: {
. AllTransponders (boolean)
. AllVignettes (boolean)
. Currency (string)
. EmissionType (object)
. VehicleCategory (string)
} (object)
Traffic: {
. FlowEventThresholdOverride (integer)
. Usage (string)
} (object)
TravelMode (string)
TravelModeOptions: {
. Car (object)
. Pedestrian (object)
. Scooter (object)
. Truck (object)
} (object)
TravelStepType (string)
Waypoints (array)
geo_routes/optimize_waypointsOptimizeWaypoints calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data.Avoid: {
. Areas (array)
. CarShuttleTrains (boolean)
. ControlledAccessHighways (boolean)
. DirtRoads (boolean)
. Ferries (boolean)
. TollRoads (boolean)
. Tunnels (boolean)
. UTurns (boolean)
} (object)
Clustering: {
. Algorithm (string)
. DrivingDistanceOptions (object)
} (object)
DepartureTime (string)
Destination (array)
DestinationOptions: {
. AccessHours (object)
. AppointmentTime (string)
. Heading (number)
. Id (string)
. ServiceDuration (integer)
. SideOfStreet (object)
} (object)
Driver: {
. RestCycles (object)
. RestProfile (object)
. TreatServiceTimeAs (string)
} (object)
Exclude: {
. Countries (array)
} (object)
Key (string)
OptimizeSequencingFor (string)
Origin (array) required
OriginOptions: {
. Id (string)
} (object)
Traffic: {
. Usage (string)
} (object)
TravelMode (string)
TravelModeOptions: {
. Pedestrian (object)
. Truck (object)
} (object)
Waypoints (array)
geo_routes/snap_to_roadsSnapToRoads matches GPS trace to roads most likely traveled on.Key (string)
SnappedGeometryFormat (string)
SnapRadius (integer)
TracePoints (array) required
TravelMode (string)
TravelModeOptions: {
. Truck (object)
} (object)
glacier/abort_multipart_uploadThis 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 accountaccountId (string) required
vaultName (string) required
uploadId (string) required
glacier/abort_vault_lockThis 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 lockaccountId (string) required
vaultName (string) required
glacier/add_tags_to_vaultThis 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 Glacier Resources.accountId (string) required
vaultName (string) required
Tags (object)
glacier/complete_multipart_uploadYou call this operation to inform Amazon 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 toaccountId (string) required
vaultName (string) required
uploadId (string) required
archiveSize (string)
checksum (string)
glacier/complete_vault_lockThis 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 iaccountId (string) required
vaultName (string) required
lockId (string) required
glacier/create_vaultThis 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 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 perfaccountId (string) required
vaultName (string) required
glacier/delete_archiveThis 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 Glacier receives the delete archive request, the archival retrieval operation might fail. If the archive retrieval job has successfully prepared the archive for download whenaccountId (string) required
vaultName (string) required
archiveId (string) required
glacier/delete_vaultThis operation deletes a vault. Amazon 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 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 foaccountId (string) required
vaultName (string) required
glacier/delete_vault_access_policyThis operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon 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 GlacieaccountId (string) required
vaultName (string) required
glacier/delete_vault_notificationsThis operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon 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 permisaccountId (string) required
vaultName (string) required
glacier/describe_jobThis 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 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 GlaaccountId (string) required
vaultName (string) required
jobId (string) required
glacier/describe_vaultThis 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 latestaccountId (string) required
vaultName (string) required
glacier/get_data_retrieval_policyThis 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.accountId (string) required
glacier/get_job_outputThis 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 Glacier Glacier returns the checksum for the portion of the data. You can compute the cheaccountId (string) required
vaultName (string) required
jobId (string) required
range (string)
glacier/get_vault_access_policyThis 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.accountId (string) required
vaultName (string) required
glacier/get_vault_lockThis 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 callingaccountId (string) required
vaultName (string) required
glacier/get_vault_notificationsThis 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 Glacier. An AWS account has full permission to perform all operations actions. However, AWS Identity and Access ManaccountId (string) required
vaultName (string) required
glacier/initiate_jobThis 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.accountId (string) required
vaultName (string) required
jobParameters: {
. Format (string)
. Type (string)
. ArchiveId (string)
. Description (string)
. SNSTopic (string)
. RetrievalByteRange (string)
. Tier (string)
. InventoryRetrievalParameters (object)
. SelectParameters (object)
. OutputLocation (object)
} (object)
glacier/initiate_multipart_uploadThis operation initiates a multipart upload. Amazon 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 partaccountId (string) required
vaultName (string) required
archiveDescription (string)
partSize (string)
glacier/initiate_vault_lockThis 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 processaccountId (string) required
vaultName (string) required
policy: {
. Policy (string)
} (object)
glacier/list_jobsThis 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 thaccountId (string) required
vaultName (string) required
limit (integer)
marker (string)
statuscode (string)
completed (string)
glacier/list_multipart_uploadsThis 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 maraccountId (string) required
vaultName (string) required
limit (integer)
marker (string)
glacier/list_partsThis 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 caccountId (string) required
vaultName (string) required
uploadId (string) required
marker (string)
limit (integer)
glacier/list_provisioned_capacityThis operation lists the provisioned capacity units for the specified AWS account.accountId (string) required
glacier/list_tags_for_vaultThis 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 Glacier Resources.accountId (string) required
vaultName (string) required
glacier/list_vaultsThis 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 yoaccountId (string) required
marker (string)
limit (integer)
glacier/purchase_provisioned_capacityThis operation purchases a provisioned capacity unit for an AWS account.accountId (string) required
glacier/remove_tags_from_vaultThis operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see Tagging Amazon Glacier Resources. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault.accountId (string) required
vaultName (string) required
TagKeys (array)
glacier/set_data_retrieval_policyThis 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.accountId (string) required
Policy: {
. Rules (array)
} (object)
glacier/set_vault_access_policyThis 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.accountId (string) required
vaultName (string) required
policy: {
. Policy (string)
} (object)
glacier/set_vault_notificationsThis 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 Glacier to send notifications to the topic. Amazon SNS topics must grant permission to the vault to be allowed to publishaccountId (string) required
vaultName (string) required
vaultNotificationConfig: {
. SNSTopic (string)
. Events (array)
} (object)
glacier/upload_archiveThis operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon 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 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 allvaultName (string) required
accountId (string) required
archiveDescription (string)
checksum (string)
body (string)
glacier/upload_multipart_partThis 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 Glacier also computesaccountId (string) required
vaultName (string) required
uploadId (string) required
checksum (string)
range (string)
body (string)
global_accelerator/add_custom_routing_endpointsAssociate 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 tEndpointConfigurations (array) required
EndpointGroupArn (string) required
global_accelerator/add_endpointsAdd endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group with the CreateEndpointGroup API or when you update an endpoint group with the UpdateEndpointGroup API. There are two advantages to using AddEndpoints to add endpoints in Global Accelerator: It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding, rather than resolEndpointConfigurations (array) required
EndpointGroupArn (string) required
global_accelerator/advertise_byoip_cidrAdvertises 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.Cidr (string) required
global_accelerator/allow_custom_routing_trafficSpecify 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 checEndpointGroupArn (string) required
EndpointId (string) required
DestinationAddresses (array)
DestinationPorts (array)
AllowAllTrafficToEndpoint (boolean)
global_accelerator/create_acceleratorCreate 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 Amazon Web Services CLIName (string) required
IpAddressType (string)
IpAddresses (array)
Enabled (boolean)
IdempotencyToken (string) required
Tags (array)
global_accelerator/create_cross_account_attachmentCreate a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the principals who have permission to work with resources in accelerators in their own account. You specify, in the same attachment, the resources that are shared. A principal can be an Amazon Web Services account number or the Amazon Resource Name ARN for an accelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment, you must sign in toName (string) required
Principals (array)
Resources (array)
IdempotencyToken (string) required
Tags (array)
global_accelerator/create_custom_routing_acceleratorCreate 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 AcceleName (string) required
IpAddressType (string)
IpAddresses (array)
Enabled (boolean)
IdempotencyToken (string) required
Tags (array)
global_accelerator/create_custom_routing_endpoint_groupCreate 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.ListenerArn (string) required
EndpointGroupRegion (string) required
DestinationConfigurations (array) required
IdempotencyToken (string) required
global_accelerator/create_custom_routing_listenerCreate 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.AcceleratorArn (string) required
PortRanges (array) required
IdempotencyToken (string) required
global_accelerator/create_endpoint_groupCreate 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. For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.ListenerArn (string) required
EndpointGroupRegion (string) required
EndpointConfigurations (array)
TrafficDialPercentage (number)
HealthCheckPort (integer)
HealthCheckProtocol (string)
HealthCheckPath (string)
HealthCheckIntervalSeconds (integer)
ThresholdCount (integer)
IdempotencyToken (string) required
PortOverrides (array)
global_accelerator/create_listenerCreate 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.AcceleratorArn (string) required
PortRanges (array) required
Protocol (string) required
ClientAffinity (string)
IdempotencyToken (string) required
global_accelerator/delete_acceleratorDelete 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 accAcceleratorArn (string) required
global_accelerator/delete_cross_account_attachmentDelete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all principals in the list of principals. Global Accelerator revokes the permission for specific resources. For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.AttachmentArn (string) required
global_accelerator/delete_custom_routing_acceleratorDelete 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 accepAcceleratorArn (string) required
global_accelerator/delete_custom_routing_endpoint_groupDelete an endpoint group from a listener for a custom routing accelerator.EndpointGroupArn (string) required
global_accelerator/delete_custom_routing_listenerDelete a listener for a custom routing accelerator.ListenerArn (string) required
global_accelerator/delete_endpoint_groupDelete an endpoint group from a listener.EndpointGroupArn (string) required
global_accelerator/delete_listenerDelete a listener from an accelerator.ListenerArn (string) required
global_accelerator/deny_custom_routing_trafficSpecify 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 statusEndpointGroupArn (string) required
EndpointId (string) required
DestinationAddresses (array)
DestinationPorts (array)
DenyAllTrafficToEndpoint (boolean)
global_accelerator/deprovision_byoip_cidrReleases 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.Cidr (string) required
global_accelerator/describe_acceleratorDescribe an accelerator.AcceleratorArn (string) required
global_accelerator/describe_accelerator_attributesDescribe the attributes of an accelerator.AcceleratorArn (string) required
global_accelerator/describe_cross_account_attachmentGets configuration information about a cross-account attachment.AttachmentArn (string) required
global_accelerator/describe_custom_routing_acceleratorDescribe a custom routing accelerator.AcceleratorArn (string) required
global_accelerator/describe_custom_routing_accelerator_attributesDescribe the attributes of a custom routing accelerator.AcceleratorArn (string) required
global_accelerator/describe_custom_routing_endpoint_groupDescribe an endpoint group for a custom routing accelerator.EndpointGroupArn (string) required
global_accelerator/describe_custom_routing_listenerThe description of a listener for a custom routing accelerator.ListenerArn (string) required
global_accelerator/describe_endpoint_groupDescribe an endpoint group.EndpointGroupArn (string) required
global_accelerator/describe_listenerDescribe a listener.ListenerArn (string) required
global_accelerator/list_acceleratorsList the accelerators for an Amazon Web Services account.MaxResults (integer)
NextToken (string)
global_accelerator/list_byoip_cidrsLists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.MaxResults (integer)
NextToken (string)
global_accelerator/list_cross_account_attachmentsList the cross-account attachments that have been created in Global Accelerator.MaxResults (integer)
NextToken (string)
global_accelerator/list_cross_account_resource_accountsList the accounts that have cross-account resources. For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.No parameters
global_accelerator/list_cross_account_resourcesList the cross-account resources available to work with.AcceleratorArn (string)
ResourceOwnerAwsAccountId (string) required
MaxResults (integer)
NextToken (string)
global_accelerator/list_custom_routing_acceleratorsList the custom routing accelerators for an Amazon Web Services account.MaxResults (integer)
NextToken (string)
global_accelerator/list_custom_routing_endpoint_groupsList the endpoint groups that are associated with a listener for a custom routing accelerator.ListenerArn (string) required
MaxResults (integer)
NextToken (string)
global_accelerator/list_custom_routing_listenersList the listeners for a custom routing accelerator.AcceleratorArn (string) required
MaxResults (integer)
NextToken (string)
global_accelerator/list_custom_routing_port_mappingsProvides 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 acceleratAcceleratorArn (string) required
EndpointGroupArn (string)
MaxResults (integer)
NextToken (string)
global_accelerator/list_custom_routing_port_mappings_by_destinationList 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.EndpointId (string) required
DestinationAddress (string) required
MaxResults (integer)
NextToken (string)
global_accelerator/list_endpoint_groupsList the endpoint groups that are associated with a listener.ListenerArn (string) required
MaxResults (integer)
NextToken (string)
global_accelerator/list_listenersList the listeners for an accelerator.AcceleratorArn (string) required
MaxResults (integer)
NextToken (string)
global_accelerator/list_tags_for_resourceList all tags for an accelerator. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.ResourceArn (string) required
global_accelerator/provision_byoip_cidrProvisions 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.Cidr (string) required
CidrAuthorizationContext: {
. Message (string)
. Signature (string)
} (object) required
global_accelerator/remove_custom_routing_endpointsRemove endpoints from a custom routing accelerator.EndpointIds (array) required
EndpointGroupArn (string) required
global_accelerator/remove_endpointsRemove endpoints from an endpoint group. The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation. There are two advantages to using AddEndpoints to remove endpoints instead: It's more convenient, because you only need to specify the endpoints that you want to remove. With the UpdateEndpointGroup API operation, you must specify all of the endpoints in theEndpointIdentifiers (array) required
EndpointGroupArn (string) required
global_accelerator/tag_resourceAdd tags to an accelerator resource. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.ResourceArn (string) required
Tags (array) required
global_accelerator/untag_resourceRemove 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.ResourceArn (string) required
TagKeys (array) required
global_accelerator/update_acceleratorUpdate an accelerator to make changes, such as the following: Change the name of the accelerator. Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it. Enable the accelerator, if it is disabled. Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack. Be aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no lAcceleratorArn (string) required
Name (string)
IpAddressType (string)
IpAddresses (array)
Enabled (boolean)
global_accelerator/update_accelerator_attributesUpdate the attributes for an accelerator.AcceleratorArn (string) required
FlowLogsEnabled (boolean)
FlowLogsS3Bucket (string)
FlowLogsS3Prefix (string)
global_accelerator/update_cross_account_attachmentUpdate a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal account ID or accelerator or a resource, Global Accelerator revokes the permission for specific resources. For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.AttachmentArn (string) required
Name (string)
AddPrincipals (array)
RemovePrincipals (array)
AddResources (array)
RemoveResources (array)
global_accelerator/update_custom_routing_acceleratorUpdate a custom routing accelerator.AcceleratorArn (string) required
Name (string)
IpAddressType (string)
IpAddresses (array)
Enabled (boolean)
global_accelerator/update_custom_routing_accelerator_attributesUpdate the attributes for a custom routing accelerator.AcceleratorArn (string) required
FlowLogsEnabled (boolean)
FlowLogsS3Bucket (string)
FlowLogsS3Prefix (string)
global_accelerator/update_custom_routing_listenerUpdate a listener for a custom routing accelerator.ListenerArn (string) required
PortRanges (array) required
global_accelerator/update_endpoint_groupUpdate an endpoint group. A resource must be valid and active when you add it as an endpoint.EndpointGroupArn (string) required
EndpointConfigurations (array)
TrafficDialPercentage (number)
HealthCheckPort (integer)
HealthCheckProtocol (string)
HealthCheckPath (string)
HealthCheckIntervalSeconds (integer)
ThresholdCount (integer)
PortOverrides (array)
global_accelerator/update_listenerUpdate a listener.ListenerArn (string) required
PortRanges (array)
Protocol (string)
ClientAffinity (string)
global_accelerator/withdraw_byoip_cidrStops 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.Cidr (string) required
glue/batch_create_partitionCreates one or more partitions in a batch operation.CatalogId (string)
DatabaseName (string) required
TableName (string) required
PartitionInputList (array) required
glue/batch_delete_connectionDeletes a list of connection definitions from the Data Catalog.CatalogId (string)
ConnectionNameList (array) required
glue/batch_delete_partitionDeletes one or more partitions in a batch operation.CatalogId (string)
DatabaseName (string) required
TableName (string) required
PartitionsToDelete (array) required
glue/batch_delete_tableDeletes 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 tCatalogId (string)
DatabaseName (string) required
TablesToDelete (array) required
TransactionId (string)
glue/batch_delete_table_versionDeletes a specified batch of versions of a table.CatalogId (string)
DatabaseName (string) required
TableName (string) required
VersionIds (array) required
glue/batch_get_blueprintsRetrieves information about a list of blueprints.Names (array) required
IncludeBlueprint (boolean)
IncludeParameterSpec (boolean)
glue/batch_get_crawlersReturns 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.CrawlerNames (array) required
glue/batch_get_custom_entity_typesRetrieves the details for the custom patterns specified by a list of names.Names (array) required
glue/batch_get_data_quality_resultRetrieves a list of data quality results for the specified result IDs.ResultIds (array) required
glue/batch_get_dev_endpointsReturns 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.DevEndpointNames (array) required
glue/batch_get_jobsReturns 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.JobNames (array) required
glue/batch_get_partitionRetrieves partitions in a batch request.CatalogId (string)
DatabaseName (string) required
TableName (string) required
PartitionsToGet (array) required
glue/batch_get_table_optimizerReturns the configuration for the specified table optimizers.Entries (array) required
glue/batch_get_triggersReturns 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.TriggerNames (array) required
glue/batch_get_workflowsReturns 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.Names (array) required
IncludeGraph (boolean)
glue/batch_put_data_quality_statistic_annotationAnnotate datapoints over time for a specific data quality statistic. The API requires both profileID and statisticID as part of the InclusionAnnotation input. The API only works for a single statisticId across multiple profiles.InclusionAnnotations (array) required
ClientToken (string)
glue/batch_stop_job_runStops one or more job runs for a specified job definition.JobName (string) required
JobRunIds (array) required
glue/batch_update_partitionUpdates one or more partitions in a batch operation.CatalogId (string)
DatabaseName (string) required
TableName (string) required
Entries (array) required
glue/cancel_data_quality_rule_recommendation_runCancels the specified recommendation run that was being used to generate rules.RunId (string) required
glue/cancel_data_quality_ruleset_evaluation_runCancels a run where a ruleset is being evaluated against a data source.RunId (string) required
glue/cancel_mltask_runCancels 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.TransformId (string) required
TaskRunId (string) required
glue/cancel_statementCancels the statement.SessionId (string) required
Id (integer) required
RequestOrigin (string)
glue/check_schema_version_validityValidates 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.DataFormat (string) required
SchemaDefinition (string) required
glue/create_blueprintRegisters a blueprint with Glue.Name (string) required
Description (string)
BlueprintLocation (string) required
Tags (object)
glue/create_catalogCreates a new catalog in the Glue Data Catalog.Name (string) required
CatalogInput: {
. Description (string)
. FederatedCatalog (object)
. Parameters (object)
. TargetRedshiftCatalog (object)
. CatalogProperties (object)
. CreateTableDefaultPermissions (array)
. CreateDatabaseDefaultPermissions (array)
. AllowFullTableExternalDataAccess (string)
} (object) required
Tags (object)
glue/create_classifierCreates 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.GrokClassifier: {
. Classification (string)
. Name (string)
. GrokPattern (string)
. CustomPatterns (string)
} (object)
XMLClassifier: {
. Classification (string)
. Name (string)
. RowTag (string)
} (object)
JsonClassifier: {
. Name (string)
. JsonPath (string)
} (object)
CsvClassifier: {
. Name (string)
. Delimiter (string)
. QuoteSymbol (string)
. ContainsHeader (string)
. Header (array)
. DisableValueTrimming (boolean)
. AllowSingleColumn (boolean)
. CustomDatatypeConfigured (boolean)
. CustomDatatypes (array)
. Serde (string)
} (object)
glue/create_column_statistics_task_settingsCreates settings for a column statistics task.DatabaseName (string) required
TableName (string) required
Role (string) required
Schedule (string)
ColumnNameList (array)
SampleSize (number)
CatalogID (string)
SecurityConfiguration (string)
Tags (object)
glue/create_connectionCreates a connection definition in the Data Catalog. Connections used for creating federated resources require the IAM glue:PassConnection permission.CatalogId (string)
ConnectionInput: {
. Name (string)
. Description (string)
. ConnectionType (string)
. MatchCriteria (array)
. ConnectionProperties (object)
. SparkProperties (object)
. AthenaProperties (object)
. PythonProperties (object)
. PhysicalConnectionRequirements (object)
. AuthenticationConfiguration (object)
. ValidateCredentials (boolean)
. ValidateForComputeEnvironments (array)
} (object) required
Tags (object)
glue/create_crawlerCreates 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.Name (string) required
Role (string) required
DatabaseName (string)
Description (string)
Targets: {
. S3Targets (array)
. JdbcTargets (array)
. MongoDBTargets (array)
. DynamoDBTargets (array)
. CatalogTargets (array)
. DeltaTargets (array)
. IcebergTargets (array)
. HudiTargets (array)
} (object) required
Schedule (string)
Classifiers (array)
TablePrefix (string)
SchemaChangePolicy: {
. UpdateBehavior (string)
. DeleteBehavior (string)
} (object)
RecrawlPolicy: {
. RecrawlBehavior (string)
} (object)
LineageConfiguration: {
. CrawlerLineageSettings (string)
} (object)
LakeFormationConfiguration: {
. UseLakeFormationCredentials (boolean)
. AccountId (string)
} (object)
Configuration (string)
CrawlerSecurityConfiguration (string)
Tags (object)
glue/create_custom_entity_typeCreates 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.Name (string) required
RegexString (string) required
ContextWords (array)
Tags (object)
glue/create_databaseCreates a new database in a Data Catalog.CatalogId (string)
DatabaseInput: {
. Name (string)
. Description (string)
. LocationUri (string)
. Parameters (object)
. CreateTableDefaultPermissions (array)
. TargetDatabase (object)
. FederatedDatabase (object)
} (object) required
Tags (object)
glue/create_data_quality_rulesetCreates a data quality ruleset with DQDL rules applied to a specified Glue table. You create the ruleset using the Data Quality Definition Language DQDL. For more information, see the Glue developer guide.Name (string) required
Description (string)
Ruleset (string) required
Tags (object)
TargetTable: {
. TableName (string)
. DatabaseName (string)
. CatalogId (string)
} (object)
DataQualitySecurityConfiguration (string)
ClientToken (string)
glue/create_dev_endpointCreates a new development endpoint.EndpointName (string) required
RoleArn (string) required
SecurityGroupIds (array)
SubnetId (string)
PublicKey (string)
PublicKeys (array)
NumberOfNodes (integer)
WorkerType (string)
GlueVersion (string)
NumberOfWorkers (integer)
ExtraPythonLibsS3Path (string)
ExtraJarsS3Path (string)
SecurityConfiguration (string)
Tags (object)
Arguments (object)
glue/create_glue_identity_center_configurationCreates a new Glue Identity Center configuration to enable integration between Glue and Amazon Web Services IAM Identity Center for authentication and authorization.InstanceArn (string) required
Scopes (array)
UserBackgroundSessionsEnabled (boolean)
glue/create_integrationCreates a Zero-ETL integration in the caller's account between two resources with Amazon Resource Names ARNs: the SourceArn and TargetArn.IntegrationName (string) required
SourceArn (string) required
TargetArn (string) required
Description (string)
DataFilter (string)
KmsKeyId (string)
AdditionalEncryptionContext (object)
Tags (array)
IntegrationConfig: {
. RefreshInterval (string)
. SourceProperties (object)
. ContinuousSync (boolean)
} (object)
glue/create_integration_resource_propertyThis API can be used for setting up the ResourceProperty of the Glue connection for the source or Glue database ARN for the target. These properties can include the role to access the connection or database. To set both source and target properties the same API needs to be invoked with the Glue connection ARN as ResourceArn with SourceProcessingProperties and the Glue database ARN as ResourceArn with TargetProcessingProperties respectively.ResourceArn (string) required
SourceProcessingProperties: {
. RoleArn (string)
} (object)
TargetProcessingProperties: {
. RoleArn (string)
. KmsArn (string)
. ConnectionName (string)
. EventBusArn (string)
} (object)
Tags (array)
glue/create_integration_table_propertiesThis API is used to provide optional override properties for the the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn with SourceTableConfig, and the Glue database ARN as ResourceArn with TargetTableConfig respectively.ResourceArn (string) required
TableName (string) required
SourceTableConfig: {
. Fields (array)
. FilterPredicate (string)
. PrimaryKey (array)
. RecordUpdateField (string)
} (object)
TargetTableConfig: {
. UnnestSpec (string)
. PartitionSpec (array)
. TargetTableName (string)
} (object)
glue/create_jobCreates a new job definition.Name (string) required
JobMode (string)
JobRunQueuingEnabled (boolean)
Description (string)
LogUri (string)
Role (string) required
ExecutionProperty: {
. MaxConcurrentRuns (integer)
} (object)
Command: {
. Name (string)
. ScriptLocation (string)
. PythonVersion (string)
. Runtime (string)
} (object) required
DefaultArguments (object)
NonOverridableArguments (object)
Connections: {
. Connections (array)
} (object)
MaxRetries (integer)
AllocatedCapacity (integer)
Timeout (integer)
MaxCapacity (number)
SecurityConfiguration (string)
Tags (object)
NotificationProperty: {
. NotifyDelayAfter (integer)
} (object)
GlueVersion (string)
NumberOfWorkers (integer)
WorkerType (string)
CodeGenConfigurationNodes (object)
ExecutionClass (string)
SourceControlDetails: {
. Provider (string)
. Repository (string)
. Owner (string)
. Branch (string)
. Folder (string)
. LastCommitId (string)
. AuthStrategy (string)
. AuthToken (string)
} (object)
MaintenanceWindow (string)
glue/create_mltransformCreates 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 yoName (string) required
Description (string)
InputRecordTables (array) required
Parameters: {
. TransformType (string)
. FindMatchesParameters (object)
} (object) required
Role (string) required
GlueVersion (string)
MaxCapacity (number)
WorkerType (string)
NumberOfWorkers (integer)
Timeout (integer)
MaxRetries (integer)
Tags (object)
TransformEncryption: {
. MlUserDataEncryption (object)
. TaskRunSecurityConfigurationName (string)
} (object)
glue/create_partitionCreates a new partition.CatalogId (string)
DatabaseName (string) required
TableName (string) required
PartitionInput: {
. Values (array)
. LastAccessTime (string)
. StorageDescriptor (object)
. Parameters (object)
. LastAnalyzedTime (string)
} (object) required
glue/create_partition_indexCreates a specified partition index in an existing table.CatalogId (string)
DatabaseName (string) required
TableName (string) required
PartitionIndex: {
. Keys (array)
. IndexName (string)
} (object) required
glue/create_registryCreates a new registry which may be used to hold a collection of schemas.RegistryName (string) required
Description (string)
Tags (object)
glue/create_schemaCreates 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 RegisRegistryId: {
. RegistryName (string)
. RegistryArn (string)
} (object)
SchemaName (string) required
DataFormat (string) required
Compatibility (string)
Description (string)
Tags (object)
SchemaDefinition (string)
glue/create_scriptTransforms a directed acyclic graph DAG into code.DagNodes (array)
DagEdges (array)
Language (string)
glue/create_security_configurationCreates 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.Name (string) required
EncryptionConfiguration: {
. S3Encryption (array)
. CloudWatchEncryption (object)
. JobBookmarksEncryption (object)
. DataQualityEncryption (object)
} (object) required
glue/create_sessionCreates a new session.Id (string) required
Description (string)
Role (string) required
Command: {
. Name (string)
. PythonVersion (string)
} (object) required
Timeout (integer)
IdleTimeout (integer)
DefaultArguments (object)
Connections: {
. Connections (array)
} (object)
MaxCapacity (number)
NumberOfWorkers (integer)
WorkerType (string)
SecurityConfiguration (string)
GlueVersion (string)
Tags (object)
RequestOrigin (string)
glue/create_tableCreates a new table definition in the Data Catalog.CatalogId (string)
DatabaseName (string) required
Name (string)
TableInput: {
. Name (string)
. Description (string)
. Owner (string)
. LastAccessTime (string)
. LastAnalyzedTime (string)
. Retention (integer)
. StorageDescriptor (object)
. PartitionKeys (array)
. ViewOriginalText (string)
. ViewExpandedText (string)
. TableType (string)
. Parameters (object)
. TargetTable (object)
. ViewDefinition (object)
} (object)
PartitionIndexes (array)
TransactionId (string)
OpenTableFormatInput: {
. IcebergInput (object)
} (object)
glue/create_table_optimizerCreates a new table optimizer for a specific function.CatalogId (string) required
DatabaseName (string) required
TableName (string) required
Type (string) required
TableOptimizerConfiguration: {
. roleArn (string)
. enabled (boolean)
. vpcConfiguration
. compactionConfiguration (object)
. retentionConfiguration (object)
. orphanFileDeletionConfiguration (object)
} (object) required
glue/create_triggerCreates a new trigger. Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to keep them within the Job.Name (string) required
WorkflowName (string)
Type (string) required
Schedule (string)
Predicate: {
. Logical (string)
. Conditions (array)
} (object)
Actions (array) required
Description (string)
StartOnCreation (boolean)
Tags (object)
EventBatchingCondition: {
. BatchSize (integer)
. BatchWindow (integer)
} (object)
glue/create_usage_profileCreates an Glue usage profile.Name (string) required
Description (string)
Configuration: {
. SessionConfiguration (object)
. JobConfiguration (object)
} (object) required
Tags (object)
glue/create_user_defined_functionCreates a new function definition in the Data Catalog.CatalogId (string)
DatabaseName (string) required
FunctionInput: {
. FunctionName (string)
. ClassName (string)
. OwnerName (string)
. FunctionType (string)
. OwnerType (string)
. ResourceUris (array)
} (object) required
glue/create_workflowCreates a new workflow.Name (string) required
Description (string)
DefaultRunProperties (object)
Tags (object)
MaxConcurrentRuns (integer)
glue/delete_blueprintDeletes an existing blueprint.Name (string) required
glue/delete_catalogRemoves the specified catalog from the Glue Data Catalog. After completing this operation, you no longer have access to the databases, tables and all table versions and partitions that might belong to the tables and the user-defined functions in the deleted catalog. 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 the DeleteCatalog operation, use DeleteTableVersionCatalogId (string) required
glue/delete_classifierRemoves a classifier from the Data Catalog.Name (string) required
glue/delete_column_statistics_for_partitionDelete the partition column statistics of a column. The Identity and Access Management IAM permission required for this operation is DeletePartition.CatalogId (string)
DatabaseName (string) required
TableName (string) required
PartitionValues (array) required
ColumnName (string) required
glue/delete_column_statistics_for_tableRetrieves table statistics of columns. The Identity and Access Management IAM permission required for this operation is DeleteTable.CatalogId (string)
DatabaseName (string) required
TableName (string) required
ColumnName (string) required
glue/delete_column_statistics_task_settingsDeletes settings for a column statistics task.DatabaseName (string) required
TableName (string) required
glue/delete_connectionDeletes a connection from the Data Catalog.CatalogId (string)
ConnectionName (string) required
glue/delete_connection_typeDeletes a custom connection type in Glue. The connection type must exist and be registered before it can be deleted. This operation supports cleanup of connection type resources and helps maintain proper lifecycle management of custom connection types.ConnectionType (string) required
glue/delete_crawlerRemoves a specified crawler from the Glue Data Catalog, unless the crawler state is RUNNING.Name (string) required
glue/delete_custom_entity_typeDeletes a custom pattern by specifying its name.Name (string) required
glue/delete_databaseRemoves 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, DCatalogId (string)
Name (string) required
glue/delete_data_quality_rulesetDeletes a data quality ruleset.Name (string) required
glue/delete_dev_endpointDeletes a specified development endpoint.EndpointName (string) required
glue/delete_glue_identity_center_configurationDeletes the existing Glue Identity Center configuration, removing the integration between Glue and Amazon Web Services IAM Identity Center.No parameters
glue/delete_integrationDeletes the specified Zero-ETL integration.IntegrationIdentifier (string) required
glue/delete_integration_resource_propertyThis API is used for deleting the ResourceProperty of the Glue connection for the source or Glue database ARN for the target.ResourceArn (string) required
glue/delete_integration_table_propertiesDeletes the table properties that have been created for the tables that need to be replicated.ResourceArn (string) required
TableName (string) required
glue/delete_jobDeletes a specified job definition. If the job definition is not found, no exception is thrown.JobName (string) required
glue/delete_mltransformDeletes 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.TransformId (string) required
glue/delete_partitionDeletes a specified partition.CatalogId (string)
DatabaseName (string) required
TableName (string) required
PartitionValues (array) required
glue/delete_partition_indexDeletes a specified partition index from an existing table.CatalogId (string)
DatabaseName (string) required
TableName (string) required
IndexName (string) required
glue/delete_registryDelete 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.RegistryId: {
. RegistryName (string)
. RegistryArn (string)
} (object) required
glue/delete_resource_policyDeletes a specified policy.PolicyHashCondition (string)
ResourceArn (string)
glue/delete_schemaDeletes 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.SchemaId: {
. SchemaArn (string)
. SchemaName (string)
. RegistryName (string)
} (object) required
glue/delete_schema_versionsRemove 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 DeleteSSchemaId: {
. SchemaArn (string)
. SchemaName (string)
. RegistryName (string)
} (object) required
Versions (string) required
glue/delete_security_configurationDeletes a specified security configuration.Name (string) required
glue/delete_sessionDeletes the session.Id (string) required
RequestOrigin (string)
glue/delete_tableRemoves 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 thatCatalogId (string)
DatabaseName (string) required
Name (string) required
TransactionId (string)
glue/delete_table_optimizerDeletes an optimizer and all associated metadata for a table. The optimization will no longer be performed on the table.CatalogId (string) required
DatabaseName (string) required
TableName (string) required
Type (string) required
glue/delete_table_versionDeletes a specified version of a table.CatalogId (string)
DatabaseName (string) required
TableName (string) required
VersionId (string) required
glue/delete_triggerDeletes a specified trigger. If the trigger is not found, no exception is thrown.Name (string) required
glue/delete_usage_profileDeletes the Glue specified usage profile.Name (string) required
glue/delete_user_defined_functionDeletes an existing function definition from the Data Catalog.CatalogId (string)
DatabaseName (string) required
FunctionName (string) required
glue/delete_workflowDeletes a workflow.Name (string) required
glue/describe_connection_typeThe DescribeConnectionType API provides full details of the supported options for a given connection type in Glue. The response includes authentication configuration details that show supported authentication types and properties, and RestConfiguration for custom REST-based connection types registered via RegisterConnectionType. See also: ListConnectionTypes, RegisterConnectionType, DeleteConnectionTypeConnectionType (string) required
glue/describe_entityProvides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity. The response includes all the fields which make up the entity.ConnectionName (string) required
CatalogId (string)
EntityName (string) required
NextToken (string)
DataStoreApiVersion (string)
glue/describe_inbound_integrationsReturns a list of inbound integrations for the specified integration.IntegrationArn (string)
Marker (string)
MaxRecords (integer)
TargetArn (string)
glue/describe_integrationsThe API is used to retrieve a list of integrations.IntegrationIdentifier (string)
Marker (string)
MaxRecords (integer)
Filters (array)
glue/get_blueprintRetrieves the details of a blueprint.Name (string) required
IncludeBlueprint (boolean)
IncludeParameterSpec (boolean)
glue/get_blueprint_runRetrieves the details of a blueprint run.BlueprintName (string) required
RunId (string) required
glue/get_blueprint_runsRetrieves the details of blueprint runs for a specified blueprint.BlueprintName (string) required
NextToken (string)
MaxResults (integer)
glue/get_catalogThe name of the Catalog to retrieve. This should be all lowercase.CatalogId (string) required
glue/get_catalog_import_statusRetrieves the status of a migration operation.CatalogId (string)
glue/get_catalogsRetrieves all catalogs defined in a catalog in the Glue Data Catalog. For a Redshift-federated catalog use case, this operation returns the list of catalogs mapped to Redshift databases in the Redshift namespace catalog.ParentCatalogId (string)
NextToken (string)
MaxResults (integer)
Recursive (boolean)
IncludeRoot (boolean)
glue/get_classifierRetrieve a classifier by name.Name (string) required
glue/get_classifiersLists all classifier objects in the Data Catalog.MaxResults (integer)
NextToken (string)
glue/get_column_statistics_for_partitionRetrieves partition statistics of columns. The Identity and Access Management IAM permission required for this operation is GetPartition.CatalogId (string)
DatabaseName (string) required
TableName (string) required
PartitionValues (array) required
ColumnNames (array) required
glue/get_column_statistics_for_tableRetrieves table statistics of columns. The Identity and Access Management IAM permission required for this operation is GetTable.CatalogId (string)
DatabaseName (string) required
TableName (string) required
ColumnNames (array) required
glue/get_column_statistics_task_runGet the associated metadata/information for a task run, given a task run ID.ColumnStatisticsTaskRunId (string) required
glue/get_column_statistics_task_runsRetrieves information about all runs associated with the specified table.DatabaseName (string) required
TableName (string) required
MaxResults (integer)
NextToken (string)
glue/get_column_statistics_task_settingsGets settings for a column statistics task.DatabaseName (string) required
TableName (string) required
glue/get_connectionRetrieves a connection definition from the Data Catalog.CatalogId (string)
Name (string) required
HidePassword (boolean)
ApplyOverrideForComputeEnvironment (string)
glue/get_connectionsRetrieves a list of connection definitions from the Data Catalog.CatalogId (string)
Filter: {
. MatchCriteria (array)
. ConnectionType (string)
. ConnectionSchemaVersion (integer)
} (object)
HidePassword (boolean)
NextToken (string)
MaxResults (integer)
glue/get_crawlerRetrieves metadata for a specified crawler.Name (string) required
glue/get_crawler_metricsRetrieves metrics about specified crawlers.CrawlerNameList (array)
MaxResults (integer)
NextToken (string)
glue/get_crawlersRetrieves metadata for all crawlers defined in the customer account.MaxResults (integer)
NextToken (string)
glue/get_custom_entity_typeRetrieves the details of a custom pattern by specifying its name.Name (string) required
glue/get_databaseRetrieves the definition of a specified database.CatalogId (string)
Name (string) required
glue/get_databasesRetrieves all databases defined in a given Data Catalog.CatalogId (string)
NextToken (string)
MaxResults (integer)
ResourceShareType (string)
AttributesToGet (array)
glue/get_data_catalog_encryption_settingsRetrieves the security configuration for a specified catalog.CatalogId (string)
glue/get_dataflow_graphTransforms a Python script into a directed acyclic graph DAG.PythonScript (string)
glue/get_data_quality_modelRetrieve the training status of the model along with more information CompletedOn, StartedOn, FailureReason.StatisticId (string)
ProfileId (string) required
glue/get_data_quality_model_resultRetrieve a statistic's predictions for a given Profile ID.StatisticId (string) required
ProfileId (string) required
glue/get_data_quality_resultRetrieves the result of a data quality rule evaluation.ResultId (string) required
glue/get_data_quality_rule_recommendation_runGets the specified recommendation run that was used to generate rules.RunId (string) required
glue/get_data_quality_rulesetReturns an existing ruleset by identifier or name.Name (string) required
glue/get_data_quality_ruleset_evaluation_runRetrieves a specific run where a ruleset is evaluated against a data source.RunId (string) required
glue/get_dev_endpointRetrieves 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.EndpointName (string) required
glue/get_dev_endpointsRetrieves all the development endpoints in this Amazon Web Services 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.MaxResults (integer)
NextToken (string)
glue/get_entity_recordsThis API is used to query preview data from a given connection type or from a native Amazon S3 based Glue Data Catalog. Returns records as an array of JSON blobs. Each record is formatted using Jackson JsonNode based on the field type defined by the DescribeEntity API. Spark connectors generate schemas according to the same data type mapping as in the DescribeEntity API. Spark connectors convert data to the appropriate data types matching the schema when returning rows.ConnectionName (string)
CatalogId (string)
EntityName (string) required
NextToken (string)
DataStoreApiVersion (string)
ConnectionOptions (object)
FilterPredicate (string)
Limit (integer) required
OrderBy (string)
SelectedFields (array)
glue/get_glue_identity_center_configurationRetrieves the current Glue Identity Center configuration details, including the associated Identity Center instance and application information.No parameters
glue/get_integration_resource_propertyThis API is used for fetching the ResourceProperty of the Glue connection for the source or Glue database ARN for the targetResourceArn (string) required
glue/get_integration_table_propertiesThis API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables.ResourceArn (string) required
TableName (string) required
glue/get_jobRetrieves an existing job definition.JobName (string) required
glue/get_job_bookmarkReturns information on a job bookmark entry. For more information about enabling and using job bookmarks, see: Tracking processed data using job bookmarks Job parameters used by Glue Job structureJobName (string) required
RunId (string)
glue/get_job_runRetrieves the metadata for a given job run. Job run history is accessible for 365 days for your workflow and job run.JobName (string) required
RunId (string) required
PredecessorsIncluded (boolean)
glue/get_job_runsRetrieves metadata for all runs of a given job definition. GetJobRuns returns the job runs in chronological order, with the newest jobs returned first.JobName (string) required
NextToken (string)
MaxResults (integer)
glue/get_jobsRetrieves all current job definitions.NextToken (string)
MaxResults (integer)
glue/get_mappingCreates mappings.Source: {
. DatabaseName (string)
. TableName (string)
} (object) required
Sinks (array)
Location: {
. Jdbc (array)
. S3 (array)
. DynamoDB (array)
} (object)
glue/get_materialized_view_refresh_task_runGet the associated metadata/information for a task run, given a task run ID.CatalogId (string) required
MaterializedViewRefreshTaskRunId (string) required
glue/get_mltask_runGets 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.TransformId (string) required
TaskRunId (string) required
glue/get_mltask_runsGets 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.TransformId (string) required
NextToken (string)
MaxResults (integer)
Filter: {
. TaskRunType (string)
. Status (string)
. StartedBefore (string)
. StartedAfter (string)
} (object)
Sort: {
. Column (string)
. SortDirection (string)
} (object)
glue/get_mltransformGets 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.TransformId (string) required
glue/get_mltransformsGets 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.NextToken (string)
MaxResults (integer)
Filter: {
. Name (string)
. TransformType (string)
. Status (string)
. GlueVersion (string)
. CreatedBefore (string)
. CreatedAfter (string)
. LastModifiedBefore (string)
. LastModifiedAfter (string)
. Schema (array)
} (object)
Sort: {
. Column (string)
. SortDirection (string)
} (object)
glue/get_partitionRetrieves information about a specified partition.CatalogId (string)
DatabaseName (string) required
TableName (string) required
PartitionValues (array) required
glue/get_partition_indexesRetrieves the partition indexes associated with a table.CatalogId (string)
DatabaseName (string) required
TableName (string) required
NextToken (string)
glue/get_partitionsRetrieves information about the partitions in a table.CatalogId (string)
DatabaseName (string) required
TableName (string) required
Expression (string)
NextToken (string)
Segment: {
. SegmentNumber (integer)
. TotalSegments (integer)
} (object)
MaxResults (integer)
ExcludeColumnSchema (boolean)
TransactionId (string)
QueryAsOfTime (string)
glue/get_planGets code to perform a specified mapping.Mapping (array) required
Source: {
. DatabaseName (string)
. TableName (string)
} (object) required
Sinks (array)
Location: {
. Jdbc (array)
. S3 (array)
. DynamoDB (array)
} (object)
Language (string)
AdditionalPlanOptionsMap (object)
glue/get_registryDescribes the specified registry in detail.RegistryId: {
. RegistryName (string)
. RegistryArn (string)
} (object) required
glue/get_resource_policiesRetrieves 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.NextToken (string)
MaxResults (integer)
glue/get_resource_policyRetrieves a specified resource policy.ResourceArn (string)
glue/get_schemaDescribes the specified schema in detail.SchemaId: {
. SchemaArn (string)
. SchemaName (string)
. RegistryName (string)
} (object) required
glue/get_schema_by_definitionRetrieves 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.SchemaId: {
. SchemaArn (string)
. SchemaName (string)
. RegistryName (string)
} (object) required
SchemaDefinition (string) required
glue/get_schema_versionGet 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.SchemaId: {
. SchemaArn (string)
. SchemaName (string)
. RegistryName (string)
} (object)
SchemaVersionId (string)
SchemaVersionNumber: {
. LatestVersion (boolean)
. VersionNumber (integer)
} (object)
glue/get_schema_versions_diffFetches 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.SchemaId: {
. SchemaArn (string)
. SchemaName (string)
. RegistryName (string)
} (object) required
FirstSchemaVersionNumber: {
. LatestVersion (boolean)
. VersionNumber (integer)
} (object) required
SecondSchemaVersionNumber: {
. LatestVersion (boolean)
. VersionNumber (integer)
} (object) required
SchemaDiffType (string) required
glue/get_security_configurationRetrieves a specified security configuration.Name (string) required
glue/get_security_configurationsRetrieves a list of all security configurations.MaxResults (integer)
NextToken (string)
glue/get_sessionRetrieves the session.Id (string) required
RequestOrigin (string)
glue/get_statementRetrieves the statement.SessionId (string) required
Id (integer) required
RequestOrigin (string)
glue/get_tableRetrieves the Table definition in a Data Catalog for a specified table.CatalogId (string)
DatabaseName (string) required
Name (string) required
TransactionId (string)
QueryAsOfTime (string)
AuditContext: {
. AdditionalAuditContext (string)
. RequestedColumns (array)
. AllColumnsRequested (boolean)
} (object)
IncludeStatusDetails (boolean)
glue/get_table_optimizerReturns the configuration of all optimizers associated with a specified table.CatalogId (string) required
DatabaseName (string) required
TableName (string) required
Type (string) required
glue/get_tablesRetrieves the definitions of some or all of the tables in a given Database.CatalogId (string)
DatabaseName (string) required
Expression (string)
NextToken (string)
MaxResults (integer)
TransactionId (string)
QueryAsOfTime (string)
AuditContext: {
. AdditionalAuditContext (string)
. RequestedColumns (array)
. AllColumnsRequested (boolean)
} (object)
IncludeStatusDetails (boolean)
AttributesToGet (array)
glue/get_table_versionRetrieves a specified version of a table.CatalogId (string)
DatabaseName (string) required
TableName (string) required
VersionId (string)
glue/get_table_versionsRetrieves a list of strings that identify available versions of a specified table.CatalogId (string)
DatabaseName (string) required
TableName (string) required
NextToken (string)
MaxResults (integer)
glue/get_tagsRetrieves a list of tags associated with a resource.ResourceArn (string) required
glue/get_triggerRetrieves the definition of a trigger.Name (string) required
glue/get_triggersGets all the triggers associated with a job.NextToken (string)
DependentJobName (string)
MaxResults (integer)
glue/get_unfiltered_partition_metadataRetrieves partition metadata from the Data Catalog that contains unfiltered metadata. For IAM authorization, the public IAM action associated with this API is glue:GetPartition.Region (string)
CatalogId (string) required
DatabaseName (string) required
TableName (string) required
PartitionValues (array) required
AuditContext: {
. AdditionalAuditContext (string)
. RequestedColumns (array)
. AllColumnsRequested (boolean)
} (object)
SupportedPermissionTypes (array) required
QuerySessionContext: {
. QueryId (string)
. QueryStartTime (string)
. ClusterId (string)
. QueryAuthorizationId (string)
. AdditionalContext (object)
} (object)
glue/get_unfiltered_partitions_metadataRetrieves partition metadata from the Data Catalog that contains unfiltered metadata. For IAM authorization, the public IAM action associated with this API is glue:GetPartitions.Region (string)
CatalogId (string) required
DatabaseName (string) required
TableName (string) required
Expression (string)
AuditContext: {
. AdditionalAuditContext (string)
. RequestedColumns (array)
. AllColumnsRequested (boolean)
} (object)
SupportedPermissionTypes (array) required
NextToken (string)
Segment: {
. SegmentNumber (integer)
. TotalSegments (integer)
} (object)
MaxResults (integer)
QuerySessionContext: {
. QueryId (string)
. QueryStartTime (string)
. ClusterId (string)
. QueryAuthorizationId (string)
. AdditionalContext (object)
} (object)
glue/get_unfiltered_table_metadataAllows a third-party analytical engine to retrieve unfiltered table metadata from the Data Catalog. For IAM authorization, the public IAM action associated with this API is glue:GetTable.Region (string)
CatalogId (string) required
DatabaseName (string) required
Name (string) required
AuditContext: {
. AdditionalAuditContext (string)
. RequestedColumns (array)
. AllColumnsRequested (boolean)
} (object)
SupportedPermissionTypes (array) required
ParentResourceArn (string)
RootResourceArn (string)
SupportedDialect: {
. Dialect (string)
. DialectVersion (string)
} (object)
Permissions (array)
QuerySessionContext: {
. QueryId (string)
. QueryStartTime (string)
. ClusterId (string)
. QueryAuthorizationId (string)
. AdditionalContext (object)
} (object)
glue/get_usage_profileRetrieves information about the specified Glue usage profile.Name (string) required
glue/get_user_defined_functionRetrieves a specified function definition from the Data Catalog.CatalogId (string)
DatabaseName (string) required
FunctionName (string) required
glue/get_user_defined_functionsRetrieves multiple function definitions from the Data Catalog.CatalogId (string)
DatabaseName (string)
Pattern (string) required
FunctionType (string)
NextToken (string)
MaxResults (integer)
glue/get_workflowRetrieves resource metadata for a workflow.Name (string) required
IncludeGraph (boolean)
glue/get_workflow_runRetrieves the metadata for a given workflow run. Job run history is accessible for 90 days for your workflow and job run.Name (string) required
RunId (string) required
IncludeGraph (boolean)
glue/get_workflow_run_propertiesRetrieves the workflow run properties which were set during the run.Name (string) required
RunId (string) required
glue/get_workflow_runsRetrieves metadata for all runs of a given workflow.Name (string) required
IncludeGraph (boolean)
NextToken (string)
MaxResults (integer)
glue/import_catalog_to_glueImports an existing Amazon Athena Data Catalog to Glue.CatalogId (string)
glue/list_blueprintsLists all the blueprint names in an account.NextToken (string)
MaxResults (integer)
Tags (object)
glue/list_column_statistics_task_runsList all task runs for a particular account.MaxResults (integer)
NextToken (string)
glue/list_connection_typesThe ListConnectionTypes API provides a discovery mechanism to learn available connection types in Glue. The response contains a list of connection types with high-level details of what is supported for each connection type, including both built-in connection types and custom connection types registered via RegisterConnectionType. The connection types listed are the set of supported options for the ConnectionType value in the CreateConnection API. See also: DescribeConnectionType, RegisterConnectMaxResults (integer)
NextToken (string)
glue/list_crawlersRetrieves 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.MaxResults (integer)
NextToken (string)
Tags (object)
glue/list_crawlsReturns 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 particuCrawlerName (string) required
MaxResults (integer)
Filters (array)
NextToken (string)
glue/list_custom_entity_typesLists all the custom patterns that have been created.NextToken (string)
MaxResults (integer)
Tags (object)
glue/list_data_quality_resultsReturns all data quality execution results for your account.Filter: {
. DataSource (object)
. JobName (string)
. JobRunId (string)
. StartedAfter (string)
. StartedBefore (string)
} (object)
NextToken (string)
MaxResults (integer)
glue/list_data_quality_rule_recommendation_runsLists the recommendation runs meeting the filter criteria.Filter: {
. DataSource (object)
. StartedBefore (string)
. StartedAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
glue/list_data_quality_ruleset_evaluation_runsLists all the runs meeting the filter criteria, where a ruleset is evaluated against a data source.Filter: {
. DataSource (object)
. StartedBefore (string)
. StartedAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
glue/list_data_quality_rulesetsReturns a paginated list of rulesets for the specified list of Glue tables.NextToken (string)
MaxResults (integer)
Filter: {
. Name (string)
. Description (string)
. CreatedBefore (string)
. CreatedAfter (string)
. LastModifiedBefore (string)
. LastModifiedAfter (string)
. TargetTable (object)
} (object)
Tags (object)
glue/list_data_quality_statistic_annotationsRetrieve annotations for a data quality statistic.StatisticId (string)
ProfileId (string)
TimestampFilter: {
. RecordedBefore (string)
. RecordedAfter (string)
} (object)
MaxResults (integer)
NextToken (string)
glue/list_data_quality_statisticsRetrieves a list of data quality statistics.StatisticId (string)
ProfileId (string)
TimestampFilter: {
. RecordedBefore (string)
. RecordedAfter (string)
} (object)
MaxResults (integer)
NextToken (string)
glue/list_dev_endpointsRetrieves 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.NextToken (string)
MaxResults (integer)
Tags (object)
glue/list_entitiesReturns the available entities supported by the connection type.ConnectionName (string)
CatalogId (string)
ParentEntityName (string)
NextToken (string)
DataStoreApiVersion (string)
glue/list_integration_resource_propertiesList integration resource properties for a single customer. It supports the filters, maxRecords and markers.Marker (string)
Filters (array)
MaxRecords (integer)
glue/list_jobsRetrieves 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.NextToken (string)
MaxResults (integer)
Tags (object)
glue/list_materialized_view_refresh_task_runsList all task runs for a particular account.CatalogId (string) required
DatabaseName (string)
TableName (string)
MaxResults (integer)
NextToken (string)
glue/list_mltransformsRetrieves 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.NextToken (string)
MaxResults (integer)
Filter: {
. Name (string)
. TransformType (string)
. Status (string)
. GlueVersion (string)
. CreatedBefore (string)
. CreatedAfter (string)
. LastModifiedBefore (string)
. LastModifiedAfter (string)
. Schema (array)
} (object)
Sort: {
. Column (string)
. SortDirection (string)
} (object)
Tags (object)
glue/list_registriesReturns 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.MaxResults (integer)
NextToken (string)
glue/list_schemasReturns 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.RegistryId: {
. RegistryName (string)
. RegistryArn (string)
} (object)
MaxResults (integer)
NextToken (string)
glue/list_schema_versionsReturns 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.SchemaId: {
. SchemaArn (string)
. SchemaName (string)
. RegistryName (string)
} (object) required
MaxResults (integer)
NextToken (string)
glue/list_sessionsRetrieve a list of sessions.NextToken (string)
MaxResults (integer)
Tags (object)
RequestOrigin (string)
glue/list_statementsLists statements for the session.SessionId (string) required
RequestOrigin (string)
NextToken (string)
glue/list_table_optimizer_runsLists the history of previous optimizer runs for a specific table.CatalogId (string) required
DatabaseName (string) required
TableName (string) required
Type (string) required
MaxResults (integer)
NextToken (string)
glue/list_triggersRetrieves 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.NextToken (string)
DependentJobName (string)
MaxResults (integer)
Tags (object)
glue/list_usage_profilesList all the Glue usage profiles.NextToken (string)
MaxResults (integer)
glue/list_workflowsLists names of workflows created in the account.NextToken (string)
MaxResults (integer)
glue/modify_integrationModifies a Zero-ETL integration in the caller's account.IntegrationIdentifier (string) required
Description (string)
DataFilter (string)
IntegrationConfig: {
. RefreshInterval (string)
. SourceProperties (object)
. ContinuousSync (boolean)
} (object)
IntegrationName (string)
glue/put_data_catalog_encryption_settingsSets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.CatalogId (string)
DataCatalogEncryptionSettings: {
. EncryptionAtRest (object)
. ConnectionPasswordEncryption (object)
} (object) required
glue/put_data_quality_profile_annotationAnnotate all datapoints for a Profile.ProfileId (string) required
InclusionAnnotation (string) required
glue/put_resource_policySets the Data Catalog resource policy for access control.PolicyInJson (string) required
ResourceArn (string)
PolicyHashCondition (string)
PolicyExistsCondition (string)
EnableHybrid (string)
glue/put_schema_version_metadataPuts 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.SchemaId: {
. SchemaArn (string)
. SchemaName (string)
. RegistryName (string)
} (object)
SchemaVersionNumber: {
. LatestVersion (boolean)
. VersionNumber (integer)
} (object)
SchemaVersionId (string)
MetadataKeyValue: {
. MetadataKey (string)
. MetadataValue (string)
} (object) required
glue/put_workflow_run_propertiesPuts 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.Name (string) required
RunId (string) required
RunProperties (object) required
glue/query_schema_version_metadataQueries for the schema version metadata information.SchemaId: {
. SchemaArn (string)
. SchemaName (string)
. RegistryName (string)
} (object)
SchemaVersionNumber: {
. LatestVersion (boolean)
. VersionNumber (integer)
} (object)
SchemaVersionId (string)
MetadataList (array)
MaxResults (integer)
NextToken (string)
glue/register_connection_typeRegisters a custom connection type in Glue based on the configuration provided. This operation enables customers to configure custom connectors for any data source with REST-based APIs, eliminating the need for building custom Lambda connectors. The registered connection type stores details about how requests and responses are interpreted by REST sources, including connection properties, authentication configuration, and REST configuration with entity definitions. Once registered, customers canConnectionType (string) required
IntegrationType (string) required
Description (string)
ConnectionProperties: {
. Url (object)
. AdditionalRequestParameters (array)
} (object) required
ConnectorAuthenticationConfiguration: {
. AuthenticationTypes (array)
. OAuth2Properties (object)
. BasicAuthenticationProperties (object)
. CustomAuthenticationProperties (object)
} (object) required
RestConfiguration: {
. GlobalSourceConfiguration (object)
. ValidationEndpointConfiguration (object)
. EntityConfigurations (object)
} (object) required
Tags (object)
glue/register_schema_versionAdds 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 operationSchemaId: {
. SchemaArn (string)
. SchemaName (string)
. RegistryName (string)
} (object) required
SchemaDefinition (string) required
glue/remove_schema_version_metadataRemoves a key value pair from the schema version metadata for the specified schema version ID.SchemaId: {
. SchemaArn (string)
. SchemaName (string)
. RegistryName (string)
} (object)
SchemaVersionNumber: {
. LatestVersion (boolean)
. VersionNumber (integer)
} (object)
SchemaVersionId (string)
MetadataKeyValue: {
. MetadataKey (string)
. MetadataValue (string)
} (object) required
glue/reset_job_bookmarkResets a bookmark entry. For more information about enabling and using job bookmarks, see: Tracking processed data using job bookmarks Job parameters used by Glue Job structureJobName (string) required
RunId (string)
glue/resume_workflow_runRestarts 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.Name (string) required
RunId (string) required
NodeIds (array) required
glue/run_statementExecutes the statement.SessionId (string) required
Code (string) required
RequestOrigin (string)
glue/search_tablesSearches 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 tCatalogId (string)
NextToken (string)
Filters (array)
SearchText (string)
SortCriteria (array)
MaxResults (integer)
ResourceShareType (string)
IncludeStatusDetails (boolean)
glue/start_blueprint_runStarts a new run of the specified blueprint.BlueprintName (string) required
Parameters (string)
RoleArn (string) required
glue/start_column_statistics_task_runStarts a column statistics task run, for a specified table and columns.DatabaseName (string) required
TableName (string) required
ColumnNameList (array)
Role (string) required
SampleSize (number)
CatalogID (string)
SecurityConfiguration (string)
glue/start_column_statistics_task_run_scheduleStarts a column statistics task run schedule.DatabaseName (string) required
TableName (string) required
glue/start_crawlerStarts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException.Name (string) required
glue/start_crawler_scheduleChanges the schedule state of the specified crawler to SCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED.CrawlerName (string) required
glue/start_data_quality_rule_recommendation_runStarts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking. Recommendation runs are automatically deleted after 90 days.DataSource: {
. GlueTable (object)
. DataQualityGlueTable (object)
} (object) required
Role (string) required
NumberOfWorkers (integer)
Timeout (integer)
CreatedRulesetName (string)
DataQualitySecurityConfiguration (string)
ClientToken (string)
glue/start_data_quality_ruleset_evaluation_runOnce you have a ruleset definition either recommended or your own, you call this operation to evaluate the ruleset against a data source Glue table. The evaluation computes results which you can retrieve with the GetDataQualityResult API.DataSource: {
. GlueTable (object)
. DataQualityGlueTable (object)
} (object) required
Role (string) required
NumberOfWorkers (integer)
Timeout (integer)
ClientToken (string)
AdditionalRunOptions: {
. CloudWatchMetricsEnabled (boolean)
. ResultsS3Prefix (string)
. CompositeRuleEvaluationMethod (string)
} (object)
RulesetNames (array) required
AdditionalDataSources (object)
glue/start_export_labels_task_runBegins 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 ServTransformId (string) required
OutputS3Path (string) required
glue/start_import_labels_task_runEnables 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 ansTransformId (string) required
InputS3Path (string) required
ReplaceAllLabels (boolean)
glue/start_job_runStarts a job run using a job definition.JobName (string) required
JobRunQueuingEnabled (boolean)
JobRunId (string)
Arguments (object)
AllocatedCapacity (integer)
Timeout (integer)
MaxCapacity (number)
SecurityConfiguration (string)
NotificationProperty: {
. NotifyDelayAfter (integer)
} (object)
WorkerType (string)
NumberOfWorkers (integer)
ExecutionClass (string)
ExecutionRoleSessionPolicy (string)
glue/start_materialized_view_refresh_task_runStarts a materialized view refresh task run, for a specified table and columns.CatalogId (string) required
DatabaseName (string) required
TableName (string) required
FullRefresh (boolean)
glue/start_mlevaluation_task_runStarts 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.TransformId (string) required
glue/start_mllabeling_set_generation_task_runStarts 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 processTransformId (string) required
OutputS3Path (string) required
glue/start_triggerStarts an existing trigger. See Triggering Jobs for information about how different types of trigger are started.Name (string) required
glue/start_workflow_runStarts a new run of the specified workflow.Name (string) required
RunProperties (object)
glue/stop_column_statistics_task_runStops a task run for the specified table.DatabaseName (string) required
TableName (string) required
glue/stop_column_statistics_task_run_scheduleStops a column statistics task run schedule.DatabaseName (string) required
TableName (string) required
glue/stop_crawlerIf the specified crawler is running, stops the crawl.Name (string) required
glue/stop_crawler_scheduleSets the schedule state of the specified crawler to NOT_SCHEDULED, but does not stop the crawler if it is already running.CrawlerName (string) required
glue/stop_materialized_view_refresh_task_runStops a materialized view refresh task run, for a specified table and columns.CatalogId (string) required
DatabaseName (string) required
TableName (string) required
glue/stop_sessionStops the session.Id (string) required
RequestOrigin (string)
glue/stop_triggerStops a specified trigger.Name (string) required
glue/stop_workflow_runStops the execution of the specified workflow run.Name (string) required
RunId (string) required
glue/tag_resourceAdds 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.ResourceArn (string) required
TagsToAdd (object) required
glue/test_connectionTests a connection to a service to validate the service credentials that you provide. You can either provide an existing connection name or a TestConnectionInput for testing a non-existing connection input. Providing both at the same time will cause an error. If the action is successful, the service sends back an HTTP 200 response.ConnectionName (string)
CatalogId (string)
TestConnectionInput: {
. ConnectionType (string)
. ConnectionProperties (object)
. AuthenticationConfiguration (object)
} (object)
glue/untag_resourceRemoves tags from a resource.ResourceArn (string) required
TagsToRemove (array) required
glue/update_blueprintUpdates a registered blueprint.Name (string) required
Description (string)
BlueprintLocation (string) required
glue/update_catalogUpdates an existing catalog's properties in the Glue Data Catalog.CatalogId (string) required
CatalogInput: {
. Description (string)
. FederatedCatalog (object)
. Parameters (object)
. TargetRedshiftCatalog (object)
. CatalogProperties (object)
. CreateTableDefaultPermissions (array)
. CreateDatabaseDefaultPermissions (array)
. AllowFullTableExternalDataAccess (string)
} (object) required
glue/update_classifierModifies an existing classifier a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present.GrokClassifier: {
. Name (string)
. Classification (string)
. GrokPattern (string)
. CustomPatterns (string)
} (object)
XMLClassifier: {
. Name (string)
. Classification (string)
. RowTag (string)
} (object)
JsonClassifier: {
. Name (string)
. JsonPath (string)
} (object)
CsvClassifier: {
. Name (string)
. Delimiter (string)
. QuoteSymbol (string)
. ContainsHeader (string)
. Header (array)
. DisableValueTrimming (boolean)
. AllowSingleColumn (boolean)
. CustomDatatypeConfigured (boolean)
. CustomDatatypes (array)
. Serde (string)
} (object)
glue/update_column_statistics_for_partitionCreates or updates partition statistics of columns. The Identity and Access Management IAM permission required for this operation is UpdatePartition.CatalogId (string)
DatabaseName (string) required
TableName (string) required
PartitionValues (array) required
ColumnStatisticsList (array) required
glue/update_column_statistics_for_tableCreates or updates table statistics of columns. The Identity and Access Management IAM permission required for this operation is UpdateTable.CatalogId (string)
DatabaseName (string) required
TableName (string) required
ColumnStatisticsList (array) required
glue/update_column_statistics_task_settingsUpdates settings for a column statistics task.DatabaseName (string) required
TableName (string) required
Role (string)
Schedule (string)
ColumnNameList (array)
SampleSize (number)
CatalogID (string)
SecurityConfiguration (string)
glue/update_connectionUpdates a connection definition in the Data Catalog.CatalogId (string)
Name (string) required
ConnectionInput: {
. Name (string)
. Description (string)
. ConnectionType (string)
. MatchCriteria (array)
. ConnectionProperties (object)
. SparkProperties (object)
. AthenaProperties (object)
. PythonProperties (object)
. PhysicalConnectionRequirements (object)
. AuthenticationConfiguration (object)
. ValidateCredentials (boolean)
. ValidateForComputeEnvironments (array)
} (object) required
glue/update_crawlerUpdates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it.Name (string) required
Role (string)
DatabaseName (string)
Description (string)
Targets: {
. S3Targets (array)
. JdbcTargets (array)
. MongoDBTargets (array)
. DynamoDBTargets (array)
. CatalogTargets (array)
. DeltaTargets (array)
. IcebergTargets (array)
. HudiTargets (array)
} (object)
Schedule (string)
Classifiers (array)
TablePrefix (string)
SchemaChangePolicy: {
. UpdateBehavior (string)
. DeleteBehavior (string)
} (object)
RecrawlPolicy: {
. RecrawlBehavior (string)
} (object)
LineageConfiguration: {
. CrawlerLineageSettings (string)
} (object)
LakeFormationConfiguration: {
. UseLakeFormationCredentials (boolean)
. AccountId (string)
} (object)
Configuration (string)
CrawlerSecurityConfiguration (string)
glue/update_crawler_scheduleUpdates the schedule of a crawler using a cron expression.CrawlerName (string) required
Schedule (string)
glue/update_databaseUpdates an existing database definition in a Data Catalog.CatalogId (string)
Name (string) required
DatabaseInput: {
. Name (string)
. Description (string)
. LocationUri (string)
. Parameters (object)
. CreateTableDefaultPermissions (array)
. TargetDatabase (object)
. FederatedDatabase (object)
} (object) required
glue/update_data_quality_rulesetUpdates the specified data quality ruleset.Name (string) required
Description (string)
Ruleset (string)
glue/update_dev_endpointUpdates a specified development endpoint.EndpointName (string) required
PublicKey (string)
AddPublicKeys (array)
DeletePublicKeys (array)
CustomLibraries: {
. ExtraPythonLibsS3Path (string)
. ExtraJarsS3Path (string)
} (object)
UpdateEtlLibraries (boolean)
DeleteArguments (array)
AddArguments (object)
glue/update_glue_identity_center_configurationUpdates the existing Glue Identity Center configuration, allowing modification of scopes and permissions for the integration.Scopes (array)
UserBackgroundSessionsEnabled (boolean)
glue/update_integration_resource_propertyThis API can be used for updating the ResourceProperty of the Glue connection for the source or Glue database ARN for the target. These properties can include the role to access the connection or database. Since the same resource can be used across multiple integrations, updating resource properties will impact all the integrations using it.ResourceArn (string) required
SourceProcessingProperties: {
. RoleArn (string)
} (object)
TargetProcessingProperties: {
. RoleArn (string)
. KmsArn (string)
. ConnectionName (string)
. EventBusArn (string)
} (object)
glue/update_integration_table_propertiesThis API is used to provide optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn with SourceTableConfig, and the Glue database ARN as ResourceArn with TargetTableConfig respectively. The override will be reflected across all the integrations using same ResourResourceArn (string) required
TableName (string) required
SourceTableConfig: {
. Fields (array)
. FilterPredicate (string)
. PrimaryKey (array)
. RecordUpdateField (string)
} (object)
TargetTableConfig: {
. UnnestSpec (string)
. PartitionSpec (array)
. TargetTableName (string)
} (object)
glue/update_jobUpdates an existing job definition. The previous job definition is completely overwritten by this information.JobName (string) required
JobUpdate: {
. JobMode (string)
. JobRunQueuingEnabled (boolean)
. Description (string)
. LogUri (string)
. Role (string)
. ExecutionProperty (object)
. Command (object)
. DefaultArguments (object)
. NonOverridableArguments (object)
. Connections (object)
. MaxRetries (integer)
. AllocatedCapacity (integer)
. Timeout (integer)
. MaxCapacity (number)
. WorkerType (string)
. NumberOfWorkers (integer)
. SecurityConfiguration (string)
. NotificationProperty (object)
. GlueVersion (string)
. CodeGenConfigurationNodes (object)
. ExecutionClass (string)
. SourceControlDetails (object)
. MaintenanceWindow (string)
} (object) required
glue/update_job_from_source_controlSynchronizes 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.JobName (string)
Provider (string)
RepositoryName (string)
RepositoryOwner (string)
BranchName (string)
Folder (string)
CommitId (string)
AuthStrategy (string)
AuthToken (string)
glue/update_mltransformUpdates 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.TransformId (string) required
Name (string)
Description (string)
Parameters: {
. TransformType (string)
. FindMatchesParameters (object)
} (object)
Role (string)
GlueVersion (string)
MaxCapacity (number)
WorkerType (string)
NumberOfWorkers (integer)
Timeout (integer)
MaxRetries (integer)
glue/update_partitionUpdates a partition.CatalogId (string)
DatabaseName (string) required
TableName (string) required
PartitionValueList (array) required
PartitionInput: {
. Values (array)
. LastAccessTime (string)
. StorageDescriptor (object)
. Parameters (object)
. LastAnalyzedTime (string)
} (object) required
glue/update_registryUpdates 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.RegistryId: {
. RegistryName (string)
. RegistryArn (string)
} (object) required
Description (string) required
glue/update_schemaUpdates 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 cSchemaId: {
. SchemaArn (string)
. SchemaName (string)
. RegistryName (string)
} (object) required
SchemaVersionNumber: {
. LatestVersion (boolean)
. VersionNumber (integer)
} (object)
Compatibility (string)
Description (string)
glue/update_source_control_from_jobSynchronizes 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.JobName (string)
Provider (string)
RepositoryName (string)
RepositoryOwner (string)
BranchName (string)
Folder (string)
CommitId (string)
AuthStrategy (string)
AuthToken (string)
glue/update_tableUpdates a metadata table in the Data Catalog.CatalogId (string)
DatabaseName (string) required
Name (string)
TableInput: {
. Name (string)
. Description (string)
. Owner (string)
. LastAccessTime (string)
. LastAnalyzedTime (string)
. Retention (integer)
. StorageDescriptor (object)
. PartitionKeys (array)
. ViewOriginalText (string)
. ViewExpandedText (string)
. TableType (string)
. Parameters (object)
. TargetTable (object)
. ViewDefinition (object)
} (object)
SkipArchive (boolean)
TransactionId (string)
VersionId (string)
ViewUpdateAction (string)
Force (boolean)
UpdateOpenTableFormatInput: {
. UpdateIcebergInput (object)
} (object)
glue/update_table_optimizerUpdates the configuration for an existing table optimizer.CatalogId (string) required
DatabaseName (string) required
TableName (string) required
Type (string) required
TableOptimizerConfiguration: {
. roleArn (string)
. enabled (boolean)
. vpcConfiguration
. compactionConfiguration (object)
. retentionConfiguration (object)
. orphanFileDeletionConfiguration (object)
} (object) required
glue/update_triggerUpdates a trigger definition. Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to keep them within the Job.Name (string) required
TriggerUpdate: {
. Name (string)
. Description (string)
. Schedule (string)
. Actions (array)
. Predicate (object)
. EventBatchingCondition (object)
} (object) required
glue/update_usage_profileUpdate an Glue usage profile.Name (string) required
Description (string)
Configuration: {
. SessionConfiguration (object)
. JobConfiguration (object)
} (object) required
glue/update_user_defined_functionUpdates an existing function definition in the Data Catalog.CatalogId (string)
DatabaseName (string) required
FunctionName (string) required
FunctionInput: {
. FunctionName (string)
. ClassName (string)
. OwnerName (string)
. FunctionType (string)
. OwnerType (string)
. ResourceUris (array)
} (object) required
glue/update_workflowUpdates an existing workflow.Name (string) required
Description (string)
DefaultRunProperties (object)
MaxConcurrentRuns (integer)
grafana/list_tags_for_resourceThe 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.resourceArn (string) required
grafana/list_versionsLists available versions of Grafana. These are available when calling CreateWorkspace. Optionally, include a workspace to list the versions to which it can be upgraded.maxResults (integer)
nextToken (string)
workspaceId (string)
grafana/tag_resourceThe 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.resourceArn (string) required
tags (object) required
grafana/untag_resourceThe UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource.resourceArn (string) required
tagKeys (array) required
grafana/create_workspace_api_keyCreates a Grafana 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. In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.keyName (string) required
keyRole (string) required
secondsToLive (integer) required
workspaceId (string) required
grafana/delete_workspace_api_keyDeletes a Grafana API key for the workspace. In workspaces compatible with Grafana version 9 or above, use workspace service accounts instead of API keys. API keys will be removed in a future release.keyName (string) required
workspaceId (string) required
grafana/describe_workspace_authenticationDisplays information about the authentication methods used in one Amazon Managed Grafana workspace.workspaceId (string) required
grafana/update_workspace_authenticationUse 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. Changes to the authentication method for a workspace may take a few minutes to take effect.workspaceId (string) required
authenticationProviders (array) required
samlConfiguration: {
. idpMetadata
. assertionAttributes (object)
. roleValues (object)
. allowedOrganizations (array)
. loginValidityDuration (integer)
} (object)
grafana/describe_workspace_configurationGets the current configuration string for the given workspace.workspaceId (string) required
grafana/update_workspace_configurationUpdates the configuration string for the given workspaceconfiguration (string) required
workspaceId (string) required
grafanaVersion (string)
grafana/associate_licenseAssigns a Grafana Enterprise license to a workspace. To upgrade, you must use ENTERPRISE for the licenseType, and pass in a valid Grafana Labs token for the grafanaToken. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise.workspaceId (string) required
licenseType (string) required
grafanaToken (string)
grafana/disassociate_licenseRemoves the Grafana Enterprise license from a workspace.workspaceId (string) required
licenseType (string) required
grafana/list_permissionsLists 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.maxResults (integer)
nextToken (string)
userType (string)
userId (string)
groupId (string)
workspaceId (string) required
grafana/update_permissionsUpdates which users in a workspace have the Grafana Admin or Editor roles.updateInstructionBatch (array) required
workspaceId (string) required
grafana/create_workspace_service_accountCreates a service account for the workspace. A service account can be used to call Grafana HTTP APIs, and run automated workloads. After creating the service account with the correct GrafanaRole for your use case, use CreateWorkspaceServiceAccountToken to create a token that can be used to authenticate and authorize Grafana HTTP API calls. You can only create service accounts for workspaces that are compatible with Grafana version 9 and above. For more information about service accounts, see Sername (string) required
grafanaRole (string) required
workspaceId (string) required
grafana/delete_workspace_service_accountDeletes a workspace service account from the workspace. This will delete any tokens created for the service account, as well. If the tokens are currently in use, the will fail to authenticate / authorize after they are deleted. Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.serviceAccountId (string) required
workspaceId (string) required
grafana/list_workspace_service_accountsReturns a list of service accounts for a workspace. Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.maxResults (integer)
nextToken (string)
workspaceId (string) required
grafana/create_workspace_service_account_tokenCreates a token that can be used to authenticate and authorize Grafana HTTP API operations for the given workspace service account. The service account acts as a user for the API operations, and defines the permissions that are used by the API. When you create the service account token, you will receive a key that is used when calling Grafana APIs. Do not lose this key, as it will not be retrievable again. If you do lose the key, you can delete the token and recreate it to receive a new key. Thiname (string) required
secondsToLive (integer) required
serviceAccountId (string) required
workspaceId (string) required
grafana/delete_workspace_service_account_tokenDeletes a token for the workspace service account. This will disable the key associated with the token. If any automation is currently using the key, it will no longer be authenticated or authorized to perform actions with the Grafana HTTP APIs. Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.tokenId (string) required
serviceAccountId (string) required
workspaceId (string) required
grafana/list_workspace_service_account_tokensReturns a list of tokens for a workspace service account. This does not return the key for each token. You cannot access keys after they are created. To create a new key, delete the token and recreate it. Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.maxResults (integer)
nextToken (string)
serviceAccountId (string) required
workspaceId (string) required
grafana/create_workspaceCreates 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.accountAccessType (string) required
clientToken (string)
organizationRoleName (string)
permissionType (string) required
stackSetName (string)
workspaceDataSources (array)
workspaceDescription (string)
workspaceName (string)
workspaceNotificationDestinations (array)
workspaceOrganizationalUnits (array)
workspaceRoleArn (string)
authenticationProviders (array) required
tags (object)
vpcConfiguration: {
. securityGroupIds (array)
. subnetIds (array)
} (object)
configuration (string)
networkAccessControl: {
. prefixListIds (array)
. vpceIds (array)
} (object)
grafanaVersion (string)
grafana/describe_workspaceDisplays information about one Amazon Managed Grafana workspace.workspaceId (string) required
grafana/update_workspaceModifies 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 IAM Identity Center, use UpdateWorkspaceAuthentication. To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions.accountAccessType (string)
organizationRoleName (string)
permissionType (string)
stackSetName (string)
workspaceDataSources (array)
workspaceDescription (string)
workspaceId (string) required
workspaceName (string)
workspaceNotificationDestinations (array)
workspaceOrganizationalUnits (array)
workspaceRoleArn (string)
vpcConfiguration: {
. securityGroupIds (array)
. subnetIds (array)
} (object)
removeVpcConfiguration (boolean)
networkAccessControl: {
. prefixListIds (array)
. vpceIds (array)
} (object)
removeNetworkAccessConfiguration (boolean)
grafana/delete_workspaceDeletes an Amazon Managed Grafana workspace.workspaceId (string) required
grafana/list_workspacesReturns 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.maxResults (integer)
nextToken (string)
greengrass/associate_role_to_groupAssociates 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.GroupId (string) required
RoleArn (string) required
greengrass/associate_service_role_to_accountAssociates 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''.RoleArn (string) required
greengrass/create_connector_definitionCreates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.AmznClientToken (string)
InitialVersion: {
. Connectors (array)
} (object)
Name (string)
tags (object)
greengrass/create_connector_definition_versionCreates a version of a connector definition which has already been defined.AmznClientToken (string)
ConnectorDefinitionId (string) required
Connectors (array)
greengrass/create_core_definitionCreates 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.AmznClientToken (string)
InitialVersion: {
. Cores (array)
} (object)
Name (string)
tags (object)
greengrass/create_core_definition_versionCreates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core.AmznClientToken (string)
CoreDefinitionId (string) required
Cores (array)
greengrass/create_deploymentCreates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.AmznClientToken (string)
DeploymentId (string)
DeploymentType (string) required
GroupId (string) required
GroupVersionId (string)
greengrass/create_device_definitionCreates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time.AmznClientToken (string)
InitialVersion: {
. Devices (array)
} (object)
Name (string)
tags (object)
greengrass/create_device_definition_versionCreates a version of a device definition that has already been defined.AmznClientToken (string)
DeviceDefinitionId (string) required
Devices (array)
greengrass/create_function_definitionCreates 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.AmznClientToken (string)
InitialVersion: {
. DefaultConfig (object)
. Functions (array)
} (object)
Name (string)
tags (object)
greengrass/create_function_definition_versionCreates a version of a Lambda function definition that has already been defined.AmznClientToken (string)
DefaultConfig: {
. Execution (object)
} (object)
FunctionDefinitionId (string) required
Functions (array)
greengrass/create_groupCreates 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.AmznClientToken (string)
InitialVersion: {
. ConnectorDefinitionVersionArn (string)
. CoreDefinitionVersionArn (string)
. DeviceDefinitionVersionArn (string)
. FunctionDefinitionVersionArn (string)
. LoggerDefinitionVersionArn (string)
. ResourceDefinitionVersionArn (string)
. SubscriptionDefinitionVersionArn (string)
} (object)
Name (string) required
tags (object)
greengrass/create_group_certificate_authorityCreates a CA for the group. If a CA already exists, it will rotate the existing CA.AmznClientToken (string)
GroupId (string) required
greengrass/create_group_versionCreates a version of a group which has already been defined.AmznClientToken (string)
ConnectorDefinitionVersionArn (string)
CoreDefinitionVersionArn (string)
DeviceDefinitionVersionArn (string)
FunctionDefinitionVersionArn (string)
GroupId (string) required
LoggerDefinitionVersionArn (string)
ResourceDefinitionVersionArn (string)
SubscriptionDefinitionVersionArn (string)
greengrass/create_logger_definitionCreates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time.AmznClientToken (string)
InitialVersion: {
. Loggers (array)
} (object)
Name (string)
tags (object)
greengrass/create_logger_definition_versionCreates a version of a logger definition that has already been defined.AmznClientToken (string)
LoggerDefinitionId (string) required
Loggers (array)
greengrass/create_resource_definitionCreates 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.AmznClientToken (string)
InitialVersion: {
. Resources (array)
} (object)
Name (string)
tags (object)
greengrass/create_resource_definition_versionCreates a version of a resource definition that has already been defined.AmznClientToken (string)
ResourceDefinitionId (string) required
Resources (array)
greengrass/create_software_update_jobCreates 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.AmznClientToken (string)
S3UrlSignerRole (string) required
SoftwareToUpdate (string) required
UpdateAgentLogLevel (string)
UpdateTargets (array) required
UpdateTargetsArchitecture (string) required
UpdateTargetsOperatingSystem (string) required
greengrass/create_subscription_definitionCreates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time.AmznClientToken (string)
InitialVersion: {
. Subscriptions (array)
} (object)
Name (string)
tags (object)
greengrass/create_subscription_definition_versionCreates a version of a subscription definition which has already been defined.AmznClientToken (string)
SubscriptionDefinitionId (string) required
Subscriptions (array)
greengrass/delete_connector_definitionDeletes a connector definition.ConnectorDefinitionId (string) required
greengrass/delete_core_definitionDeletes a core definition.CoreDefinitionId (string) required
greengrass/delete_device_definitionDeletes a device definition.DeviceDefinitionId (string) required
greengrass/delete_function_definitionDeletes a Lambda function definition.FunctionDefinitionId (string) required
greengrass/delete_groupDeletes a group.GroupId (string) required
greengrass/delete_logger_definitionDeletes a logger definition.LoggerDefinitionId (string) required
greengrass/delete_resource_definitionDeletes a resource definition.ResourceDefinitionId (string) required
greengrass/delete_subscription_definitionDeletes a subscription definition.SubscriptionDefinitionId (string) required
greengrass/disassociate_role_from_groupDisassociates the role from a group.GroupId (string) required
greengrass/disassociate_service_role_from_accountDisassociates the service role from your account. Without a service role, deployments will not work.No parameters
greengrass/get_associated_roleRetrieves the role associated with a particular group.GroupId (string) required
greengrass/get_bulk_deployment_statusReturns the status of a bulk deployment.BulkDeploymentId (string) required
greengrass/get_connectivity_infoRetrieves the connectivity information for a core.ThingName (string) required
greengrass/get_connector_definitionRetrieves information about a connector definition.ConnectorDefinitionId (string) required
greengrass/get_connector_definition_versionRetrieves 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.ConnectorDefinitionId (string) required
ConnectorDefinitionVersionId (string) required
NextToken (string)
greengrass/get_core_definitionRetrieves information about a core definition version.CoreDefinitionId (string) required
greengrass/get_core_definition_versionRetrieves information about a core definition version.CoreDefinitionId (string) required
CoreDefinitionVersionId (string) required
greengrass/get_deployment_statusReturns the status of a deployment.DeploymentId (string) required
GroupId (string) required
greengrass/get_device_definitionRetrieves information about a device definition.DeviceDefinitionId (string) required
greengrass/get_device_definition_versionRetrieves information about a device definition version.DeviceDefinitionId (string) required
DeviceDefinitionVersionId (string) required
NextToken (string)
greengrass/get_function_definitionRetrieves information about a Lambda function definition, including its creation time and latest version.FunctionDefinitionId (string) required
greengrass/get_function_definition_versionRetrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.FunctionDefinitionId (string) required
FunctionDefinitionVersionId (string) required
NextToken (string)
greengrass/get_groupRetrieves information about a group.GroupId (string) required
greengrass/get_group_certificate_authorityRetreives the CA associated with a group. Returns the public key of the CA.CertificateAuthorityId (string) required
GroupId (string) required
greengrass/get_group_certificate_configurationRetrieves the current configuration for the CA used by the group.GroupId (string) required
greengrass/get_group_versionRetrieves information about a group version.GroupId (string) required
GroupVersionId (string) required
greengrass/get_logger_definitionRetrieves information about a logger definition.LoggerDefinitionId (string) required
greengrass/get_logger_definition_versionRetrieves information about a logger definition version.LoggerDefinitionId (string) required
LoggerDefinitionVersionId (string) required
NextToken (string)
greengrass/get_resource_definitionRetrieves information about a resource definition, including its creation time and latest version.ResourceDefinitionId (string) required
greengrass/get_resource_definition_versionRetrieves information about a resource definition version, including which resources are included in the version.ResourceDefinitionId (string) required
ResourceDefinitionVersionId (string) required
greengrass/get_service_role_for_accountRetrieves the service role that is attached to your account.No parameters
greengrass/get_subscription_definitionRetrieves information about a subscription definition.SubscriptionDefinitionId (string) required
greengrass/get_subscription_definition_versionRetrieves information about a subscription definition version.NextToken (string)
SubscriptionDefinitionId (string) required
SubscriptionDefinitionVersionId (string) required
greengrass/get_thing_runtime_configurationGet the runtime configuration of a thing.ThingName (string) required
greengrass/list_bulk_deployment_detailed_reportsGets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.BulkDeploymentId (string) required
MaxResults (string)
NextToken (string)
greengrass/list_bulk_deploymentsReturns a list of bulk deployments.MaxResults (string)
NextToken (string)
greengrass/list_connector_definitionsRetrieves a list of connector definitions.MaxResults (string)
NextToken (string)
greengrass/list_connector_definition_versionsLists 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.ConnectorDefinitionId (string) required
MaxResults (string)
NextToken (string)
greengrass/list_core_definitionsRetrieves a list of core definitions.MaxResults (string)
NextToken (string)
greengrass/list_core_definition_versionsLists the versions of a core definition.CoreDefinitionId (string) required
MaxResults (string)
NextToken (string)
greengrass/list_deploymentsReturns a history of deployments for the group.GroupId (string) required
MaxResults (string)
NextToken (string)
greengrass/list_device_definitionsRetrieves a list of device definitions.MaxResults (string)
NextToken (string)
greengrass/list_device_definition_versionsLists the versions of a device definition.DeviceDefinitionId (string) required
MaxResults (string)
NextToken (string)
greengrass/list_function_definitionsRetrieves a list of Lambda function definitions.MaxResults (string)
NextToken (string)
greengrass/list_function_definition_versionsLists the versions of a Lambda function definition.FunctionDefinitionId (string) required
MaxResults (string)
NextToken (string)
greengrass/list_group_certificate_authoritiesRetrieves the current CAs for a group.GroupId (string) required
greengrass/list_groupsRetrieves a list of groups.MaxResults (string)
NextToken (string)
greengrass/list_group_versionsLists the versions of a group.GroupId (string) required
MaxResults (string)
NextToken (string)
greengrass/list_logger_definitionsRetrieves a list of logger definitions.MaxResults (string)
NextToken (string)
greengrass/list_logger_definition_versionsLists the versions of a logger definition.LoggerDefinitionId (string) required
MaxResults (string)
NextToken (string)
greengrass/list_resource_definitionsRetrieves a list of resource definitions.MaxResults (string)
NextToken (string)
greengrass/list_resource_definition_versionsLists the versions of a resource definition.MaxResults (string)
NextToken (string)
ResourceDefinitionId (string) required
greengrass/list_subscription_definitionsRetrieves a list of subscription definitions.MaxResults (string)
NextToken (string)
greengrass/list_subscription_definition_versionsLists the versions of a subscription definition.MaxResults (string)
NextToken (string)
SubscriptionDefinitionId (string) required
greengrass/list_tags_for_resourceRetrieves a list of resource tags for a resource arn.ResourceArn (string) required
greengrass/reset_deploymentsResets a group's deployments.AmznClientToken (string)
Force (boolean)
GroupId (string) required
greengrass/start_bulk_deploymentDeploys 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.AmznClientToken (string)
ExecutionRoleArn (string) required
InputFileUri (string) required
tags (object)
greengrass/stop_bulk_deploymentStops 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.BulkDeploymentId (string) required
greengrass/tag_resourceAdds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'.ResourceArn (string) required
tags (object)
greengrass/untag_resourceRemove resource tags from a Greengrass Resource.ResourceArn (string) required
TagKeys (array) required
greengrass/update_connectivity_infoUpdates 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.ConnectivityInfo (array)
ThingName (string) required
greengrass/update_connector_definitionUpdates a connector definition.ConnectorDefinitionId (string) required
Name (string)
greengrass/update_core_definitionUpdates a core definition.CoreDefinitionId (string) required
Name (string)
greengrass/update_device_definitionUpdates a device definition.DeviceDefinitionId (string) required
Name (string)
greengrass/update_function_definitionUpdates a Lambda function definition.FunctionDefinitionId (string) required
Name (string)
greengrass/update_groupUpdates a group.GroupId (string) required
Name (string)
greengrass/update_group_certificate_configurationUpdates the Certificate expiry time for a group.CertificateExpiryInMilliseconds (string)
GroupId (string) required
greengrass/update_logger_definitionUpdates a logger definition.LoggerDefinitionId (string) required
Name (string)
greengrass/update_resource_definitionUpdates a resource definition.Name (string)
ResourceDefinitionId (string) required
greengrass/update_subscription_definitionUpdates a subscription definition.Name (string)
SubscriptionDefinitionId (string) required
greengrass/update_thing_runtime_configurationUpdates the runtime configuration of a thing.TelemetryConfiguration: {
. Telemetry (string)
} (object)
ThingName (string) required
greengrassv2/associate_service_role_to_accountAssociates 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 GreengrasroleArn (string) required
greengrassv2/batch_associate_client_device_with_core_deviceAssociates 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 deventries (array)
coreDeviceThingName (string) required
greengrassv2/batch_disassociate_client_device_from_core_deviceDisassociates 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.entries (array)
coreDeviceThingName (string) required
greengrassv2/cancel_deploymentCancels 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.deploymentId (string) required
greengrassv2/create_component_versionCreates 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 platforminlineRecipe (string)
lambdaFunction: {
. lambdaArn (string)
. componentName (string)
. componentVersion (string)
. componentPlatforms (array)
. componentDependencies (object)
. componentLambdaParameters (object)
} (object)
tags (object)
clientToken (string)
greengrassv2/create_deploymentCreates 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 hatargetArn (string) required
deploymentName (string)
components (object)
iotJobConfiguration: {
. jobExecutionsRolloutConfig (object)
. abortConfig (object)
. timeoutConfig (object)
} (object)
deploymentPolicies: {
. failureHandlingPolicy (string)
. componentUpdatePolicy (object)
. configurationValidationPolicy (object)
} (object)
parentTargetArn (string)
tags (object)
clientToken (string)
greengrassv2/delete_componentDeletes 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.arn (string) required
greengrassv2/delete_core_deviceDeletes 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.coreDeviceThingName (string) required
greengrassv2/delete_deploymentDeletes 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.deploymentId (string) required
greengrassv2/describe_componentRetrieves metadata for a version of a component.arn (string) required
greengrassv2/disassociate_service_role_from_accountDisassociates 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.No parameters
greengrassv2/get_componentGets the recipe for a version of a component.recipeOutputFormat (string)
arn (string) required
greengrassv2/get_component_version_artifactGets 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.arn (string) required
artifactName (string) required
s3EndpointType (string)
iotEndpointType (string)
greengrassv2/get_connectivity_infoRetrieves 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.thingName (string) required
greengrassv2/get_core_deviceRetrieves 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 GrcoreDeviceThingName (string) required
greengrassv2/get_deploymentGets a deployment. Deployments define the components that run on Greengrass core devices.deploymentId (string) required
greengrassv2/get_service_role_for_accountGets 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.No parameters
greengrassv2/list_client_devices_associated_with_core_deviceRetrieves a paginated list of client devices that are associated with a core device.coreDeviceThingName (string) required
maxResults (integer)
nextToken (string)
greengrassv2/list_componentsRetrieves a paginated list of component summaries. This list includes components that you have permission to view.scope (string)
maxResults (integer)
nextToken (string)
greengrassv2/list_component_versionsRetrieves a paginated list of all versions for a component. Greater versions are listed first.arn (string) required
maxResults (integer)
nextToken (string)
greengrassv2/list_core_devicesRetrieves 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 thethingGroupArn (string)
status (string)
maxResults (integer)
nextToken (string)
runtime (string)
greengrassv2/list_deploymentsRetrieves a paginated list of deployments.targetArn (string)
historyFilter (string)
parentTargetArn (string)
maxResults (integer)
nextToken (string)
greengrassv2/list_effective_deploymentsRetrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.coreDeviceThingName (string) required
maxResults (integer)
nextToken (string)
greengrassv2/list_installed_componentsRetrieves 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, thencoreDeviceThingName (string) required
maxResults (integer)
nextToken (string)
topologyFilter (string)
greengrassv2/list_tags_for_resourceRetrieves the list of tags for an IoT Greengrass resource.resourceArn (string) required
greengrassv2/resolve_component_candidatesRetrieves 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 versplatform: {
. name (string)
. attributes (object)
} (object)
componentCandidates (array)
greengrassv2/tag_resourceAdds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.resourceArn (string) required
tags (object) required
greengrassv2/untag_resourceRemoves a tag from an IoT Greengrass resource.resourceArn (string) required
tagKeys (array) required
greengrassv2/update_connectivity_infoUpdates 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.thingName (string) required
connectivityInfo (array) required
groundstation/get_agent_task_response_urlFor use by AWS Ground Station Agent and shouldn't be called directly. Gets a presigned URL for uploading agent task response logs.agentId (string) required
taskId (string) required
groundstation/get_minute_usageReturns the number of reserved minutes used by account.month (integer) required
year (integer) required
groundstation/list_tags_for_resourceReturns a list of tags for a specified resource.resourceArn (string) required
groundstation/tag_resourceAssigns a tag to a resource.resourceArn (string) required
tags (object) required
groundstation/untag_resourceDeassigns a resource tag.resourceArn (string) required
tagKeys (array) required
groundstation/register_agentFor use by AWS Ground Station Agent and shouldn't be called directly. Registers a new agent with AWS Ground Station.discoveryData: {
. publicIpAddresses (array)
. privateIpAddresses (array)
. capabilityArns (array)
} (object) required
agentDetails: {
. agentVersion (string)
. instanceId (string)
. instanceType (string)
. reservedCpuCores (array)
. agentCpuCores (array)
. componentVersions (array)
} (object) required
tags (object)
groundstation/get_agent_configurationFor use by AWS Ground Station Agent and shouldn't be called directly. Gets the latest configuration information for a registered agent.agentId (string) required
groundstation/update_agent_statusFor use by AWS Ground Station Agent and shouldn't be called directly. Update the status of the agent.agentId (string) required
taskId (string) required
aggregateStatus: {
. status (string)
. signatureMap (object)
} (object) required
componentStatuses (array) required
groundstation/create_configCreates a Config with the specified configData parameters. Only one type of configData can be specified.name (string) required
configData (undefined) required
tags (object)
groundstation/get_configReturns Config information. Only one Config response can be returned.configId (string) required
configType (string) required
groundstation/update_configUpdates the Config used when scheduling contacts. Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.configId (string) required
name (string) required
configType (string) required
configData (undefined) required
groundstation/delete_configDeletes a Config.configId (string) required
configType (string) required
groundstation/list_configsReturns a list of Config objects.maxResults (integer)
nextToken (string)
groundstation/reserve_contactReserves a contact using specified parameters.missionProfileArn (string) required
satelliteArn (string)
startTime (string) required
endTime (string) required
groundStation (string) required
tags (object)
trackingOverrides: {
. programTrackSettings
} (object)
groundstation/describe_contactDescribes an existing contact.contactId (string) required
groundstation/cancel_contactCancels or stops a contact with a specified contact ID based on its position in the contact lifecycle. For contacts that: Have yet to start, the contact will be cancelled. Have started but have yet to finish, the contact will be stopped.contactId (string) required
groundstation/list_contactsReturns a list of contacts. If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.maxResults (integer)
nextToken (string)
statusList (array) required
startTime (string) required
endTime (string) required
groundStation (string)
satelliteArn (string)
missionProfileArn (string)
ephemeris (undefined)
groundstation/create_dataflow_endpoint_groupCreates 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.endpointDetails (array) required
tags (object)
contactPrePassDurationSeconds (integer)
contactPostPassDurationSeconds (integer)
groundstation/get_dataflow_endpoint_groupReturns the dataflow endpoint group.dataflowEndpointGroupId (string) required
groundstation/delete_dataflow_endpoint_groupDeletes a dataflow endpoint group.dataflowEndpointGroupId (string) required
groundstation/list_dataflow_endpoint_groupsReturns a list of DataflowEndpoint groups.maxResults (integer)
nextToken (string)
groundstation/create_dataflow_endpoint_group_v2Creates a DataflowEndpoint group containing the specified list of Ground Station Agent based endpoints. 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.endpoints (array) required
contactPrePassDurationSeconds (integer)
contactPostPassDurationSeconds (integer)
tags (object)
groundstation/create_ephemerisCreate an ephemeris with your specified EphemerisData.satelliteId (string)
enabled (boolean)
priority (integer)
expirationTime (string)
name (string) required
kmsKeyArn (string)
ephemeris (undefined)
tags (object)
groundstation/describe_ephemerisRetrieve information about an existing ephemeris.ephemerisId (string) required
groundstation/update_ephemerisUpdate an existing ephemeris.ephemerisId (string) required
enabled (boolean) required
name (string)
priority (integer)
groundstation/delete_ephemerisDelete an ephemeris.ephemerisId (string) required
groundstation/list_ephemeridesList your existing ephemerides.satelliteId (string)
ephemerisType (string)
startTime (string) required
endTime (string) required
statusList (array)
maxResults (integer)
nextToken (string)
groundstation/list_ground_stationsReturns a list of ground stations.satelliteId (string)
maxResults (integer)
nextToken (string)
groundstation/create_mission_profileCreates 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.name (string) required
contactPrePassDurationSeconds (integer)
contactPostPassDurationSeconds (integer)
minimumViableContactDurationSeconds (integer) required
dataflowEdges (array) required
trackingConfigArn (string) required
telemetrySinkConfigArn (string)
tags (object)
streamsKmsKey (undefined)
streamsKmsRole (string)
groundstation/get_mission_profileReturns a mission profile.missionProfileId (string) required
groundstation/update_mission_profileUpdates a mission profile. Updating a mission profile will not update the execution parameters for existing future contacts.missionProfileId (string) required
name (string)
contactPrePassDurationSeconds (integer)
contactPostPassDurationSeconds (integer)
minimumViableContactDurationSeconds (integer)
dataflowEdges (array)
trackingConfigArn (string)
telemetrySinkConfigArn (string)
streamsKmsKey (undefined)
streamsKmsRole (string)
groundstation/delete_mission_profileDeletes a mission profile.missionProfileId (string) required
groundstation/list_mission_profilesReturns a list of mission profiles.maxResults (integer)
nextToken (string)
groundstation/get_satelliteReturns a satellite.satelliteId (string) required
groundstation/list_satellitesReturns a list of satellites.maxResults (integer)
nextToken (string)
guardduty/accept_administrator_invitationAccepts the invitation to be a member account and get monitored by a GuardDuty administrator account that sent the invitation.DetectorId (string) required
AdministratorId (string) required
InvitationId (string) required
guardduty/accept_invitationAccepts the invitation to be monitored by a GuardDuty administrator account.DetectorId (string) required
MasterId (string) required
InvitationId (string) required
guardduty/archive_findingsArchives 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.DetectorId (string) required
FindingIds (array) required
guardduty/create_detectorCreates a single 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. When you don't specify any features, with an exception to RUNTIME_MONITORING, all the optional features are enabled by default. When you specify some of the features, any feature that isEnable (boolean) required
ClientToken (string)
FindingPublishingFrequency (string)
DataSources: {
. S3Logs (object)
. Kubernetes (object)
. MalwareProtection (object)
} (object)
Tags (object)
Features (array)
guardduty/create_filterCreates a filter using the specified finding criteria. The maximum number of saved filters per Amazon Web Services account per Region is 100. For more information, see Quotas for GuardDuty.DetectorId (string) required
Name (string) required
Description (string)
Action (string)
Rank (integer)
FindingCriteria: {
. Criterion (object)
} (object) required
ClientToken (string)
Tags (object)
guardduty/create_ipsetCreates 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.DetectorId (string) required
Name (string) required
Format (string) required
Location (string) required
Activate (boolean) required
ClientToken (string)
Tags (object)
ExpectedBucketOwner (string)
guardduty/create_malware_protection_planCreates a new Malware Protection plan for the protected resource. When you create a Malware Protection plan, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuardDuty Malware Protection.ClientToken (string)
Role (string) required
ProtectedResource: {
. S3Bucket (object)
} (object) required
Actions: {
. Tagging (object)
} (object)
Tags (object)
guardduty/create_membersCreates 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. As a delegated administrator, using CreateMembers will enable GuardDuty in the added member accounts, with the exception of the organization delegated administrator account. A delegated administrator must enable GuardDuty prior to being added as a member.DetectorId (string) required
AccountDetails (array) required
guardduty/create_publishing_destinationCreates a publishing destination where you can export your GuardDuty findings. Before you start exporting the findings, the destination resource must exist.DetectorId (string) required
DestinationType (string) required
DestinationProperties: {
. DestinationArn (string)
. KmsKeyArn (string)
} (object) required
ClientToken (string)
Tags (object)
guardduty/create_sample_findingsGenerates sample findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes, the API generates sample findings of all supported finding types.DetectorId (string) required
FindingTypes (array)
guardduty/create_threat_entity_setCreates a new threat entity set. In a threat entity set, you can provide known malicious IP addresses and domains for your Amazon Web Services environment. GuardDuty generates findings based on the entries in the threat entity sets. Only users of the administrator account can manage entity sets, which automatically apply to member accounts.DetectorId (string) required
Name (string) required
Format (string) required
Location (string) required
ExpectedBucketOwner (string)
Activate (boolean) required
ClientToken (string)
Tags (object)
guardduty/create_threat_intel_setCreates 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.DetectorId (string) required
Name (string) required
Format (string) required
Location (string) required
Activate (boolean) required
ClientToken (string)
Tags (object)
ExpectedBucketOwner (string)
guardduty/create_trusted_entity_setCreates a new trusted entity set. In the trusted entity set, you can provide IP addresses and domains that you believe are secure for communication in your Amazon Web Services environment. GuardDuty will not generate findings for the entries that are specified in a trusted entity set. At any given time, you can have only one trusted entity set. Only users of the administrator account can manage the entity sets, which automatically apply to member accounts.DetectorId (string) required
Name (string) required
Format (string) required
Location (string) required
ExpectedBucketOwner (string)
Activate (boolean) required
ClientToken (string)
Tags (object)
guardduty/decline_invitationsDeclines invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.AccountIds (array) required
guardduty/delete_detectorDeletes an Amazon GuardDuty detector that is specified by the detector ID.DetectorId (string) required
guardduty/delete_filterDeletes the filter specified by the filter name.DetectorId (string) required
FilterName (string) required
guardduty/delete_invitationsDeletes invitations sent to the current member account by Amazon Web Services accounts specified by their account IDs.AccountIds (array) required
guardduty/delete_ipsetDeletes the IPSet specified by the ipSetId. IPSets are called trusted IP lists in the console user interface.DetectorId (string) required
IpSetId (string) required
guardduty/delete_malware_protection_planDeletes the Malware Protection plan ID associated with the Malware Protection plan resource. Use this API only when you no longer want to protect the resource associated with this Malware Protection plan ID.MalwareProtectionPlanId (string) required
guardduty/delete_membersDeletes GuardDuty member accounts to the current GuardDuty administrator account specified by the account IDs. With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to disable GuardDuty for a member account in your organization.DetectorId (string) required
AccountIds (array) required
guardduty/delete_publishing_destinationDeletes the publishing definition with the specified destinationId.DetectorId (string) required
DestinationId (string) required
guardduty/delete_threat_entity_setDeletes the threat entity set that is associated with the specified threatEntitySetId.DetectorId (string) required
ThreatEntitySetId (string) required
guardduty/delete_threat_intel_setDeletes the ThreatIntelSet specified by the ThreatIntelSet ID.DetectorId (string) required
ThreatIntelSetId (string) required
guardduty/delete_trusted_entity_setDeletes the trusted entity set that is associated with the specified trustedEntitySetId.DetectorId (string) required
TrustedEntitySetId (string) required
guardduty/describe_malware_scansReturns a list of malware scans. Each member account can view the malware scans for their own accounts. An administrator can view the malware scans for all the member accounts. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.DetectorId (string) required
NextToken (string)
MaxResults (integer)
FilterCriteria: {
. FilterCriterion (array)
} (object)
SortCriteria: {
. AttributeName (string)
. OrderBy (string)
} (object)
guardduty/describe_organization_configurationReturns information about the account selected as the delegated administrator for GuardDuty. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.DetectorId (string) required
MaxResults (integer)
NextToken (string)
guardduty/describe_publishing_destinationReturns information about the publishing destination specified by the provided destinationId.DetectorId (string) required
DestinationId (string) required
guardduty/disable_organization_admin_accountRemoves the existing GuardDuty delegated administrator of the organization. Only the organization's management account can run this API operation.AdminAccountId (string) required
guardduty/disassociate_from_administrator_accountDisassociates the current GuardDuty member account from its administrator account. When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated adminisDetectorId (string) required
guardduty/disassociate_from_master_accountDisassociates the current GuardDuty member account from its administrator account. When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member account, the delegated adminisDetectorId (string) required
guardduty/disassociate_membersDisassociates GuardDuty member accounts from the current administrator account specified by the account IDs. When you disassociate an invited member from a GuardDuty delegated administrator, the member account details obtained from the CreateMembers API, including the associated email addresses, are retained. This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To remove the details associated with a member accoDetectorId (string) required
AccountIds (array) required
guardduty/enable_organization_admin_accountDesignates an Amazon Web Services account within the organization as your GuardDuty delegated administrator. Only the organization's management account can run this API operation.AdminAccountId (string) required
guardduty/get_administrator_accountProvides the details of the GuardDuty administrator account associated with the current GuardDuty member account. Based on the type of account that runs this API, the following list shows how the API behavior varies: When the GuardDuty administrator account runs this API, it will return success HTTP 200 but no content. When a member account runs this API, it will return the details of the GuardDuty administrator account that is associated with this calling member account. When an individual accoDetectorId (string) required
guardduty/get_coverage_statisticsRetrieves aggregated statistics for your account. If you are a GuardDuty administrator, you can retrieve the statistics for all the resources associated with the active member accounts in your organization who have enabled Runtime Monitoring and have the GuardDuty security agent running on their resources.DetectorId (string) required
FilterCriteria: {
. FilterCriterion (array)
} (object)
StatisticsType (array) required
guardduty/get_detectorRetrieves a GuardDuty detector specified by the detectorId. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.DetectorId (string) required
guardduty/get_filterReturns the details of the filter specified by the filter name.DetectorId (string) required
FilterName (string) required
guardduty/get_findingsDescribes Amazon GuardDuty findings specified by finding IDs.DetectorId (string) required
FindingIds (array) required
SortCriteria: {
. AttributeName (string)
. OrderBy (string)
} (object)
guardduty/get_findings_statisticsLists GuardDuty findings statistics for the specified detector ID. You must provide either findingStatisticTypes or groupBy parameter, and not both. You can use the maxResults and orderBy parameters only when using groupBy. There might be regional differences because some flags might not be available in all the Regions where GuardDuty is currently supported. For more information, see Regions and endpoints.DetectorId (string) required
FindingStatisticTypes (array)
FindingCriteria: {
. Criterion (object)
} (object)
GroupBy (string)
OrderBy (string)
MaxResults (integer)
guardduty/get_invitations_countReturns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.No parameters
guardduty/get_ipsetRetrieves the IPSet specified by the ipSetId.DetectorId (string) required
IpSetId (string) required
guardduty/get_malware_protection_planRetrieves the Malware Protection plan details associated with a Malware Protection plan ID.MalwareProtectionPlanId (string) required
guardduty/get_malware_scanRetrieves the detailed information for a specific malware scan. Each member account can view the malware scan details for their own account. An administrator can view malware scan details for all accounts in the organization. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.ScanId (string) required
guardduty/get_malware_scan_settingsReturns the details of the malware scan settings. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.DetectorId (string) required
guardduty/get_master_accountProvides the details for the GuardDuty administrator account associated with the current GuardDuty member account.DetectorId (string) required
guardduty/get_member_detectorsDescribes which data sources are enabled for the member account's detector. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.DetectorId (string) required
AccountIds (array) required
guardduty/get_membersRetrieves GuardDuty member accounts of the current GuardDuty administrator account specified by the account IDs.DetectorId (string) required
AccountIds (array) required
guardduty/get_organization_statisticsRetrieves how many active member accounts have each feature enabled within GuardDuty. Only a delegated GuardDuty administrator of an organization can run this API. When you create a new organization, it might take up to 24 hours to generate the statistics for the entire organization.No parameters
guardduty/get_remaining_free_trial_daysProvides the number of days left for each data source used in the free trial period.DetectorId (string) required
AccountIds (array) required
guardduty/get_threat_entity_setRetrieves the threat entity set associated with the specified threatEntitySetId.DetectorId (string) required
ThreatEntitySetId (string) required
guardduty/get_threat_intel_setRetrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.DetectorId (string) required
ThreatIntelSetId (string) required
guardduty/get_trusted_entity_setRetrieves the trusted entity set associated with the specified trustedEntitySetId.DetectorId (string) required
TrustedEntitySetId (string) required
guardduty/get_usage_statisticsLists 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.DetectorId (string) required
UsageStatisticType (string) required
UsageCriteria: {
. AccountIds (array)
. DataSources (array)
. Resources (array)
. Features (array)
} (object) required
Unit (string)
MaxResults (integer)
NextToken (string)
guardduty/invite_membersInvites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account that invokes this API. If you are using Amazon Web Services Organizations to manage your GuardDuty environment, this step is not needed. For more information, see Managing accounts with organizations. To invite Amazon Web Services accounts, the first step is to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API to add accountsDetectorId (string) required
AccountIds (array) required
DisableEmailNotification (boolean)
Message (string)
guardduty/list_coverageLists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can retrieve all resources associated with the active member accounts in your organization. Make sure the accounts have Runtime Monitoring enabled and GuardDuty agent running on their resources.DetectorId (string) required
NextToken (string)
MaxResults (integer)
FilterCriteria: {
. FilterCriterion (array)
} (object)
SortCriteria: {
. AttributeName (string)
. OrderBy (string)
} (object)
guardduty/list_detectorsLists detectorIds of all the existing Amazon GuardDuty detector resources.MaxResults (integer)
NextToken (string)
guardduty/list_filtersReturns a paginated list of the current filters.DetectorId (string) required
MaxResults (integer)
NextToken (string)
guardduty/list_findingsLists GuardDuty findings for the specified detector ID. There might be regional differences because some flags might not be available in all the Regions where GuardDuty is currently supported. For more information, see Regions and endpoints.DetectorId (string) required
FindingCriteria: {
. Criterion (object)
} (object)
SortCriteria: {
. AttributeName (string)
. OrderBy (string)
} (object)
MaxResults (integer)
NextToken (string)
guardduty/list_invitationsLists all GuardDuty membership invitations that were sent to the current Amazon Web Services account.MaxResults (integer)
NextToken (string)
guardduty/list_ipsetsLists 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.DetectorId (string) required
MaxResults (integer)
NextToken (string)
guardduty/list_malware_protection_plansLists the Malware Protection plan IDs associated with the protected resources in your Amazon Web Services account.NextToken (string)
guardduty/list_malware_scansReturns a list of malware scans. Each member account can view the malware scans for their own accounts. An administrator can view the malware scans for all of its members' accounts.MaxResults (integer)
NextToken (string)
FilterCriteria: {
. ListMalwareScansFilterCriterion (array)
} (object)
SortCriteria: {
. AttributeName (string)
. OrderBy (string)
} (object)
guardduty/list_membersLists details about all member accounts for the current GuardDuty administrator account.DetectorId (string) required
MaxResults (integer)
NextToken (string)
OnlyAssociated (string)
guardduty/list_organization_admin_accountsLists the accounts designated as GuardDuty delegated administrators. Only the organization's management account can run this API operation.MaxResults (integer)
NextToken (string)
guardduty/list_publishing_destinationsReturns a list of publishing destinations associated with the specified detectorId.DetectorId (string) required
MaxResults (integer)
NextToken (string)
guardduty/list_tags_for_resourceLists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.ResourceArn (string) required
guardduty/list_threat_entity_setsLists the threat entity sets associated with the specified GuardDuty detector ID. If you use this operation from a member account, the threat entity sets that are returned as a response, belong to the administrator account.DetectorId (string) required
MaxResults (integer)
NextToken (string)
guardduty/list_threat_intel_setsLists 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.DetectorId (string) required
MaxResults (integer)
NextToken (string)
guardduty/list_trusted_entity_setsLists the trusted entity sets associated with the specified GuardDuty detector ID. If you use this operation from a member account, the trusted entity sets that are returned as a response, belong to the administrator account.DetectorId (string) required
MaxResults (integer)
NextToken (string)
guardduty/send_object_malware_scanInitiates a malware scan for a specific S3 object. This API allows you to perform on-demand malware scanning of individual objects in S3 buckets that have Malware Protection for S3 enabled. When you use this API, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuardDuty Malware Protection.S3Object: {
. Bucket (string)
. Key (string)
. VersionId (string)
} (object)
guardduty/start_malware_scanInitiates the malware scan. Invoking this API will automatically create the Service-linked role in the corresponding account if the resourceArn belongs to an EC2 instance. When the malware scan starts, you can use the associated scan ID to track the status of the scan. For more information, see ListMalwareScans and GetMalwareScan. When you use this API, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuResourceArn (string) required
ClientToken (string)
ScanConfiguration: {
. Role (string)
. IncrementalScanDetails (object)
. RecoveryPoint (object)
} (object)
guardduty/start_monitoring_membersTurns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.DetectorId (string) required
AccountIds (array) required
guardduty/stop_monitoring_membersStops GuardDuty monitoring for the specified member accounts. Use the StartMonitoringMembers operation to restart monitoring for those accounts. With autoEnableOrganizationMembers configuration for your organization set to ALL, you'll receive an error if you attempt to stop monitoring the member accounts in your organization.DetectorId (string) required
AccountIds (array) required
guardduty/tag_resourceAdds tags to a resource.ResourceArn (string) required
Tags (object) required
guardduty/unarchive_findingsUnarchives GuardDuty findings specified by the findingIds.DetectorId (string) required
FindingIds (array) required
guardduty/untag_resourceRemoves tags from a resource.ResourceArn (string) required
TagKeys (array) required
guardduty/update_detectorUpdates the GuardDuty detector specified by the detector ID. Specifying both EKS Runtime Monitoring EKS_RUNTIME_MONITORING and Runtime Monitoring RUNTIME_MONITORING will cause an error. You can add only one of these two features because Runtime Monitoring already includes the threat detection for Amazon EKS resources. For more information, see Runtime Monitoring. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuarDetectorId (string) required
Enable (boolean)
FindingPublishingFrequency (string)
DataSources: {
. S3Logs (object)
. Kubernetes (object)
. MalwareProtection (object)
} (object)
Features (array)
guardduty/update_filterUpdates the filter specified by the filter name.DetectorId (string) required
FilterName (string) required
Description (string)
Action (string)
Rank (integer)
FindingCriteria: {
. Criterion (object)
} (object)
guardduty/update_findings_feedbackMarks the specified GuardDuty findings as useful or not useful.DetectorId (string) required
FindingIds (array) required
Feedback (string) required
Comments (string)
guardduty/update_ipsetUpdates the IPSet specified by the IPSet ID.DetectorId (string) required
IpSetId (string) required
Name (string)
Location (string)
Activate (boolean)
ExpectedBucketOwner (string)
guardduty/update_malware_protection_planUpdates an existing Malware Protection plan resource.MalwareProtectionPlanId (string) required
Role (string)
Actions: {
. Tagging (object)
} (object)
ProtectedResource: {
. S3Bucket (object)
} (object)
guardduty/update_malware_scan_settingsUpdates the malware scan settings. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.DetectorId (string) required
ScanResourceCriteria: {
. Include (object)
. Exclude (object)
} (object)
EbsSnapshotPreservation (string)
guardduty/update_member_detectorsContains information on member accounts to be updated. Specifying both EKS Runtime Monitoring EKS_RUNTIME_MONITORING and Runtime Monitoring RUNTIME_MONITORING will cause an error. You can add only one of these two features because Runtime Monitoring already includes the threat detection for Amazon EKS resources. For more information, see Runtime Monitoring. There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDutyDetectorId (string) required
AccountIds (array) required
DataSources: {
. S3Logs (object)
. Kubernetes (object)
. MalwareProtection (object)
} (object)
Features (array)
guardduty/update_organization_configurationConfigures the delegated administrator account with the provided values. You must provide a value for either autoEnableOrganizationMembers or autoEnable, but not both. Specifying both EKS Runtime Monitoring EKS_RUNTIME_MONITORING and Runtime Monitoring RUNTIME_MONITORING will cause an error. You can add only one of these two features because Runtime Monitoring already includes the threat detection for Amazon EKS resources. For more information, see Runtime Monitoring. There might be regional difDetectorId (string) required
AutoEnable (boolean)
DataSources: {
. S3Logs (object)
. Kubernetes (object)
. MalwareProtection (object)
} (object)
Features (array)
AutoEnableOrganizationMembers (string)
guardduty/update_publishing_destinationUpdates information about the publishing destination specified by the destinationId.DetectorId (string) required
DestinationId (string) required
DestinationProperties: {
. DestinationArn (string)
. KmsKeyArn (string)
} (object)
guardduty/update_threat_entity_setUpdates the threat entity set associated with the specified threatEntitySetId.DetectorId (string) required
ThreatEntitySetId (string) required
Name (string)
Location (string)
ExpectedBucketOwner (string)
Activate (boolean)
guardduty/update_threat_intel_setUpdates the ThreatIntelSet specified by the ThreatIntelSet ID.DetectorId (string) required
ThreatIntelSetId (string) required
Name (string)
Location (string)
Activate (boolean)
ExpectedBucketOwner (string)
guardduty/update_trusted_entity_setUpdates the trusted entity set associated with the specified trustedEntitySetId.DetectorId (string) required
TrustedEntitySetId (string) required
Name (string)
Location (string)
ExpectedBucketOwner (string)
Activate (boolean)
health/describe_affected_accounts_for_organizationReturns 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 resueventArn (string) required
nextToken (string)
maxResults (integer)
health/describe_affected_entitiesReturns 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 thfilter: {
. eventArns (array)
. entityArns (array)
. entityValues (array)
. lastUpdatedTimes (array)
. tags (array)
. statusCodes (array)
} (object) required
locale (string)
nextToken (string)
maxResults (integer)
health/describe_affected_entities_for_organizationReturns 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, caorganizationEntityFilters (array)
locale (string)
nextToken (string)
maxResults (integer)
organizationEntityAccountFilters (array)
health/describe_entity_aggregatesReturns the number of entities that are affected by each of the specified events.eventArns (array)
health/describe_entity_aggregates_for_organizationReturns a list of entity aggregates for your Organizations that are affected by each of the specified events.eventArns (array) required
awsAccountIds (array)
health/describe_event_aggregatesReturns 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.filter: {
. actionabilities (array)
. eventArns (array)
. eventTypeCodes (array)
. services (array)
. regions (array)
. availabilityZones (array)
. startTimes (array)
. endTimes (array)
. lastUpdatedTimes (array)
. entityArns (array)
. entityValues (array)
. eventTypeCategories (array)
. tags (array)
. eventStatusCodes (array)
. personas (array)
} (object)
aggregateField (string) required
maxResults (integer)
nextToken (string)
health/describe_event_detailsReturns 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 sueventArns (array) required
locale (string)
health/describe_event_details_for_organizationReturns 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 thorganizationEventDetailFilters (array) required
locale (string)
health/describe_eventsReturns 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 Desfilter: {
. actionabilities (array)
. eventArns (array)
. eventTypeCodes (array)
. services (array)
. regions (array)
. availabilityZones (array)
. startTimes (array)
. endTimes (array)
. lastUpdatedTimes (array)
. entityArns (array)
. entityValues (array)
. eventTypeCategories (array)
. tags (array)
. eventStatusCodes (array)
. personas (array)
} (object)
nextToken (string)
maxResults (integer)
locale (string)
health/describe_events_for_organizationReturns 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 DescribeAffectedEntitiesfilter: {
. actionabilities (array)
. eventTypeCodes (array)
. awsAccountIds (array)
. services (array)
. regions (array)
. startTime (object)
. endTime (object)
. lastUpdatedTime (object)
. entityArns (array)
. entityValues (array)
. eventTypeCategories (array)
. eventStatusCodes (array)
. personas (array)
} (object)
nextToken (string)
maxResults (integer)
locale (string)
health/describe_event_typesReturns 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.filter: {
. eventTypeCodes (array)
. services (array)
. eventTypeCategories (array)
. actionabilities (array)
. personas (array)
} (object)
locale (string)
nextToken (string)
maxResults (integer)
health/describe_health_service_status_for_organizationThis operation provides status information on enabling or disabling Health to work with your organization. To call this operation, you must use the organization's management account.No parameters
health/disable_health_service_access_for_organizationDisables Health from working with Organizations. To call this operation, you must sign in to the organization's management account. For more information, see Aggregating Health events in the Health User Guide. This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or Command Line Interface CLI to remove the service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide. You caNo parameters
health/enable_health_service_access_for_organizationEnables Health to work with Organizations. You can use the organizational view feature to aggregate events from all Amazon Web Services accounts in your organization in a centralized location. This operation also creates a service-linked role for the management account in the organization. To call this operation, you must meet the following requirements: You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from Amazon Web Services Support to use the Health API. If you call thNo parameters
healthlake/create_fhirdatastoreCreate a FHIR-enabled data store.DatastoreName (string)
DatastoreTypeVersion (string) required
SseConfiguration: {
. KmsEncryptionConfig (object)
} (object)
PreloadDataConfig: {
. PreloadDataType (string)
} (object)
ClientToken (string)
Tags (array)
IdentityProviderConfiguration: {
. AuthorizationStrategy (string)
. FineGrainedAuthorizationEnabled (boolean)
. Metadata (string)
. IdpLambdaArn (string)
} (object)
healthlake/delete_fhirdatastoreDelete a FHIR-enabled data store.DatastoreId (string) required
healthlake/describe_fhirdatastoreGet properties for a FHIR-enabled data store.DatastoreId (string) required
healthlake/describe_fhirexport_jobGet FHIR export job properties.DatastoreId (string) required
JobId (string) required
healthlake/describe_fhirimport_jobGet the import job properties to learn more about the job or job progress.DatastoreId (string) required
JobId (string) required
healthlake/list_fhirdatastoresList all FHIR-enabled data stores in a user’s account, regardless of data store status.Filter: {
. DatastoreName (string)
. DatastoreStatus (string)
. CreatedBefore (string)
. CreatedAfter (string)
} (object)
NextToken (string)
MaxResults (integer)
healthlake/list_fhirexport_jobsLists all FHIR export jobs associated with an account and their statuses.DatastoreId (string) required
NextToken (string)
MaxResults (integer)
JobName (string)
JobStatus (string)
SubmittedBefore (string)
SubmittedAfter (string)
healthlake/list_fhirimport_jobsList all FHIR import jobs associated with an account and their statuses.DatastoreId (string) required
NextToken (string)
MaxResults (integer)
JobName (string)
JobStatus (string)
SubmittedBefore (string)
SubmittedAfter (string)
healthlake/list_tags_for_resourceReturns a list of all existing tags associated with a data store.ResourceARN (string) required
healthlake/start_fhirexport_jobStart a FHIR export job.JobName (string)
OutputDataConfig (undefined) required
DatastoreId (string) required
DataAccessRoleArn (string) required
ClientToken (string)
healthlake/start_fhirimport_jobStart importing bulk FHIR data into an ACTIVE data store. The import job imports FHIR data found in the InputDataConfig object and stores processing results in the JobOutputDataConfig object.JobName (string)
InputDataConfig (undefined) required
JobOutputDataConfig (undefined) required
DatastoreId (string) required
DataAccessRoleArn (string) required
ClientToken (string)
ValidationLevel (string)
healthlake/tag_resourceAdd a user-specifed key and value tag to a data store.ResourceARN (string) required
Tags (array) required
healthlake/untag_resourceRemove a user-specifed key and value tag from a data store.ResourceARN (string) required
TagKeys (array) required
iam/accept_delegation_requestAccepts a delegation request, granting the requested temporary access. Once the delegation request is accepted, it is eligible to send the exchange token to the partner. The SendDelegationToken API has to be explicitly called to send the delegation token. At the time of acceptance, IAM records the details and the state of the identity that called this API. This is the identity that gets mapped to the delegated credential. An accepted request may be rejected before the exchange token is sent to tDelegationRequestId (string) required
iam/add_client_idto_open_idconnect_providerAdds 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.OpenIDConnectProviderArn (string) required
ClientID (string) required
iam/add_role_to_instance_profileAdds 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.InstanceProfileName (string) required
RoleName (string) required
iam/add_user_to_groupAdds the specified user to the specified group.GroupName (string) required
UserName (string) required
iam/associate_delegation_requestAssociates a delegation request with the current identity. If the partner that created the delegation request has specified the owner account during creation, only an identity from that owner account can call the AssociateDelegationRequest API for the specified delegation request. Once the AssociateDelegationRequest API call is successful, the ARN of the current calling identity will be stored as the ownerId of the request. If the partner that created the delegation request has not specified theDelegationRequestId (string) required
iam/attach_group_policyAttaches 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.GroupName (string) required
PolicyArn (string) required
iam/attach_role_policyAttaches 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 PutRolePoRoleName (string) required
PolicyArn (string) required
iam/attach_user_policyAttaches 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.UserName (string) required
PolicyArn (string) required
iam/change_passwordChanges 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 passOldPassword (string) required
NewPassword (string) required
iam/create_access_keyCreates 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 isUserName (string)
iam/create_account_aliasCreates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.AccountAlias (string) required
iam/create_delegation_requestCreates an IAM delegation request for temporary access delegation. This API is not available for general use. In order to use this API, a caller first need to go through an onboarding process described in the partner onboarding documentation.OwnerAccountId (string)
Description (string) required
Permissions: {
. PolicyTemplateArn (string)
. Parameters (array)
} (object) required
RequestMessage (string)
RequestorWorkflowId (string) required
RedirectUrl (string)
NotificationChannel (string) required
SessionDuration (integer) required
OnlySendByOwner (boolean)
iam/create_groupCreates a new group. For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.Path (string)
GroupName (string) required
iam/create_instance_profileCreates 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.InstanceProfileName (string) required
Path (string)
Tags (array)
iam/create_login_profileCreates 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 passworUserName (string)
Password (string)
PasswordResetRequired (boolean)
iam/create_open_idconnect_providerCreates 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 AmaUrl (string) required
ClientIDList (array)
ThumbprintList (array)
Tags (array)
iam/create_policyCreates 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 polPolicyName (string) required
Path (string)
PolicyDocument (string) required
Description (string)
Tags (array)
iam/create_policy_versionCreates 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 infoPolicyArn (string) required
PolicyDocument (string) required
SetAsDefault (boolean)
iam/create_roleCreates a new role for your Amazon Web Services account. For more information about roles, see IAM roles in the IAM User Guide. 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.Path (string)
RoleName (string) required
AssumeRolePolicyDocument (string) required
Description (string)
MaxSessionDuration (integer)
PermissionsBoundary (string)
Tags (array)
iam/create_samlproviderCreates 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 prSAMLMetadataDocument (string) required
Name (string) required
Tags (array)
AssertionEncryptionMode (string)
AddPrivateKey (string)
iam/create_service_linked_roleCreates 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 servAWSServiceName (string) required
Description (string)
CustomSuffix (string)
iam/create_service_specific_credentialGenerates 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 Amazon Bedrock, CodeCommit and Amazon Keyspaces for Apache Cassandra. You can reset the password to a new service-generated vUserName (string) required
ServiceName (string) required
CredentialAgeDays (integer)
iam/create_userCreates 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.Path (string)
UserName (string) required
PermissionsBoundary (string)
Tags (array)
iam/create_virtual_mfadeviceCreates 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 likePath (string)
VirtualMFADeviceName (string) required
Tags (array)
iam/deactivate_mfadeviceDeactivates 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.UserName (string)
SerialNumber (string) required
iam/delete_access_keyDeletes 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.UserName (string)
AccessKeyId (string) required
iam/delete_account_aliasDeletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services account alias, see Creating, deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User Guide.AccountAlias (string) required
iam/delete_account_password_policyDeletes the password policy for the Amazon Web Services account. There are no parameters.No parameters
iam/delete_groupDeletes the specified IAM group. The group must not contain any users or have any attached policies.GroupName (string) required
iam/delete_group_policyDeletes 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.GroupName (string) required
PolicyName (string) required
iam/delete_instance_profileDeletes 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 Using instance profiles in the IAM User Guide.InstanceProfileName (string) required
iam/delete_login_profileDeletes the password for the specified IAM user or root user, For more information, see Managing passwords for IAM users. 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 theUserName (string)
iam/delete_open_idconnect_providerDeletes 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.OpenIDConnectProviderArn (string) required
iam/delete_policyDeletes 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 policyPolicyArn (string) required
iam/delete_policy_versionDeletes 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.PolicyArn (string) required
VersionId (string) required
iam/delete_roleDeletes the specified role. Unlike the Amazon Web Services Management Console, when you delete a role programmatically, you must delete the items attached to the role manually, or the deletion fails. For more information, see Deleting an IAM role. Before attempting to delete a role, remove the following attached items: Inline policies DeleteRolePolicy Attached managed policies DetachRolePolicy Instance profile RemoveRoleFromInstanceProfile Optional – Delete instance profile after detaching fromRoleName (string) required
iam/delete_role_permissions_boundaryDeletes the permissions boundary for the specified IAM role. You cannot set the boundary for a service-linked 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.RoleName (string) required
iam/delete_role_policyDeletes 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.RoleName (string) required
PolicyName (string) required
iam/delete_samlproviderDeletes 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.SAMLProviderArn (string) required
iam/delete_server_certificateDeletes 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 certificaServerCertificateName (string) required
iam/delete_service_linked_roleSubmits 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 foRoleName (string) required
iam/delete_service_specific_credentialDeletes the specified service-specific credential.UserName (string)
ServiceSpecificCredentialId (string) required
iam/delete_signing_certificateDeletes 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.UserName (string)
CertificateId (string) required
iam/delete_sshpublic_keyDeletes 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.UserName (string) required
SSHPublicKeyId (string) required
iam/delete_userDeletes 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 MUserName (string) required
iam/delete_user_permissions_boundaryDeletes 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.UserName (string) required
iam/delete_user_policyDeletes 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.UserName (string) required
PolicyName (string) required
iam/delete_virtual_mfadeviceDeletes 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.SerialNumber (string) required
iam/detach_group_policyRemoves 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.GroupName (string) required
PolicyArn (string) required
iam/detach_role_policyRemoves 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.RoleName (string) required
PolicyArn (string) required
iam/detach_user_policyRemoves 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.UserName (string) required
PolicyArn (string) required
iam/disable_organizations_root_credentials_managementDisables the management of privileged root user credentials across member accounts in your organization. When you disable this feature, the management account and the delegated administrator for IAM can no longer manage root user credentials for member accounts in your organization.No parameters
iam/disable_organizations_root_sessionsDisables root user sessions for privileged tasks across member accounts in your organization. When you disable this feature, the management account and the delegated administrator for IAM can no longer perform privileged tasks on member accounts in your organization.No parameters
iam/disable_outbound_web_identity_federationDisables the outbound identity federation feature for your Amazon Web Services account. When disabled, IAM principals in the account cannot use the GetWebIdentityToken API to obtain JSON Web Tokens JWTs for authentication with external services. This operation does not affect tokens that were issued before the feature was disabled.No parameters
iam/enable_mfadeviceEnables 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.UserName (string) required
SerialNumber (string) required
AuthenticationCode1 (string) required
AuthenticationCode2 (string) required
iam/enable_organizations_root_credentials_managementEnables the management of privileged root user credentials across member accounts in your organization. When you enable root credentials management for centralized root access, the management account and the delegated administrator for IAM can manage root user credentials for member accounts in your organization. Before you enable centralized root access, you must have an account configured with the following settings: You must manage your Amazon Web Services accounts in Organizations. Enable trNo parameters
iam/enable_organizations_root_sessionsAllows the management account or delegated administrator to perform privileged tasks on member accounts in your organization. For more information, see Centrally manage root access for member accounts in the Identity and Access Management User Guide. Before you enable this feature, you must have an account configured with the following settings: You must manage your Amazon Web Services accounts in Organizations. Enable trusted access for Identity and Access Management in Organizations. For detaiNo parameters
iam/enable_outbound_web_identity_federationEnables the outbound identity federation feature for your Amazon Web Services account. When enabled, IAM principals in your account can use the GetWebIdentityToken API to obtain JSON Web Tokens JWTs for secure authentication with external services. This operation also generates a unique issuer URL for your Amazon Web Services account.No parameters
iam/generate_credential_reportGenerates a credential report for the Amazon Web Services account. For more information about the credential report, see Getting credential reports in the IAM User Guide.No parameters
iam/generate_organizations_access_reportGenerates 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 OrEntityPath (string) required
OrganizationsPolicyId (string)
iam/generate_service_last_accessed_detailsGenerates 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. For more information about services and actions for which action last accessed information is displArn (string) required
Granularity (string)
iam/get_access_key_last_usedRetrieves 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.AccessKeyId (string) required
iam/get_account_authorization_detailsRetrieves 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 metFilter (array)
MaxItems (integer)
Marker (string)
iam/get_account_password_policyRetrieves the password policy for the Amazon Web Services account. This tells you the complexity requirements and mandatory rotation periods for the IAM user passwords in your account. For more information about using a password policy, see Managing an IAM password policy.No parameters
iam/get_account_summaryRetrieves information about IAM entity usage and IAM quotas in the Amazon Web Services account. For information about IAM quotas, see IAM and STS quotas in the IAM User Guide.No parameters
iam/get_context_keys_for_custom_policyGets 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 GetContextKeysFPolicyInputList (array) required
iam/get_context_keys_for_principal_policyGets 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 operaPolicySourceArn (string) required
PolicyInputList (array)
iam/get_credential_reportRetrieves a credential report for the Amazon Web Services account. For more information about the credential report, see Getting credential reports in the IAM User Guide.No parameters
iam/get_delegation_requestRetrieves information about a specific delegation request. If a delegation request has no owner or owner account, GetDelegationRequest for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call GetDelegationRequest for the delegation request. Once the delegation request is fully owned, the owner of the request gets a default permission to get that delegation request. For more details, seeDelegationRequestId (string) required
DelegationPermissionCheck (boolean)
iam/get_groupReturns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.GroupName (string) required
Marker (string)
MaxItems (integer)
iam/get_group_policyRetrieves 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, and some SDKs do this decoding automatically. An IAM group can also have manGroupName (string) required
PolicyName (string) required
iam/get_human_readable_summaryRetrieves a human readable summary for a given entity. At this time, the only supported entity type is delegation-request This method uses a Large Language Model LLM to generate the summary. If a delegation request has no owner or owner account, GetHumanReadableSummary for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call GetHumanReadableSummary for the delegation request to retrieveEntityArn (string) required
Locale (string)
iam/get_instance_profileRetrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see Using instance profiles in the IAM User Guide.InstanceProfileName (string) required
iam/get_login_profileRetrieves 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 theUserName (string)
iam/get_mfadeviceRetrieves information about an MFA device for a specified user.SerialNumber (string) required
UserName (string)
iam/get_open_idconnect_providerReturns information about the specified OpenID Connect OIDC provider resource object in IAM.OpenIDConnectProviderArn (string) required
iam/get_organizations_access_reportRetrieves 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 organizJobId (string) required
MaxItems (integer)
Marker (string)
SortKey (string)
iam/get_outbound_web_identity_federation_infoRetrieves the configuration information for the outbound identity federation feature in your Amazon Web Services account. The response includes the unique issuer URL for your Amazon Web Services account and the current enabled/disabled status of the feature. Use this operation to obtain the issuer URL that you need to configure trust relationships with external services.No parameters
iam/get_policyRetrieves 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 manaPolicyArn (string) required
iam/get_policy_versionRetrieves 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, and some SDKs do this decoding automatically. To listPolicyArn (string) required
VersionId (string) required
iam/get_roleRetrieves 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 IAM roles in the IAM User Guide. 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 SRoleName (string) required
iam/get_role_policyRetrieves 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, and some SDKs do this decoding automatically. An IAM role can also have manRoleName (string) required
PolicyName (string) required
iam/get_samlproviderReturns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated. This operation requires Signature Version 4.SAMLProviderArn (string) required
iam/get_server_certificateRetrieves 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.ServerCertificateName (string) required
iam/get_service_last_accessed_detailsRetrieves 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 whetherJobId (string) required
MaxItems (integer)
Marker (string)
iam/get_service_last_accessed_details_with_entitiesAfter 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. PolJobId (string) required
ServiceNamespace (string) required
MaxItems (integer)
Marker (string)
iam/get_service_linked_role_deletion_statusRetrieves 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.DeletionTaskId (string) required
iam/get_sshpublic_keyRetrieves 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.UserName (string) required
SSHPublicKeyId (string) required
Encoding (string) required
iam/get_userRetrieves 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.UserName (string)
iam/get_user_policyRetrieves 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, and some SDKs do this decoding automatically. An IAM user can also have managUserName (string) required
PolicyName (string) required
iam/list_access_keysReturns 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 keyUserName (string)
Marker (string)
MaxItems (integer)
iam/list_account_aliasesLists 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 Creating, deleting, and listing an Amazon Web Services account alias in the IAM User Guide.Marker (string)
MaxItems (integer)
iam/list_attached_group_policiesLists 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 poGroupName (string) required
PathPrefix (string)
Marker (string)
MaxItems (integer)
iam/list_attached_role_policiesLists 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 policiRoleName (string) required
PathPrefix (string)
Marker (string)
MaxItems (integer)
iam/list_attached_user_policiesLists 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 policiUserName (string) required
PathPrefix (string)
Marker (string)
MaxItems (integer)
iam/list_delegation_requestsLists delegation requests based on the specified criteria. If a delegation request has no owner, even if it is assigned to a specific account, it will not be part of the ListDelegationRequests output for that account. For more details, see Managing Permissions for Delegation Requests.OwnerId (string)
Marker (string)
MaxItems (integer)
iam/list_entities_for_policyLists 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.PolicyArn (string) required
EntityFilter (string)
PathPrefix (string)
PolicyUsageFilter (string)
Marker (string)
MaxItems (integer)
iam/list_group_policiesLists 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 eGroupName (string) required
Marker (string)
MaxItems (integer)
iam/list_groupsLists the IAM groups that have the specified path prefix. You can paginate the results using the MaxItems and Marker parameters.PathPrefix (string)
Marker (string)
MaxItems (integer)
iam/list_groups_for_userLists the IAM groups that the specified IAM user belongs to. You can paginate the results using the MaxItems and Marker parameters.UserName (string) required
Marker (string)
MaxItems (integer)
iam/list_instance_profilesLists 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 Using instance profiles 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 an instance profile, see GetInstanceProfile.PathPrefix (string)
Marker (string)
MaxItems (integer)
iam/list_instance_profiles_for_roleLists 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 Using instance profiles in the IAM User Guide. You can paginate the results using the MaxItems and Marker parameters.RoleName (string) required
Marker (string)
MaxItems (integer)
iam/list_instance_profile_tagsLists 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.InstanceProfileName (string) required
Marker (string)
MaxItems (integer)
iam/list_mfadevicesLists 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.UserName (string)
Marker (string)
MaxItems (integer)
iam/list_mfadevice_tagsLists 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.SerialNumber (string) required
Marker (string)
MaxItems (integer)
iam/list_open_idconnect_providersLists 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.No parameters
iam/list_open_idconnect_provider_tagsLists 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.OpenIDConnectProviderArn (string) required
Marker (string)
MaxItems (integer)
iam/list_organizations_featuresLists the centralized root access features enabled for your organization. For more information, see Centrally manage root access for member accounts.No parameters
iam/list_policiesLists 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 pagiScope (string)
OnlyAttached (boolean)
PathPrefix (string)
PolicyUsageFilter (string)
Marker (string)
MaxItems (integer)
iam/list_policies_granting_service_accessRetrieves 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 tMarker (string)
Arn (string) required
ServiceNamespaces (array) required
iam/list_policy_tagsLists 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.PolicyArn (string) required
Marker (string)
MaxItems (integer)
iam/list_policy_versionsLists 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.PolicyArn (string) required
Marker (string)
MaxItems (integer)
iam/list_role_policiesLists 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 emptyRoleName (string) required
Marker (string)
MaxItems (integer)
iam/list_rolesLists 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 IAM roles in the IAM User Guide. IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object: PermissionsBoundary RoleLastUsed Tags To view all of the information for a role, see GetRole. You can paginPathPrefix (string)
Marker (string)
MaxItems (integer)
iam/list_role_tagsLists 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.RoleName (string) required
Marker (string)
MaxItems (integer)
iam/list_samlprovidersLists 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.No parameters
iam/list_samlprovider_tagsLists 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.SAMLProviderArn (string) required
Marker (string)
MaxItems (integer)
iam/list_server_certificatesLists 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 subsetPathPrefix (string)
Marker (string)
MaxItems (integer)
iam/list_server_certificate_tagsLists 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 IServerCertificateName (string) required
Marker (string)
MaxItems (integer)
iam/list_service_specific_credentialsReturns 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.UserName (string)
ServiceName (string)
AllUsers (boolean)
Marker (string)
MaxItems (integer)
iam/list_signing_certificatesReturns 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 keyUserName (string)
Marker (string)
MaxItems (integer)
iam/list_sshpublic_keysReturns 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 paginateUserName (string)
Marker (string)
MaxItems (integer)
iam/list_user_policiesLists 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.UserName (string) required
Marker (string)
MaxItems (integer)
iam/list_usersLists 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. This operation does not return the following attributes, even though they are an attribute of the returned object: PermissionsBoundary Tags To view all of the information for a user, see GetUsePathPrefix (string)
Marker (string)
MaxItems (integer)
iam/list_user_tagsLists 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.UserName (string) required
Marker (string)
MaxItems (integer)
iam/list_virtual_mfadevicesLists 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 devicAssignmentStatus (string)
Marker (string)
MaxItems (integer)
iam/put_group_policyAdds 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 poliGroupName (string) required
PolicyName (string) required
PolicyDocument (string) required
iam/put_role_permissions_boundaryAdds 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 mRoleName (string) required
PermissionsBoundary (string) required
iam/put_role_policyAdds 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 roles, see IAM roles in the IAM User Guide. A role can also have a managed policy attached to it. To attach a managedRoleName (string) required
PolicyName (string) required
PolicyDocument (string) required
iam/put_user_permissions_boundaryAdds 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 usUserName (string) required
PermissionsBoundary (string) required
iam/put_user_policyAdds 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 polUserName (string) required
PolicyName (string) required
PolicyDocument (string) required
iam/reject_delegation_requestRejects a delegation request, denying the requested temporary access. Once a request is rejected, it cannot be accepted or updated later. Rejected requests expire after 7 days. When rejecting a request, an optional explanation can be added using the Notes request parameter. For more details, see Managing Permissions for Delegation Requests.DelegationRequestId (string) required
Notes (string)
iam/remove_client_idfrom_open_idconnect_providerRemoves 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.OpenIDConnectProviderArn (string) required
ClientID (string) required
iam/remove_role_from_instance_profileRemoves the specified IAM role from the specified Amazon 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 roles, see IAM roles in the IAM User Guide. For more information about instance profiles, see Using instance profiles in the IAInstanceProfileName (string) required
RoleName (string) required
iam/remove_user_from_groupRemoves the specified user from the specified group.GroupName (string) required
UserName (string) required
iam/reset_service_specific_credentialResets 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.UserName (string)
ServiceSpecificCredentialId (string) required
iam/resync_mfadeviceSynchronizes 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.UserName (string) required
SerialNumber (string) required
AuthenticationCode1 (string) required
AuthenticationCode2 (string) required
iam/send_delegation_tokenSends the exchange token for an accepted delegation request. The exchange token is sent to the partner via an asynchronous notification channel, established by the partner. The delegation request must be in the ACCEPTED state when calling this API. After the SendDelegationToken API call is successful, the request transitions to a FINALIZED state and cannot be rolled back. However, a user may reject an accepted request before the SendDelegationToken API is called. For more details, see Managing PDelegationRequestId (string) required
iam/set_default_policy_versionSets 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.PolicyArn (string) required
VersionId (string) required
iam/set_security_token_service_preferencesSets 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 qGlobalEndpointTokenVersion (string) required
iam/simulate_custom_policySimulate 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 atPolicyInputList (array) required
PermissionsBoundaryPolicyInputList (array)
ActionNames (array) required
ResourceArns (array)
ResourcePolicy (string)
ResourceOwner (string)
CallerArn (string)
ContextEntries (array)
ResourceHandlingOption (string)
MaxItems (integer)
Marker (string)
iam/simulate_principal_policySimulate 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 aPolicySourceArn (string) required
PolicyInputList (array)
PermissionsBoundaryPolicyInputList (array)
ActionNames (array) required
ResourceArns (array)
ResourcePolicy (string)
ResourceOwner (string)
CallerArn (string)
ContextEntries (array)
ResourceHandlingOption (string)
MaxItems (integer)
Marker (string)
iam/tag_instance_profileAdds 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 resourcInstanceProfileName (string) required
Tags (array) required
iam/tag_mfadeviceAdds 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 MyImportantProjectSerialNumber (string) required
Tags (array) required
iam/tag_open_idconnect_providerAdds 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 searchOpenIDConnectProviderArn (string) required
Tags (array) required
iam/tag_policyAdds 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 resPolicyArn (string) required
Tags (array) required
iam/tag_roleAdds 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 MyIRoleName (string) required
Tags (array) required
iam/tag_samlproviderAdds 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 cSAMLProviderArn (string) required
Tags (array) required
iam/tag_server_certificateAdds 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 associaServerCertificateName (string) required
Tags (array) required
iam/tag_userAdds 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 keyUserName (string) required
Tags (array) required
iam/untag_instance_profileRemoves the specified tags from the IAM instance profile. For more information about tagging, see Tagging IAM resources in the IAM User Guide.InstanceProfileName (string) required
TagKeys (array) required
iam/untag_mfadeviceRemoves 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.SerialNumber (string) required
TagKeys (array) required
iam/untag_open_idconnect_providerRemoves 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.OpenIDConnectProviderArn (string) required
TagKeys (array) required
iam/untag_policyRemoves the specified tags from the customer managed policy. For more information about tagging, see Tagging IAM resources in the IAM User Guide.PolicyArn (string) required
TagKeys (array) required
iam/untag_roleRemoves the specified tags from the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.RoleName (string) required
TagKeys (array) required
iam/untag_samlproviderRemoves 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.SAMLProviderArn (string) required
TagKeys (array) required
iam/untag_server_certificateRemoves 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.ServerCertificateName (string) required
TagKeys (array) required
iam/untag_userRemoves the specified tags from the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.UserName (string) required
TagKeys (array) required
iam/update_access_keyChanges 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 underUserName (string)
AccessKeyId (string) required
Status (string) required
iam/update_account_password_policyUpdates 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.MinimumPasswordLength (integer)
RequireSymbols (boolean)
RequireNumbers (boolean)
RequireUppercaseCharacters (boolean)
RequireLowercaseCharacters (boolean)
AllowUsersToChangePassword (boolean)
MaxPasswordAge (integer)
PasswordReusePrevention (integer)
HardExpiry (boolean)
iam/update_assume_role_policyUpdates 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.RoleName (string) required
PolicyDocument (string) required
iam/update_delegation_requestUpdates an existing delegation request with additional information. When the delegation request is updated, it reaches the PENDING_APPROVAL state. Once a delegation request has an owner, that owner gets a default permission to update the delegation request. For more details, see Managing Permissions for Delegation Requests.DelegationRequestId (string) required
Notes (string)
iam/update_groupUpdates 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 permissionGroupName (string) required
NewPath (string)
NewGroupName (string)
iam/update_login_profileChanges 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.UserName (string) required
Password (string)
PasswordResetRequired (boolean)
iam/update_open_idconnect_provider_thumbprintReplaces 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 thOpenIDConnectProviderArn (string) required
ThumbprintList (array) required
iam/update_roleUpdates the description or maximum session duration setting of a role.RoleName (string) required
Description (string)
MaxSessionDuration (integer)
iam/update_role_descriptionUse UpdateRole instead. Modifies only the description of a role. This operation performs the same function as the Description parameter in the UpdateRole operation.RoleName (string) required
Description (string) required
iam/update_samlproviderUpdates the metadata document, SAML encryption settings, and private keys for an existing SAML provider. To rotate private keys, add your new private key and then remove the old key in a separate request.SAMLMetadataDocument (string)
SAMLProviderArn (string) required
AssertionEncryptionMode (string)
AddPrivateKey (string)
RemovePrivateKey (string)
iam/update_server_certificateUpdates 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. TServerCertificateName (string) required
NewPath (string)
NewServerCertificateName (string)
iam/update_service_specific_credentialSets 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.UserName (string)
ServiceSpecificCredentialId (string) required
Status (string) required
iam/update_signing_certificateChanges 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 AmaUserName (string)
CertificateId (string) required
Status (string) required
iam/update_sshpublic_keySets 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 iUserName (string) required
SSHPublicKeyId (string) required
Status (string) required
iam/update_userUpdates 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 . ForUserName (string) required
NewPath (string)
NewUserName (string)
iam/upload_server_certificateUploads 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. FoPath (string)
ServerCertificateName (string) required
CertificateBody (string) required
PrivateKey (string) required
CertificateChain (string)
Tags (array)
iam/upload_signing_certificateUploads 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 basedUserName (string)
CertificateBody (string) required
iam/upload_sshpublic_keyUploads 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.UserName (string) required
SSHPublicKeyBody (string) required
identitystore/get_group_idRetrieves GroupId in an identity store. If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.IdentityStoreId (string) required
AlternateIdentifier (undefined) required
identitystore/get_group_membership_idRetrieves the MembershipId in an identity store. If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.IdentityStoreId (string) required
GroupId (string) required
MemberId (undefined) required
identitystore/get_user_idRetrieves the UserId in an identity store. If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.IdentityStoreId (string) required
AlternateIdentifier (undefined) required
identitystore/is_member_in_groupsChecks the user's membership in all requested groups and returns if the member exists in all queried groups. If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.IdentityStoreId (string) required
MemberId (undefined) required
GroupIds (array) required
identitystore/list_group_memberships_for_memberFor the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form. If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.IdentityStoreId (string) required
MemberId (undefined) required
MaxResults (integer)
NextToken (string)
identitystore/create_group_membershipCreates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.IdentityStoreId (string) required
GroupId (string) required
MemberId (undefined) required
identitystore/describe_group_membershipRetrieves membership metadata and attributes from MembershipId in an identity store. If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.IdentityStoreId (string) required
MembershipId (string) required
identitystore/delete_group_membershipDelete a membership within a group given MembershipId.IdentityStoreId (string) required
MembershipId (string) required
identitystore/list_group_membershipsFor the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form. If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.IdentityStoreId (string) required
GroupId (string) required
MaxResults (integer)
NextToken (string)
identitystore/create_groupCreates a group within the specified identity store.IdentityStoreId (string) required
DisplayName (string)
Description (string)
identitystore/describe_groupRetrieves the group metadata and attributes from GroupId in an identity store. If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.IdentityStoreId (string) required
GroupId (string) required
identitystore/update_groupUpdates the specified group metadata and attributes in the specified identity store.IdentityStoreId (string) required
GroupId (string) required
Operations (array) required
identitystore/delete_groupDelete a group within an identity store given GroupId.IdentityStoreId (string) required
GroupId (string) required
identitystore/list_groupsLists 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. If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.IdentityStoreId (string) required
MaxResults (integer)
NextToken (string)
Filters (array)
identitystore/create_userCreates a user within the specified identity store.IdentityStoreId (string) required
UserName (string)
Name: {
. Formatted (string)
. FamilyName (string)
. GivenName (string)
. MiddleName (string)
. HonorificPrefix (string)
. HonorificSuffix (string)
} (object)
DisplayName (string)
NickName (string)
ProfileUrl (string)
Emails (array)
Addresses (array)
PhoneNumbers (array)
UserType (string)
Title (string)
PreferredLanguage (string)
Locale (string)
Timezone (string)
Photos (array)
Website (string)
Birthdate (string)
Roles (array)
Extensions (object)
identitystore/describe_userRetrieves the user metadata and attributes from the UserId in an identity store. If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.IdentityStoreId (string) required
UserId (string) required
Extensions (array)
identitystore/update_userUpdates the specified user metadata and attributes in the specified identity store.IdentityStoreId (string) required
UserId (string) required
Operations (array) required
identitystore/delete_userDeletes a user within an identity store given UserId.IdentityStoreId (string) required
UserId (string) required
identitystore/list_usersLists 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. If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.IdentityStoreId (string) required
Extensions (array)
MaxResults (integer)
NextToken (string)
Filters (array)
imagebuilder/cancel_image_creationCancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.imageBuildVersionArn (string) required
clientToken (string) required
imagebuilder/cancel_lifecycle_executionCancel a specific image lifecycle policy runtime instance.lifecycleExecutionId (string) required
clientToken (string) required
imagebuilder/create_componentCreates 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.name (string) required
semanticVersion (string) required
description (string)
changeDescription (string)
platform (string) required
supportedOsVersions (array)
data (string)
uri (string)
kmsKeyId (string)
tags (object)
clientToken (string) required
dryRun (boolean)
imagebuilder/create_container_recipeCreates a new container recipe. Container recipes define how images are configured, tested, and assessed.containerType (string) required
name (string) required
description (string)
semanticVersion (string) required
components (array)
instanceConfiguration: {
. image (string)
. blockDeviceMappings (array)
} (object)
dockerfileTemplateData (string)
dockerfileTemplateUri (string)
platformOverride (string)
imageOsVersionOverride (string)
parentImage (string) required
tags (object)
workingDirectory (string)
targetRepository: {
. service (string)
. repositoryName (string)
} (object) required
kmsKeyId (string)
clientToken (string) required
imagebuilder/create_distribution_configurationCreates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.name (string) required
description (string)
distributions (array) required
tags (object)
clientToken (string) required
imagebuilder/create_imageCreates 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.imageRecipeArn (string)
containerRecipeArn (string)
distributionConfigurationArn (string)
infrastructureConfigurationArn (string) required
imageTestsConfiguration: {
. imageTestsEnabled (boolean)
. timeoutMinutes (integer)
} (object)
enhancedImageMetadataEnabled (boolean)
tags (object)
clientToken (string) required
imageScanningConfiguration: {
. imageScanningEnabled (boolean)
. ecrConfiguration (object)
} (object)
workflows (array)
executionRole (string)
loggingConfiguration: {
. logGroupName (string)
} (object)
imagebuilder/create_image_pipelineCreates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.name (string) required
description (string)
imageRecipeArn (string)
containerRecipeArn (string)
infrastructureConfigurationArn (string) required
distributionConfigurationArn (string)
imageTestsConfiguration: {
. imageTestsEnabled (boolean)
. timeoutMinutes (integer)
} (object)
enhancedImageMetadataEnabled (boolean)
schedule: {
. scheduleExpression (string)
. timezone (string)
. pipelineExecutionStartCondition (string)
. autoDisablePolicy (object)
} (object)
status (string)
tags (object)
clientToken (string) required
imageScanningConfiguration: {
. imageScanningEnabled (boolean)
. ecrConfiguration (object)
} (object)
workflows (array)
executionRole (string)
loggingConfiguration: {
. imageLogGroupName (string)
. pipelineLogGroupName (string)
} (object)
imagebuilder/create_image_recipeCreates a new image recipe. Image recipes define how images are configured, tested, and assessed.name (string) required
description (string)
semanticVersion (string) required
components (array)
parentImage (string) required
blockDeviceMappings (array)
tags (object)
workingDirectory (string)
additionalInstanceConfiguration: {
. systemsManagerAgent (object)
. userDataOverride (string)
} (object)
amiTags (object)
clientToken (string) required
imagebuilder/create_infrastructure_configurationCreates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.name (string) required
description (string)
instanceTypes (array)
instanceProfileName (string) required
securityGroupIds (array)
subnetId (string)
logging: {
. s3Logs (object)
} (object)
keyPair (string)
terminateInstanceOnFailure (boolean)
snsTopicArn (string)
resourceTags (object)
instanceMetadataOptions: {
. httpTokens (string)
. httpPutResponseHopLimit (integer)
} (object)
tags (object)
placement: {
. availabilityZone (string)
. tenancy (string)
. hostId (string)
. hostResourceGroupArn (string)
} (object)
clientToken (string) required
imagebuilder/create_lifecycle_policyCreate a lifecycle policy resource.name (string) required
description (string)
status (string)
executionRole (string) required
resourceType (string) required
policyDetails (array) required
resourceSelection: {
. recipes (array)
. tagMap (object)
} (object) required
tags (object)
clientToken (string) required
imagebuilder/create_workflowCreate a new workflow or a new version of an existing workflow.name (string) required
semanticVersion (string) required
description (string)
changeDescription (string)
data (string)
uri (string)
kmsKeyId (string)
tags (object)
clientToken (string) required
type (string) required
dryRun (boolean)
imagebuilder/delete_componentDeletes a component build version.componentBuildVersionArn (string) required
imagebuilder/delete_container_recipeDeletes a container recipe.containerRecipeArn (string) required
imagebuilder/delete_distribution_configurationDeletes a distribution configuration.distributionConfigurationArn (string) required
imagebuilder/delete_imageDeletes 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 AmimageBuildVersionArn (string) required
imagebuilder/delete_image_pipelineDeletes an image pipeline.imagePipelineArn (string) required
imagebuilder/delete_image_recipeDeletes an image recipe.imageRecipeArn (string) required
imagebuilder/delete_infrastructure_configurationDeletes an infrastructure configuration.infrastructureConfigurationArn (string) required
imagebuilder/delete_lifecycle_policyDelete the specified lifecycle policy resource.lifecyclePolicyArn (string) required
imagebuilder/delete_workflowDeletes a specific workflow resource.workflowBuildVersionArn (string) required
imagebuilder/distribute_imageDistributeImage distributes existing AMIs to additional regions and accounts without rebuilding the image.sourceImage (string) required
distributionConfigurationArn (string) required
executionRole (string) required
tags (object)
clientToken (string) required
loggingConfiguration: {
. logGroupName (string)
} (object)
imagebuilder/get_componentGets a component object.componentBuildVersionArn (string) required
imagebuilder/get_component_policyGets a component policy.componentArn (string) required
imagebuilder/get_container_recipeRetrieves a container recipe.containerRecipeArn (string) required
imagebuilder/get_container_recipe_policyRetrieves the policy for a container recipe.containerRecipeArn (string) required
imagebuilder/get_distribution_configurationGets a distribution configuration.distributionConfigurationArn (string) required
imagebuilder/get_imageGets an image.imageBuildVersionArn (string) required
imagebuilder/get_image_pipelineGets an image pipeline.imagePipelineArn (string) required
imagebuilder/get_image_policyGets an image policy.imageArn (string) required
imagebuilder/get_image_recipeGets an image recipe.imageRecipeArn (string) required
imagebuilder/get_image_recipe_policyGets an image recipe policy.imageRecipeArn (string) required
imagebuilder/get_infrastructure_configurationGets an infrastructure configuration.infrastructureConfigurationArn (string) required
imagebuilder/get_lifecycle_executionGet the runtime information that was logged for a specific runtime instance of the lifecycle policy.lifecycleExecutionId (string) required
imagebuilder/get_lifecycle_policyGet details for the specified image lifecycle policy.lifecyclePolicyArn (string) required
imagebuilder/get_marketplace_resourceVerify the subscription and perform resource dependency checks on the requested Amazon Web Services Marketplace resource. For Amazon Web Services Marketplace components, the response contains fields to download the components and their artifacts.resourceType (string) required
resourceArn (string) required
resourceLocation (string)
imagebuilder/get_workflowGet a workflow resource object.workflowBuildVersionArn (string) required
imagebuilder/get_workflow_executionGet the runtime information that was logged for a specific runtime instance of the workflow.workflowExecutionId (string) required
imagebuilder/get_workflow_step_executionGet the runtime information that was logged for a specific runtime instance of the workflow step.stepExecutionId (string) required
imagebuilder/import_componentImports a component and transforms its data into a component document.name (string) required
semanticVersion (string) required
description (string)
changeDescription (string)
type (string) required
format (string) required
platform (string) required
data (string)
uri (string)
kmsKeyId (string)
tags (object)
clientToken (string) required
imagebuilder/import_disk_imageImport a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported: Windows 11 Enterprisename (string) required
semanticVersion (string) required
description (string)
platform (string) required
osVersion (string) required
executionRole (string)
infrastructureConfigurationArn (string) required
uri (string) required
loggingConfiguration: {
. logGroupName (string)
} (object)
tags (object)
clientToken (string) required
imagebuilder/import_vm_imageWhen 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.name (string) required
semanticVersion (string) required
description (string)
platform (string) required
osVersion (string)
vmImportTaskId (string) required
loggingConfiguration: {
. logGroupName (string)
} (object)
tags (object)
clientToken (string) required
imagebuilder/list_component_build_versionsReturns the list of component build versions for the specified component version Amazon Resource Name ARN.componentVersionArn (string)
maxResults (integer)
nextToken (string)
imagebuilder/list_componentsReturns the list of components that can be filtered by name, or by using the listed filters to streamline results. Newly created components can take up to two minutes to appear in the ListComponents API Results. The semantic version has four nodes: ../. 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 foowner (string)
filters (array)
byName (boolean)
maxResults (integer)
nextToken (string)
imagebuilder/list_container_recipesReturns a list of container recipes.owner (string)
filters (array)
maxResults (integer)
nextToken (string)
imagebuilder/list_distribution_configurationsReturns a list of distribution configurations.filters (array)
maxResults (integer)
nextToken (string)
imagebuilder/list_image_build_versionsReturns a list of image build versions.imageVersionArn (string)
filters (array)
maxResults (integer)
nextToken (string)
imagebuilder/list_image_packagesList the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.imageBuildVersionArn (string) required
maxResults (integer)
nextToken (string)
imagebuilder/list_image_pipeline_imagesReturns a list of images created by the specified pipeline.imagePipelineArn (string) required
filters (array)
maxResults (integer)
nextToken (string)
imagebuilder/list_image_pipelinesReturns a list of image pipelines.filters (array)
maxResults (integer)
nextToken (string)
imagebuilder/list_image_recipesReturns a list of image recipes.owner (string)
filters (array)
maxResults (integer)
nextToken (string)
imagebuilder/list_imagesReturns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.owner (string)
filters (array)
byName (boolean)
maxResults (integer)
nextToken (string)
includeDeprecated (boolean)
imagebuilder/list_image_scan_finding_aggregationsReturns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the imagePipelineArn filter. If you don't specify a filter, Image Builder returns an aggregation for your account. To streamline results, you can use the following filters in your request: accountId imageBuildVersionArn imagePipelifilter: {
. name (string)
. values (array)
} (object)
nextToken (string)
imagebuilder/list_image_scan_findingsReturns a list of image scan findings for your account.filters (array)
maxResults (integer)
nextToken (string)
imagebuilder/list_infrastructure_configurationsReturns a list of infrastructure configurations.filters (array)
maxResults (integer)
nextToken (string)
imagebuilder/list_lifecycle_execution_resourcesList resources that the runtime instance of the image lifecycle identified for lifecycle actions.lifecycleExecutionId (string) required
parentResourceId (string)
maxResults (integer)
nextToken (string)
imagebuilder/list_lifecycle_executionsGet the lifecycle runtime history for the specified resource.maxResults (integer)
nextToken (string)
resourceArn (string) required
imagebuilder/list_lifecycle_policiesGet a list of lifecycle policies in your Amazon Web Services account.filters (array)
maxResults (integer)
nextToken (string)
imagebuilder/list_tags_for_resourceReturns the list of tags for the specified resource.resourceArn (string) required
imagebuilder/list_waiting_workflow_stepsGet a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.maxResults (integer)
nextToken (string)
imagebuilder/list_workflow_build_versionsReturns a list of build versions for a specific workflow resource.workflowVersionArn (string)
maxResults (integer)
nextToken (string)
imagebuilder/list_workflow_executionsReturns a list of workflow runtime instance metadata objects for a specific image build version.maxResults (integer)
nextToken (string)
imageBuildVersionArn (string) required
imagebuilder/list_workflowsLists workflow build versions based on filtering parameters.owner (string)
filters (array)
byName (boolean)
maxResults (integer)
nextToken (string)
imagebuilder/list_workflow_step_executionsReturns runtime data for each step in a runtime instance of the workflow that you specify in the request.maxResults (integer)
nextToken (string)
workflowExecutionId (string) required
imagebuilder/put_component_policyApplies 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.componentArn (string) required
policy (string) required
imagebuilder/put_container_recipe_policyApplies 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 thecontainerRecipeArn (string) required
policy (string) required
imagebuilder/put_image_policyApplies 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.imageArn (string) required
policy (string) required
imagebuilder/put_image_recipe_policyApplies 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.imageRecipeArn (string) required
policy (string) required
imagebuilder/retry_imageRetryImage retries an image distribution without rebuilding the image.imageBuildVersionArn (string) required
clientToken (string) required
imagebuilder/send_workflow_step_actionPauses or resumes image creation when the associated workflow runs a WaitForAction step.stepExecutionId (string) required
imageBuildVersionArn (string) required
action (string) required
reason (string)
clientToken (string) required
imagebuilder/start_image_pipeline_executionManually triggers a pipeline to create an image.imagePipelineArn (string) required
clientToken (string) required
tags (object)
imagebuilder/start_resource_state_updateBegin asynchronous resource state update for lifecycle changes to the specified image resources.resourceArn (string) required
state: {
. status (string)
} (object) required
executionRole (string)
includeResources: {
. amis (boolean)
. snapshots (boolean)
. containers (boolean)
} (object)
exclusionRules: {
. amis (object)
} (object)
updateAt (string)
clientToken (string) required
imagebuilder/tag_resourceAdds a tag to a resource.resourceArn (string) required
tags (object) required
imagebuilder/untag_resourceRemoves a tag from a resource.resourceArn (string) required
tagKeys (array) required
imagebuilder/update_distribution_configurationUpdates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.distributionConfigurationArn (string) required
description (string)
distributions (array) required
clientToken (string) required
imagebuilder/update_image_pipelineUpdates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn. 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.imagePipelineArn (string) required
description (string)
imageRecipeArn (string)
containerRecipeArn (string)
infrastructureConfigurationArn (string) required
distributionConfigurationArn (string)
imageTestsConfiguration: {
. imageTestsEnabled (boolean)
. timeoutMinutes (integer)
} (object)
enhancedImageMetadataEnabled (boolean)
schedule: {
. scheduleExpression (string)
. timezone (string)
. pipelineExecutionStartCondition (string)
. autoDisablePolicy (object)
} (object)
status (string)
clientToken (string) required
imageScanningConfiguration: {
. imageScanningEnabled (boolean)
. ecrConfiguration (object)
} (object)
workflows (array)
loggingConfiguration: {
. imageLogGroupName (string)
. pipelineLogGroupName (string)
} (object)
executionRole (string)
imagebuilder/update_infrastructure_configurationUpdates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.infrastructureConfigurationArn (string) required
description (string)
instanceTypes (array)
instanceProfileName (string) required
securityGroupIds (array)
subnetId (string)
logging: {
. s3Logs (object)
} (object)
keyPair (string)
terminateInstanceOnFailure (boolean)
snsTopicArn (string)
resourceTags (object)
instanceMetadataOptions: {
. httpTokens (string)
. httpPutResponseHopLimit (integer)
} (object)
placement: {
. availabilityZone (string)
. tenancy (string)
. hostId (string)
. hostResourceGroupArn (string)
} (object)
clientToken (string) required
imagebuilder/update_lifecycle_policyUpdate the specified lifecycle policy.lifecyclePolicyArn (string) required
description (string)
status (string)
executionRole (string) required
resourceType (string) required
policyDetails (array) required
resourceSelection: {
. recipes (array)
. tagMap (object)
} (object) required
clientToken (string) required
inspector_scan/scan_sbomScans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that SBOM. You can generate compatible SBOMs for your resources using the Amazon Inspector SBOM generator. The output of this action reports NVD and CVSS scores when NVD and CVSS scores are available. Because the output reports both scores, you might notice a discrepency between them. However, you can triage the severity of either score depending on the vendor of your choosing.sbom (undefined) required
outputFormat (string)
inspector/add_attributes_to_findingsAssigns attributes key and value pairs to the findings that are specified by the ARNs of the findings.findingArns (array) required
attributes (array) required
inspector/create_assessment_targetCreates 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 accassessmentTargetName (string) required
resourceGroupArn (string)
inspector/create_assessment_templateCreates 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.assessmentTargetArn (string) required
assessmentTemplateName (string) required
durationInSeconds (integer) required
rulesPackageArns (array) required
userAttributesForFindings (array)
inspector/create_exclusions_previewStarts 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.assessmentTemplateArn (string) required
inspector/create_resource_groupCreates 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.resourceGroupTags (array) required
inspector/delete_assessment_runDeletes the assessment run that is specified by the ARN of the assessment run.assessmentRunArn (string) required
inspector/delete_assessment_targetDeletes the assessment target that is specified by the ARN of the assessment target.assessmentTargetArn (string) required
inspector/delete_assessment_templateDeletes the assessment template that is specified by the ARN of the assessment template.assessmentTemplateArn (string) required
inspector/describe_assessment_runsDescribes the assessment runs that are specified by the ARNs of the assessment runs.assessmentRunArns (array) required
inspector/describe_assessment_targetsDescribes the assessment targets that are specified by the ARNs of the assessment targets.assessmentTargetArns (array) required
inspector/describe_assessment_templatesDescribes the assessment templates that are specified by the ARNs of the assessment templates.assessmentTemplateArns (array) required
inspector/describe_cross_account_access_roleDescribes the IAM role that enables Amazon Inspector to access your AWS account.No parameters
inspector/describe_exclusionsDescribes the exclusions that are specified by the exclusions' ARNs.exclusionArns (array) required
locale (string)
inspector/describe_findingsDescribes the findings that are specified by the ARNs of the findings.findingArns (array) required
locale (string)
inspector/describe_resource_groupsDescribes the resource groups that are specified by the ARNs of the resource groups.resourceGroupArns (array) required
inspector/describe_rules_packagesDescribes the rules packages that are specified by the ARNs of the rules packages.rulesPackageArns (array) required
locale (string)
inspector/get_assessment_reportProduces an assessment report that includes detailed and comprehensive results of a specified assessment run.assessmentRunArn (string) required
reportFileFormat (string) required
reportType (string) required
inspector/get_exclusions_previewRetrieves the exclusions preview a list of ExclusionPreview objects specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.assessmentTemplateArn (string) required
previewToken (string) required
nextToken (string)
maxResults (integer)
locale (string)
inspector/get_telemetry_metadataInformation about the data that is collected for the specified assessment run.assessmentRunArn (string) required
inspector/list_assessment_run_agentsLists the agents of the assessment runs that are specified by the ARNs of the assessment runs.assessmentRunArn (string) required
filter: {
. agentHealths (array)
. agentHealthCodes (array)
} (object)
nextToken (string)
maxResults (integer)
inspector/list_assessment_runsLists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.assessmentTemplateArns (array)
filter: {
. namePattern (string)
. states (array)
. durationRange (object)
. rulesPackageArns (array)
. startTimeRange (object)
. completionTimeRange (object)
. stateChangeTimeRange (object)
} (object)
nextToken (string)
maxResults (integer)
inspector/list_assessment_targetsLists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.filter: {
. assessmentTargetNamePattern (string)
} (object)
nextToken (string)
maxResults (integer)
inspector/list_assessment_templatesLists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.assessmentTargetArns (array)
filter: {
. namePattern (string)
. durationRange (object)
. rulesPackageArns (array)
} (object)
nextToken (string)
maxResults (integer)
inspector/list_event_subscriptionsLists 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.resourceArn (string)
nextToken (string)
maxResults (integer)
inspector/list_exclusionsList exclusions that are generated by the assessment run.assessmentRunArn (string) required
nextToken (string)
maxResults (integer)
inspector/list_findingsLists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.assessmentRunArns (array)
filter: {
. agentIds (array)
. autoScalingGroups (array)
. ruleNames (array)
. severities (array)
. rulesPackageArns (array)
. attributes (array)
. userAttributes (array)
. creationTimeRange (object)
} (object)
nextToken (string)
maxResults (integer)
inspector/list_rules_packagesLists all available Amazon Inspector rules packages.nextToken (string)
maxResults (integer)
inspector/list_tags_for_resourceLists all tags associated with an assessment template.resourceArn (string) required
inspector/preview_agentsPreviews the agents installed on the EC2 instances that are part of the specified assessment target.previewAgentsArn (string) required
nextToken (string)
maxResults (integer)
inspector/register_cross_account_access_roleRegisters the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.roleArn (string) required
inspector/remove_attributes_from_findingsRemoves 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.findingArns (array) required
attributeKeys (array) required
inspector/set_tags_for_resourceSets tags key and value pairs to the assessment template that is specified by the ARN of the assessment template.resourceArn (string) required
tags (array)
inspector/start_assessment_runStarts 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.assessmentTemplateArn (string) required
assessmentRunName (string)
inspector/stop_assessment_runStops the assessment run that is specified by the ARN of the assessment run.assessmentRunArn (string) required
stopAction (string)
inspector/subscribe_to_eventEnables the process of sending Amazon Simple Notification Service SNS notifications about a specified event to a specified SNS topic.resourceArn (string) required
event (string) required
topicArn (string) required
inspector/unsubscribe_from_eventDisables the process of sending Amazon Simple Notification Service SNS notifications about a specified event to a specified SNS topic.resourceArn (string) required
event (string) required
topicArn (string) required
inspector/update_assessment_targetUpdates 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.assessmentTargetArn (string) required
assessmentTargetName (string) required
resourceGroupArn (string)
inspector2/associate_memberAssociates an Amazon Web Services account with an Amazon Inspector delegated administrator. An HTTP 200 response indicates the association was successfully started, but doesn’t indicate whether it was completed. You can check if the association completed by using ListMembers for multiple accounts or GetMembers for a single account.accountId (string) required
inspector2/batch_associate_code_security_scan_configurationAssociates multiple code repositories with an Amazon Inspector code security scan configuration.associateConfigurationRequests (array) required
inspector2/batch_disassociate_code_security_scan_configurationDisassociates multiple code repositories from an Amazon Inspector code security scan configuration.disassociateConfigurationRequests (array) required
inspector2/batch_get_account_statusRetrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.accountIds (array)
inspector2/batch_get_code_snippetRetrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.findingArns (array) required
inspector2/batch_get_finding_detailsGets vulnerability details for findings.findingArns (array) required
inspector2/batch_get_free_trial_infoGets free trial status for multiple Amazon Web Services accounts.accountIds (array) required
inspector2/batch_get_member_ec2deep_inspection_statusRetrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.accountIds (array)
inspector2/batch_update_member_ec2deep_inspection_statusActivates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization. You must be the delegated administrator of an organization in Amazon Inspector to use this API.accountIds (array) required
inspector2/cancel_findings_reportCancels the given findings report.reportId (string) required
inspector2/cancel_sbom_exportCancels a software bill of materials SBOM report.reportId (string) required
inspector2/create_cis_scan_configurationCreates a CIS scan configuration.scanName (string) required
securityLevel (string) required
schedule (undefined) required
targets: {
. accountIds (array)
. targetResourceTags (object)
} (object) required
tags (object)
inspector2/create_code_security_integrationCreates a code security integration with a source code repository provider. After calling the CreateCodeSecurityIntegration operation, you complete authentication and authorization with your provider. Next you call the UpdateCodeSecurityIntegration operation to provide the details to complete the integration setupname (string) required
type (string) required
details (undefined)
tags (object)
inspector2/create_code_security_scan_configurationCreates a scan configuration for code security scanning.name (string) required
level (string) required
configuration: {
. periodicScanConfiguration (object)
. continuousIntegrationScanConfiguration (object)
. ruleSetCategories (array)
} (object) required
scopeSettings: {
. projectSelectionScope (string)
} (object)
tags (object)
inspector2/create_filterCreates a filter resource using specified filter criteria. When the filter action is set to SUPPRESS this action creates a suppression rule.action (string) required
description (string)
filterCriteria: {
. findingArn (array)
. awsAccountId (array)
. findingType (array)
. severity (array)
. firstObservedAt (array)
. lastObservedAt (array)
. updatedAt (array)
. findingStatus (array)
. title (array)
. inspectorScore (array)
. resourceType (array)
. resourceId (array)
. resourceTags (array)
. ec2InstanceImageId (array)
. ec2InstanceVpcId (array)
. ec2InstanceSubnetId (array)
. ecrImagePushedAt (array)
. ecrImageArchitecture (array)
. ecrImageRegistry (array)
. ecrImageRepositoryName (array)
. ecrImageTags (array)
. ecrImageHash (array)
. ecrImageLastInUseAt (array)
. ecrImageInUseCount (array)
. portRange (array)
. networkProtocol (array)
. componentId (array)
. componentType (array)
. vulnerabilityId (array)
. vulnerabilitySource (array)
. vendorSeverity (array)
. vulnerablePackages (array)
. relatedVulnerabilities (array)
. fixAvailable (array)
. lambdaFunctionName (array)
. lambdaFunctionLayers (array)
. lambdaFunctionRuntime (array)
. lambdaFunctionLastModifiedAt (array)
. lambdaFunctionExecutionRoleArn (array)
. exploitAvailable (array)
. codeVulnerabilityDetectorName (array)
. codeVulnerabilityDetectorTags (array)
. codeVulnerabilityFilePath (array)
. epssScore (array)
. codeRepositoryProjectName (array)
. codeRepositoryProviderType (array)
} (object) required
name (string) required
tags (object)
reason (string)
inspector2/create_findings_reportCreates a finding report. By default only ACTIVE findings are returned in the report. To see SUPRESSED or CLOSED findings you must specify a value for the findingStatus filter criteria.filterCriteria: {
. findingArn (array)
. awsAccountId (array)
. findingType (array)
. severity (array)
. firstObservedAt (array)
. lastObservedAt (array)
. updatedAt (array)
. findingStatus (array)
. title (array)
. inspectorScore (array)
. resourceType (array)
. resourceId (array)
. resourceTags (array)
. ec2InstanceImageId (array)
. ec2InstanceVpcId (array)
. ec2InstanceSubnetId (array)
. ecrImagePushedAt (array)
. ecrImageArchitecture (array)
. ecrImageRegistry (array)
. ecrImageRepositoryName (array)
. ecrImageTags (array)
. ecrImageHash (array)
. ecrImageLastInUseAt (array)
. ecrImageInUseCount (array)
. portRange (array)
. networkProtocol (array)
. componentId (array)
. componentType (array)
. vulnerabilityId (array)
. vulnerabilitySource (array)
. vendorSeverity (array)
. vulnerablePackages (array)
. relatedVulnerabilities (array)
. fixAvailable (array)
. lambdaFunctionName (array)
. lambdaFunctionLayers (array)
. lambdaFunctionRuntime (array)
. lambdaFunctionLastModifiedAt (array)
. lambdaFunctionExecutionRoleArn (array)
. exploitAvailable (array)
. codeVulnerabilityDetectorName (array)
. codeVulnerabilityDetectorTags (array)
. codeVulnerabilityFilePath (array)
. epssScore (array)
. codeRepositoryProjectName (array)
. codeRepositoryProviderType (array)
} (object)
reportFormat (string) required
s3Destination: {
. bucketName (string)
. keyPrefix (string)
. kmsKeyArn (string)
} (object) required
inspector2/create_sbom_exportCreates a software bill of materials SBOM report.resourceFilterCriteria: {
. accountId (array)
. resourceId (array)
. resourceType (array)
. ecrRepositoryName (array)
. lambdaFunctionName (array)
. ecrImageTags (array)
. ec2InstanceTags (array)
. lambdaFunctionTags (array)
} (object)
reportFormat (string) required
s3Destination: {
. bucketName (string)
. keyPrefix (string)
. kmsKeyArn (string)
} (object) required
inspector2/delete_cis_scan_configurationDeletes a CIS scan configuration.scanConfigurationArn (string) required
inspector2/delete_code_security_integrationDeletes a code security integration.integrationArn (string) required
inspector2/delete_code_security_scan_configurationDeletes a code security scan configuration.scanConfigurationArn (string) required
inspector2/delete_filterDeletes a filter resource.arn (string) required
inspector2/describe_organization_configurationDescribe Amazon Inspector configuration settings for an Amazon Web Services organization.No parameters
inspector2/disableDisables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.accountIds (array)
resourceTypes (array)
inspector2/disable_delegated_admin_accountDisables the Amazon Inspector delegated administrator for your organization.delegatedAdminAccountId (string) required
inspector2/disassociate_memberDisassociates a member account from an Amazon Inspector delegated administrator.accountId (string) required
inspector2/enableEnables Amazon Inspector scans for one or more Amazon Web Services accounts.accountIds (array)
resourceTypes (array) required
clientToken (string)
inspector2/enable_delegated_admin_accountEnables the Amazon Inspector delegated administrator for your Organizations organization.delegatedAdminAccountId (string) required
clientToken (string)
inspector2/get_cis_scan_reportRetrieves a CIS scan report.scanArn (string) required
targetAccounts (array)
reportFormat (string)
inspector2/get_cis_scan_result_detailsRetrieves CIS scan result details.scanArn (string) required
targetResourceId (string) required
accountId (string) required
filterCriteria: {
. findingStatusFilters (array)
. checkIdFilters (array)
. titleFilters (array)
. securityLevelFilters (array)
. findingArnFilters (array)
} (object)
sortBy (string)
sortOrder (string)
nextToken (string)
maxResults (integer)
inspector2/get_clusters_for_imageReturns a list of clusters and metadata associated with an image.filter: {
. resourceId (string)
} (object) required
maxResults (integer)
nextToken (string)
inspector2/get_code_security_integrationRetrieves information about a code security integration.integrationArn (string) required
tags (object)
inspector2/get_code_security_scanRetrieves information about a specific code security scan.resource (undefined) required
scanId (string) required
inspector2/get_code_security_scan_configurationRetrieves information about a code security scan configuration.scanConfigurationArn (string) required
inspector2/get_configurationRetrieves setting configurations for Inspector scans.No parameters
inspector2/get_delegated_admin_accountRetrieves information about the Amazon Inspector delegated administrator for your organization.No parameters
inspector2/get_ec2deep_inspection_configurationRetrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.No parameters
inspector2/get_encryption_keyGets an encryption key.scanType (string) required
resourceType (string) required
inspector2/get_findings_report_statusGets the status of a findings report.reportId (string)
inspector2/get_memberGets member information for your organization.accountId (string) required
inspector2/get_sbom_exportGets details of a software bill of materials SBOM report.reportId (string) required
inspector2/list_account_permissionsLists the permissions an account has to configure Amazon Inspector. If the account is a member account or standalone account with resources managed by an Organizations policy, the operation returns fewer permissions.service (string)
maxResults (integer)
nextToken (string)
inspector2/list_cis_scan_configurationsLists CIS scan configurations.filterCriteria: {
. scanNameFilters (array)
. targetResourceTagFilters (array)
. scanConfigurationArnFilters (array)
} (object)
sortBy (string)
sortOrder (string)
nextToken (string)
maxResults (integer)
inspector2/list_cis_scan_results_aggregated_by_checksLists scan results aggregated by checks.scanArn (string) required
filterCriteria: {
. accountIdFilters (array)
. checkIdFilters (array)
. titleFilters (array)
. platformFilters (array)
. failedResourcesFilters (array)
. securityLevelFilters (array)
} (object)
sortBy (string)
sortOrder (string)
nextToken (string)
maxResults (integer)
inspector2/list_cis_scan_results_aggregated_by_target_resourceLists scan results aggregated by a target resource.scanArn (string) required
filterCriteria: {
. accountIdFilters (array)
. statusFilters (array)
. checkIdFilters (array)
. targetResourceIdFilters (array)
. targetResourceTagFilters (array)
. platformFilters (array)
. targetStatusFilters (array)
. targetStatusReasonFilters (array)
. failedChecksFilters (array)
} (object)
sortBy (string)
sortOrder (string)
nextToken (string)
maxResults (integer)
inspector2/list_cis_scansReturns a CIS scan list.filterCriteria: {
. scanNameFilters (array)
. targetResourceTagFilters (array)
. targetResourceIdFilters (array)
. scanStatusFilters (array)
. scanAtFilters (array)
. scanConfigurationArnFilters (array)
. scanArnFilters (array)
. scheduledByFilters (array)
. failedChecksFilters (array)
. targetAccountIdFilters (array)
} (object)
detailLevel (string)
sortBy (string)
sortOrder (string)
nextToken (string)
maxResults (integer)
inspector2/list_code_security_integrationsLists all code security integrations in your account.nextToken (string)
maxResults (integer)
inspector2/list_code_security_scan_configuration_associationsLists the associations between code repositories and Amazon Inspector code security scan configurations.scanConfigurationArn (string) required
nextToken (string)
maxResults (integer)
inspector2/list_code_security_scan_configurationsLists all code security scan configurations in your account.nextToken (string)
maxResults (integer)
inspector2/list_coverageLists coverage details for your environment.maxResults (integer)
nextToken (string)
filterCriteria: {
. scanStatusCode (array)
. scanStatusReason (array)
. accountId (array)
. resourceId (array)
. resourceType (array)
. scanType (array)
. ecrRepositoryName (array)
. ecrImageTags (array)
. ec2InstanceTags (array)
. lambdaFunctionName (array)
. lambdaFunctionTags (array)
. lambdaFunctionRuntime (array)
. lastScannedAt (array)
. scanMode (array)
. imagePulledAt (array)
. ecrImageLastInUseAt (array)
. ecrImageInUseCount (array)
. codeRepositoryProjectName (array)
. codeRepositoryProviderType (array)
. codeRepositoryProviderTypeVisibility (array)
. lastScannedCommitId (array)
} (object)
inspector2/list_coverage_statisticsLists Amazon Inspector coverage statistics for your environment.filterCriteria: {
. scanStatusCode (array)
. scanStatusReason (array)
. accountId (array)
. resourceId (array)
. resourceType (array)
. scanType (array)
. ecrRepositoryName (array)
. ecrImageTags (array)
. ec2InstanceTags (array)
. lambdaFunctionName (array)
. lambdaFunctionTags (array)
. lambdaFunctionRuntime (array)
. lastScannedAt (array)
. scanMode (array)
. imagePulledAt (array)
. ecrImageLastInUseAt (array)
. ecrImageInUseCount (array)
. codeRepositoryProjectName (array)
. codeRepositoryProviderType (array)
. codeRepositoryProviderTypeVisibility (array)
. lastScannedCommitId (array)
} (object)
groupBy (string)
nextToken (string)
inspector2/list_delegated_admin_accountsLists information about the Amazon Inspector delegated administrator of your organization.maxResults (integer)
nextToken (string)
inspector2/list_filtersLists the filters associated with your account.arns (array)
action (string)
nextToken (string)
maxResults (integer)
inspector2/list_finding_aggregationsLists aggregated finding data for your environment based on specific criteria.aggregationType (string) required
nextToken (string)
maxResults (integer)
accountIds (array)
aggregationRequest (undefined)
inspector2/list_findingsLists findings for your environment.maxResults (integer)
nextToken (string)
filterCriteria: {
. findingArn (array)
. awsAccountId (array)
. findingType (array)
. severity (array)
. firstObservedAt (array)
. lastObservedAt (array)
. updatedAt (array)
. findingStatus (array)
. title (array)
. inspectorScore (array)
. resourceType (array)
. resourceId (array)
. resourceTags (array)
. ec2InstanceImageId (array)
. ec2InstanceVpcId (array)
. ec2InstanceSubnetId (array)
. ecrImagePushedAt (array)
. ecrImageArchitecture (array)
. ecrImageRegistry (array)
. ecrImageRepositoryName (array)
. ecrImageTags (array)
. ecrImageHash (array)
. ecrImageLastInUseAt (array)
. ecrImageInUseCount (array)
. portRange (array)
. networkProtocol (array)
. componentId (array)
. componentType (array)
. vulnerabilityId (array)
. vulnerabilitySource (array)
. vendorSeverity (array)
. vulnerablePackages (array)
. relatedVulnerabilities (array)
. fixAvailable (array)
. lambdaFunctionName (array)
. lambdaFunctionLayers (array)
. lambdaFunctionRuntime (array)
. lambdaFunctionLastModifiedAt (array)
. lambdaFunctionExecutionRoleArn (array)
. exploitAvailable (array)
. codeVulnerabilityDetectorName (array)
. codeVulnerabilityDetectorTags (array)
. codeVulnerabilityFilePath (array)
. epssScore (array)
. codeRepositoryProjectName (array)
. codeRepositoryProviderType (array)
} (object)
sortCriteria: {
. field (string)
. sortOrder (string)
} (object)
inspector2/list_membersList members associated with the Amazon Inspector delegated administrator for your organization.onlyAssociated (boolean)
maxResults (integer)
nextToken (string)
inspector2/list_tags_for_resourceLists all tags attached to a given resource.resourceArn (string) required
inspector2/list_usage_totalsLists the Amazon Inspector usage totals over the last 30 days.maxResults (integer)
nextToken (string)
accountIds (array)
inspector2/reset_encryption_keyResets an encryption key. After the key is reset your resources will be encrypted by an Amazon Web Services owned key.scanType (string) required
resourceType (string) required
inspector2/search_vulnerabilitiesLists Amazon Inspector coverage details for a specific vulnerability.filterCriteria: {
. vulnerabilityIds (array)
} (object) required
nextToken (string)
inspector2/send_cis_session_healthSends a CIS session health. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.scanJobId (string) required
sessionToken (string) required
inspector2/send_cis_session_telemetrySends a CIS session telemetry. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.scanJobId (string) required
sessionToken (string) required
messages (array) required
inspector2/start_cis_sessionStarts a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to start a CIS scan session for the scan ID supplied by the service.scanJobId (string) required
message: {
. sessionToken (string)
} (object) required
inspector2/start_code_security_scanInitiates a code security scan on a specified repository.clientToken (string)
resource (undefined) required
inspector2/stop_cis_sessionStops a CIS session. This API is used by the Amazon Inspector SSM plugin to communicate with the Amazon Inspector service. The Amazon Inspector SSM plugin calls this API to stop a CIS scan session for the scan ID supplied by the service.scanJobId (string) required
sessionToken (string) required
message: {
. status (string)
. reason (string)
. progress (object)
. computePlatform (object)
. benchmarkVersion (string)
. benchmarkProfile (string)
} (object) required
inspector2/tag_resourceAdds tags to a resource.resourceArn (string) required
tags (object) required
inspector2/untag_resourceRemoves tags from a resource.resourceArn (string) required
tagKeys (array) required
inspector2/update_cis_scan_configurationUpdates a CIS scan configuration.scanConfigurationArn (string) required
scanName (string)
securityLevel (string)
schedule (undefined)
targets: {
. accountIds (array)
. targetResourceTags (object)
} (object)
inspector2/update_code_security_integrationUpdates an existing code security integration. After calling the CreateCodeSecurityIntegration operation, you complete authentication and authorization with your provider. Next you call the UpdateCodeSecurityIntegration operation to provide the details to complete the integration setupintegrationArn (string) required
details (undefined) required
inspector2/update_code_security_scan_configurationUpdates an existing code security scan configuration.scanConfigurationArn (string) required
configuration: {
. periodicScanConfiguration (object)
. continuousIntegrationScanConfiguration (object)
. ruleSetCategories (array)
} (object) required
inspector2/update_configurationUpdates 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.ecrConfiguration: {
. rescanDuration (string)
. pullDateRescanDuration (string)
. pullDateRescanMode (string)
} (object)
ec2Configuration: {
. scanMode (string)
} (object)
inspector2/update_ec2deep_inspection_configurationActivates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.activateDeepInspection (boolean)
packagePaths (array)
inspector2/update_encryption_keyUpdates an encryption key. A ResourceNotFoundException means that an Amazon Web Services owned key is being used for encryption.kmsKeyId (string) required
scanType (string) required
resourceType (string) required
inspector2/update_filterSpecifies the action that is to be applied to the findings that match the filter.action (string)
description (string)
filterCriteria: {
. findingArn (array)
. awsAccountId (array)
. findingType (array)
. severity (array)
. firstObservedAt (array)
. lastObservedAt (array)
. updatedAt (array)
. findingStatus (array)
. title (array)
. inspectorScore (array)
. resourceType (array)
. resourceId (array)
. resourceTags (array)
. ec2InstanceImageId (array)
. ec2InstanceVpcId (array)
. ec2InstanceSubnetId (array)
. ecrImagePushedAt (array)
. ecrImageArchitecture (array)
. ecrImageRegistry (array)
. ecrImageRepositoryName (array)
. ecrImageTags (array)
. ecrImageHash (array)
. ecrImageLastInUseAt (array)
. ecrImageInUseCount (array)
. portRange (array)
. networkProtocol (array)
. componentId (array)
. componentType (array)
. vulnerabilityId (array)
. vulnerabilitySource (array)
. vendorSeverity (array)
. vulnerablePackages (array)
. relatedVulnerabilities (array)
. fixAvailable (array)
. lambdaFunctionName (array)
. lambdaFunctionLayers (array)
. lambdaFunctionRuntime (array)
. lambdaFunctionLastModifiedAt (array)
. lambdaFunctionExecutionRoleArn (array)
. exploitAvailable (array)
. codeVulnerabilityDetectorName (array)
. codeVulnerabilityDetectorTags (array)
. codeVulnerabilityFilePath (array)
. epssScore (array)
. codeRepositoryProjectName (array)
. codeRepositoryProviderType (array)
} (object)
name (string)
filterArn (string) required
reason (string)
inspector2/update_organization_configurationUpdates the configurations for your Amazon Inspector organization.autoEnable: {
. ec2 (boolean)
. ecr (boolean)
. lambda (boolean)
. lambdaCode (boolean)
. codeRepository (boolean)
} (object) required
inspector2/update_org_ec2deep_inspection_configurationUpdates the Amazon Inspector deep inspection custom paths for your organization. You must be an Amazon Inspector delegated administrator to use this API.orgPackagePaths (array) required
internetmonitor/list_tags_for_resourceLists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.ResourceArn (string) required
internetmonitor/tag_resourceAdds a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet Monitor. A minimum of one tag is required for this call. It returns an error if you use the TagResource request with 0 tags.ResourceArn (string) required
Tags (object) required
internetmonitor/untag_resourceRemoves a tag from a resource.ResourceArn (string) required
TagKeys (array) required
internetmonitor/get_internet_eventGets information that Amazon CloudWatch Internet Monitor has generated about an internet event. Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers. The information returned here includes the impacted location, when the event started and if the event is over ended, the type of event PERFORMANCE or AVAILABILITY, and the status ACTIVE or RESOLVED.EventId (string) required
internetmonitor/list_internet_eventsLists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers. You can constrain the list of internet events returned by providing a start time and end time to define a total time frame for events you want to list. Both start time and end time specify the time when an event staNextToken (string)
MaxResults (integer)
StartTime (string)
EndTime (string)
EventStatus (string)
EventType (string)
internetmonitor/get_query_resultsReturn the data for a query with the Amazon CloudWatch Internet Monitor query interface. Specify the query that you want to return results for by providing a QueryId and a monitor name. For more information about using the query interface, including examples, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.MonitorName (string) required
QueryId (string) required
NextToken (string)
MaxResults (integer)
internetmonitor/get_query_statusReturns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor. When you run a query, check the status to make sure that the query has SUCCEEDED before you review the results. QUEUED: The query is scheduled to run. RUNNING: The query is in progress but not complete. SUCCEEDED: The query completed sucessfully. FAILED: The query failed due to an error. CANCELED: The query was canceled.MonitorName (string) required
QueryId (string) required
internetmonitor/start_queryStart a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface. Specify a time period for the data that you want returned by using StartTime and EndTime. You filter the query results to return by providing parameters that you specify with FilterParameters. For more information about using the query interface, including examples, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.MonitorName (string) required
StartTime (string) required
EndTime (string) required
QueryType (string) required
FilterParameters (array)
LinkedAccountId (string)
internetmonitor/stop_queryStop a query that is progress for a specific monitor.MonitorName (string) required
QueryId (string) required
internetmonitor/get_monitorGets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name ARN, create time, modified time, resources included in the monitor, and status information.MonitorName (string) required
LinkedAccountId (string)
internetmonitor/update_monitorUpdates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks locations and ASNs, to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor. The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User GuideMonitorName (string) required
ResourcesToAdd (array)
ResourcesToRemove (array)
Status (string)
ClientToken (string)
MaxCityNetworksToMonitor (integer)
InternetMeasurementsLogDelivery: {
. S3Config (object)
} (object)
TrafficPercentageToMonitor (integer)
HealthEventsConfig: {
. AvailabilityScoreThreshold (number)
. PerformanceScoreThreshold (number)
. AvailabilityLocalHealthEventsConfig (object)
. PerformanceLocalHealthEventsConfig (object)
} (object)
internetmonitor/delete_monitorDeletes a monitor in Amazon CloudWatch Internet Monitor.MonitorName (string) required
internetmonitor/list_monitorsLists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name ARN and name of each monitor.NextToken (string)
MaxResults (integer)
MonitorStatus (string)
IncludeLinkedAccounts (boolean)
internetmonitor/create_monitorCreates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: VPCs, Network Load Balancers NLBs, Amazon CloudFront distributions, and Amazon WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to the city-networks. That is, the locations and ASNs typically internet service providers or ISPs, where clients access your application. For more informatioMonitorName (string) required
Resources (array)
ClientToken (string)
Tags (object)
MaxCityNetworksToMonitor (integer)
InternetMeasurementsLogDelivery: {
. S3Config (object)
} (object)
TrafficPercentageToMonitor (integer)
HealthEventsConfig: {
. AvailabilityScoreThreshold (number)
. PerformanceScoreThreshold (number)
. AvailabilityLocalHealthEventsConfig (object)
. PerformanceLocalHealthEventsConfig (object)
} (object)
internetmonitor/get_health_eventGets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all the information related to the event, by location. The information returned includes the impact on performance, availability, and round-trip time, information about the network providers ASNs, the event type, and so on. Information rolled up at the global traffic level is also returned, including the impact type anMonitorName (string) required
EventId (string) required
LinkedAccountId (string)
internetmonitor/list_health_eventsLists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end times, and the status. Health events that have start times during the time frame that is requested are not included in the list of health events.MonitorName (string) required
StartTime (string)
EndTime (string)
NextToken (string)
MaxResults (integer)
EventStatus (string)
LinkedAccountId (string)
invoicing/batch_get_invoice_profileThis gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization.AccountIds (array) required
invoicing/create_invoice_unitThis creates a new invoice unit with the provided definition.Name (string) required
InvoiceReceiver (string) required
Description (string)
TaxInheritanceDisabled (boolean)
Rule: {
. LinkedAccounts (array)
. BillSourceAccounts (array)
} (object) required
ResourceTags (array)
invoicing/create_procurement_portal_preferenceCreates a procurement portal preference configuration for e-invoice delivery and purchase order retrieval. This preference defines how invoices are delivered to a procurement portal and how purchase orders are retrieved.ProcurementPortalName (string) required
BuyerDomain (string) required
BuyerIdentifier (string) required
SupplierDomain (string) required
SupplierIdentifier (string) required
Selector: {
. InvoiceUnitArns (array)
. SellerOfRecords (array)
} (object)
ProcurementPortalSharedSecret (string)
ProcurementPortalInstanceEndpoint (string)
TestEnvPreference: {
. BuyerDomain (string)
. BuyerIdentifier (string)
. SupplierDomain (string)
. SupplierIdentifier (string)
. ProcurementPortalSharedSecret (string)
. ProcurementPortalInstanceEndpoint (string)
} (object)
EinvoiceDeliveryEnabled (boolean) required
EinvoiceDeliveryPreference: {
. EinvoiceDeliveryDocumentTypes (array)
. EinvoiceDeliveryAttachmentTypes (array)
. Protocol (string)
. PurchaseOrderDataSources (array)
. ConnectionTestingMethod (string)
. EinvoiceDeliveryActivationDate (string)
} (object)
PurchaseOrderRetrievalEnabled (boolean) required
Contacts (array) required
ResourceTags (array)
ClientToken (string)
invoicing/delete_invoice_unitThis deletes an invoice unit with the provided invoice unit ARN.InvoiceUnitArn (string) required
invoicing/delete_procurement_portal_preferenceDeletes an existing procurement portal preference. This action cannot be undone. Active e-invoice delivery and PO retrieval configurations will be terminated.ProcurementPortalPreferenceArn (string) required
invoicing/get_invoice_pdfReturns a URL to download the invoice document and supplemental documents associated with an invoice. The URLs are pre-signed and have expiration time. For special cases like Brazil, where Amazon Web Services generated invoice identifiers and government provided identifiers do not match, use the Amazon Web Services generated invoice identifier when making API requests. To grant IAM permission to use this operation, the caller needs the invoicing:GetInvoicePDF policy action.InvoiceId (string) required
invoicing/get_invoice_unitThis retrieves the invoice unit definition.InvoiceUnitArn (string) required
AsOf (string)
invoicing/get_procurement_portal_preferenceRetrieves the details of a specific procurement portal preference configuration.ProcurementPortalPreferenceArn (string) required
invoicing/list_invoice_summariesRetrieves your invoice details programmatically, without line item details.Selector: {
. ResourceType (string)
. Value (string)
} (object) required
Filter: {
. TimeInterval (object)
. BillingPeriod (object)
. InvoicingEntity (string)
} (object)
NextToken (string)
MaxResults (integer)
invoicing/list_invoice_unitsThis fetches a list of all invoice unit definitions for a given account, as of the provided AsOf date.Filters: {
. Names (array)
. InvoiceReceivers (array)
. Accounts (array)
. BillSourceAccounts (array)
} (object)
NextToken (string)
MaxResults (integer)
AsOf (string)
invoicing/list_procurement_portal_preferencesRetrieves a list of procurement portal preferences associated with the Amazon Web Services account.NextToken (string)
MaxResults (integer)
invoicing/list_tags_for_resourceLists the tags for a resource.ResourceArn (string) required
invoicing/put_procurement_portal_preferenceUpdates an existing procurement portal preference configuration. This operation can modify settings for e-invoice delivery and purchase order retrieval.ProcurementPortalPreferenceArn (string) required
Selector: {
. InvoiceUnitArns (array)
. SellerOfRecords (array)
} (object)
ProcurementPortalSharedSecret (string)
ProcurementPortalInstanceEndpoint (string)
TestEnvPreference: {
. BuyerDomain (string)
. BuyerIdentifier (string)
. SupplierDomain (string)
. SupplierIdentifier (string)
. ProcurementPortalSharedSecret (string)
. ProcurementPortalInstanceEndpoint (string)
} (object)
EinvoiceDeliveryEnabled (boolean) required
EinvoiceDeliveryPreference: {
. EinvoiceDeliveryDocumentTypes (array)
. EinvoiceDeliveryAttachmentTypes (array)
. Protocol (string)
. PurchaseOrderDataSources (array)
. ConnectionTestingMethod (string)
. EinvoiceDeliveryActivationDate (string)
} (object)
PurchaseOrderRetrievalEnabled (boolean) required
Contacts (array) required
invoicing/tag_resourceAdds a tag to a resource.ResourceArn (string) required
ResourceTags (array) required
invoicing/untag_resourceRemoves a tag from a resource.ResourceArn (string) required
ResourceTagKeys (array) required
invoicing/update_invoice_unitYou can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.InvoiceUnitArn (string) required
Description (string)
TaxInheritanceDisabled (boolean)
Rule: {
. LinkedAccounts (array)
. BillSourceAccounts (array)
} (object)
invoicing/update_procurement_portal_preference_statusUpdates the status of a procurement portal preference, including the activation state of e-invoice delivery and purchase order retrieval features.ProcurementPortalPreferenceArn (string) required
EinvoiceDeliveryPreferenceStatus (string)
EinvoiceDeliveryPreferenceStatusReason (string)
PurchaseOrderRetrievalPreferenceStatus (string)
PurchaseOrderRetrievalPreferenceStatusReason (string)
iot_data_plane/delete_connectionDisconnects a connected MQTT client from Amazon Web Services IoT Core. When you disconnect a client, Amazon Web Services IoT Core closes the client's network connection and optionally cleans the session state.clientId (string) required
cleanSession (boolean)
preventWillMessage (boolean)
iot_data_plane/delete_thing_shadowDeletes the shadow for the specified thing. Requires permission to access the DeleteThingShadow action. For more information, see DeleteThingShadow in the IoT Developer Guide.thingName (string) required
shadowName (string)
iot_data_plane/get_retained_messageGets 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.topic (string) required
iot_data_plane/get_thing_shadowGets the shadow for the specified thing. Requires permission to access the GetThingShadow action. For more information, see GetThingShadow in the IoT Developer Guide.thingName (string) required
shadowName (string)
iot_data_plane/list_named_shadows_for_thingLists the shadows for the specified thing. Requires permission to access the ListNamedShadowsForThing action.thingName (string) required
nextToken (string)
pageSize (integer)
iot_data_plane/list_retained_messagesLists 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 costsnextToken (string)
maxResults (integer)
iot_data_plane/publishPublishes 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.topic (string) required
qos (integer)
retain (boolean)
payload (string)
userProperties (string)
payloadFormatIndicator (string)
contentType (string)
responseTopic (string)
correlationData (string)
messageExpiry (integer)
iot_data_plane/update_thing_shadowUpdates the shadow for the specified thing. Requires permission to access the UpdateThingShadow action. For more information, see UpdateThingShadow in the IoT Developer Guide.thingName (string) required
shadowName (string)
payload (string) required
iot_events_data/batch_acknowledge_alarmAcknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge them.acknowledgeActionRequests (array) required
iot_events_data/batch_delete_detectorDeletes 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.detectors (array) required
iot_events_data/batch_disable_alarmDisables one or more alarms. The alarms change to the DISABLED state after you disable them.disableActionRequests (array) required
iot_events_data/batch_enable_alarmEnables one or more alarms. The alarms change to the NORMAL state after you enable them.enableActionRequests (array) required
iot_events_data/batch_put_messageSends 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.messages (array) required
iot_events_data/batch_reset_alarmResets one or more alarms. The alarms return to the NORMAL state after you reset them.resetActionRequests (array) required
iot_events_data/batch_snooze_alarmChanges one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED state after you set them to the snooze mode.snoozeActionRequests (array) required
iot_events_data/batch_update_detectorUpdates the state, variable values, and timer settings of one or more detectors instances of a specified detector model.detectors (array) required
iot_events_data/describe_alarmRetrieves information about an alarm.alarmModelName (string) required
keyValue (string)
iot_events_data/describe_detectorReturns information about the specified detector instance.detectorModelName (string) required
keyValue (string)
iot_events_data/list_alarmsLists one or more alarms. The operation returns only the metadata associated with each alarm.alarmModelName (string) required
nextToken (string)
maxResults (integer)
iot_events_data/list_detectorsLists detectors the instances of a detector model.detectorModelName (string) required
stateName (string)
nextToken (string)
maxResults (integer)
iot_events/create_alarm_modelCreates 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.alarmModelName (string) required
alarmModelDescription (string)
roleArn (string) required
tags (array)
key (string)
severity (integer)
alarmRule: {
. simpleRule (object)
} (object) required
alarmNotification: {
. notificationActions (array)
} (object)
alarmEventActions: {
. alarmActions (array)
} (object)
alarmCapabilities: {
. initializationConfiguration (object)
. acknowledgeFlow (object)
} (object)
iot_events/create_detector_modelCreates a detector model.detectorModelName (string) required
detectorModelDefinition: {
. states (array)
. initialStateName (string)
} (object) required
detectorModelDescription (string)
key (string)
roleArn (string) required
tags (array)
evaluationMethod (string)
iot_events/create_inputCreates an input.inputName (string) required
inputDescription (string)
inputDefinition: {
. attributes (array)
} (object) required
tags (array)
iot_events/delete_alarm_modelDeletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.alarmModelName (string) required
iot_events/delete_detector_modelDeletes a detector model. Any active instances of the detector model are also deleted.detectorModelName (string) required
iot_events/delete_inputDeletes an input.inputName (string) required
iot_events/describe_alarm_modelRetrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.alarmModelName (string) required
alarmModelVersion (string)
iot_events/describe_detector_modelDescribes a detector model. If the version parameter is not specified, information about the latest version is returned.detectorModelName (string) required
detectorModelVersion (string)
iot_events/describe_detector_model_analysisRetrieves 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.analysisId (string) required
iot_events/describe_inputDescribes an input.inputName (string) required
iot_events/describe_logging_optionsRetrieves the current settings of the AWS IoT Events logging options.No parameters
iot_events/get_detector_model_analysis_resultsRetrieves 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.analysisId (string) required
nextToken (string)
maxResults (integer)
iot_events/list_alarm_modelsLists the alarm models that you created. The operation returns only the metadata associated with each alarm model.nextToken (string)
maxResults (integer)
iot_events/list_alarm_model_versionsLists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.alarmModelName (string) required
nextToken (string)
maxResults (integer)
iot_events/list_detector_modelsLists the detector models you have created. Only the metadata associated with each detector model is returned.nextToken (string)
maxResults (integer)
iot_events/list_detector_model_versionsLists all the versions of a detector model. Only the metadata associated with each detector model version is returned.detectorModelName (string) required
nextToken (string)
maxResults (integer)
iot_events/list_input_routingsLists one or more input routings.inputIdentifier: {
. iotEventsInputIdentifier (object)
. iotSiteWiseInputIdentifier (object)
} (object) required
maxResults (integer)
nextToken (string)
iot_events/list_inputsLists the inputs you have created.nextToken (string)
maxResults (integer)
iot_events/list_tags_for_resourceLists the tags metadata you have assigned to the resource.resourceArn (string) required
iot_events/put_logging_optionsSets 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.loggingOptions: {
. roleArn (string)
. level (string)
. enabled (boolean)
. detectorDebugOptions (array)
} (object) required
iot_events/start_detector_model_analysisPerforms an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.detectorModelDefinition: {
. states (array)
. initialStateName (string)
} (object) required
iot_events/tag_resourceAdds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.resourceArn (string) required
tags (array) required
iot_events/untag_resourceRemoves the given tags metadata from the resource.resourceArn (string) required
tagKeys (array) required
iot_events/update_alarm_modelUpdates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.alarmModelName (string) required
alarmModelDescription (string)
roleArn (string) required
severity (integer)
alarmRule: {
. simpleRule (object)
} (object) required
alarmNotification: {
. notificationActions (array)
} (object)
alarmEventActions: {
. alarmActions (array)
} (object)
alarmCapabilities: {
. initializationConfiguration (object)
. acknowledgeFlow (object)
} (object)
iot_events/update_detector_modelUpdates a detector model. Detectors instances spawned by the previous version are deleted and then re-created as new inputs arrive.detectorModelName (string) required
detectorModelDefinition: {
. states (array)
. initialStateName (string)
} (object) required
detectorModelDescription (string)
roleArn (string) required
evaluationMethod (string)
iot_events/update_inputUpdates an input.inputName (string) required
inputDescription (string)
inputDefinition: {
. attributes (array)
} (object) required
iot_jobs_data_plane/describe_job_executionGets details of a job execution. Requires permission to access the DescribeJobExecution action.jobId (string) required
thingName (string) required
includeJobDocument (boolean)
executionNumber (integer)
iot_jobs_data_plane/get_pending_job_executionsGets the list of all jobs for a thing that are not in a terminal status. Requires permission to access the GetPendingJobExecutions action.thingName (string) required
iot_jobs_data_plane/start_command_executionUsing the command created with the CreateCommand API, start a command execution on a specific device.targetArn (string) required
commandArn (string) required
parameters (object)
executionTimeoutSeconds (integer)
clientToken (string)
iot_jobs_data_plane/start_next_pending_job_executionGets and starts the next pending status IN_PROGRESS or QUEUED job execution for a thing. Requires permission to access the StartNextPendingJobExecution action.thingName (string) required
statusDetails (object)
stepTimeoutInMinutes (integer)
iot_jobs_data_plane/update_job_executionUpdates the status of a job execution. Requires permission to access the UpdateJobExecution action.jobId (string) required
thingName (string) required
status (string) required
statusDetails (object)
stepTimeoutInMinutes (integer)
expectedVersion (integer)
includeJobExecutionState (boolean)
includeJobDocument (boolean)
executionNumber (integer)
iot_managed_integrations/get_custom_endpointReturns the IoT managed integrations custom endpoint.No parameters
iot_managed_integrations/list_tags_for_resourceLists the tags for a specified resource.ResourceArn (string) required
iot_managed_integrations/register_custom_endpointCustomers can request IoT managed integrations to manage the server trust for them or bring their own external server trusts for the custom domain. Returns an IoT managed integrations endpoint.No parameters
iot_managed_integrations/send_connector_eventRelays third-party device events for a connector such as a new device or a device state change event.ConnectorId (string) required
UserId (string)
Operation (string) required
OperationVersion (string)
StatusCode (integer)
Message (string)
DeviceDiscoveryId (string)
ConnectorDeviceId (string)
TraceId (string)
Devices (array)
MatterEndpoint: {
. id (string)
. clusters (array)
} (object)
iot_managed_integrations/tag_resourceAdds tags to a specified resource.ResourceArn (string) required
Tags (object) required
iot_managed_integrations/untag_resourceRemoves tags from a specified resource.ResourceArn (string) required
TagKeys (array) required
iot_managed_integrations/start_account_association_refreshInitiates a refresh of an existing account association to update its authorization and connection status.AccountAssociationId (string) required
iot_managed_integrations/create_account_associationCreates a new account association via the destination id.ClientToken (string)
ConnectorDestinationId (string) required
Name (string)
Description (string)
Tags (object)
GeneralAuthorization: {
. AuthMaterialName (string)
} (object)
iot_managed_integrations/get_account_associationGet an account association for an Amazon Web Services account linked to a customer-managed destination.AccountAssociationId (string) required
iot_managed_integrations/update_account_associationUpdates the properties of an existing account association.AccountAssociationId (string) required
Name (string)
Description (string)
iot_managed_integrations/delete_account_associationRemove a third-party account association for an end user. You must first call the DeregisterAccountAssociation to remove the connection between the managed thing and the third-party account before calling the DeleteAccountAssociation API.AccountAssociationId (string) required
iot_managed_integrations/list_account_associationsLists all account associations, with optional filtering by connector destination ID.ConnectorDestinationId (string)
MaxResults (integer)
NextToken (string)
iot_managed_integrations/create_cloud_connectorCreates a C2C cloud-to-cloud connector.Name (string) required
EndpointConfig: {
. lambda (object)
} (object) required
Description (string)
EndpointType (string)
ClientToken (string)
iot_managed_integrations/get_cloud_connectorGet configuration details for a cloud connector.Identifier (string) required
iot_managed_integrations/update_cloud_connectorUpdate an existing cloud connector.Identifier (string) required
Name (string)
Description (string)
iot_managed_integrations/delete_cloud_connectorDelete a cloud connector.Identifier (string) required
iot_managed_integrations/list_cloud_connectorsReturns a list of connectors filtered by its Lambda Amazon Resource Name ARN and type.Type (string)
LambdaArn (string)
MaxResults (integer)
NextToken (string)
iot_managed_integrations/create_connector_destinationCreate a connector destination for connecting a cloud-to-cloud C2C connector to the customer's Amazon Web Services account.Name (string)
Description (string)
CloudConnectorId (string) required
AuthType (string)
AuthConfig: {
. oAuth (object)
. GeneralAuthorization (array)
} (object) required
SecretsManager: {
. arn (string)
. versionId (string)
} (object)
ClientToken (string)
iot_managed_integrations/get_connector_destinationGet connector destination details linked to a cloud-to-cloud C2C connector.Identifier (string) required
iot_managed_integrations/update_connector_destinationUpdates the properties of an existing connector destination.Identifier (string) required
Description (string)
Name (string)
AuthType (string)
AuthConfig: {
. oAuthUpdate (object)
. GeneralAuthorizationUpdate (object)
} (object)
SecretsManager: {
. arn (string)
. versionId (string)
} (object)
iot_managed_integrations/delete_connector_destinationDelete a connector destination linked to a cloud-to-cloud C2C connector. Deletion can't be done if the account association has used this connector destination.Identifier (string) required
iot_managed_integrations/list_connector_destinationsLists all connector destinations, with optional filtering by cloud connector ID.CloudConnectorId (string)
NextToken (string)
MaxResults (integer)
iot_managed_integrations/create_credential_lockerCreate a credential locker. This operation will not trigger the creation of all the manufacturing resources.Name (string)
ClientToken (string)
Tags (object)
iot_managed_integrations/get_credential_lockerGet information on an existing credential lockerIdentifier (string) required
iot_managed_integrations/delete_credential_lockerDelete a credential locker. This operation can't be undone and any existing device won't be able to use IoT managed integrations.Identifier (string) required
iot_managed_integrations/list_credential_lockersList information on an existing credential locker.NextToken (string)
MaxResults (integer)
iot_managed_integrations/create_destinationCreate a notification destination such as Kinesis Data Streams that receive events and notifications from Managed integrations. Managed integrations uses the destination to determine where to deliver notifications.DeliveryDestinationArn (string) required
DeliveryDestinationType (string) required
Name (string) required
RoleArn (string) required
ClientToken (string)
Description (string)
Tags (object)
iot_managed_integrations/delete_destinationDeletes a notification destination specified by name.Name (string) required
iot_managed_integrations/get_destinationGets a destination by name.Name (string) required
iot_managed_integrations/list_destinationsList all notification destinations.NextToken (string)
MaxResults (integer)
iot_managed_integrations/update_destinationUpdate a destination specified by name.Name (string) required
DeliveryDestinationArn (string)
DeliveryDestinationType (string)
RoleArn (string)
Description (string)
iot_managed_integrations/list_discovered_devicesLists all devices discovered during a specific device discovery task.Identifier (string) required
NextToken (string)
MaxResults (integer)
iot_managed_integrations/start_device_discoveryThis API is used to start device discovery for hub-connected and third-party-connected devices. The authentication material install code is delivered as a message to the controller instructing it to start the discovery.DiscoveryType (string) required
CustomProtocolDetail (object)
ControllerIdentifier (string)
ConnectorAssociationIdentifier (string)
AccountAssociationId (string)
AuthenticationMaterial (string)
AuthenticationMaterialType (string)
ClientToken (string)
Tags (object)
ConnectorDeviceIdList (array)
Protocol (string)
EndDeviceIdentifier (string)
iot_managed_integrations/get_device_discoveryGet the current state of a device discovery.Identifier (string) required
iot_managed_integrations/list_device_discoveriesLists all device discovery tasks, with optional filtering by type and status.NextToken (string)
MaxResults (integer)
TypeFilter (string)
StatusFilter (string)
iot_managed_integrations/create_event_log_configurationSet the event log configuration for the account, resource type, or specific resource.ResourceType (string) required
ResourceId (string)
EventLogLevel (string) required
ClientToken (string)
iot_managed_integrations/delete_event_log_configurationDelete an event log configuration.Id (string) required
iot_managed_integrations/get_event_log_configurationGet an event log configuration.Id (string) required
iot_managed_integrations/list_event_log_configurationsList all event log configurations for an account.NextToken (string)
MaxResults (integer)
iot_managed_integrations/update_event_log_configurationUpdate an event log configuration by log configuration ID.Id (string) required
EventLogLevel (string) required
iot_managed_integrations/get_hub_configurationGet a hub configuration.No parameters
iot_managed_integrations/put_hub_configurationUpdate a hub configuration.HubTokenTimerExpirySettingInSeconds (integer) required
iot_managed_integrations/get_default_encryption_configurationRetrieves 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 AWS IoT SiteWise User Guide.No parameters
iot_managed_integrations/put_default_encryption_configurationSets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the AWS IoT SiteWise User Guide.encryptionType (string) required
kmsKeyArn (string)
iot_managed_integrations/deregister_account_associationDeregister an account association from a managed thing.ManagedThingId (string) required
AccountAssociationId (string) required
iot_managed_integrations/list_managed_thing_account_associationsLists all account associations for a specific managed thing.ManagedThingId (string)
AccountAssociationId (string)
MaxResults (integer)
NextToken (string)
iot_managed_integrations/register_account_associationRegisters an account association with a managed thing, establishing a connection between a device and a third-party account.ManagedThingId (string) required
AccountAssociationId (string) required
DeviceDiscoveryId (string) required
iot_managed_integrations/send_managed_thing_commandSend the command to the device represented by the managed thing.ManagedThingId (string) required
Endpoints (array) required
ConnectorAssociationId (string)
AccountAssociationId (string)
iot_managed_integrations/get_managed_thing_capabilitiesGet the capabilities for a managed thing using the device ID.Identifier (string) required
iot_managed_integrations/get_managed_thing_certificateRetrieves the certificate PEM for a managed IoT thing.Identifier (string) required
iot_managed_integrations/get_managed_thing_connectivity_dataGet the connectivity status of a managed thing.Identifier (string) required
iot_managed_integrations/get_managed_thing_meta_dataGet the metadata information for a managed thing. The managedThing metadata parameter is used for associating attributes with a managedThing that can be used for grouping over-the-air OTA tasks. Name value pairs in metadata can be used in the OtaTargetQueryString parameter for the CreateOtaTask API operation.Identifier (string) required
iot_managed_integrations/list_managed_thing_schemasList schemas associated with a managed thing.Identifier (string) required
EndpointIdFilter (string)
CapabilityIdFilter (string)
NextToken (string)
MaxResults (integer)
iot_managed_integrations/create_managed_thingCreates a managed thing. A managed thing contains the device identifier, protocol supported, and capabilities of the device in a data model format defined by Managed integrations.Role (string) required
Owner (string)
CredentialLockerId (string)
AuthenticationMaterial (string) required
AuthenticationMaterialType (string) required
WiFiSimpleSetupConfiguration: {
. EnableAsProvisioner (boolean)
. EnableAsProvisionee (boolean)
. TimeoutInMinutes (integer)
} (object)
SerialNumber (string)
Brand (string)
Model (string)
Name (string)
CapabilityReport: {
. version (string)
. nodeId (string)
. endpoints (array)
} (object)
CapabilitySchemas (array)
Capabilities (string)
ClientToken (string)
Classification (string)
Tags (object)
MetaData (object)
iot_managed_integrations/get_managed_thingGet details of a managed thing including its attributes and capabilities.Identifier (string) required
iot_managed_integrations/update_managed_thingUpdate the attributes and capabilities associated with a managed thing.Identifier (string) required
Owner (string)
CredentialLockerId (string)
SerialNumber (string)
WiFiSimpleSetupConfiguration: {
. EnableAsProvisioner (boolean)
. EnableAsProvisionee (boolean)
. TimeoutInMinutes (integer)
} (object)
Brand (string)
Model (string)
Name (string)
CapabilityReport: {
. version (string)
. nodeId (string)
. endpoints (array)
} (object)
CapabilitySchemas (array)
Capabilities (string)
Classification (string)
HubNetworkMode (string)
MetaData (object)
iot_managed_integrations/delete_managed_thingDelete a managed thing. For direct-connected and hub-connected devices connecting with Managed integrations via a controller, all of the devices connected to it will have their status changed to PENDING. It is not possible to remove a cloud-to-cloud device.Identifier (string) required
Force (boolean)
iot_managed_integrations/list_managed_thingsListing all managed things with provision for filters.OwnerFilter (string)
CredentialLockerFilter (string)
RoleFilter (string)
ParentControllerIdentifierFilter (string)
ConnectorPolicyIdFilter (string)
ConnectorDestinationIdFilter (string)
ConnectorDeviceIdFilter (string)
SerialNumberFilter (string)
ProvisioningStatusFilter (string)
NextToken (string)
MaxResults (integer)
iot_managed_integrations/get_managed_thing_stateReturns the managed thing state for the given device Id.ManagedThingId (string) required
iot_managed_integrations/create_notification_configurationCreates a notification configuration. A configuration is a connection between an event type and a destination that you have already created.EventType (string) required
DestinationName (string) required
ClientToken (string)
Tags (object)
iot_managed_integrations/delete_notification_configurationDeletes a notification configuration.EventType (string) required
iot_managed_integrations/get_notification_configurationGet a notification configuration for a specified event type.EventType (string) required
iot_managed_integrations/list_notification_configurationsList all notification configurations.MaxResults (integer)
NextToken (string)
iot_managed_integrations/update_notification_configurationUpdate a notification configuration.EventType (string) required
DestinationName (string) required
iot_managed_integrations/create_ota_task_configurationCreate a configuraiton for the over-the-air OTA task.Description (string)
Name (string)
PushConfig: {
. AbortConfig (object)
. RolloutConfig (object)
. TimeoutConfig (object)
} (object)
ClientToken (string)
iot_managed_integrations/delete_ota_task_configurationDelete the over-the-air OTA task configuration.Identifier (string) required
iot_managed_integrations/get_ota_task_configurationGet a configuraiton for the over-the-air OTA task.Identifier (string) required
iot_managed_integrations/list_ota_task_configurationsList all of the over-the-air OTA task configurations.NextToken (string)
MaxResults (integer)
iot_managed_integrations/list_ota_task_executionsList all of the over-the-air OTA task executions.Identifier (string) required
NextToken (string)
MaxResults (integer)
iot_managed_integrations/create_ota_taskCreate an over-the-air OTA task to target a device.Description (string)
S3Url (string) required
Protocol (string)
Target (array)
TaskConfigurationId (string)
OtaMechanism (string)
OtaType (string) required
OtaTargetQueryString (string)
ClientToken (string)
OtaSchedulingConfig: {
. EndBehavior (string)
. EndTime (string)
. MaintenanceWindows (array)
. StartTime (string)
} (object)
OtaTaskExecutionRetryConfig: {
. RetryConfigCriteria (array)
} (object)
Tags (object)
iot_managed_integrations/get_ota_taskGet details of the over-the-air OTA task by its task id.Identifier (string) required
iot_managed_integrations/update_ota_taskUpdate an over-the-air OTA task.Identifier (string) required
Description (string)
TaskConfigurationId (string)
iot_managed_integrations/delete_ota_taskDelete the over-the-air OTA task.Identifier (string) required
iot_managed_integrations/list_ota_tasksList all of the over-the-air OTA tasks.NextToken (string)
MaxResults (integer)
iot_managed_integrations/create_provisioning_profileCreate a provisioning profile for a device to execute the provisioning flows using a provisioning template. The provisioning template is a document that defines the set of resources and policies applied to a device during the provisioning process.ProvisioningType (string) required
CaCertificate (string)
ClaimCertificate (string)
Name (string)
ClientToken (string)
Tags (object)
iot_managed_integrations/get_provisioning_profileGet a provisioning profile by template name.Identifier (string) required
iot_managed_integrations/delete_provisioning_profileDelete a provisioning profile.Identifier (string) required
iot_managed_integrations/list_provisioning_profilesList the provisioning profiles within the Amazon Web Services account.NextToken (string)
MaxResults (integer)
iot_managed_integrations/get_runtime_log_configurationGet the runtime log configuration for a specific managed thing.ManagedThingId (string) required
iot_managed_integrations/put_runtime_log_configurationSet the runtime log configuration for a specific managed thing.ManagedThingId (string) required
RuntimeLogConfigurations: {
. LogLevel (string)
. LogFlushLevel (string)
. LocalStoreLocation (string)
. LocalStoreFileRotationMaxFiles (integer)
. LocalStoreFileRotationMaxBytes (integer)
. UploadLog (boolean)
. UploadPeriodMinutes (integer)
. DeleteLocalStoreAfterUpload (boolean)
} (object) required
iot_managed_integrations/reset_runtime_log_configurationReset a runtime log configuration for a specific managed thing.ManagedThingId (string) required
iot_managed_integrations/get_schema_versionGets a schema version with the provided information.Type (string) required
SchemaVersionedId (string) required
Format (string)
iot_managed_integrations/list_schema_versionsLists schema versions with the provided information.Type (string) required
MaxResults (integer)
NextToken (string)
SchemaId (string)
Namespace (string)
Visibility (string)
SemanticVersion (string)
iot_wireless/associate_aws_account_with_partner_accountAssociates a partner account with your AWS account.Sidewalk: {
. AmazonId (string)
. AppServerPrivateKey (string)
} (object) required
ClientRequestToken (string)
Tags (array)
iot_wireless/associate_multicast_group_with_fuota_taskAssociate a multicast group with a FUOTA task.Id (string) required
MulticastGroupId (string) required
iot_wireless/associate_wireless_device_with_fuota_taskAssociate a wireless device with a FUOTA task.Id (string) required
WirelessDeviceId (string) required
iot_wireless/associate_wireless_device_with_multicast_groupAssociates a wireless device with a multicast group.Id (string) required
WirelessDeviceId (string) required
iot_wireless/associate_wireless_device_with_thingAssociates a wireless device with a thing.Id (string) required
ThingArn (string) required
iot_wireless/associate_wireless_gateway_with_certificateAssociates a wireless gateway with a certificate.Id (string) required
IotCertificateId (string) required
iot_wireless/associate_wireless_gateway_with_thingAssociates a wireless gateway with a thing.Id (string) required
ThingArn (string) required
iot_wireless/cancel_multicast_group_sessionCancels an existing multicast group session.Id (string) required
iot_wireless/create_destinationCreates a new destination that maps a device message to an AWS IoT rule.Name (string) required
ExpressionType (string) required
Expression (string) required
Description (string)
RoleArn (string) required
Tags (array)
ClientRequestToken (string)
iot_wireless/create_device_profileCreates a new device profile.Name (string)
LoRaWAN: {
. SupportsClassB (boolean)
. ClassBTimeout (integer)
. PingSlotPeriod (integer)
. PingSlotDr (integer)
. PingSlotFreq (integer)
. SupportsClassC (boolean)
. ClassCTimeout (integer)
. MacVersion (string)
. RegParamsRevision (string)
. RxDelay1 (integer)
. RxDrOffset1 (integer)
. RxDataRate2 (integer)
. RxFreq2 (integer)
. FactoryPresetFreqsList (array)
. MaxEirp (integer)
. MaxDutyCycle (integer)
. RfRegion (string)
. SupportsJoin (boolean)
. Supports32BitFCnt (boolean)
} (object)
Tags (array)
ClientRequestToken (string)
Sidewalk: {

} (object)
iot_wireless/create_fuota_taskCreates a FUOTA task.Name (string)
Description (string)
ClientRequestToken (string)
LoRaWAN: {
. RfRegion (string)
} (object)
FirmwareUpdateImage (string) required
FirmwareUpdateRole (string) required
Tags (array)
RedundancyPercent (integer)
FragmentSizeBytes (integer)
FragmentIntervalMS (integer)
Descriptor (string)
iot_wireless/create_multicast_groupCreates a multicast group.Name (string)
Description (string)
ClientRequestToken (string)
LoRaWAN: {
. RfRegion (string)
. DlClass (string)
. ParticipatingGateways (object)
} (object) required
Tags (array)
iot_wireless/create_network_analyzer_configurationCreates a new network analyzer configuration.Name (string) required
TraceContent: {
. WirelessDeviceFrameInfo (string)
. LogLevel (string)
. MulticastFrameInfo (string)
} (object)
WirelessDevices (array)
WirelessGateways (array)
Description (string)
Tags (array)
ClientRequestToken (string)
MulticastGroups (array)
iot_wireless/create_service_profileCreates a new service profile.Name (string)
LoRaWAN: {
. AddGwMetadata (boolean)
. DrMin (integer)
. DrMax (integer)
. PrAllowed (boolean)
. RaAllowed (boolean)
. TxPowerIndexMin (integer)
. TxPowerIndexMax (integer)
. NbTransMin (integer)
. NbTransMax (integer)
} (object)
Tags (array)
ClientRequestToken (string)
iot_wireless/create_wireless_deviceProvisions a wireless device.Type (string) required
Name (string)
Description (string)
DestinationName (string) required
ClientRequestToken (string)
LoRaWAN: {
. DevEui (string)
. DeviceProfileId (string)
. ServiceProfileId (string)
. OtaaV1_1 (object)
. OtaaV1_0_x (object)
. AbpV1_1 (object)
. AbpV1_0_x (object)
. FPorts (object)
} (object)
Tags (array)
Positioning (string)
Sidewalk: {
. DeviceProfileId (string)
. Positioning (object)
. SidewalkManufacturingSn (string)
} (object)
iot_wireless/create_wireless_gatewayProvisions a wireless gateway. When provisioning a wireless gateway, you might run into duplication errors for the following reasons. If you specify a GatewayEui value that already exists. If you used a ClientRequestToken with the same parameters within the last 10 minutes. To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.Name (string)
Description (string)
LoRaWAN: {
. GatewayEui (string)
. RfRegion (string)
. JoinEuiFilters (array)
. NetIdFilters (array)
. SubBands (array)
. Beaconing (object)
. MaxEirp (number)
} (object) required
Tags (array)
ClientRequestToken (string)
iot_wireless/create_wireless_gateway_taskCreates a task for a wireless gateway.Id (string) required
WirelessGatewayTaskDefinitionId (string) required
iot_wireless/create_wireless_gateway_task_definitionCreates a gateway task definition.AutoCreateTasks (boolean) required
Name (string)
Update: {
. UpdateDataSource (string)
. UpdateDataRole (string)
. LoRaWAN (object)
} (object)
ClientRequestToken (string)
Tags (array)
iot_wireless/delete_destinationDeletes a destination.Name (string) required
iot_wireless/delete_device_profileDeletes a device profile.Id (string) required
iot_wireless/delete_fuota_taskDeletes a FUOTA task.Id (string) required
iot_wireless/delete_multicast_groupDeletes a multicast group if it is not in use by a FUOTA task.Id (string) required
iot_wireless/delete_network_analyzer_configurationDeletes a network analyzer configuration.ConfigurationName (string) required
iot_wireless/delete_queued_messagesRemove queued messages from the downlink queue.Id (string) required
MessageId (string) required
WirelessDeviceType (string)
iot_wireless/delete_service_profileDeletes a service profile.Id (string) required
iot_wireless/delete_wireless_deviceDeletes a wireless device.Id (string) required
iot_wireless/delete_wireless_device_import_taskDelete an import task.Id (string) required
iot_wireless/delete_wireless_gatewayDeletes a wireless gateway. When deleting a wireless gateway, you might run into duplication errors for the following reasons. If you specify a GatewayEui value that already exists. If you used a ClientRequestToken with the same parameters within the last 10 minutes. To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.Id (string) required
iot_wireless/delete_wireless_gateway_taskDeletes a wireless gateway task.Id (string) required
iot_wireless/delete_wireless_gateway_task_definitionDeletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.Id (string) required
iot_wireless/deregister_wireless_deviceDeregister a wireless device from AWS IoT Wireless.Identifier (string) required
WirelessDeviceType (string)
iot_wireless/disassociate_aws_account_from_partner_accountDisassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.PartnerAccountId (string) required
PartnerType (string) required
iot_wireless/disassociate_multicast_group_from_fuota_taskDisassociates a multicast group from a FUOTA task.Id (string) required
MulticastGroupId (string) required
iot_wireless/disassociate_wireless_device_from_fuota_taskDisassociates a wireless device from a FUOTA task.Id (string) required
WirelessDeviceId (string) required
iot_wireless/disassociate_wireless_device_from_multicast_groupDisassociates a wireless device from a multicast group.Id (string) required
WirelessDeviceId (string) required
iot_wireless/disassociate_wireless_device_from_thingDisassociates a wireless device from its currently associated thing.Id (string) required
iot_wireless/disassociate_wireless_gateway_from_certificateDisassociates a wireless gateway from its currently associated certificate.Id (string) required
iot_wireless/disassociate_wireless_gateway_from_thingDisassociates a wireless gateway from its currently associated thing.Id (string) required
iot_wireless/get_destinationGets information about a destination.Name (string) required
iot_wireless/get_device_profileGets information about a device profile.Id (string) required
iot_wireless/get_event_configuration_by_resource_typesGet the event configuration based on resource types.No parameters
iot_wireless/get_fuota_taskGets information about a FUOTA task.Id (string) required
iot_wireless/get_log_levels_by_resource_typesReturns current default log levels or log levels by resource types. Based on the resource type, log levels can be returned for wireless device, wireless gateway, or FUOTA task log options.No parameters
iot_wireless/get_metric_configurationGet the metric configuration status for this AWS account.No parameters
iot_wireless/get_metricsGet the summary metrics for this AWS account.SummaryMetricQueries (array)
iot_wireless/get_multicast_groupGets information about a multicast group.Id (string) required
iot_wireless/get_multicast_group_sessionGets information about a multicast group session.Id (string) required
iot_wireless/get_network_analyzer_configurationGet network analyzer configuration.ConfigurationName (string) required
iot_wireless/get_partner_accountGets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.PartnerAccountId (string) required
PartnerType (string) required
iot_wireless/get_positionGet the position information for a given resource. This action is no longer supported. Calls to retrieve the position information should use the GetResourcePosition API operation instead.ResourceIdentifier (string) required
ResourceType (string) required
iot_wireless/get_position_configurationGet position configuration for a given resource. This action is no longer supported. Calls to retrieve the position configuration should use the GetResourcePosition API operation instead.ResourceIdentifier (string) required
ResourceType (string) required
iot_wireless/get_position_estimateGet estimated position information as a payload in GeoJSON format. The payload measurement data is resolved using solvers that are provided by third-party vendors.WiFiAccessPoints (array)
CellTowers: {
. Gsm (array)
. Wcdma (array)
. Tdscdma (array)
. Lte (array)
. Cdma (array)
} (object)
Ip: {
. IpAddress (string)
} (object)
Gnss: {
. Payload (string)
. CaptureTime (number)
. CaptureTimeAccuracy (number)
. AssistPosition (array)
. AssistAltitude (number)
. Use2DSolver (boolean)
} (object)
Timestamp (string)
iot_wireless/get_resource_event_configurationGet the event configuration for a particular resource identifier.Identifier (string) required
IdentifierType (string) required
PartnerType (string)
iot_wireless/get_resource_log_levelFetches the log-level override, if any, for a given resource ID and resource type..ResourceIdentifier (string) required
ResourceType (string) required
iot_wireless/get_resource_positionGet the position information for a given wireless device or a wireless gateway resource. The position information uses the World Geodetic System WGS84.ResourceIdentifier (string) required
ResourceType (string) required
iot_wireless/get_service_endpointGets the account-specific endpoint for Configuration and Update Server CUPS protocol or LoRaWAN Network Server LNS connections.ServiceType (string)
iot_wireless/get_service_profileGets information about a service profile.Id (string) required
iot_wireless/get_wireless_deviceGets information about a wireless device.Identifier (string) required
IdentifierType (string) required
iot_wireless/get_wireless_device_import_taskGet information about an import task and count of device onboarding summary information for the import task.Id (string) required
iot_wireless/get_wireless_device_statisticsGets operating information about a wireless device.WirelessDeviceId (string) required
iot_wireless/get_wireless_gatewayGets information about a wireless gateway.Identifier (string) required
IdentifierType (string) required
iot_wireless/get_wireless_gateway_certificateGets the ID of the certificate that is currently associated with a wireless gateway.Id (string) required
iot_wireless/get_wireless_gateway_firmware_informationGets the firmware version and other information about a wireless gateway.Id (string) required
iot_wireless/get_wireless_gateway_statisticsGets operating information about a wireless gateway.WirelessGatewayId (string) required
iot_wireless/get_wireless_gateway_taskGets information about a wireless gateway task.Id (string) required
iot_wireless/get_wireless_gateway_task_definitionGets information about a wireless gateway task definition.Id (string) required
iot_wireless/list_destinationsLists the destinations registered to your AWS account.MaxResults (integer)
NextToken (string)
iot_wireless/list_device_profilesLists the device profiles registered to your AWS account.NextToken (string)
MaxResults (integer)
DeviceProfileType (string)
iot_wireless/list_devices_for_wireless_device_import_taskList the Sidewalk devices in an import task and their onboarding status.Id (string) required
MaxResults (integer)
NextToken (string)
Status (string)
iot_wireless/list_event_configurationsList event configurations where at least one event topic has been enabled.ResourceType (string) required
MaxResults (integer)
NextToken (string)
iot_wireless/list_fuota_tasksLists the FUOTA tasks registered to your AWS account.NextToken (string)
MaxResults (integer)
iot_wireless/list_multicast_groupsLists the multicast groups registered to your AWS account.NextToken (string)
MaxResults (integer)
iot_wireless/list_multicast_groups_by_fuota_taskList all multicast groups associated with a FUOTA task.Id (string) required
NextToken (string)
MaxResults (integer)
iot_wireless/list_network_analyzer_configurationsLists the network analyzer configurations.MaxResults (integer)
NextToken (string)
iot_wireless/list_partner_accountsLists the partner accounts associated with your AWS account.NextToken (string)
MaxResults (integer)
iot_wireless/list_position_configurationsList position configurations for a given resource, such as positioning solvers. This action is no longer supported. Calls to retrieve position information should use the GetResourcePosition API operation instead.ResourceType (string)
MaxResults (integer)
NextToken (string)
iot_wireless/list_queued_messagesList queued messages in the downlink queue.Id (string) required
NextToken (string)
MaxResults (integer)
WirelessDeviceType (string)
iot_wireless/list_service_profilesLists the service profiles registered to your AWS account.NextToken (string)
MaxResults (integer)
iot_wireless/list_tags_for_resourceLists the tags metadata you have assigned to the resource.ResourceArn (string) required
iot_wireless/list_wireless_device_import_tasksList of import tasks and summary information of onboarding status of devices in each import task.MaxResults (integer)
NextToken (string)
iot_wireless/list_wireless_devicesLists the wireless devices registered to your AWS account.MaxResults (integer)
NextToken (string)
DestinationName (string)
DeviceProfileId (string)
ServiceProfileId (string)
WirelessDeviceType (string)
FuotaTaskId (string)
MulticastGroupId (string)
iot_wireless/list_wireless_gatewaysLists the wireless gateways registered to your AWS account.NextToken (string)
MaxResults (integer)
iot_wireless/list_wireless_gateway_task_definitionsList the wireless gateway tasks definitions registered to your AWS account.MaxResults (integer)
NextToken (string)
TaskDefinitionType (string)
iot_wireless/put_position_configurationPut position configuration for a given resource. This action is no longer supported. Calls to update the position configuration should use the UpdateResourcePosition API operation instead.ResourceIdentifier (string) required
ResourceType (string) required
Solvers: {
. SemtechGnss (object)
} (object)
Destination (string)
iot_wireless/put_resource_log_levelSets the log-level override for a resource ID and resource type. A limit of 200 log level override can be set per account.ResourceIdentifier (string) required
ResourceType (string) required
LogLevel (string) required
iot_wireless/reset_all_resource_log_levelsRemoves the log-level overrides for all resources; wireless devices, wireless gateways, and FUOTA tasks.No parameters
iot_wireless/reset_resource_log_levelRemoves the log-level override, if any, for a specific resource ID and resource type. It can be used for a wireless device, a wireless gateway, or a FUOTA task.ResourceIdentifier (string) required
ResourceType (string) required
iot_wireless/send_data_to_multicast_groupSends the specified data to a multicast group.Id (string) required
PayloadData (string) required
WirelessMetadata: {
. LoRaWAN (object)
} (object) required
iot_wireless/send_data_to_wireless_deviceSends a decrypted application data frame to a device.Id (string) required
TransmitMode (integer) required
PayloadData (string) required
WirelessMetadata: {
. LoRaWAN (object)
. Sidewalk (object)
} (object)
iot_wireless/start_bulk_associate_wireless_device_with_multicast_groupStarts a bulk association of all qualifying wireless devices with a multicast group.Id (string) required
QueryString (string)
Tags (array)
iot_wireless/start_bulk_disassociate_wireless_device_from_multicast_groupStarts a bulk disassociatin of all qualifying wireless devices from a multicast group.Id (string) required
QueryString (string)
Tags (array)
iot_wireless/start_fuota_taskStarts a FUOTA task.Id (string) required
LoRaWAN: {
. StartTime (string)
} (object)
iot_wireless/start_multicast_group_sessionStarts a multicast group session.Id (string) required
LoRaWAN: {
. DlDr (integer)
. DlFreq (integer)
. SessionStartTime (string)
. SessionTimeout (integer)
. PingSlotPeriod (integer)
} (object) required
iot_wireless/start_single_wireless_device_import_taskStart import task for a single wireless device.DestinationName (string) required
ClientRequestToken (string)
DeviceName (string)
Tags (array)
Positioning (string)
Sidewalk: {
. SidewalkManufacturingSn (string)
. Positioning (object)
} (object) required
iot_wireless/start_wireless_device_import_taskStart import task for provisioning Sidewalk devices in bulk using an S3 CSV file.DestinationName (string) required
ClientRequestToken (string)
Tags (array)
Positioning (string)
Sidewalk: {
. DeviceCreationFile (string)
. Role (string)
. Positioning (object)
} (object) required
iot_wireless/tag_resourceAdds a tag to a resource.ResourceArn (string) required
Tags (array) required
iot_wireless/test_wireless_deviceSimulates a provisioned device by sending an uplink data payload of Hello.Id (string) required
iot_wireless/untag_resourceRemoves one or more tags from a resource.ResourceArn (string) required
TagKeys (array) required
iot_wireless/update_destinationUpdates properties of a destination.Name (string) required
ExpressionType (string)
Expression (string)
Description (string)
RoleArn (string)
iot_wireless/update_event_configuration_by_resource_typesUpdate the event configuration based on resource types.DeviceRegistrationState: {
. Sidewalk (object)
} (object)
Proximity: {
. Sidewalk (object)
} (object)
Join: {
. LoRaWAN (object)
} (object)
ConnectionStatus: {
. LoRaWAN (object)
} (object)
MessageDeliveryStatus: {
. Sidewalk (object)
} (object)
iot_wireless/update_fuota_taskUpdates properties of a FUOTA task.Id (string) required
Name (string)
Description (string)
LoRaWAN: {
. RfRegion (string)
} (object)
FirmwareUpdateImage (string)
FirmwareUpdateRole (string)
RedundancyPercent (integer)
FragmentSizeBytes (integer)
FragmentIntervalMS (integer)
Descriptor (string)
iot_wireless/update_log_levels_by_resource_typesSet default log level, or log levels by resource types. This can be for wireless device, wireless gateway, or FUOTA task log options, and is used to control the log messages that'll be displayed in CloudWatch.DefaultLogLevel (string)
FuotaTaskLogOptions (array)
WirelessDeviceLogOptions (array)
WirelessGatewayLogOptions (array)
iot_wireless/update_metric_configurationUpdate the summary metric configuration.SummaryMetric: {
. Status (string)
} (object)
iot_wireless/update_multicast_groupUpdates properties of a multicast group session.Id (string) required
Name (string)
Description (string)
LoRaWAN: {
. RfRegion (string)
. DlClass (string)
. ParticipatingGateways (object)
} (object)
iot_wireless/update_network_analyzer_configurationUpdate network analyzer configuration.ConfigurationName (string) required
TraceContent: {
. WirelessDeviceFrameInfo (string)
. LogLevel (string)
. MulticastFrameInfo (string)
} (object)
WirelessDevicesToAdd (array)
WirelessDevicesToRemove (array)
WirelessGatewaysToAdd (array)
WirelessGatewaysToRemove (array)
Description (string)
MulticastGroupsToAdd (array)
MulticastGroupsToRemove (array)
iot_wireless/update_partner_accountUpdates properties of a partner account.Sidewalk: {
. AppServerPrivateKey (string)
} (object) required
PartnerAccountId (string) required
PartnerType (string) required
iot_wireless/update_positionUpdate the position information of a resource. This action is no longer supported. Calls to update the position information should use the UpdateResourcePosition API operation instead.ResourceIdentifier (string) required
ResourceType (string) required
Position (array) required
iot_wireless/update_resource_event_configurationUpdate the event configuration for a particular resource identifier.Identifier (string) required
IdentifierType (string) required
PartnerType (string)
DeviceRegistrationState: {
. Sidewalk (object)
. WirelessDeviceIdEventTopic (string)
} (object)
Proximity: {
. Sidewalk (object)
. WirelessDeviceIdEventTopic (string)
} (object)
Join: {
. LoRaWAN (object)
. WirelessDeviceIdEventTopic (string)
} (object)
ConnectionStatus: {
. LoRaWAN (object)
. WirelessGatewayIdEventTopic (string)
} (object)
MessageDeliveryStatus: {
. Sidewalk (object)
. WirelessDeviceIdEventTopic (string)
} (object)
iot_wireless/update_resource_positionUpdate the position information of a given wireless device or a wireless gateway resource. The position coordinates are based on the World Geodetic System WGS84.ResourceIdentifier (string) required
ResourceType (string) required
GeoJsonPayload (string)
iot_wireless/update_wireless_deviceUpdates properties of a wireless device.Id (string) required
DestinationName (string)
Name (string)
Description (string)
LoRaWAN: {
. DeviceProfileId (string)
. ServiceProfileId (string)
. AbpV1_1 (object)
. AbpV1_0_x (object)
. FPorts (object)
} (object)
Positioning (string)
Sidewalk: {
. Positioning (object)
} (object)
iot_wireless/update_wireless_device_import_taskUpdate an import task to add more devices to the task.Id (string) required
Sidewalk: {
. DeviceCreationFile (string)
} (object) required
iot_wireless/update_wireless_gatewayUpdates properties of a wireless gateway.Id (string) required
Name (string)
Description (string)
JoinEuiFilters (array)
NetIdFilters (array)
MaxEirp (number)
iot/accept_certificate_transferAccepts 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.certificateId (string) required
setAsActive (boolean)
iot/add_thing_to_billing_groupAdds a thing to a billing group. Requires permission to access the AddThingToBillingGroup action.billingGroupName (string)
billingGroupArn (string)
thingName (string)
thingArn (string)
iot/add_thing_to_thing_groupAdds a thing to a thing group. Requires permission to access the AddThingToThingGroup action.thingGroupName (string)
thingGroupArn (string)
thingName (string)
thingArn (string)
overrideDynamicGroups (boolean)
iot/associate_sbom_with_package_versionAssociates the selected software bill of materials SBOM with a specific software package version. Requires permission to access the AssociateSbomWithPackageVersion action.packageName (string) required
versionName (string) required
sbom: {
. s3Location (object)
} (object) required
clientToken (string)
iot/associate_targets_with_jobAssociates 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.targets (array) required
jobId (string) required
comment (string)
namespaceId (string)
iot/attach_policyAttaches the specified policy to the specified principal certificate or other credential. Requires permission to access the AttachPolicy action.policyName (string) required
target (string) required
iot/attach_principal_policyAttaches 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.policyName (string) required
principal (string) required
iot/attach_security_profileAssociates 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.securityProfileName (string) required
securityProfileTargetArn (string) required
iot/attach_thing_principalAttaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito identities or federated identities. Requires permission to access the AttachThingPrincipal action.thingName (string) required
principal (string) required
thingPrincipalType (string)
iot/cancel_audit_mitigation_actions_taskCancels 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.taskId (string) required
iot/cancel_audit_taskCancels 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.taskId (string) required
iot/cancel_certificate_transferCancels 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 INACTIVEcertificateId (string) required
iot/cancel_detect_mitigation_actions_taskCancels a Device Defender ML Detect mitigation action. Requires permission to access the CancelDetectMitigationActionsTask action.taskId (string) required
iot/cancel_jobCancels a job. Requires permission to access the CancelJob action.jobId (string) required
reasonCode (string)
comment (string)
force (boolean)
iot/cancel_job_executionCancels the execution of a job for a given thing. Requires permission to access the CancelJobExecution action.jobId (string) required
thingName (string) required
force (boolean)
expectedVersion (integer)
statusDetails (object)
iot/clear_default_authorizerClears the default authorizer. Requires permission to access the ClearDefaultAuthorizer action.No parameters
iot/confirm_topic_rule_destinationConfirms 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.confirmationToken (string) required
iot/create_audit_suppressionCreates a Device Defender audit suppression. Requires permission to access the CreateAuditSuppression action.checkName (string) required
resourceIdentifier: {
. deviceCertificateId (string)
. caCertificateId (string)
. cognitoIdentityPoolId (string)
. clientId (string)
. policyVersionIdentifier (object)
. account (string)
. iamRoleArn (string)
. roleAliasArn (string)
. issuerCertificateIdentifier (object)
. deviceCertificateArn (string)
} (object) required
expirationDate (string)
suppressIndefinitely (boolean)
description (string)
clientRequestToken (string) required
iot/create_authorizerCreates an authorizer. Requires permission to access the CreateAuthorizer action.authorizerName (string) required
authorizerFunctionArn (string) required
tokenKeyName (string)
tokenSigningPublicKeys (object)
status (string)
tags (array)
signingDisabled (boolean)
enableCachingForHttp (boolean)
iot/create_billing_groupCreates a billing group. If this call is made multiple times using the same billing group name and configuration, the call will succeed. If this call is made with the same billing group name but different configuration a ResourceAlreadyExistsException is thrown. Requires permission to access the CreateBillingGroup action.billingGroupName (string) required
billingGroupProperties: {
. billingGroupDescription (string)
} (object)
tags (array)
iot/create_certificate_from_csrCreates an X.509 certificate using the specified certificate signing request. Requires permission to access the CreateCertificateFromCsr action. 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-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT. Reusing the same certificate signing request CSR results in a distinct certificate. You can create multiple ccertificateSigningRequest (string) required
setAsActive (boolean)
iot/create_certificate_providerCreates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request CSR in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide. Requires permission to access the CreateCertificateProvider action. After you create a certificate provider, the behavior ofcertificateProviderName (string) required
lambdaFunctionArn (string) required
accountDefaultForOperations (array) required
clientToken (string)
tags (array)
iot/create_commandCreates a command. A command contains reusable configurations that can be applied before they are sent to the devices.commandId (string) required
namespace (string)
displayName (string)
description (string)
payload: {
. content (string)
. contentType (string)
} (object)
payloadTemplate (string)
preprocessor: {
. awsJsonSubstitution (object)
} (object)
mandatoryParameters (array)
roleArn (string)
tags (array)
iot/create_custom_metricUse this API to define a Custom Metric published by your devices to Device Defender. Requires permission to access the CreateCustomMetric action.metricName (string) required
displayName (string)
metricType (string) required
tags (array)
clientRequestToken (string) required
iot/create_dimensionCreate 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.name (string) required
type (string) required
stringValues (array) required
tags (array)
clientRequestToken (string) required
iot/create_domain_configurationCreates a domain configuration. Requires permission to access the CreateDomainConfiguration action.domainConfigurationName (string) required
domainName (string)
serverCertificateArns (array)
validationCertificateArn (string)
authorizerConfig: {
. defaultAuthorizerName (string)
. allowAuthorizerOverride (boolean)
} (object)
serviceType (string)
tags (array)
tlsConfig: {
. securityPolicy (string)
} (object)
serverCertificateConfig: {
. enableOCSPCheck (boolean)
. ocspLambdaArn (string)
. ocspAuthorizedResponderArn (string)
} (object)
authenticationType (string)
applicationProtocol (string)
clientCertificateConfig: {
. clientCertificateCallbackArn (string)
} (object)
iot/create_dynamic_thing_groupCreates a dynamic thing group. Requires permission to access the CreateDynamicThingGroup action.thingGroupName (string) required
thingGroupProperties: {
. thingGroupDescription (string)
. attributePayload (object)
} (object)
indexName (string)
queryString (string) required
queryVersion (string)
tags (array)
iot/create_fleet_metricCreates a fleet metric. Requires permission to access the CreateFleetMetric action.metricName (string) required
queryString (string) required
aggregationType: {
. name (string)
. values (array)
} (object) required
period (integer) required
aggregationField (string) required
description (string)
queryVersion (string)
indexName (string)
unit (string)
tags (array)
iot/create_jobCreates a job. Requires permission to access the CreateJob action.jobId (string) required
targets (array) required
documentSource (string)
document (string)
description (string)
presignedUrlConfig: {
. roleArn (string)
. expiresInSec (integer)
} (object)
targetSelection (string)
jobExecutionsRolloutConfig: {
. maximumPerMinute (integer)
. exponentialRate (object)
} (object)
abortConfig: {
. criteriaList (array)
} (object)
timeoutConfig: {
. inProgressTimeoutInMinutes (integer)
} (object)
tags (array)
namespaceId (string)
jobTemplateArn (string)
jobExecutionsRetryConfig: {
. criteriaList (array)
} (object)
documentParameters (object)
schedulingConfig: {
. startTime (string)
. endTime (string)
. endBehavior (string)
. maintenanceWindows (array)
} (object)
destinationPackageVersions (array)
iot/create_job_templateCreates a job template. Requires permission to access the CreateJobTemplate action.jobTemplateId (string) required
jobArn (string)
documentSource (string)
document (string)
description (string) required
presignedUrlConfig: {
. roleArn (string)
. expiresInSec (integer)
} (object)
jobExecutionsRolloutConfig: {
. maximumPerMinute (integer)
. exponentialRate (object)
} (object)
abortConfig: {
. criteriaList (array)
} (object)
timeoutConfig: {
. inProgressTimeoutInMinutes (integer)
} (object)
tags (array)
jobExecutionsRetryConfig: {
. criteriaList (array)
} (object)
maintenanceWindows (array)
destinationPackageVersions (array)
iot/create_keys_and_certificateCreates 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.setAsActive (boolean)
iot/create_mitigation_actionDefines 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.actionName (string) required
roleArn (string) required
actionParams: {
. updateDeviceCertificateParams (object)
. updateCACertificateParams (object)
. addThingsToThingGroupParams (object)
. replaceDefaultPolicyVersionParams (object)
. enableIoTLoggingParams (object)
. publishFindingToSnsParams (object)
} (object) required
tags (array)
iot/create_otaupdateCreates an IoT OTA update on a target group of things or groups. Requires permission to access the CreateOTAUpdate action.otaUpdateId (string) required
description (string)
targets (array) required
protocols (array)
targetSelection (string)
awsJobExecutionsRolloutConfig: {
. maximumPerMinute (integer)
. exponentialRate (object)
} (object)
awsJobPresignedUrlConfig: {
. expiresInSec (integer)
} (object)
awsJobAbortConfig: {
. abortCriteriaList (array)
} (object)
awsJobTimeoutConfig: {
. inProgressTimeoutInMinutes (integer)
} (object)
files (array) required
roleArn (string) required
additionalParameters (object)
tags (array)
iot/create_packageCreates an IoT software package that can be deployed to your fleet. Requires permission to access the CreatePackage and GetIndexingConfiguration actions.packageName (string) required
description (string)
tags (object)
clientToken (string)
iot/create_package_versionCreates a new version for an existing IoT software package. Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.packageName (string) required
versionName (string) required
description (string)
attributes (object)
artifact: {
. s3Location (object)
} (object)
recipe (string)
tags (object)
clientToken (string)
iot/create_policyCreates 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.policyName (string) required
policyDocument (string) required
tags (array)
iot/create_policy_versionCreates 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 permissipolicyName (string) required
policyDocument (string) required
setAsDefault (boolean)
iot/create_provisioning_claimCreates a provisioning claim. Requires permission to access the CreateProvisioningClaim action.templateName (string) required
iot/create_provisioning_templateCreates a provisioning template. Requires permission to access the CreateProvisioningTemplate action.templateName (string) required
description (string)
templateBody (string) required
enabled (boolean)
provisioningRoleArn (string) required
preProvisioningHook: {
. payloadVersion (string)
. targetArn (string)
} (object)
tags (array)
type (string)
iot/create_provisioning_template_versionCreates a new version of a provisioning template. Requires permission to access the CreateProvisioningTemplateVersion action.templateName (string) required
templateBody (string) required
setAsDefault (boolean)
iot/create_role_aliasCreates a role alias. Requires permission to access the CreateRoleAlias action. The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration Amazon Web Services API from the Amazon Web Services Identity and Access Management User Guide.roleAlias (string) required
roleArn (string) required
credentialDurationSeconds (integer)
tags (array)
iot/create_scheduled_auditCreates a scheduled audit that is run at a specified time interval. Requires permission to access the CreateScheduledAudit action.frequency (string) required
dayOfMonth (string)
dayOfWeek (string)
targetCheckNames (array) required
scheduledAuditName (string) required
tags (array)
iot/create_security_profileCreates a Device Defender security profile. Requires permission to access the CreateSecurityProfile action.securityProfileName (string) required
securityProfileDescription (string)
behaviors (array)
alertTargets (object)
additionalMetricsToRetain (array)
additionalMetricsToRetainV2 (array)
tags (array)
metricsExportConfig: {
. mqttTopic (string)
. roleArn (string)
} (object)
iot/create_streamCreates 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.streamId (string) required
description (string)
files (array) required
roleArn (string) required
tags (array)
iot/create_thingCreates 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.thingName (string) required
thingTypeName (string)
attributePayload: {
. attributes (object)
. merge (boolean)
} (object)
billingGroupName (string)
iot/create_thing_groupCreate a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions. If the ThingGroup that you create has the exact same attributes as an existing ThingGroup, you will get a 200 success response. Requires permission to access the CreateThingGroup action.thingGroupName (string) required
parentGroupName (string)
thingGroupProperties: {
. thingGroupDescription (string)
. attributePayload (object)
} (object)
tags (array)
iot/create_thing_typeCreates a new thing type. If this call is made multiple times using the same thing type name and configuration, the call will succeed. If this call is made with the same thing type name but different configuration a ResourceAlreadyExistsException is thrown. Requires permission to access the CreateThingType action.thingTypeName (string) required
thingTypeProperties: {
. thingTypeDescription (string)
. searchableAttributes (array)
. mqtt5Configuration (object)
} (object)
tags (array)
iot/create_topic_ruleCreates 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.ruleName (string) required
topicRulePayload: {
. sql (string)
. description (string)
. actions (array)
. ruleDisabled (boolean)
. awsIotSqlVersion (string)
. errorAction (object)
} (object) required
tags (string)
iot/create_topic_rule_destinationCreates a topic rule destination. The destination must be confirmed prior to use. Requires permission to access the CreateTopicRuleDestination action.destinationConfiguration: {
. httpUrlConfiguration (object)
. vpcConfiguration (object)
} (object) required
iot/delete_account_audit_configurationRestores 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.deleteScheduledAudits (boolean)
iot/delete_audit_suppressionDeletes a Device Defender audit suppression. Requires permission to access the DeleteAuditSuppression action.checkName (string) required
resourceIdentifier: {
. deviceCertificateId (string)
. caCertificateId (string)
. cognitoIdentityPoolId (string)
. clientId (string)
. policyVersionIdentifier (object)
. account (string)
. iamRoleArn (string)
. roleAliasArn (string)
. issuerCertificateIdentifier (object)
. deviceCertificateArn (string)
} (object) required
iot/delete_authorizerDeletes an authorizer. Requires permission to access the DeleteAuthorizer action.authorizerName (string) required
iot/delete_billing_groupDeletes the billing group. Requires permission to access the DeleteBillingGroup action.billingGroupName (string) required
expectedVersion (integer)
iot/delete_cacertificateDeletes a registered CA certificate. Requires permission to access the DeleteCACertificate action.certificateId (string) required
iot/delete_certificateDeletes 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.certificateId (string) required
forceDelete (boolean)
iot/delete_certificate_providerDeletes a certificate provider. Requires permission to access the DeleteCertificateProvider action. If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr will resume, and IoT will create certificates signed by IoT from a certificate signing request CSR.certificateProviderName (string) required
iot/delete_commandDelete a command resource.commandId (string) required
iot/delete_command_executionDelete a command execution. Only command executions that enter a terminal state can be deleted from your account.executionId (string) required
targetArn (string) required
iot/delete_custom_metricDeletes 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.metricName (string) required
iot/delete_dimensionRemoves the specified dimension from your Amazon Web Services accounts. Requires permission to access the DeleteDimension action.name (string) required
iot/delete_domain_configurationDeletes the specified domain configuration. Requires permission to access the DeleteDomainConfiguration action.domainConfigurationName (string) required
iot/delete_dynamic_thing_groupDeletes a dynamic thing group. Requires permission to access the DeleteDynamicThingGroup action.thingGroupName (string) required
expectedVersion (integer)
iot/delete_fleet_metricDeletes 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.metricName (string) required
expectedVersion (integer)
iot/delete_jobDeletes 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 tjobId (string) required
force (boolean)
namespaceId (string)
iot/delete_job_executionDeletes a job execution. Requires permission to access the DeleteJobExecution action.jobId (string) required
thingName (string) required
executionNumber (integer) required
force (boolean)
namespaceId (string)
iot/delete_job_templateDeletes the specified job template.jobTemplateId (string) required
iot/delete_mitigation_actionDeletes a defined mitigation action from your Amazon Web Services accounts. Requires permission to access the DeleteMitigationAction action.actionName (string) required
iot/delete_otaupdateDelete an OTA update. Requires permission to access the DeleteOTAUpdate action.otaUpdateId (string) required
deleteStream (boolean)
forceDeleteAWSJob (boolean)
iot/delete_packageDeletes a specific version from a software package. Note: All package versions must be deleted before deleting the software package. Requires permission to access the DeletePackageVersion action.packageName (string) required
clientToken (string)
iot/delete_package_versionDeletes a specific version from a software package. Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackage action.packageName (string) required
versionName (string) required
clientToken (string)
iot/delete_policyDeletes 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 ServicpolicyName (string) required
iot/delete_policy_versionDeletes 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.policyName (string) required
policyVersionId (string) required
iot/delete_provisioning_templateDeletes a provisioning template. Requires permission to access the DeleteProvisioningTemplate action.templateName (string) required
iot/delete_provisioning_template_versionDeletes a provisioning template version. Requires permission to access the DeleteProvisioningTemplateVersion action.templateName (string) required
versionId (integer) required
iot/delete_registration_codeDeletes a CA certificate registration code. Requires permission to access the DeleteRegistrationCode action.No parameters
iot/delete_role_aliasDeletes a role alias Requires permission to access the DeleteRoleAlias action.roleAlias (string) required
iot/delete_scheduled_auditDeletes a scheduled audit. Requires permission to access the DeleteScheduledAudit action.scheduledAuditName (string) required
iot/delete_security_profileDeletes a Device Defender security profile. Requires permission to access the DeleteSecurityProfile action.securityProfileName (string) required
expectedVersion (integer)
iot/delete_streamDeletes a stream. Requires permission to access the DeleteStream action.streamId (string) required
iot/delete_thingDeletes 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.thingName (string) required
expectedVersion (integer)
iot/delete_thing_groupDeletes a thing group. Requires permission to access the DeleteThingGroup action.thingGroupName (string) required
expectedVersion (integer)
iot/delete_thing_typeDeletes 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.thingTypeName (string) required
iot/delete_topic_ruleDeletes the rule. Requires permission to access the DeleteTopicRule action.ruleName (string) required
iot/delete_topic_rule_destinationDeletes a topic rule destination. Requires permission to access the DeleteTopicRuleDestination action.arn (string) required
iot/delete_v2logging_levelDeletes a logging level. Requires permission to access the DeleteV2LoggingLevel action.targetType (string) required
targetName (string) required
iot/deprecate_thing_typeDeprecates a thing type. You can not associate new things with deprecated thing type. Requires permission to access the DeprecateThingType action.thingTypeName (string) required
undoDeprecate (boolean)
iot/describe_account_audit_configurationGets 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.No parameters
iot/describe_audit_findingGets 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.findingId (string) required
iot/describe_audit_mitigation_actions_taskGets 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.taskId (string) required
iot/describe_audit_suppressionGets information about a Device Defender audit suppression.checkName (string) required
resourceIdentifier: {
. deviceCertificateId (string)
. caCertificateId (string)
. cognitoIdentityPoolId (string)
. clientId (string)
. policyVersionIdentifier (object)
. account (string)
. iamRoleArn (string)
. roleAliasArn (string)
. issuerCertificateIdentifier (object)
. deviceCertificateArn (string)
} (object) required
iot/describe_audit_taskGets information about a Device Defender audit. Requires permission to access the DescribeAuditTask action.taskId (string) required
iot/describe_authorizerDescribes an authorizer. Requires permission to access the DescribeAuthorizer action.authorizerName (string) required
iot/describe_billing_groupReturns information about a billing group. Requires permission to access the DescribeBillingGroup action.billingGroupName (string) required
iot/describe_cacertificateDescribes a registered CA certificate. Requires permission to access the DescribeCACertificate action.certificateId (string) required
iot/describe_certificateGets information about the specified certificate. Requires permission to access the DescribeCertificate action.certificateId (string) required
iot/describe_certificate_providerDescribes a certificate provider. Requires permission to access the DescribeCertificateProvider action.certificateProviderName (string) required
iot/describe_custom_metricGets information about a Device Defender detect custom metric. Requires permission to access the DescribeCustomMetric action.metricName (string) required
iot/describe_default_authorizerDescribes the default authorizer. Requires permission to access the DescribeDefaultAuthorizer action.No parameters
iot/describe_detect_mitigation_actions_taskGets information about a Device Defender ML Detect mitigation action. Requires permission to access the DescribeDetectMitigationActionsTask action.taskId (string) required
iot/describe_dimensionProvides details about a dimension that is defined in your Amazon Web Services accounts. Requires permission to access the DescribeDimension action.name (string) required
iot/describe_domain_configurationGets summary information about a domain configuration. Requires permission to access the DescribeDomainConfiguration action.domainConfigurationName (string) required
iot/describe_encryption_configurationRetrieves the encryption configuration for resources and data of your Amazon Web Services account in Amazon Web Services IoT Core. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide.No parameters
iot/describe_endpointReturns or creates a unique endpoint specific to the Amazon Web Services account making the call. The first time DescribeEndpoint is called, an endpoint is created. All subsequent calls to DescribeEndpoint return the same endpoint. Requires permission to access the DescribeEndpoint action.endpointType (string)
iot/describe_event_configurationsDescribes event configurations. Requires permission to access the DescribeEventConfigurations action.No parameters
iot/describe_fleet_metricGets information about the specified fleet metric. Requires permission to access the DescribeFleetMetric action.metricName (string) required
iot/describe_indexDescribes a search index. Requires permission to access the DescribeIndex action.indexName (string) required
iot/describe_jobDescribes a job. Requires permission to access the DescribeJob action.jobId (string) required
beforeSubstitution (boolean)
iot/describe_job_executionDescribes a job execution. Requires permission to access the DescribeJobExecution action.jobId (string) required
thingName (string) required
executionNumber (integer)
iot/describe_job_templateReturns information about a job template.jobTemplateId (string) required
iot/describe_managed_job_templateView details of a managed job template.templateName (string) required
templateVersion (string)
iot/describe_mitigation_actionGets information about a mitigation action. Requires permission to access the DescribeMitigationAction action.actionName (string) required
iot/describe_provisioning_templateReturns information about a provisioning template. Requires permission to access the DescribeProvisioningTemplate action.templateName (string) required
iot/describe_provisioning_template_versionReturns information about a provisioning template version. Requires permission to access the DescribeProvisioningTemplateVersion action.templateName (string) required
versionId (integer) required
iot/describe_role_aliasDescribes a role alias. Requires permission to access the DescribeRoleAlias action.roleAlias (string) required
iot/describe_scheduled_auditGets information about a scheduled audit. Requires permission to access the DescribeScheduledAudit action.scheduledAuditName (string) required
iot/describe_security_profileGets information about a Device Defender security profile. Requires permission to access the DescribeSecurityProfile action.securityProfileName (string) required
iot/describe_streamGets information about a stream. Requires permission to access the DescribeStream action.streamId (string) required
iot/describe_thingGets information about the specified thing. Requires permission to access the DescribeThing action.thingName (string) required
iot/describe_thing_groupDescribe a thing group. Requires permission to access the DescribeThingGroup action.thingGroupName (string) required
iot/describe_thing_registration_taskDescribes a bulk thing provisioning task. Requires permission to access the DescribeThingRegistrationTask action.taskId (string) required
iot/describe_thing_typeGets information about the specified thing type. Requires permission to access the DescribeThingType action.thingTypeName (string) required
iot/detach_policyDetaches 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.policyName (string) required
target (string) required
iot/detach_principal_policyRemoves 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.policyName (string) required
principal (string) required
iot/detach_security_profileDisassociates a Device Defender security profile from a thing group or from this account. Requires permission to access the DetachSecurityProfile action.securityProfileName (string) required
securityProfileTargetArn (string) required
iot/detach_thing_principalDetaches 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.thingName (string) required
principal (string) required
iot/disable_topic_ruleDisables the rule. Requires permission to access the DisableTopicRule action.ruleName (string) required
iot/disassociate_sbom_from_package_versionDisassociates the selected software bill of materials SBOM from a specific software package version. Requires permission to access the DisassociateSbomWithPackageVersion action.packageName (string) required
versionName (string) required
clientToken (string)
iot/enable_topic_ruleEnables the rule. Requires permission to access the EnableTopicRule action.ruleName (string) required
iot/get_behavior_model_training_summariesReturns a Device Defender's ML Detect Security Profile training model's status. Requires permission to access the GetBehaviorModelTrainingSummaries action.securityProfileName (string)
maxResults (integer)
nextToken (string)
iot/get_buckets_aggregationAggregates on indexed data with search queries pertaining to particular fields. Requires permission to access the GetBucketsAggregation action.indexName (string)
queryString (string) required
aggregationField (string) required
queryVersion (string)
bucketsAggregationType: {
. termsAggregation (object)
} (object) required
iot/get_cardinalityReturns the approximate count of unique values that match the query. Requires permission to access the GetCardinality action.indexName (string)
queryString (string) required
aggregationField (string)
queryVersion (string)
iot/get_commandGets information about the specified command.commandId (string) required
iot/get_command_executionGets information about the specific command execution on a single device.executionId (string) required
targetArn (string) required
includeResult (boolean)
iot/get_effective_policiesGets 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.principal (string)
cognitoIdentityPoolId (string)
thingName (string)
iot/get_indexing_configurationGets the indexing configuration. Requires permission to access the GetIndexingConfiguration action.No parameters
iot/get_job_documentGets a job document. Requires permission to access the GetJobDocument action.jobId (string) required
beforeSubstitution (boolean)
iot/get_logging_optionsGets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead. Requires permission to access the GetLoggingOptions action.No parameters
iot/get_otaupdateGets an OTA update. Requires permission to access the GetOTAUpdate action.otaUpdateId (string) required
iot/get_packageGets information about the specified software package. Requires permission to access the GetPackage action.packageName (string) required
iot/get_package_configurationGets information about the specified software package's configuration. Requires permission to access the GetPackageConfiguration action.No parameters
iot/get_package_versionGets information about the specified package version. Requires permission to access the GetPackageVersion action.packageName (string) required
versionName (string) required
iot/get_percentilesGroups 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 valueindexName (string)
queryString (string) required
aggregationField (string)
queryVersion (string)
percents (array)
iot/get_policyGets information about the specified policy with the policy document of the default version. Requires permission to access the GetPolicy action.policyName (string) required
iot/get_policy_versionGets information about the specified policy version. Requires permission to access the GetPolicyVersion action.policyName (string) required
policyVersionId (string) required
iot/get_registration_codeGets a registration code used to register a CA certificate with IoT. IoT will create a registration code as part of this API call if the registration code doesn't exist or has been deleted. If you already have a registration code, this API call will return the same registration code. Requires permission to access the GetRegistrationCode action.No parameters
iot/get_statisticsReturns 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.indexName (string)
queryString (string) required
aggregationField (string)
queryVersion (string)
iot/get_thing_connectivity_dataRetrieves the live connectivity status per device.thingName (string) required
iot/get_topic_ruleGets information about the rule. Requires permission to access the GetTopicRule action.ruleName (string) required
iot/get_topic_rule_destinationGets information about a topic rule destination. Requires permission to access the GetTopicRuleDestination action.arn (string) required
iot/get_v2logging_optionsGets the fine grained logging options. Requires permission to access the GetV2LoggingOptions action.verbose (boolean)
iot/list_active_violationsLists the active violations for a given Device Defender security profile. Requires permission to access the ListActiveViolations action.thingName (string)
securityProfileName (string)
behaviorCriteriaType (string)
listSuppressedAlerts (boolean)
verificationState (string)
nextToken (string)
maxResults (integer)
iot/list_attached_policiesLists the policies attached to the specified thing group. Requires permission to access the ListAttachedPolicies action.target (string) required
recursive (boolean)
marker (string)
pageSize (integer)
iot/list_audit_findingsLists 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.taskId (string)
checkName (string)
resourceIdentifier: {
. deviceCertificateId (string)
. caCertificateId (string)
. cognitoIdentityPoolId (string)
. clientId (string)
. policyVersionIdentifier (object)
. account (string)
. iamRoleArn (string)
. roleAliasArn (string)
. issuerCertificateIdentifier (object)
. deviceCertificateArn (string)
} (object)
maxResults (integer)
nextToken (string)
startTime (string)
endTime (string)
listSuppressedFindings (boolean)
iot/list_audit_mitigation_actions_executionsGets the status of audit mitigation action tasks that were executed. Requires permission to access the ListAuditMitigationActionsExecutions action.taskId (string) required
actionStatus (string)
findingId (string) required
maxResults (integer)
nextToken (string)
iot/list_audit_mitigation_actions_tasksGets a list of audit mitigation action tasks that match the specified filters. Requires permission to access the ListAuditMitigationActionsTasks action.auditTaskId (string)
findingId (string)
taskStatus (string)
maxResults (integer)
nextToken (string)
startTime (string) required
endTime (string) required
iot/list_audit_suppressionsLists your Device Defender audit listings. Requires permission to access the ListAuditSuppressions action.checkName (string)
resourceIdentifier: {
. deviceCertificateId (string)
. caCertificateId (string)
. cognitoIdentityPoolId (string)
. clientId (string)
. policyVersionIdentifier (object)
. account (string)
. iamRoleArn (string)
. roleAliasArn (string)
. issuerCertificateIdentifier (object)
. deviceCertificateArn (string)
} (object)
ascendingOrder (boolean)
nextToken (string)
maxResults (integer)
iot/list_audit_tasksLists the Device Defender audits that have been performed during a given time period. Requires permission to access the ListAuditTasks action.startTime (string) required
endTime (string) required
taskType (string)
taskStatus (string)
nextToken (string)
maxResults (integer)
iot/list_authorizersLists the authorizers registered in your account. Requires permission to access the ListAuthorizers action.pageSize (integer)
marker (string)
ascendingOrder (boolean)
status (string)
iot/list_billing_groupsLists the billing groups you have created. Requires permission to access the ListBillingGroups action.nextToken (string)
maxResults (integer)
namePrefixFilter (string)
iot/list_cacertificatesLists 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.pageSize (integer)
marker (string)
ascendingOrder (boolean)
templateName (string)
iot/list_certificate_providersLists all your certificate providers in your Amazon Web Services account. Requires permission to access the ListCertificateProviders action.nextToken (string)
ascendingOrder (boolean)
iot/list_certificatesLists 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.pageSize (integer)
marker (string)
ascendingOrder (boolean)
iot/list_certificates_by_caList the device certificates signed by the specified CA certificate. Requires permission to access the ListCertificatesByCA action.caCertificateId (string) required
pageSize (integer)
marker (string)
ascendingOrder (boolean)
iot/list_command_executionsList all command executions. You must provide only the startedTimeFilter or the completedTimeFilter information. If you provide both time filters, the API will generate an error. You can use this information to retrieve a list of command executions within a specific timeframe. You must provide only the commandArn or the thingArn information depending on whether you want to list executions for a specific command or an IoT thing. If you provide both fields, the API will generate an error. For moremaxResults (integer)
nextToken (string)
namespace (string)
status (string)
sortOrder (string)
startedTimeFilter: {
. after (string)
. before (string)
} (object)
completedTimeFilter: {
. after (string)
. before (string)
} (object)
targetArn (string)
commandArn (string)
iot/list_commandsList all commands in your account.maxResults (integer)
nextToken (string)
namespace (string)
commandParameterName (string)
sortOrder (string)
iot/list_custom_metricsLists your Device Defender detect custom metrics. Requires permission to access the ListCustomMetrics action.nextToken (string)
maxResults (integer)
iot/list_detect_mitigation_actions_executionsLists mitigation actions executions for a Device Defender ML Detect Security Profile. Requires permission to access the ListDetectMitigationActionsExecutions action.taskId (string)
violationId (string)
thingName (string)
startTime (string)
endTime (string)
maxResults (integer)
nextToken (string)
iot/list_detect_mitigation_actions_tasksList of Device Defender ML Detect mitigation actions tasks. Requires permission to access the ListDetectMitigationActionsTasks action.maxResults (integer)
nextToken (string)
startTime (string) required
endTime (string) required
iot/list_dimensionsList the set of dimensions that are defined for your Amazon Web Services accounts. Requires permission to access the ListDimensions action.nextToken (string)
maxResults (integer)
iot/list_domain_configurationsGets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name. Requires permission to access the ListDomainConfigurations action.marker (string)
pageSize (integer)
serviceType (string)
iot/list_fleet_metricsLists all your fleet metrics. Requires permission to access the ListFleetMetrics action.nextToken (string)
maxResults (integer)
iot/list_indicesLists the search indices. Requires permission to access the ListIndices action.nextToken (string)
maxResults (integer)
iot/list_job_executions_for_jobLists the job executions for a job. Requires permission to access the ListJobExecutionsForJob action.jobId (string) required
status (string)
maxResults (integer)
nextToken (string)
iot/list_job_executions_for_thingLists the job executions for the specified thing. Requires permission to access the ListJobExecutionsForThing action.thingName (string) required
status (string)
namespaceId (string)
maxResults (integer)
nextToken (string)
jobId (string)
iot/list_jobsLists jobs. Requires permission to access the ListJobs action.status (string)
targetSelection (string)
maxResults (integer)
nextToken (string)
thingGroupName (string)
thingGroupId (string)
namespaceId (string)
iot/list_job_templatesReturns a list of job templates. Requires permission to access the ListJobTemplates action.maxResults (integer)
nextToken (string)
iot/list_managed_job_templatesReturns a list of managed job templates.templateName (string)
maxResults (integer)
nextToken (string)
iot/list_metric_valuesLists 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.thingName (string) required
metricName (string) required
dimensionName (string)
dimensionValueOperator (string)
startTime (string) required
endTime (string) required
maxResults (integer)
nextToken (string)
iot/list_mitigation_actionsGets a list of all mitigation actions that match the specified filter criteria. Requires permission to access the ListMitigationActions action.actionType (string)
maxResults (integer)
nextToken (string)
iot/list_otaupdatesLists OTA updates. Requires permission to access the ListOTAUpdates action.maxResults (integer)
nextToken (string)
otaUpdateStatus (string)
iot/list_outgoing_certificatesLists certificates that are being transferred but not yet accepted. Requires permission to access the ListOutgoingCertificates action.pageSize (integer)
marker (string)
ascendingOrder (boolean)
iot/list_packagesLists the software packages associated to the account. Requires permission to access the ListPackages action.maxResults (integer)
nextToken (string)
iot/list_package_versionsLists the software package versions associated to the account. Requires permission to access the ListPackageVersions action.packageName (string) required
status (string)
maxResults (integer)
nextToken (string)
iot/list_policiesLists your policies. Requires permission to access the ListPolicies action.marker (string)
pageSize (integer)
ascendingOrder (boolean)
iot/list_policy_principalsLists 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.policyName (string) required
marker (string)
pageSize (integer)
ascendingOrder (boolean)
iot/list_policy_versionsLists the versions of the specified policy and identifies the default version. Requires permission to access the ListPolicyVersions action.policyName (string) required
iot/list_principal_policiesLists 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.principal (string) required
marker (string)
pageSize (integer)
ascendingOrder (boolean)
iot/list_principal_thingsLists 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.nextToken (string)
maxResults (integer)
principal (string) required
iot/list_principal_things_v2Lists the things associated with the specified principal. A principal can be an X.509 certificate or an Amazon Cognito ID. Requires permission to access the ListPrincipalThings action.nextToken (string)
maxResults (integer)
principal (string) required
thingPrincipalType (string)
iot/list_provisioning_templatesLists the provisioning templates in your Amazon Web Services account. Requires permission to access the ListProvisioningTemplates action.maxResults (integer)
nextToken (string)
iot/list_provisioning_template_versionsA list of provisioning template versions. Requires permission to access the ListProvisioningTemplateVersions action.templateName (string) required
maxResults (integer)
nextToken (string)
iot/list_related_resources_for_audit_findingThe related resources of an Audit finding. The following resources can be returned from calling this API: DEVICE_CERTIFICATE CA_CERTIFICATE IOT_POLICY COGNITO_IDENTITY_POOL CLIENT_ID ACCOUNT_SETTINGS ROLE_ALIAS IAM_ROLE ISSUER_CERTIFICATE This API is similar to DescribeAuditFinding's RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device certificates check, RelatedResources will not be populfindingId (string) required
nextToken (string)
maxResults (integer)
iot/list_role_aliasesLists the role aliases registered in your account. Requires permission to access the ListRoleAliases action.pageSize (integer)
marker (string)
ascendingOrder (boolean)
iot/list_sbom_validation_resultsThe validation results for all software bill of materials SBOM attached to a specific software package version. Requires permission to access the ListSbomValidationResults action.packageName (string) required
versionName (string) required
validationResult (string)
maxResults (integer)
nextToken (string)
iot/list_scheduled_auditsLists all of your scheduled audits. Requires permission to access the ListScheduledAudits action.nextToken (string)
maxResults (integer)
iot/list_security_profilesLists 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.nextToken (string)
maxResults (integer)
dimensionName (string)
metricName (string)
iot/list_security_profiles_for_targetLists the Device Defender security profiles attached to a target thing group. Requires permission to access the ListSecurityProfilesForTarget action.nextToken (string)
maxResults (integer)
recursive (boolean)
securityProfileTargetArn (string) required
iot/list_streamsLists all of the streams in your Amazon Web Services account. Requires permission to access the ListStreams action.maxResults (integer)
nextToken (string)
ascendingOrder (boolean)
iot/list_tags_for_resourceLists the tags metadata you have assigned to the resource. Requires permission to access the ListTagsForResource action.resourceArn (string) required
nextToken (string)
iot/list_targets_for_policyList targets for the specified policy. Requires permission to access the ListTargetsForPolicy action.policyName (string) required
marker (string)
pageSize (integer)
iot/list_targets_for_security_profileLists the targets thing groups associated with a given Device Defender security profile. Requires permission to access the ListTargetsForSecurityProfile action.securityProfileName (string) required
nextToken (string)
maxResults (integer)
iot/list_thing_groupsList the thing groups in your account. Requires permission to access the ListThingGroups action.nextToken (string)
maxResults (integer)
parentGroup (string)
namePrefixFilter (string)
recursive (boolean)
iot/list_thing_groups_for_thingList the thing groups to which the specified thing belongs. Requires permission to access the ListThingGroupsForThing action.thingName (string) required
nextToken (string)
maxResults (integer)
iot/list_thing_principalsLists 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.nextToken (string)
maxResults (integer)
thingName (string) required
iot/list_thing_principals_v2Lists the principals associated with the specified thing. A principal can be an X.509 certificate or an Amazon Cognito ID. Requires permission to access the ListThingPrincipals action.nextToken (string)
maxResults (integer)
thingName (string) required
thingPrincipalType (string)
iot/list_thing_registration_task_reportsInformation about the thing registration tasks.taskId (string) required
reportType (string) required
nextToken (string)
maxResults (integer)
iot/list_thing_registration_tasksList bulk thing provisioning tasks. Requires permission to access the ListThingRegistrationTasks action.nextToken (string)
maxResults (integer)
status (string)
iot/list_thingsLists 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. For more information, see List Things from the Amazon Web Services IoT Core Developer Guide. Requires permission to access the ListThings action. You will not be charged for calling this API if an Access denied error is returned. You wilnextToken (string)
maxResults (integer)
attributeName (string)
attributeValue (string)
thingTypeName (string)
usePrefixAttributeValue (boolean)
iot/list_things_in_billing_groupLists the things you have added to the given billing group. Requires permission to access the ListThingsInBillingGroup action.billingGroupName (string) required
nextToken (string)
maxResults (integer)
iot/list_things_in_thing_groupLists the things in the specified group. Requires permission to access the ListThingsInThingGroup action.thingGroupName (string) required
recursive (boolean)
nextToken (string)
maxResults (integer)
iot/list_thing_typesLists the existing thing types. Requires permission to access the ListThingTypes action.nextToken (string)
maxResults (integer)
thingTypeName (string)
iot/list_topic_rule_destinationsLists all the topic rule destinations in your Amazon Web Services account. Requires permission to access the ListTopicRuleDestinations action.maxResults (integer)
nextToken (string)
iot/list_topic_rulesLists the rules for the specific topic. Requires permission to access the ListTopicRules action.topic (string)
maxResults (integer)
nextToken (string)
ruleDisabled (boolean)
iot/list_v2logging_levelsLists logging levels. Requires permission to access the ListV2LoggingLevels action.targetType (string)
nextToken (string)
maxResults (integer)
iot/list_violation_eventsLists 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.startTime (string) required
endTime (string) required
thingName (string)
securityProfileName (string)
behaviorCriteriaType (string)
listSuppressedAlerts (boolean)
verificationState (string)
nextToken (string)
maxResults (integer)
iot/put_verification_state_on_violationSet a verification state and provide a description of that verification state on a violation detect alarm.violationId (string) required
verificationState (string) required
verificationStateDescription (string)
iot/register_cacertificateRegisters 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.caCertificate (string) required
verificationCertificate (string)
setAsActive (boolean)
allowAutoRegistration (boolean)
registrationConfig: {
. templateBody (string)
. roleArn (string)
. templateName (string)
} (object)
tags (array)
certificateMode (string)
iot/register_certificateRegisters 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.certificatePem (string) required
caCertificatePem (string)
setAsActive (boolean)
status (string)
iot/register_certificate_without_caRegister a certificate that does not have a certificate authority CA. For supported certificates, consult Certificate signing algorithms supported by IoT.certificatePem (string) required
status (string)
iot/register_thingProvisions 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.templateBody (string) required
parameters (object)
iot/reject_certificate_transferRejects 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.certificateId (string) required
rejectReason (string)
iot/remove_thing_from_billing_groupRemoves 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.billingGroupName (string)
billingGroupArn (string)
thingName (string)
thingArn (string)
iot/remove_thing_from_thing_groupRemove 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.thingGroupName (string)
thingGroupArn (string)
thingName (string)
thingArn (string)
iot/replace_topic_ruleReplaces 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.ruleName (string) required
topicRulePayload: {
. sql (string)
. description (string)
. actions (array)
. ruleDisabled (boolean)
. awsIotSqlVersion (string)
. errorAction (object)
} (object) required
iot/search_indexThe query search index. Requires permission to access the SearchIndex action.indexName (string)
queryString (string) required
nextToken (string)
maxResults (integer)
queryVersion (string)
iot/set_default_authorizerSets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer. Requires permission to access the SetDefaultAuthorizer action.authorizerName (string) required
iot/set_default_policy_versionSets 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.policyName (string) required
policyVersionId (string) required
iot/set_logging_optionsSets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead. Requires permission to access the SetLoggingOptions action.loggingOptionsPayload: {
. roleArn (string)
. logLevel (string)
} (object) required
iot/set_v2logging_levelSets the logging level. Requires permission to access the SetV2LoggingLevel action.logTarget: {
. targetType (string)
. targetName (string)
} (object) required
logLevel (string) required
iot/set_v2logging_optionsSets the logging options for the V2 logging service. Requires permission to access the SetV2LoggingOptions action.roleArn (string)
defaultLogLevel (string)
disableAllLogs (boolean)
eventConfigurations (array)
iot/start_audit_mitigation_actions_taskStarts a task that applies a set of mitigation actions to the specified target. Requires permission to access the StartAuditMitigationActionsTask action.taskId (string) required
target: {
. auditTaskId (string)
. findingIds (array)
. auditCheckToReasonCodeFilter (object)
} (object) required
auditCheckToActionsMapping (object) required
clientRequestToken (string) required
iot/start_detect_mitigation_actions_taskStarts a Device Defender ML Detect mitigation actions task. Requires permission to access the StartDetectMitigationActionsTask action.taskId (string) required
target: {
. violationIds (array)
. securityProfileName (string)
. behaviorName (string)
} (object) required
actions (array) required
violationEventOccurrenceRange: {
. startTime (string)
. endTime (string)
} (object)
includeOnlyActiveViolations (boolean)
includeSuppressedAlerts (boolean)
clientRequestToken (string) required
iot/start_on_demand_audit_taskStarts an on-demand Device Defender audit. Requires permission to access the StartOnDemandAuditTask action.targetCheckNames (array) required
iot/start_thing_registration_taskCreates a bulk thing provisioning task. Requires permission to access the StartThingRegistrationTask action.templateBody (string) required
inputFileBucket (string) required
inputFileKey (string) required
roleArn (string) required
iot/stop_thing_registration_taskCancels a bulk thing provisioning task. Requires permission to access the StopThingRegistrationTask action.taskId (string) required
iot/tag_resourceAdds 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.resourceArn (string) required
tags (array) required
iot/test_authorizationTests 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.principal (string)
cognitoIdentityPoolId (string)
authInfos (array) required
clientId (string)
policyNamesToAdd (array)
policyNamesToSkip (array)
iot/test_invoke_authorizerTests 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.authorizerName (string) required
token (string)
tokenSignature (string)
httpContext: {
. headers (object)
. queryString (string)
} (object)
mqttContext: {
. username (string)
. password (string)
. clientId (string)
} (object)
tlsContext: {
. serverName (string)
} (object)
iot/transfer_certificateTransfers 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 accepted by the recipient. No notification is sent to the transfer destination's account. The caller is responsible for notifying 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 policcertificateId (string) required
targetAwsAccount (string) required
transferMessage (string)
iot/untag_resourceRemoves the given tags metadata from the resource. Requires permission to access the UntagResource action.resourceArn (string) required
tagKeys (array) required
iot/update_account_audit_configurationConfigures 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.roleArn (string)
auditNotificationTargetConfigurations (object)
auditCheckConfigurations (object)
iot/update_audit_suppressionUpdates a Device Defender audit suppression.checkName (string) required
resourceIdentifier: {
. deviceCertificateId (string)
. caCertificateId (string)
. cognitoIdentityPoolId (string)
. clientId (string)
. policyVersionIdentifier (object)
. account (string)
. iamRoleArn (string)
. roleAliasArn (string)
. issuerCertificateIdentifier (object)
. deviceCertificateArn (string)
} (object) required
expirationDate (string)
suppressIndefinitely (boolean)
description (string)
iot/update_authorizerUpdates an authorizer. Requires permission to access the UpdateAuthorizer action.authorizerName (string) required
authorizerFunctionArn (string)
tokenKeyName (string)
tokenSigningPublicKeys (object)
status (string)
enableCachingForHttp (boolean)
iot/update_billing_groupUpdates information about the billing group. Requires permission to access the UpdateBillingGroup action.billingGroupName (string) required
billingGroupProperties: {
. billingGroupDescription (string)
} (object) required
expectedVersion (integer)
iot/update_cacertificateUpdates a registered CA certificate. Requires permission to access the UpdateCACertificate action.certificateId (string) required
newStatus (string)
newAutoRegistrationStatus (string)
registrationConfig: {
. templateBody (string)
. roleArn (string)
. templateName (string)
} (object)
removeAutoRegistration (boolean)
iot/update_certificateUpdates 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.certificateId (string) required
newStatus (string) required
iot/update_certificate_providerUpdates a certificate provider. Requires permission to access the UpdateCertificateProvider action.certificateProviderName (string) required
lambdaFunctionArn (string)
accountDefaultForOperations (array)
iot/update_commandUpdate information about a command or mark a command for deprecation.commandId (string) required
displayName (string)
description (string)
deprecated (boolean)
iot/update_custom_metricUpdates a Device Defender detect custom metric. Requires permission to access the UpdateCustomMetric action.metricName (string) required
displayName (string) required
iot/update_dimensionUpdates 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.name (string) required
stringValues (array) required
iot/update_domain_configurationUpdates values stored in the domain configuration. Domain configurations for default endpoints can't be updated. Requires permission to access the UpdateDomainConfiguration action.domainConfigurationName (string) required
authorizerConfig: {
. defaultAuthorizerName (string)
. allowAuthorizerOverride (boolean)
} (object)
domainConfigurationStatus (string)
removeAuthorizerConfig (boolean)
tlsConfig: {
. securityPolicy (string)
} (object)
serverCertificateConfig: {
. enableOCSPCheck (boolean)
. ocspLambdaArn (string)
. ocspAuthorizedResponderArn (string)
} (object)
authenticationType (string)
applicationProtocol (string)
clientCertificateConfig: {
. clientCertificateCallbackArn (string)
} (object)
iot/update_dynamic_thing_groupUpdates a dynamic thing group. Requires permission to access the UpdateDynamicThingGroup action.thingGroupName (string) required
thingGroupProperties: {
. thingGroupDescription (string)
. attributePayload (object)
} (object) required
expectedVersion (integer)
indexName (string)
queryString (string)
queryVersion (string)
iot/update_encryption_configurationUpdates the encryption configuration. By default, Amazon Web Services IoT Core encrypts your data at rest using Amazon Web Services owned keys. Amazon Web Services IoT Core also supports symmetric customer managed keys from Key Management Service KMS. With customer managed keys, you create, own, and manage the KMS keys in your Amazon Web Services account. Before using this API, you must set up permissions for Amazon Web Services IoT Core to access KMS. For more information, see Data encryption aencryptionType (string) required
kmsKeyArn (string)
kmsAccessRoleArn (string)
iot/update_event_configurationsUpdates the event configurations. Requires permission to access the UpdateEventConfigurations action.eventConfigurations (object)
iot/update_fleet_metricUpdates the data for a fleet metric. Requires permission to access the UpdateFleetMetric action.metricName (string) required
queryString (string)
aggregationType: {
. name (string)
. values (array)
} (object)
period (integer)
aggregationField (string)
description (string)
queryVersion (string)
indexName (string) required
unit (string)
expectedVersion (integer)
iot/update_indexing_configurationUpdates the search configuration. Requires permission to access the UpdateIndexingConfiguration action.thingIndexingConfiguration: {
. thingIndexingMode (string)
. thingConnectivityIndexingMode (string)
. deviceDefenderIndexingMode (string)
. namedShadowIndexingMode (string)
. managedFields (array)
. customFields (array)
. filter (object)
} (object)
thingGroupIndexingConfiguration: {
. thingGroupIndexingMode (string)
. managedFields (array)
. customFields (array)
} (object)
iot/update_jobUpdates supported fields of the specified job. Requires permission to access the UpdateJob action.jobId (string) required
description (string)
presignedUrlConfig: {
. roleArn (string)
. expiresInSec (integer)
} (object)
jobExecutionsRolloutConfig: {
. maximumPerMinute (integer)
. exponentialRate (object)
} (object)
abortConfig: {
. criteriaList (array)
} (object)
timeoutConfig: {
. inProgressTimeoutInMinutes (integer)
} (object)
namespaceId (string)
jobExecutionsRetryConfig: {
. criteriaList (array)
} (object)
iot/update_mitigation_actionUpdates the definition for the specified mitigation action. Requires permission to access the UpdateMitigationAction action.actionName (string) required
roleArn (string)
actionParams: {
. updateDeviceCertificateParams (object)
. updateCACertificateParams (object)
. addThingsToThingGroupParams (object)
. replaceDefaultPolicyVersionParams (object)
. enableIoTLoggingParams (object)
. publishFindingToSnsParams (object)
} (object)
iot/update_packageUpdates the supported fields for a specific software package. Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.packageName (string) required
description (string)
defaultVersionName (string)
unsetDefaultVersion (boolean)
clientToken (string)
iot/update_package_configurationUpdates the software package configuration. Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.versionUpdateByJobsConfig: {
. enabled (boolean)
. roleArn (string)
} (object)
clientToken (string)
iot/update_package_versionUpdates the supported fields for a specific package version. Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.packageName (string) required
versionName (string) required
description (string)
attributes (object)
artifact: {
. s3Location (object)
} (object)
action (string)
recipe (string)
clientToken (string)
iot/update_provisioning_templateUpdates a provisioning template. Requires permission to access the UpdateProvisioningTemplate action.templateName (string) required
description (string)
enabled (boolean)
defaultVersionId (integer)
provisioningRoleArn (string)
preProvisioningHook: {
. payloadVersion (string)
. targetArn (string)
} (object)
removePreProvisioningHook (boolean)
iot/update_role_aliasUpdates a role alias. Requires permission to access the UpdateRoleAlias action. The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration Amazon Web Services API from the Amazon Web Services Identity and Access Management User Guide.roleAlias (string) required
roleArn (string)
credentialDurationSeconds (integer)
iot/update_scheduled_auditUpdates a scheduled audit, including which checks are performed and how often the audit takes place. Requires permission to access the UpdateScheduledAudit action.frequency (string)
dayOfMonth (string)
dayOfWeek (string)
targetCheckNames (array)
scheduledAuditName (string) required
iot/update_security_profileUpdates a Device Defender security profile. Requires permission to access the UpdateSecurityProfile action.securityProfileName (string) required
securityProfileDescription (string)
behaviors (array)
alertTargets (object)
additionalMetricsToRetain (array)
additionalMetricsToRetainV2 (array)
deleteBehaviors (boolean)
deleteAlertTargets (boolean)
deleteAdditionalMetricsToRetain (boolean)
expectedVersion (integer)
metricsExportConfig: {
. mqttTopic (string)
. roleArn (string)
} (object)
deleteMetricsExportConfig (boolean)
iot/update_streamUpdates an existing stream. The stream version will be incremented by one. Requires permission to access the UpdateStream action.streamId (string) required
description (string)
files (array)
roleArn (string)
iot/update_thingUpdates the data for a thing. Requires permission to access the UpdateThing action.thingName (string) required
thingTypeName (string)
attributePayload: {
. attributes (object)
. merge (boolean)
} (object)
expectedVersion (integer)
removeThingType (boolean)
iot/update_thing_groupUpdate a thing group. Requires permission to access the UpdateThingGroup action.thingGroupName (string) required
thingGroupProperties: {
. thingGroupDescription (string)
. attributePayload (object)
} (object) required
expectedVersion (integer)
iot/update_thing_groups_for_thingUpdates the groups to which the thing belongs. Requires permission to access the UpdateThingGroupsForThing action.thingName (string)
thingGroupsToAdd (array)
thingGroupsToRemove (array)
overrideDynamicGroups (boolean)
iot/update_thing_typeUpdates a thing type.thingTypeName (string) required
thingTypeProperties: {
. thingTypeDescription (string)
. searchableAttributes (array)
. mqtt5Configuration (object)
} (object)
iot/update_topic_rule_destinationUpdates 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.arn (string) required
status (string) required
iot/validate_security_profile_behaviorsValidates a Device Defender security profile behaviors specification. Requires permission to access the ValidateSecurityProfileBehaviors action.behaviors (array) required
iotdeviceadvisor/create_suite_definitionCreates a Device Advisor test suite. Requires permission to access the CreateSuiteDefinition action.suiteDefinitionConfiguration: {
. suiteDefinitionName (string)
. devices (array)
. intendedForQualification (boolean)
. isLongDurationTest (boolean)
. rootGroup (string)
. devicePermissionRoleArn (string)
. protocol (string)
} (object) required
tags (object)
clientToken (string)
iotdeviceadvisor/delete_suite_definitionDeletes a Device Advisor test suite. Requires permission to access the DeleteSuiteDefinition action.suiteDefinitionId (string) required
iotdeviceadvisor/get_endpointGets information about an Device Advisor endpoint.thingArn (string)
certificateArn (string)
deviceRoleArn (string)
authenticationMethod (string)
iotdeviceadvisor/get_suite_definitionGets information about a Device Advisor test suite. Requires permission to access the GetSuiteDefinition action.suiteDefinitionId (string) required
suiteDefinitionVersion (string)
iotdeviceadvisor/get_suite_runGets information about a Device Advisor test suite run. Requires permission to access the GetSuiteRun action.suiteDefinitionId (string) required
suiteRunId (string) required
iotdeviceadvisor/get_suite_run_reportGets a report download link for a successful Device Advisor qualifying test suite run. Requires permission to access the GetSuiteRunReport action.suiteDefinitionId (string) required
suiteRunId (string) required
iotdeviceadvisor/list_suite_definitionsLists the Device Advisor test suites you have created. Requires permission to access the ListSuiteDefinitions action.maxResults (integer)
nextToken (string)
iotdeviceadvisor/list_suite_runsLists 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.suiteDefinitionId (string)
suiteDefinitionVersion (string)
maxResults (integer)
nextToken (string)
iotdeviceadvisor/list_tags_for_resourceLists the tags attached to an IoT Device Advisor resource. Requires permission to access the ListTagsForResource action.resourceArn (string) required
iotdeviceadvisor/start_suite_runStarts a Device Advisor test suite run. Requires permission to access the StartSuiteRun action.suiteDefinitionId (string) required
suiteDefinitionVersion (string)
suiteRunConfiguration: {
. primaryDevice (object)
. selectedTestList (array)
. parallelRun (boolean)
} (object) required
tags (object)
iotdeviceadvisor/stop_suite_runStops a Device Advisor test suite run that is currently running. Requires permission to access the StopSuiteRun action.suiteDefinitionId (string) required
suiteRunId (string) required
iotdeviceadvisor/tag_resourceAdds to and modifies existing tags of an IoT Device Advisor resource. Requires permission to access the TagResource action.resourceArn (string) required
tags (object) required
iotdeviceadvisor/untag_resourceRemoves tags from an IoT Device Advisor resource. Requires permission to access the UntagResource action.resourceArn (string) required
tagKeys (array) required
iotdeviceadvisor/update_suite_definitionUpdates a Device Advisor test suite. Requires permission to access the UpdateSuiteDefinition action.suiteDefinitionId (string) required
suiteDefinitionConfiguration: {
. suiteDefinitionName (string)
. devices (array)
. intendedForQualification (boolean)
. isLongDurationTest (boolean)
. rootGroup (string)
. devicePermissionRoleArn (string)
. protocol (string)
} (object) required
iotfleetwise/batch_create_vehicleCreates 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.vehicles (array) required
iotfleetwise/batch_update_vehicleUpdates 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.vehicles (array) required
iotfleetwise/get_encryption_configurationRetrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.No parameters
iotfleetwise/get_logging_optionsRetrieves the logging options.No parameters
iotfleetwise/get_register_account_statusRetrieves 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.No parameters
iotfleetwise/get_vehicle_statusRetrieves information about the status of campaigns, decoder manifests, or state templates associated with a vehicle.nextToken (string)
maxResults (integer)
vehicleName (string) required
iotfleetwise/list_tags_for_resourceLists the tags metadata you have assigned to the resource.ResourceARN (string) required
iotfleetwise/put_encryption_configurationCreates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption in the Amazon Web Services IoT FleetWise Developer Guide.kmsKeyId (string)
encryptionType (string) required
iotfleetwise/put_logging_optionsCreates or updates the logging option.cloudWatchLogDelivery: {
. logType (string)
. logGroupName (string)
} (object) required
iotfleetwise/register_accountThis API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the CreateCampaign API operation. You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the DeleteCampaign API operation. If you want to delete the TimestretimestreamResources: {
. timestreamDatabaseName (string)
. timestreamTableName (string)
} (object)
iamResources: {
. roleArn (string)
} (object)
iotfleetwise/tag_resourceAdds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.ResourceARN (string) required
Tags (array) required
iotfleetwise/untag_resourceRemoves the given tags metadata from the resource.ResourceARN (string) required
TagKeys (array) required
iotfleetwise/get_campaignRetrieves information about a campaign. Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.name (string) required
iotfleetwise/update_campaignUpdates a campaign.name (string) required
description (string)
dataExtraDimensions (array)
action (string) required
iotfleetwise/delete_campaignDeletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.name (string) required
iotfleetwise/list_campaignsLists information about created campaigns. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.nextToken (string)
maxResults (integer)
status (string)
listResponseScope (string)
iotfleetwise/create_campaignCreates 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. Access to certain Amazoname (string) required
description (string)
signalCatalogArn (string) required
targetArn (string) required
startTime (string)
expiryTime (string)
postTriggerCollectionDuration (integer)
diagnosticsMode (string)
spoolingMode (string)
compression (string)
priority (integer)
signalsToCollect (array)
collectionScheme (undefined) required
dataExtraDimensions (array)
tags (array)
dataDestinationConfigs (array)
dataPartitions (array)
signalsToFetch (array)
iotfleetwise/import_decoder_manifestCreates a decoder manifest using your existing CAN DBC file from your local device. The CAN signal name must be unique and not repeated across CAN message definitions in a .dbc file.name (string) required
networkFileDefinitions (array) required
iotfleetwise/list_decoder_manifest_network_interfacesLists the network interfaces specified in a decoder manifest. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.name (string) required
nextToken (string)
maxResults (integer)
iotfleetwise/list_decoder_manifest_signalsA 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.name (string) required
nextToken (string)
maxResults (integer)
iotfleetwise/get_decoder_manifestRetrieves information about a created decoder manifest.name (string) required
iotfleetwise/update_decoder_manifestUpdates a decoder manifest. A decoder manifest can only be updated when the status is DRAFT. Only ACTIVE decoder manifests can be associated with vehicles.name (string) required
description (string)
signalDecodersToAdd (array)
signalDecodersToUpdate (array)
signalDecodersToRemove (array)
networkInterfacesToAdd (array)
networkInterfacesToUpdate (array)
networkInterfacesToRemove (array)
status (string)
defaultForUnmappedSignals (string)
iotfleetwise/delete_decoder_manifestDeletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it.name (string) required
iotfleetwise/list_decoder_manifestsLists decoder manifests. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.modelManifestArn (string)
nextToken (string)
maxResults (integer)
listResponseScope (string)
iotfleetwise/create_decoder_manifestCreates 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.name (string) required
description (string)
modelManifestArn (string) required
signalDecoders (array)
networkInterfaces (array)
defaultForUnmappedSignals (string)
tags (array)
iotfleetwise/get_fleetRetrieves information about a fleet.fleetId (string) required
iotfleetwise/update_fleetUpdates the description of an existing fleet.fleetId (string) required
description (string)
iotfleetwise/delete_fleetDeletes 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.fleetId (string) required
iotfleetwise/list_fleetsRetrieves 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.nextToken (string)
maxResults (integer)
listResponseScope (string)
iotfleetwise/create_fleetCreates 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.fleetId (string) required
description (string)
signalCatalogArn (string) required
tags (array)
iotfleetwise/list_vehicles_in_fleetRetrieves 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.fleetId (string) required
nextToken (string)
maxResults (integer)
iotfleetwise/list_model_manifest_nodesLists 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.name (string) required
nextToken (string)
maxResults (integer)
iotfleetwise/get_model_manifestRetrieves information about a vehicle model model manifest.name (string) required
iotfleetwise/update_model_manifestUpdates a vehicle model model manifest. If created vehicles are associated with a vehicle model, it can't be updated.name (string) required
description (string)
nodesToAdd (array)
nodesToRemove (array)
status (string)
iotfleetwise/delete_model_manifestDeletes a vehicle model model manifest.name (string) required
iotfleetwise/list_model_manifestsRetrieves a list of vehicle models model manifests. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.signalCatalogArn (string)
nextToken (string)
maxResults (integer)
listResponseScope (string)
iotfleetwise/create_model_manifestCreates 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.name (string) required
description (string)
nodes (array) required
signalCatalogArn (string) required
tags (array)
iotfleetwise/import_signal_catalogCreates a signal catalog using your existing VSS formatted content from your local device.name (string) required
description (string)
vss (undefined)
tags (array)
iotfleetwise/list_signal_catalog_nodesLists 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.name (string) required
nextToken (string)
maxResults (integer)
signalNodeType (string)
iotfleetwise/get_signal_catalogRetrieves information about a signal catalog.name (string) required
iotfleetwise/update_signal_catalogUpdates a signal catalog.name (string) required
description (string)
nodesToAdd (array)
nodesToUpdate (array)
nodesToRemove (array)
iotfleetwise/delete_signal_catalogDeletes a signal catalog.name (string) required
iotfleetwise/list_signal_catalogsLists 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.nextToken (string)
maxResults (integer)
iotfleetwise/create_signal_catalogCreates a collection of standardized signals that can be reused to create vehicle models.name (string) required
description (string)
nodes (array)
tags (array)
iotfleetwise/create_state_templateCreates a state template. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud. Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.name (string) required
description (string)
signalCatalogArn (string) required
stateTemplateProperties (array) required
dataExtraDimensions (array)
metadataExtraDimensions (array)
tags (array)
iotfleetwise/get_state_templateRetrieves information about a state template. Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.identifier (string) required
iotfleetwise/update_state_templateUpdates a state template. Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.identifier (string) required
description (string)
stateTemplatePropertiesToAdd (array)
stateTemplatePropertiesToRemove (array)
dataExtraDimensions (array)
metadataExtraDimensions (array)
iotfleetwise/delete_state_templateDeletes a state template.identifier (string) required
iotfleetwise/list_state_templatesLists information about created state templates. Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.nextToken (string)
maxResults (integer)
listResponseScope (string)
iotfleetwise/associate_vehicle_fleetAdds, or associates, a vehicle with a fleet.vehicleName (string) required
fleetId (string) required
iotfleetwise/disassociate_vehicle_fleetRemoves, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle.vehicleName (string) required
fleetId (string) required
iotfleetwise/get_vehicleRetrieves information about a vehicle.vehicleName (string) required
iotfleetwise/update_vehicleUpdates a vehicle. Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.vehicleName (string) required
modelManifestArn (string)
decoderManifestArn (string)
attributes (object)
attributeUpdateMode (string)
stateTemplatesToAdd (array)
stateTemplatesToRemove (array)
stateTemplatesToUpdate (array)
iotfleetwise/delete_vehicleDeletes a vehicle and removes it from any campaigns.vehicleName (string) required
iotfleetwise/list_vehiclesRetrieves a list of summaries of created vehicles. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.modelManifestArn (string)
attributeNames (array)
attributeValues (array)
nextToken (string)
maxResults (integer)
listResponseScope (string)
iotfleetwise/create_vehicleCreates 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.vehicleName (string) required
modelManifestArn (string) required
decoderManifestArn (string) required
attributes (object)
associationBehavior (string)
tags (array)
stateTemplates (array)
iotfleetwise/list_fleets_for_vehicleRetrieves 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.vehicleName (string) required
nextToken (string)
maxResults (integer)
iotsecuretunneling/close_tunnelCloses 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.tunnelId (string) required
delete (boolean)
iotsecuretunneling/describe_tunnelGets information about a tunnel identified by the unique tunnel id. Requires permission to access the DescribeTunnel action.tunnelId (string) required
iotsecuretunneling/list_tags_for_resourceLists the tags for the specified resource.resourceArn (string) required
iotsecuretunneling/list_tunnelsList 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.thingName (string)
maxResults (integer)
nextToken (string)
iotsecuretunneling/open_tunnelCreates 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.description (string)
tags (array)
destinationConfig: {
. thingName (string)
. services (array)
} (object)
timeoutConfig: {
. maxLifetimeTimeoutMinutes (integer)
} (object)
iotsecuretunneling/rotate_tunnel_access_tokenRevokes 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.tunnelId (string) required
clientMode (string) required
destinationConfig: {
. thingName (string)
. services (array)
} (object)
iotsecuretunneling/tag_resourceA resource tag.resourceArn (string) required
tags (array) required
iotsecuretunneling/untag_resourceRemoves a tag from a resource.resourceArn (string) required
tagKeys (array) required
iotsitewise/associate_assetsAssociates 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.assetId (string) required
hierarchyId (string) required
childAssetId (string) required
clientToken (string)
iotsitewise/associate_time_series_to_asset_propertyAssociates a time series data stream with an asset property.alias (string) required
assetId (string) required
propertyId (string) required
clientToken (string)
iotsitewise/batch_associate_project_assetsAssociates a group batch of assets with an IoT SiteWise Monitor project.projectId (string) required
assetIds (array) required
clientToken (string)
iotsitewise/batch_disassociate_project_assetsDisassociates a group batch of assets from an IoT SiteWise Monitor project.projectId (string) required
assetIds (array) required
clientToken (string)
iotsitewise/batch_get_asset_property_aggregatesGets 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.entries (array) required
nextToken (string)
maxResults (integer)
iotsitewise/batch_get_asset_property_valueGets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.entries (array) required
nextToken (string)
iotsitewise/batch_get_asset_property_value_historyGets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.entries (array) required
nextToken (string)
maxResults (integer)
iotsitewise/batch_put_asset_property_valueSends 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 UnienablePartialEntryProcessing (boolean)
entries (array) required
iotsitewise/create_access_policyCreates an access policy that grants the specified identity IAM Identity Center user, IAM Identity Center group, or IAM user access to the specified IoT SiteWise Monitor portal or project resource. Support for access policies that use an SSO Group as the identity is not supported at this time.accessPolicyIdentity: {
. user (object)
. group (object)
. iamUser (object)
. iamRole (object)
} (object) required
accessPolicyResource: {
. portal (object)
. project (object)
} (object) required
accessPolicyPermission (string) required
clientToken (string)
tags (object)
iotsitewise/create_assetCreates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.assetName (string) required
assetModelId (string) required
assetId (string)
assetExternalId (string)
clientToken (string)
tags (object)
assetDescription (string)
iotsitewise/create_asset_modelCreates 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. You can create three types of asset models, ASSET_MODEL, COMPONENT_MODEL, or an INTERFACE. ASSET_MODEL – defaultassetModelName (string) required
assetModelType (string)
assetModelId (string)
assetModelExternalId (string)
assetModelDescription (string)
assetModelProperties (array)
assetModelHierarchies (array)
assetModelCompositeModels (array)
clientToken (string)
tags (object)
iotsitewise/create_asset_model_composite_modelCreates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based. Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provassetModelId (string) required
assetModelCompositeModelExternalId (string)
parentAssetModelCompositeModelId (string)
assetModelCompositeModelId (string)
assetModelCompositeModelDescription (string)
assetModelCompositeModelName (string) required
assetModelCompositeModelType (string) required
clientToken (string)
composedAssetModelId (string)
assetModelCompositeModelProperties (array)
ifMatch (string)
ifNoneMatch (string)
matchForVersionType (string)
iotsitewise/create_bulk_import_jobDefines 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. Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration. Bulk import is designed to store historical data to IoT SiteWise. Newly ingested data in the hot tier triggers notifications and computationsjobName (string) required
jobRoleArn (string) required
files (array) required
errorReportLocation: {
. bucket (string)
. prefix (string)
} (object) required
jobConfiguration: {
. fileFormat (object)
} (object) required
adaptiveIngestion (boolean)
deleteFilesAfterImport (boolean)
iotsitewise/create_computation_modelCreate a computation model with a configuration and data binding.computationModelName (string) required
computationModelDescription (string)
computationModelConfiguration: {
. anomalyDetection (object)
} (object) required
computationModelDataBinding (object) required
clientToken (string)
tags (object)
iotsitewise/create_dashboardCreates a dashboard in an IoT SiteWise Monitor project.projectId (string) required
dashboardName (string) required
dashboardDescription (string)
dashboardDefinition (string) required
clientToken (string)
tags (object)
iotsitewise/create_datasetCreates a dataset to connect an external datasource.datasetId (string)
datasetName (string) required
datasetDescription (string)
datasetSource: {
. sourceType (string)
. sourceFormat (string)
. sourceDetail (object)
} (object) required
clientToken (string)
tags (object)
iotsitewise/create_gatewayCreates 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.gatewayName (string) required
gatewayPlatform: {
. greengrass (object)
. greengrassV2 (object)
. siemensIE (object)
} (object) required
gatewayVersion (string)
tags (object)
iotsitewise/create_portalCreates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center 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.portalName (string) required
portalDescription (string)
portalContactEmail (string) required
clientToken (string)
portalLogoImageFile: {
. data (string)
. type (string)
} (object)
roleArn (string) required
tags (object)
portalAuthMode (string)
notificationSenderEmail (string)
alarms: {
. alarmRoleArn (string)
. notificationLambdaArn (string)
} (object)
portalType (string)
portalTypeConfiguration (object)
iotsitewise/create_projectCreates a project in the specified portal. Make sure that the project name and description don't contain confidential information.portalId (string) required
projectName (string) required
projectDescription (string)
clientToken (string)
tags (object)
iotsitewise/delete_access_policyDeletes 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.accessPolicyId (string) required
clientToken (string)
iotsitewise/delete_assetDeletes 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.assetId (string) required
clientToken (string)
iotsitewise/delete_asset_modelDeletes 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.assetModelId (string) required
clientToken (string)
ifMatch (string)
ifNoneMatch (string)
matchForVersionType (string)
iotsitewise/delete_asset_model_composite_modelDeletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite 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.assetModelId (string) required
assetModelCompositeModelId (string) required
clientToken (string)
ifMatch (string)
ifNoneMatch (string)
matchForVersionType (string)
iotsitewise/delete_asset_model_interface_relationshipDeletes an interface relationship between an asset model and an interface asset model.assetModelId (string) required
interfaceAssetModelId (string) required
clientToken (string)
iotsitewise/delete_computation_modelDeletes a computation model. This action can't be undone.computationModelId (string) required
clientToken (string)
iotsitewise/delete_dashboardDeletes a dashboard from IoT SiteWise Monitor.dashboardId (string) required
clientToken (string)
iotsitewise/delete_datasetDeletes a dataset. This cannot be undone.datasetId (string) required
clientToken (string)
iotsitewise/delete_gatewayDeletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.gatewayId (string) required
iotsitewise/delete_portalDeletes a portal from IoT SiteWise Monitor.portalId (string) required
clientToken (string)
iotsitewise/delete_projectDeletes a project from IoT SiteWise Monitor.projectId (string) required
clientToken (string)
iotsitewise/delete_time_seriesDeletes 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 propalias (string)
assetId (string)
propertyId (string)
clientToken (string)
iotsitewise/describe_access_policyDescribes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.accessPolicyId (string) required
iotsitewise/describe_actionRetrieves information about an action.actionId (string) required
iotsitewise/describe_assetRetrieves information about an asset.assetId (string) required
excludeProperties (boolean)
iotsitewise/describe_asset_composite_modelRetrieves information about an asset composite model also known as an asset component. An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.assetId (string) required
assetCompositeModelId (string) required
iotsitewise/describe_asset_modelRetrieves information about an asset model. This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.assetModelId (string) required
excludeProperties (boolean)
assetModelVersion (string)
iotsitewise/describe_asset_model_composite_modelRetrieves information about an asset model composite model also known as an asset model component. For more information, see Custom composite models Components in the IoT SiteWise User Guide.assetModelId (string) required
assetModelCompositeModelId (string) required
assetModelVersion (string)
iotsitewise/describe_asset_model_interface_relationshipRetrieves information about an interface relationship between an asset model and an interface asset model.assetModelId (string) required
interfaceAssetModelId (string) required
iotsitewise/describe_asset_propertyRetrieves 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.assetId (string) required
propertyId (string) required
iotsitewise/describe_bulk_import_jobRetrieves 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.jobId (string) required
iotsitewise/describe_computation_modelRetrieves information about a computation model.computationModelId (string) required
computationModelVersion (string)
iotsitewise/describe_computation_model_execution_summaryRetrieves information about the execution summary of a computation model.computationModelId (string) required
resolveToResourceType (string)
resolveToResourceId (string)
iotsitewise/describe_dashboardRetrieves information about a dashboard.dashboardId (string) required
iotsitewise/describe_datasetRetrieves information about a dataset.datasetId (string) required
iotsitewise/describe_default_encryption_configurationRetrieves 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.No parameters
iotsitewise/describe_executionRetrieves information about the execution.executionId (string) required
iotsitewise/describe_gatewayRetrieves information about a gateway.gatewayId (string) required
iotsitewise/describe_gateway_capability_configurationEach gateway capability defines data sources for a gateway. This is the namespace of the gateway capability. . The namespace follows the format service:capability:version, where: service - The service providing the capability, or iotsitewise. capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability. version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, agatewayId (string) required
capabilityNamespace (string) required
iotsitewise/describe_logging_optionsRetrieves the current IoT SiteWise logging options.No parameters
iotsitewise/describe_portalRetrieves information about a portal.portalId (string) required
iotsitewise/describe_projectRetrieves information about a project.projectId (string) required
iotsitewise/describe_storage_configurationRetrieves information about the storage configuration for IoT SiteWise.No parameters
iotsitewise/describe_time_seriesRetrieves 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.alias (string)
assetId (string)
propertyId (string)
iotsitewise/disassociate_assetsDisassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.assetId (string) required
hierarchyId (string) required
childAssetId (string) required
clientToken (string)
iotsitewise/disassociate_time_series_from_asset_propertyDisassociates a time series data stream from an asset property.alias (string) required
assetId (string) required
propertyId (string) required
clientToken (string)
iotsitewise/execute_actionExecutes an action on a target resource.targetResource: {
. assetId (string)
. computationModelId (string)
} (object) required
actionDefinitionId (string) required
actionPayload: {
. stringValue (string)
} (object) required
clientToken (string)
resolveTo: {
. assetId (string)
} (object)
iotsitewise/execute_queryRun SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.queryStatement (string) required
nextToken (string)
maxResults (integer)
clientToken (string)
iotsitewise/get_asset_property_aggregatesGets 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.assetId (string)
propertyId (string)
propertyAlias (string)
aggregateTypes (array) required
resolution (string) required
qualities (array)
startDate (string) required
endDate (string) required
timeOrdering (string)
nextToken (string)
maxResults (integer)
iotsitewise/get_asset_property_valueGets 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.assetId (string)
propertyId (string)
propertyAlias (string)
iotsitewise/get_asset_property_value_historyGets 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.assetId (string)
propertyId (string)
propertyAlias (string)
startDate (string)
endDate (string)
qualities (array)
timeOrdering (string)
nextToken (string)
maxResults (integer)
iotsitewise/get_interpolated_asset_property_valuesGet 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 propertassetId (string)
propertyId (string)
propertyAlias (string)
startTimeInSeconds (integer) required
startTimeOffsetInNanos (integer)
endTimeInSeconds (integer) required
endTimeOffsetInNanos (integer)
quality (string) required
intervalInSeconds (integer) required
nextToken (string)
maxResults (integer)
type (string) required
intervalWindowInSeconds (integer)
iotsitewise/invoke_assistantInvokes SiteWise Assistant to start or continue a conversation.conversationId (string)
message (string) required
enableTrace (boolean)
iotsitewise/list_access_policiesRetrieves a paginated list of access policies for an identity an IAM Identity Center user, an IAM Identity Center group, or an IAM user or an IoT SiteWise Monitor resource a portal or project.identityType (string)
identityId (string)
resourceType (string)
resourceId (string)
iamArn (string)
nextToken (string)
maxResults (integer)
iotsitewise/list_actionsRetrieves a paginated list of actions for a specific target resource.targetResourceType (string) required
targetResourceId (string) required
nextToken (string)
maxResults (integer)
resolveToResourceType (string)
resolveToResourceId (string)
iotsitewise/list_asset_model_composite_modelsRetrieves a paginated list of composite models associated with the asset modelassetModelId (string) required
nextToken (string)
maxResults (integer)
assetModelVersion (string)
iotsitewise/list_asset_model_propertiesRetrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.assetModelId (string) required
nextToken (string)
maxResults (integer)
filter (string)
assetModelVersion (string)
iotsitewise/list_asset_modelsRetrieves a paginated list of summaries of all asset models.assetModelTypes (array)
nextToken (string)
maxResults (integer)
assetModelVersion (string)
iotsitewise/list_asset_propertiesRetrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.assetId (string) required
nextToken (string)
maxResults (integer)
filter (string)
iotsitewise/list_asset_relationshipsRetrieves 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.assetId (string) required
traversalType (string) required
nextToken (string)
maxResults (integer)
iotsitewise/list_assetsRetrieves 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.nextToken (string)
maxResults (integer)
assetModelId (string)
filter (string)
iotsitewise/list_associated_assetsRetrieves a paginated list of associated assets. You can use this operation to do the following: CHILD - List all child assets associated to the asset. PARENT - List the asset's parent asset.assetId (string) required
hierarchyId (string)
traversalDirection (string)
nextToken (string)
maxResults (integer)
iotsitewise/list_bulk_import_jobsRetrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs CLI in the IoT SiteWise User Guide.nextToken (string)
maxResults (integer)
filter (string)
iotsitewise/list_composition_relationshipsRetrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.assetModelId (string) required
nextToken (string)
maxResults (integer)
iotsitewise/list_computation_model_data_binding_usagesLists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models.dataBindingValueFilter: {
. asset (object)
. assetModel (object)
. assetProperty (object)
. assetModelProperty (object)
} (object) required
nextToken (string)
maxResults (integer)
iotsitewise/list_computation_model_resolve_to_resourcesLists all distinct resources that are resolved from the executed actions of the computation model.computationModelId (string) required
nextToken (string)
maxResults (integer)
iotsitewise/list_computation_modelsRetrieves a paginated list of summaries of all computation models.computationModelType (string)
nextToken (string)
maxResults (integer)
iotsitewise/list_dashboardsRetrieves a paginated list of dashboards for an IoT SiteWise Monitor project.projectId (string) required
nextToken (string)
maxResults (integer)
iotsitewise/list_datasetsRetrieves a paginated list of datasets for a specific target resource.sourceType (string) required
nextToken (string)
maxResults (integer)
iotsitewise/list_executionsRetrieves a paginated list of summaries of all executions.targetResourceType (string) required
targetResourceId (string) required
resolveToResourceType (string)
resolveToResourceId (string)
nextToken (string)
maxResults (integer)
actionType (string)
iotsitewise/list_gatewaysRetrieves a paginated list of gateways.nextToken (string)
maxResults (integer)
iotsitewise/list_interface_relationshipsRetrieves a paginated list of asset models that have a specific interface asset model applied to them.interfaceAssetModelId (string) required
nextToken (string)
maxResults (integer)
iotsitewise/list_portalsRetrieves a paginated list of IoT SiteWise Monitor portals.nextToken (string)
maxResults (integer)
iotsitewise/list_project_assetsRetrieves a paginated list of assets associated with an IoT SiteWise Monitor project.projectId (string) required
nextToken (string)
maxResults (integer)
iotsitewise/list_projectsRetrieves a paginated list of projects for an IoT SiteWise Monitor portal.portalId (string) required
nextToken (string)
maxResults (integer)
iotsitewise/list_tags_for_resourceRetrieves the list of tags for an IoT SiteWise resource.resourceArn (string) required
iotsitewise/list_time_seriesRetrieves a paginated list of time series data streams.nextToken (string)
maxResults (integer)
assetId (string)
aliasPrefix (string)
timeSeriesType (string)
iotsitewise/put_asset_model_interface_relationshipCreates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.assetModelId (string) required
interfaceAssetModelId (string) required
propertyMappingConfiguration: {
. matchByPropertyName (boolean)
. createMissingProperty (boolean)
. overrides (array)
} (object) required
clientToken (string)
iotsitewise/put_default_encryption_configurationSets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.encryptionType (string) required
kmsKeyId (string)
iotsitewise/put_logging_optionsSets logging options for IoT SiteWise.loggingOptions: {
. level (string)
} (object) required
iotsitewise/put_storage_configurationConfigures storage settings for IoT SiteWise.storageType (string) required
multiLayerStorage: {
. customerManagedS3Storage (object)
} (object)
disassociatedDataStorage (string)
retentionPeriod: {
. numberOfDays (integer)
. unlimited (boolean)
} (object)
warmTier (string)
warmTierRetentionPeriod: {
. numberOfDays (integer)
. unlimited (boolean)
} (object)
disallowIngestNullNaN (boolean)
iotsitewise/tag_resourceAdds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.resourceArn (string) required
tags (object) required
iotsitewise/untag_resourceRemoves a tag from an IoT SiteWise resource.resourceArn (string) required
tagKeys (array) required
iotsitewise/update_access_policyUpdates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.accessPolicyId (string) required
accessPolicyIdentity: {
. user (object)
. group (object)
. iamUser (object)
. iamRole (object)
} (object) required
accessPolicyResource: {
. portal (object)
. project (object)
} (object) required
accessPolicyPermission (string) required
clientToken (string)
iotsitewise/update_assetUpdates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.assetId (string) required
assetExternalId (string)
assetName (string) required
clientToken (string)
assetDescription (string)
iotsitewise/update_asset_modelUpdates 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. If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property. To replace an existing asset model property with a new one withassetModelId (string) required
assetModelExternalId (string)
assetModelName (string) required
assetModelDescription (string)
assetModelProperties (array)
assetModelHierarchies (array)
assetModelCompositeModels (array)
clientToken (string)
ifMatch (string)
ifNoneMatch (string)
matchForVersionType (string)
iotsitewise/update_asset_model_composite_modelUpdates a composite 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. If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property. To replace an existing composite asset model properassetModelId (string) required
assetModelCompositeModelId (string) required
assetModelCompositeModelExternalId (string)
assetModelCompositeModelDescription (string)
assetModelCompositeModelName (string) required
clientToken (string)
assetModelCompositeModelProperties (array)
ifMatch (string)
ifNoneMatch (string)
matchForVersionType (string)
iotsitewise/update_asset_propertyUpdates 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.assetId (string) required
propertyId (string) required
propertyAlias (string)
propertyNotificationState (string)
clientToken (string)
propertyUnit (string)
iotsitewise/update_computation_modelUpdates the computation model.computationModelId (string) required
computationModelName (string) required
computationModelDescription (string)
computationModelConfiguration: {
. anomalyDetection (object)
} (object) required
computationModelDataBinding (object) required
clientToken (string)
iotsitewise/update_dashboardUpdates an IoT SiteWise Monitor dashboard.dashboardId (string) required
dashboardName (string) required
dashboardDescription (string)
dashboardDefinition (string) required
clientToken (string)
iotsitewise/update_datasetUpdates a dataset.datasetId (string) required
datasetName (string) required
datasetDescription (string)
datasetSource: {
. sourceType (string)
. sourceFormat (string)
. sourceDetail (object)
} (object) required
clientToken (string)
iotsitewise/update_gatewayUpdates a gateway's name.gatewayId (string) required
gatewayName (string) required
iotsitewise/update_gateway_capability_configurationUpdates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. Important workflow notes: Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability. . The namespace follows the format service:capability:version, where: service - The service providing the capability, or iotsitewise. capability - The specific capability type. Options include: opcuacollector for the OPgatewayId (string) required
capabilityNamespace (string) required
capabilityConfiguration (string) required
iotsitewise/update_portalUpdates an IoT SiteWise Monitor portal.portalId (string) required
portalName (string) required
portalDescription (string)
portalContactEmail (string) required
portalLogoImage: {
. id (string)
. file (object)
} (object)
roleArn (string) required
clientToken (string)
notificationSenderEmail (string)
alarms: {
. alarmRoleArn (string)
. notificationLambdaArn (string)
} (object)
portalType (string)
portalTypeConfiguration (object)
iotsitewise/update_projectUpdates an IoT SiteWise Monitor project.projectId (string) required
projectName (string) required
projectDescription (string)
clientToken (string)
iotthingsgraph/associate_entity_to_thingAssociates 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.thingName (string) required
entityId (string) required
namespaceVersion (integer)
iotthingsgraph/create_flow_templateCreates 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.definition: {
. language (string)
. text (string)
} (object) required
compatibleNamespaceVersion (integer)
iotthingsgraph/create_system_instanceCreates 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'stags (array)
definition: {
. language (string)
. text (string)
} (object) required
target (string) required
greengrassGroupName (string)
s3BucketName (string)
metricsConfiguration: {
. cloudMetricEnabled (boolean)
. metricRuleRoleArn (string)
} (object)
flowActionsRoleArn (string)
iotthingsgraph/create_system_templateCreates 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.definition: {
. language (string)
. text (string)
} (object) required
compatibleNamespaceVersion (integer)
iotthingsgraph/delete_flow_templateDeletes 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.id (string) required
iotthingsgraph/delete_namespaceDeletes 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.No parameters
iotthingsgraph/delete_system_instanceDeletes 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.id (string)
iotthingsgraph/delete_system_templateDeletes 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.id (string) required
iotthingsgraph/deploy_system_instanceGreengrass 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, theid (string)
iotthingsgraph/deprecate_flow_templateDeprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.id (string) required
iotthingsgraph/deprecate_system_templateDeprecates the specified system.id (string) required
iotthingsgraph/describe_namespaceGets the latest version of the user's namespace and the public version that it is tracking.namespaceName (string)
iotthingsgraph/dissociate_entity_from_thingDissociates 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.thingName (string) required
entityType (string) required
iotthingsgraph/get_entitiesGets 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.ids (array) required
namespaceVersion (integer)
iotthingsgraph/get_flow_templateGets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.id (string) required
revisionNumber (integer)
iotthingsgraph/get_flow_template_revisionsGets 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.id (string) required
nextToken (string)
maxResults (integer)
iotthingsgraph/get_namespace_deletion_statusGets the status of a namespace deletion task.No parameters
iotthingsgraph/get_system_instanceGets a system instance.id (string) required
iotthingsgraph/get_system_templateGets a system.id (string) required
revisionNumber (integer)
iotthingsgraph/get_system_template_revisionsGets 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.id (string) required
nextToken (string)
maxResults (integer)
iotthingsgraph/get_upload_statusGets the status of the specified upload.uploadId (string) required
iotthingsgraph/list_flow_execution_messagesReturns a list of objects that contain information about events in a flow execution.flowExecutionId (string) required
nextToken (string)
maxResults (integer)
iotthingsgraph/list_tags_for_resourceLists all tags on an AWS IoT Things Graph resource.maxResults (integer)
resourceArn (string) required
nextToken (string)
iotthingsgraph/search_entitiesSearches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.entityTypes (array) required
filters (array)
nextToken (string)
maxResults (integer)
namespaceVersion (integer)
iotthingsgraph/search_flow_executionsSearches for AWS IoT Things Graph workflow execution instances.systemInstanceId (string) required
flowExecutionId (string)
startTime (string)
endTime (string)
nextToken (string)
maxResults (integer)
iotthingsgraph/search_flow_templatesSearches for summary information about workflows.filters (array)
nextToken (string)
maxResults (integer)
iotthingsgraph/search_system_instancesSearches for system instances in the user's account.filters (array)
nextToken (string)
maxResults (integer)
iotthingsgraph/search_system_templatesSearches 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.filters (array)
nextToken (string)
maxResults (integer)
iotthingsgraph/search_thingsSearches 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. SearchThingscamera2 will return only thing2, but SearchThingscamera will return both thing1 and thing2. This action searches for exact matches and doesn't perform partial text matching.entityId (string) required
nextToken (string)
maxResults (integer)
namespaceVersion (integer)
iotthingsgraph/tag_resourceCreates a tag for the specified resource.resourceArn (string) required
tags (array) required
iotthingsgraph/undeploy_system_instanceRemoves a system instance from its target Cloud or Greengrass.id (string)
iotthingsgraph/untag_resourceRemoves a tag from the specified resource.resourceArn (string) required
tagKeys (array) required
iotthingsgraph/update_flow_templateUpdates 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.id (string) required
definition: {
. language (string)
. text (string)
} (object) required
compatibleNamespaceVersion (integer)
iotthingsgraph/update_system_templateUpdates 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.id (string) required
definition: {
. language (string)
. text (string)
} (object) required
compatibleNamespaceVersion (integer)
iotthingsgraph/upload_entity_definitionsAsynchronously 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 definitidocument: {
. language (string)
. text (string)
} (object)
syncWithPublicNamespace (boolean)
deprecateExistingEntities (boolean)
iottwinmaker/batch_put_property_valuesSets values for multiple time series properties.workspaceId (string) required
entries (array) required
iottwinmaker/cancel_metadata_transfer_jobCancels the metadata transfer job.metadataTransferJobId (string) required
iottwinmaker/create_component_typeCreates a component type.workspaceId (string) required
isSingleton (boolean)
componentTypeId (string) required
description (string)
propertyDefinitions (object)
extendsFrom (array)
functions (object)
tags (object)
propertyGroups (object)
componentTypeName (string)
compositeComponentTypes (object)
iottwinmaker/create_entityCreates an entity.workspaceId (string) required
entityId (string)
entityName (string) required
description (string)
components (object)
compositeComponents (object)
parentEntityId (string)
tags (object)
iottwinmaker/create_metadata_transfer_jobCreates a new metadata transfer job.metadataTransferJobId (string)
description (string)
sources (array) required
destination: {
. type (string)
. s3Configuration (object)
. iotTwinMakerConfiguration (object)
} (object) required
iottwinmaker/create_sceneCreates a scene.workspaceId (string) required
sceneId (string) required
contentLocation (string) required
description (string)
capabilities (array)
tags (object)
sceneMetadata (object)
iottwinmaker/create_sync_jobThis action creates a SyncJob.workspaceId (string) required
syncSource (string) required
syncRole (string) required
tags (object)
iottwinmaker/create_workspaceCreates a workplace.workspaceId (string) required
description (string)
s3Location (string)
role (string)
tags (object)
iottwinmaker/delete_component_typeDeletes a component type.workspaceId (string) required
componentTypeId (string) required
iottwinmaker/delete_entityDeletes an entity.workspaceId (string) required
entityId (string) required
isRecursive (boolean)
iottwinmaker/delete_sceneDeletes a scene.workspaceId (string) required
sceneId (string) required
iottwinmaker/delete_sync_jobDelete the SyncJob.workspaceId (string) required
syncSource (string) required
iottwinmaker/delete_workspaceDeletes a workspace.workspaceId (string) required
iottwinmaker/execute_queryRun queries to access information from your knowledge graph of entities within individual workspaces. The ExecuteQuery action only works with Amazon Web Services Java SDK2. ExecuteQuery will not work with any Amazon Web Services Java SDK version 2.x.workspaceId (string) required
queryStatement (string) required
maxResults (integer)
nextToken (string)
iottwinmaker/get_component_typeRetrieves information about a component type.workspaceId (string) required
componentTypeId (string) required
iottwinmaker/get_entityRetrieves information about an entity.workspaceId (string) required
entityId (string) required
iottwinmaker/get_metadata_transfer_jobGets a nmetadata transfer job.metadataTransferJobId (string) required
iottwinmaker/get_pricing_planGets the pricing plan.No parameters
iottwinmaker/get_property_valueGets the property values for a component, component type, entity, or workspace. You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.componentName (string)
componentPath (string)
componentTypeId (string)
entityId (string)
selectedProperties (array) required
workspaceId (string) required
maxResults (integer)
nextToken (string)
propertyGroupName (string)
tabularConditions: {
. orderBy (array)
. propertyFilters (array)
} (object)
iottwinmaker/get_property_value_historyRetrieves 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.workspaceId (string) required
entityId (string)
componentName (string)
componentPath (string)
componentTypeId (string)
selectedProperties (array) required
propertyFilters (array)
startDateTime (string)
endDateTime (string)
interpolation: {
. interpolationType (string)
. intervalInSeconds (integer)
} (object)
nextToken (string)
maxResults (integer)
orderByTime (string)
startTime (string)
endTime (string)
iottwinmaker/get_sceneRetrieves information about a scene.workspaceId (string) required
sceneId (string) required
iottwinmaker/get_sync_jobGets the SyncJob.syncSource (string) required
workspaceId (string)
iottwinmaker/get_workspaceRetrieves information about a workspace.workspaceId (string) required
iottwinmaker/list_componentsThis API lists the components of an entity.workspaceId (string) required
entityId (string) required
componentPath (string)
maxResults (integer)
nextToken (string)
iottwinmaker/list_component_typesLists all component types in a workspace.workspaceId (string) required
filters (array)
nextToken (string)
maxResults (integer)
iottwinmaker/list_entitiesLists all entities in a workspace.workspaceId (string) required
filters (array)
maxResults (integer)
nextToken (string)
iottwinmaker/list_metadata_transfer_jobsLists the metadata transfer jobs.sourceType (string) required
destinationType (string) required
filters (array)
nextToken (string)
maxResults (integer)
iottwinmaker/list_propertiesThis API lists the properties of a component.workspaceId (string) required
componentName (string)
componentPath (string)
entityId (string) required
maxResults (integer)
nextToken (string)
iottwinmaker/list_scenesLists all scenes in a workspace.workspaceId (string) required
maxResults (integer)
nextToken (string)
iottwinmaker/list_sync_jobsList all SyncJobs.workspaceId (string) required
maxResults (integer)
nextToken (string)
iottwinmaker/list_sync_resourcesLists the sync resources.workspaceId (string) required
syncSource (string) required
filters (array)
maxResults (integer)
nextToken (string)
iottwinmaker/list_tags_for_resourceLists all tags associated with a resource.resourceARN (string) required
maxResults (integer)
nextToken (string)
iottwinmaker/list_workspacesRetrieves information about workspaces in the current account.maxResults (integer)
nextToken (string)
iottwinmaker/tag_resourceAdds tags to a resource.resourceARN (string) required
tags (object) required
iottwinmaker/untag_resourceRemoves tags from a resource.resourceARN (string) required
tagKeys (array) required
iottwinmaker/update_component_typeUpdates information in a component type.workspaceId (string) required
isSingleton (boolean)
componentTypeId (string) required
description (string)
propertyDefinitions (object)
extendsFrom (array)
functions (object)
propertyGroups (object)
componentTypeName (string)
compositeComponentTypes (object)
iottwinmaker/update_entityUpdates an entity.workspaceId (string) required
entityId (string) required
entityName (string)
description (string)
componentUpdates (object)
compositeComponentUpdates (object)
parentEntityUpdate: {
. updateType (string)
. parentEntityId (string)
} (object)
iottwinmaker/update_pricing_planUpdate the pricing plan.pricingMode (string) required
bundleNames (array)
iottwinmaker/update_sceneUpdates a scene.workspaceId (string) required
sceneId (string) required
contentLocation (string)
description (string)
capabilities (array)
sceneMetadata (object)
iottwinmaker/update_workspaceUpdates a workspace.workspaceId (string) required
description (string)
role (string)
s3Location (string)
ivs_realtime/create_encoder_configurationCreates an EncoderConfiguration object.name (string)
video: {
. width (integer)
. height (integer)
. framerate (number)
. bitrate (integer)
} (object)
tags (object)
ivs_realtime/create_ingest_configurationCreates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.name (string)
stageArn (string)
userId (string)
attributes (object)
ingestProtocol (string) required
insecureIngest (boolean)
tags (object)
ivs_realtime/create_participant_tokenCreates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created. Encryption keys are owned by Amazon IVS and never used directly by your application.stageArn (string) required
duration (integer)
userId (string)
attributes (object)
capabilities (array)
ivs_realtime/create_stageCreates a new stage and optionally participant tokens.name (string)
participantTokenConfigurations (array)
tags (object)
autoParticipantRecordingConfiguration: {
. storageConfigurationArn (string)
. mediaTypes (array)
. thumbnailConfiguration (object)
. recordingReconnectWindowSeconds (integer)
. hlsConfiguration (object)
. recordParticipantReplicas (boolean)
} (object)
ivs_realtime/create_storage_configurationCreates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.name (string)
s3: {
. bucketName (string)
} (object) required
tags (object)
ivs_realtime/delete_encoder_configurationDeletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.arn (string) required
ivs_realtime/delete_ingest_configurationDeletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force is set to true.arn (string) required
force (boolean)
ivs_realtime/delete_public_keyDeletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.arn (string) required
ivs_realtime/delete_stageShuts down and deletes the specified stage disconnecting all participants. This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.arn (string) required
ivs_realtime/delete_storage_configurationDeletes the storage configuration for the specified ARN. If you try to delete a storage configuration that is used by a Composition, you will get an error 409 ConflictException. To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.arn (string) required
ivs_realtime/disconnect_participantDisconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.stageArn (string) required
participantId (string) required
reason (string)
ivs_realtime/get_compositionGet information about the specified Composition resource.arn (string) required
ivs_realtime/get_encoder_configurationGets information about the specified EncoderConfiguration resource.arn (string) required
ivs_realtime/get_ingest_configurationGets information about the specified IngestConfiguration.arn (string) required
ivs_realtime/get_participantGets information about the specified participant token.stageArn (string) required
sessionId (string) required
participantId (string) required
ivs_realtime/get_public_keyGets information for the specified public key.arn (string) required
ivs_realtime/get_stageGets information for the specified stage.arn (string) required
ivs_realtime/get_stage_sessionGets information for the specified stage session.stageArn (string) required
sessionId (string) required
ivs_realtime/get_storage_configurationGets the storage configuration for the specified ARN.arn (string) required
ivs_realtime/import_public_keyImport a public key to be used for signing stage participant tokens.publicKeyMaterial (string) required
name (string)
tags (object)
ivs_realtime/list_compositionsGets summary information about all Compositions in your account, in the AWS region where the API request is processed.filterByStageArn (string)
filterByEncoderConfigurationArn (string)
nextToken (string)
maxResults (integer)
ivs_realtime/list_encoder_configurationsGets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.nextToken (string)
maxResults (integer)
ivs_realtime/list_ingest_configurationsLists all IngestConfigurations in your account, in the AWS region where the API request is processed.filterByStageArn (string)
filterByState (string)
nextToken (string)
maxResults (integer)
ivs_realtime/list_participant_eventsLists events for a specified participant that occurred during a specified stage session.stageArn (string) required
sessionId (string) required
participantId (string) required
nextToken (string)
maxResults (integer)
ivs_realtime/list_participant_replicasLists all the replicas for a participant from a source stage.sourceStageArn (string) required
participantId (string) required
nextToken (string)
maxResults (integer)
ivs_realtime/list_participantsLists all participants in a specified stage session.stageArn (string) required
sessionId (string) required
filterByUserId (string)
filterByPublished (boolean)
filterByState (string)
nextToken (string)
maxResults (integer)
filterByRecordingState (string)
ivs_realtime/list_public_keysGets summary information about all public keys in your account, in the AWS region where the API request is processed.nextToken (string)
maxResults (integer)
ivs_realtime/list_stagesGets summary information about all stages in your account, in the AWS region where the API request is processed.nextToken (string)
maxResults (integer)
ivs_realtime/list_stage_sessionsGets all sessions for a specified stage.stageArn (string) required
nextToken (string)
maxResults (integer)
ivs_realtime/list_storage_configurationsGets summary information about all storage configurations in your account, in the AWS region where the API request is processed.nextToken (string)
maxResults (integer)
ivs_realtime/list_tags_for_resourceGets information about AWS tags for the specified ARN.resourceArn (string) required
ivs_realtime/start_compositionStarts a Composition from a stage based on the configuration provided in the request. A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted: When StopComposition is called. After a 1-minute timeout, when all participants are disconnected from the stage. After a 1-minute timeout, if there are no participants in the stage when StartComposition is called. When broadcasting to the IVS channel fails and all retriesstageArn (string) required
idempotencyToken (string)
layout: {
. grid (object)
. pip (object)
} (object)
destinations (array) required
tags (object)
ivs_realtime/start_participant_replicationStarts replicating a publishing participant from a source stage to a destination stage.sourceStageArn (string) required
destinationStageArn (string) required
participantId (string) required
reconnectWindowSeconds (integer)
attributes (object)
ivs_realtime/stop_compositionStops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.arn (string) required
ivs_realtime/stop_participant_replicationStops a replicated participant session.sourceStageArn (string) required
destinationStageArn (string) required
participantId (string) required
ivs_realtime/tag_resourceAdds or updates tags for the AWS resource with the specified ARN.resourceArn (string) required
tags (object) required
ivs_realtime/untag_resourceRemoves tags from the resource with the specified ARN.resourceArn (string) required
tagKeys (array) required
ivs_realtime/update_ingest_configurationUpdates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.arn (string) required
stageArn (string)
ivs_realtime/update_stageUpdates a stage’s configuration.arn (string) required
name (string)
autoParticipantRecordingConfiguration: {
. storageConfigurationArn (string)
. mediaTypes (array)
. thumbnailConfiguration (object)
. recordingReconnectWindowSeconds (integer)
. hlsConfiguration (object)
. recordParticipantReplicas (boolean)
} (object)
ivs/batch_get_channelPerforms GetChannel on multiple ARNs simultaneously.arns (array) required
ivs/batch_get_stream_keyPerforms GetStreamKey on multiple ARNs simultaneously.arns (array) required
ivs/batch_start_viewer_session_revocationPerforms StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.viewerSessions (array) required
ivs/create_channelCreates a new channel and an associated stream key to start streaming.name (string)
latencyMode (string)
type (string)
authorized (boolean)
recordingConfigurationArn (string)
tags (object)
insecureIngest (boolean)
preset (string)
playbackRestrictionPolicyArn (string)
multitrackInputConfiguration: {
. enabled (boolean)
. policy (string)
. maximumResolution (string)
} (object)
containerFormat (string)
ivs/create_playback_restriction_policyCreates a new playback restriction policy, for constraining playback by countries and/or origins.allowedCountries (array)
allowedOrigins (array)
enableStrictOriginEnforcement (boolean)
name (string)
tags (object)
ivs/create_recording_configurationCreates 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 reginame (string)
destinationConfiguration: {
. s3 (object)
} (object) required
tags (object)
thumbnailConfiguration: {
. recordingMode (string)
. targetIntervalSeconds (integer)
. resolution (string)
. storage (array)
} (object)
recordingReconnectWindowSeconds (integer)
renditionConfiguration: {
. renditionSelection (string)
. renditions (array)
} (object)
ivs/create_stream_keyCreates 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.channelArn (string) required
tags (object)
ivs/delete_channelDeletes 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 is no longer Live, then call DeleteChannel. See Using EventBridge with Amazon IVS.arn (string) required
ivs/delete_playback_key_pairDeletes 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.arn (string) required
ivs/delete_playback_restriction_policyDeletes the specified playback restriction policy.arn (string) required
ivs/delete_recording_configurationDeletes 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.arn (string) required
ivs/delete_stream_keyDeletes the stream key for the specified ARN, so it can no longer be used to stream.arn (string) required
ivs/get_channelGets the channel configuration for the specified channel ARN. See also BatchGetChannel.arn (string) required
ivs/get_playback_key_pairGets 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.arn (string) required
ivs/get_playback_restriction_policyGets the specified playback restriction policy.arn (string) required
ivs/get_recording_configurationGets the recording configuration for the specified ARN.arn (string) required
ivs/get_streamGets information about the active live stream on a specified channel.channelArn (string) required
ivs/get_stream_keyGets stream-key information for a specified ARN.arn (string) required
ivs/get_stream_sessionGets metadata on a specified stream.channelArn (string) required
streamId (string)
ivs/import_playback_key_pairImports 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.publicKeyMaterial (string) required
name (string)
tags (object)
ivs/list_channelsGets 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.filterByName (string)
filterByRecordingConfigurationArn (string)
filterByPlaybackRestrictionPolicyArn (string)
nextToken (string)
maxResults (integer)
ivs/list_playback_key_pairsGets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.nextToken (string)
maxResults (integer)
ivs/list_playback_restriction_policiesGets summary information about playback restriction policies.nextToken (string)
maxResults (integer)
ivs/list_recording_configurationsGets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.nextToken (string)
maxResults (integer)
ivs/list_stream_keysGets summary information about stream keys for the specified channel.channelArn (string) required
nextToken (string)
maxResults (integer)
ivs/list_streamsGets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.filterBy: {
. health (string)
} (object)
nextToken (string)
maxResults (integer)
ivs/list_stream_sessionsGets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.channelArn (string) required
nextToken (string)
maxResults (integer)
ivs/list_tags_for_resourceGets information about Amazon Web Services tags for the specified ARN.resourceArn (string) required
ivs/put_metadataInserts 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.channelArn (string) required
metadata (string) required
ivs/start_viewer_session_revocationStarts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.channelArn (string) required
viewerId (string) required
viewerSessionVersionsLessThanOrEqualTo (integer)
ivs/stop_streamDisconnects 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.channelArn (string) required
ivs/tag_resourceAdds or updates tags for the Amazon Web Services resource with the specified ARN.resourceArn (string) required
tags (object) required
ivs/untag_resourceRemoves tags from the resource with the specified ARN.resourceArn (string) required
tagKeys (array) required
ivs/update_channelUpdates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.arn (string) required
name (string)
latencyMode (string)
type (string)
authorized (boolean)
recordingConfigurationArn (string)
insecureIngest (boolean)
preset (string)
playbackRestrictionPolicyArn (string)
multitrackInputConfiguration: {
. enabled (boolean)
. policy (string)
. maximumResolution (string)
} (object)
containerFormat (string)
ivs/update_playback_restriction_policyUpdates a specified playback restriction policy.arn (string) required
allowedCountries (array)
allowedOrigins (array)
enableStrictOriginEnforcement (boolean)
name (string)
ivschat/create_chat_tokenCreates an encrypted token that is used by a chat participant to establish an individual WebSocket chat connection to a room. When the token is used to connect to chat, the connection is valid for the session duration specified in the request. The token becomes invalid at the token-expiration timestamp included in the response. Use the capabilities field to permit an end user to send messages or moderate a room. The attributes field securely attaches structured data to the chat session; the dataroomIdentifier (string) required
userId (string) required
capabilities (array)
sessionDurationInMinutes (integer)
attributes (object)
ivschat/create_logging_configurationCreates a logging configuration that allows clients to store and record sent messages.name (string)
destinationConfiguration (undefined) required
tags (object)
ivschat/create_roomCreates a room that allows clients to connect and pass messages.name (string)
maximumMessageRatePerSecond (integer)
maximumMessageLength (integer)
messageReviewHandler: {
. uri (string)
. fallbackResult (string)
} (object)
tags (object)
loggingConfigurationIdentifiers (array)
ivschat/delete_logging_configurationDeletes the specified logging configuration.identifier (string) required
ivschat/delete_messageSends 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.roomIdentifier (string) required
id (string) required
reason (string)
ivschat/delete_roomDeletes the specified room.identifier (string) required
ivschat/disconnect_userDisconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.roomIdentifier (string) required
userId (string) required
reason (string)
ivschat/get_logging_configurationGets the specified logging configuration.identifier (string) required
ivschat/get_roomGets the specified room.identifier (string) required
ivschat/list_logging_configurationsGets summary information about all your logging configurations in the AWS region where the API request is processed.nextToken (string)
maxResults (integer)
ivschat/list_roomsGets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.name (string)
nextToken (string)
maxResults (integer)
messageReviewHandlerUri (string)
loggingConfigurationIdentifier (string)
ivschat/list_tags_for_resourceGets information about AWS tags for the specified ARN.resourceArn (string) required
ivschat/send_eventSends 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.roomIdentifier (string) required
eventName (string) required
attributes (object)
ivschat/tag_resourceAdds or updates tags for the AWS resource with the specified ARN.resourceArn (string) required
tags (object) required
ivschat/untag_resourceRemoves tags from the resource with the specified ARN.resourceArn (string) required
tagKeys (array) required
ivschat/update_logging_configurationUpdates a specified logging configuration.identifier (string) required
name (string)
destinationConfiguration (undefined)
ivschat/update_roomUpdates a room’s configuration.identifier (string) required
name (string)
maximumMessageRatePerSecond (integer)
maximumMessageLength (integer)
messageReviewHandler: {
. uri (string)
. fallbackResult (string)
} (object)
loggingConfigurationIdentifiers (array)
kafka/batch_associate_scram_secretAssociates one or more Scram Secrets with an Amazon MSK cluster.ClusterArn (string) required
SecretArnList (array) required
kafka/batch_disassociate_scram_secretDisassociates one or more Scram Secrets from an Amazon MSK cluster.ClusterArn (string) required
SecretArnList (array) required
kafka/create_clusterCreates a new MSK cluster.BrokerNodeGroupInfo: {
. BrokerAZDistribution (string)
. ClientSubnets (array)
. InstanceType (string)
. SecurityGroups (array)
. StorageInfo (object)
. ConnectivityInfo (object)
. ZoneIds (array)
} (object) required
Rebalancing: {
. Status (string)
} (object)
ClientAuthentication: {
. Sasl (object)
. Tls (object)
. Unauthenticated (object)
} (object)
ClusterName (string) required
ConfigurationInfo: {
. Arn (string)
. Revision (integer)
} (object)
EncryptionInfo: {
. EncryptionAtRest (object)
. EncryptionInTransit (object)
} (object)
EnhancedMonitoring (string)
OpenMonitoring: {
. Prometheus (object)
} (object)
KafkaVersion (string) required
LoggingInfo: {
. BrokerLogs (object)
} (object)
NumberOfBrokerNodes (integer) required
Tags (object)
StorageMode (string)
kafka/create_cluster_v2Creates a new MSK cluster.ClusterName (string) required
Tags (object)
Provisioned: {
. BrokerNodeGroupInfo (object)
. Rebalancing (object)
. ClientAuthentication (object)
. ConfigurationInfo (object)
. EncryptionInfo (object)
. EnhancedMonitoring (string)
. OpenMonitoring (object)
. KafkaVersion (string)
. LoggingInfo (object)
. NumberOfBrokerNodes (integer)
. StorageMode (string)
} (object)
Serverless: {
. VpcConfigs (array)
. ClientAuthentication (object)
} (object)
kafka/create_configurationCreates a new MSK configuration.Description (string)
KafkaVersions (array)
Name (string) required
ServerProperties (string) required
kafka/create_replicatorCreates the replicator.Description (string)
KafkaClusters (array) required
ReplicationInfoList (array) required
ReplicatorName (string) required
ServiceExecutionRoleArn (string) required
Tags (object)
kafka/create_topicCreates a topic in the specified MSK cluster.ClusterArn (string) required
TopicName (string) required
PartitionCount (integer) required
ReplicationFactor (integer) required
Configs (string)
kafka/create_vpc_connectionCreates a new MSK VPC connection.TargetClusterArn (string) required
Authentication (string) required
VpcId (string) required
ClientSubnets (array) required
SecurityGroups (array) required
Tags (object)
kafka/delete_clusterDeletes the MSK cluster specified by the Amazon Resource Name ARN in the request.ClusterArn (string) required
CurrentVersion (string)
kafka/delete_cluster_policyDeletes the MSK cluster policy specified by the Amazon Resource Name ARN in the request.ClusterArn (string) required
kafka/delete_configurationDeletes an MSK Configuration.Arn (string) required
kafka/delete_replicatorDeletes a replicator.CurrentVersion (string)
ReplicatorArn (string) required
kafka/delete_topicDeletes a topic in the specified MSK cluster.ClusterArn (string) required
TopicName (string) required
kafka/delete_vpc_connectionDeletes a MSK VPC connection.Arn (string) required
kafka/describe_clusterReturns a description of the MSK cluster whose Amazon Resource Name ARN is specified in the request.ClusterArn (string) required
kafka/describe_cluster_operationReturns a description of the cluster operation specified by the ARN.ClusterOperationArn (string) required
kafka/describe_cluster_operation_v2Returns a description of the cluster operation specified by the ARN.ClusterOperationArn (string) required
kafka/describe_cluster_v2Returns a description of the MSK cluster whose Amazon Resource Name ARN is specified in the request.ClusterArn (string) required
kafka/describe_configurationReturns a description of this MSK configuration.Arn (string) required
kafka/describe_configuration_revisionReturns a description of this revision of the configuration.Arn (string) required
Revision (integer) required
kafka/describe_replicatorDescribes a replicator.ReplicatorArn (string) required
kafka/describe_topicReturns topic details of this topic on a MSK cluster.ClusterArn (string) required
TopicName (string) required
kafka/describe_topic_partitionsReturns partition details of this topic on a MSK cluster.ClusterArn (string) required
TopicName (string) required
MaxResults (integer)
NextToken (string)
kafka/describe_vpc_connectionReturns a description of this MSK VPC connection.Arn (string) required
kafka/get_bootstrap_brokersA list of brokers that a client application can use to bootstrap. This list doesn't necessarily include all of the brokers in the cluster. The following Python 3.6 example shows how you can use the Amazon Resource Name ARN of a cluster to get its bootstrap brokers. If you don't know the ARN of your cluster, you can use the ListClusters operation to get the ARNs of all the clusters in this account and Region.ClusterArn (string) required
kafka/get_cluster_policyGet the MSK cluster policy specified by the Amazon Resource Name ARN in the request.ClusterArn (string) required
kafka/get_compatible_kafka_versionsGets the Apache Kafka versions to which you can update the MSK cluster.ClusterArn (string)
kafka/list_client_vpc_connectionsReturns a list of all the VPC connections in this Region.ClusterArn (string) required
MaxResults (integer)
NextToken (string)
kafka/list_cluster_operationsReturns a list of all the operations that have been performed on the specified MSK cluster.ClusterArn (string) required
MaxResults (integer)
NextToken (string)
kafka/list_cluster_operations_v2Returns a list of all the operations that have been performed on the specified MSK cluster.ClusterArn (string) required
MaxResults (integer)
NextToken (string)
kafka/list_clustersReturns a list of all the MSK clusters in the current Region.ClusterNameFilter (string)
MaxResults (integer)
NextToken (string)
kafka/list_clusters_v2Returns a list of all the MSK clusters in the current Region.ClusterNameFilter (string)
ClusterTypeFilter (string)
MaxResults (integer)
NextToken (string)
kafka/list_configuration_revisionsReturns a list of all the MSK configurations in this Region.Arn (string) required
MaxResults (integer)
NextToken (string)
kafka/list_configurationsReturns a list of all the MSK configurations in this Region.MaxResults (integer)
NextToken (string)
kafka/list_kafka_versionsReturns a list of Apache Kafka versions.MaxResults (integer)
NextToken (string)
kafka/list_nodesReturns a list of the broker nodes in the cluster.ClusterArn (string) required
MaxResults (integer)
NextToken (string)
kafka/list_replicatorsLists the replicators.MaxResults (integer)
NextToken (string)
ReplicatorNameFilter (string)
kafka/list_scram_secretsReturns a list of the Scram Secrets associated with an Amazon MSK cluster.ClusterArn (string) required
MaxResults (integer)
NextToken (string)
kafka/list_tags_for_resourceReturns a list of the tags associated with the specified resource.ResourceArn (string) required
kafka/list_topicsList topics in a MSK cluster.ClusterArn (string) required
MaxResults (integer)
NextToken (string)
TopicNameFilter (string)
kafka/list_vpc_connectionsReturns a list of all the VPC connections in this Region.MaxResults (integer)
NextToken (string)
kafka/put_cluster_policyCreates or updates the MSK cluster policy specified by the cluster Amazon Resource Name ARN in the request.ClusterArn (string) required
CurrentVersion (string)
Policy (string) required
kafka/reboot_brokerReboots brokers.BrokerIds (array) required
ClusterArn (string) required
kafka/reject_client_vpc_connectionReturns empty response.ClusterArn (string) required
VpcConnectionArn (string) required
kafka/tag_resourceAdds tags to the specified MSK resource.ResourceArn (string) required
Tags (object) required
kafka/untag_resourceRemoves the tags associated with the keys that are provided in the query.ResourceArn (string) required
TagKeys (array) required
kafka/update_broker_countUpdates the number of broker nodes in the cluster.ClusterArn (string) required
CurrentVersion (string) required
TargetNumberOfBrokerNodes (integer) required
kafka/update_broker_storageUpdates the EBS storage associated with MSK brokers.ClusterArn (string) required
CurrentVersion (string) required
TargetBrokerEBSVolumeInfo (array) required
kafka/update_broker_typeUpdates EC2 instance type.ClusterArn (string) required
CurrentVersion (string) required
TargetInstanceType (string) required
kafka/update_cluster_configurationUpdates the cluster with the configuration that is specified in the request body.ClusterArn (string) required
ConfigurationInfo: {
. Arn (string)
. Revision (integer)
} (object) required
CurrentVersion (string) required
kafka/update_cluster_kafka_versionUpdates the Apache Kafka version for the cluster.ClusterArn (string) required
ConfigurationInfo: {
. Arn (string)
. Revision (integer)
} (object)
CurrentVersion (string) required
TargetKafkaVersion (string) required
kafka/update_configurationUpdates an MSK configuration.Arn (string) required
Description (string)
ServerProperties (string) required
kafka/update_connectivityUpdates the cluster's connectivity configuration.ClusterArn (string) required
ConnectivityInfo: {
. PublicAccess (object)
. VpcConnectivity (object)
} (object) required
CurrentVersion (string) required
kafka/update_monitoringUpdates 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.ClusterArn (string) required
CurrentVersion (string) required
EnhancedMonitoring (string)
OpenMonitoring: {
. Prometheus (object)
} (object)
LoggingInfo: {
. BrokerLogs (object)
} (object)
kafka/update_rebalancingUse this resource to update the intelligent rebalancing status of an Amazon MSK Provisioned cluster with Express brokers.ClusterArn (string) required
CurrentVersion (string) required
Rebalancing: {
. Status (string)
} (object) required
kafka/update_replication_infoUpdates replication info of a replicator.ConsumerGroupReplication: {
. ConsumerGroupsToExclude (array)
. ConsumerGroupsToReplicate (array)
. DetectAndCopyNewConsumerGroups (boolean)
. SynchroniseConsumerGroupOffsets (boolean)
} (object)
CurrentVersion (string) required
ReplicatorArn (string) required
SourceKafkaClusterArn (string) required
TargetKafkaClusterArn (string) required
TopicReplication: {
. CopyAccessControlListsForTopics (boolean)
. CopyTopicConfigurations (boolean)
. DetectAndCopyNewTopics (boolean)
. TopicsToExclude (array)
. TopicsToReplicate (array)
} (object)
kafka/update_securityUpdates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.ClientAuthentication: {
. Sasl (object)
. Tls (object)
. Unauthenticated (object)
} (object)
ClusterArn (string) required
CurrentVersion (string) required
EncryptionInfo: {
. EncryptionAtRest (object)
. EncryptionInTransit (object)
} (object)
kafka/update_storageUpdates cluster broker volume size or sets cluster storage mode to TIERED.ClusterArn (string) required
CurrentVersion (string) required
ProvisionedThroughput: {
. Enabled (boolean)
. VolumeThroughput (integer)
} (object)
StorageMode (string)
VolumeSizeGB (integer)
kafka/update_topicUpdates the configuration of the specified topic.ClusterArn (string) required
TopicName (string) required
Configs (string)
PartitionCount (integer)
kafkaconnect/create_connectorCreates a connector using the specified properties.capacity: {
. autoScaling (object)
. provisionedCapacity (object)
} (object) required
connectorConfiguration (object) required
connectorDescription (string)
connectorName (string) required
kafkaCluster: {
. apacheKafkaCluster (object)
} (object) required
kafkaClusterClientAuthentication: {
. authenticationType (string)
} (object) required
kafkaClusterEncryptionInTransit: {
. encryptionType (string)
} (object) required
kafkaConnectVersion (string) required
logDelivery: {
. workerLogDelivery (object)
} (object)
networkType (string)
plugins (array) required
serviceExecutionRoleArn (string) required
workerConfiguration: {
. revision (integer)
. workerConfigurationArn (string)
} (object)
tags (object)
kafkaconnect/create_custom_pluginCreates a custom plugin using the specified properties.contentType (string) required
description (string)
location: {
. s3Location (object)
} (object) required
name (string) required
tags (object)
kafkaconnect/create_worker_configurationCreates a worker configuration using the specified properties.description (string)
name (string) required
propertiesFileContent (string) required
tags (object)
kafkaconnect/delete_connectorDeletes the specified connector.connectorArn (string) required
currentVersion (string)
kafkaconnect/delete_custom_pluginDeletes a custom plugin.customPluginArn (string) required
kafkaconnect/delete_worker_configurationDeletes the specified worker configuration.workerConfigurationArn (string) required
kafkaconnect/describe_connectorReturns summary information about the connector.connectorArn (string) required
kafkaconnect/describe_connector_operationReturns information about the specified connector's operations.connectorOperationArn (string) required
kafkaconnect/describe_custom_pluginA summary description of the custom plugin.customPluginArn (string) required
kafkaconnect/describe_worker_configurationReturns information about a worker configuration.workerConfigurationArn (string) required
kafkaconnect/list_connector_operationsLists information about a connector's operations.connectorArn (string) required
maxResults (integer)
nextToken (string)
kafkaconnect/list_connectorsReturns 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.connectorNamePrefix (string)
maxResults (integer)
nextToken (string)
kafkaconnect/list_custom_pluginsReturns a list of all of the custom plugins in this account and Region.maxResults (integer)
nextToken (string)
namePrefix (string)
kafkaconnect/list_tags_for_resourceLists all the tags attached to the specified resource.resourceArn (string) required
kafkaconnect/list_worker_configurationsReturns a list of all of the worker configurations in this account and Region.maxResults (integer)
nextToken (string)
namePrefix (string)
kafkaconnect/tag_resourceAttaches tags to the specified resource.resourceArn (string) required
tags (object) required
kafkaconnect/untag_resourceRemoves tags from the specified resource.resourceArn (string) required
tagKeys (array) required
kafkaconnect/update_connectorUpdates the specified connector. For request body, specify only one parameter: either capacity or connectorConfiguration.capacity: {
. autoScaling (object)
. provisionedCapacity (object)
} (object)
connectorConfiguration (object)
connectorArn (string) required
currentVersion (string) required
kendra_ranking/create_rescore_execution_planCreates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You set the number of capacity units that you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results. For an example of using the CreateRescoreExecutionPlan API, including using the Python and Java SDKs, see Semantically ranking a search service's results.Name (string) required
Description (string)
CapacityUnits: {
. RescoreCapacityUnits (integer)
} (object)
Tags (array)
ClientToken (string)
kendra_ranking/delete_rescore_execution_planDeletes a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.Id (string) required
kendra_ranking/describe_rescore_execution_planGets information about a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.Id (string) required
kendra_ranking/list_rescore_execution_plansLists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.NextToken (string)
MaxResults (integer)
kendra_ranking/list_tags_for_resourceGets a list of tags associated with a specified resource. A rescore execution plan is an example of a resource that can have tags associated with it.ResourceARN (string) required
kendra_ranking/rescoreRescores or re-ranks search results from a search service such as OpenSearch self managed. You use the semantic search capabilities of Amazon Kendra Intelligent Ranking to improve the search service's results.RescoreExecutionPlanId (string) required
SearchQuery (string) required
Documents (array) required
kendra_ranking/tag_resourceAdds a specified tag to a specified rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. If the tag already exists, the existing value is replaced with the new value.ResourceARN (string) required
Tags (array) required
kendra_ranking/untag_resourceRemoves a tag from a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore operation.ResourceARN (string) required
TagKeys (array) required
kendra_ranking/update_rescore_execution_planUpdates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can update the number of capacity units you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service's results.Id (string) required
Name (string)
Description (string)
CapacityUnits: {
. RescoreCapacityUnits (integer)
} (object)
kendra/associate_entities_to_experienceGrants 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.Id (string) required
IndexId (string) required
EntityList (array) required
kendra/associate_personas_to_entitiesDefines 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.Id (string) required
IndexId (string) required
Personas (array) required
kendra/batch_delete_documentRemoves 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 your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting your documents. Deleting documents from an index using BatchDeleteDocuIndexId (string) required
DocumentIdList (array) required
DataSourceSyncJobMetricTarget: {
. DataSourceId (string)
. DataSourceSyncJobId (string)
} (object)
kendra/batch_delete_featured_results_setRemoves one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.IndexId (string) required
FeaturedResultsSetIds (array) required
kendra/batch_get_document_statusReturns 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_FIndexId (string) required
DocumentInfoList (array) required
kendra/batch_put_documentAdds 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 processingIndexId (string) required
RoleArn (string)
Documents (array) required
CustomDocumentEnrichmentConfiguration: {
. InlineConfigurations (array)
. PreExtractionHookConfiguration (object)
. PostExtractionHookConfiguration (object)
. RoleArn (string)
} (object)
kendra/clear_query_suggestionsClears 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.IndexId (string) required
kendra/create_access_control_configurationCreates 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 theseIndexId (string) required
Name (string) required
Description (string)
AccessControlList (array)
HierarchicalAccessControlList (array)
ClientToken (string)
kendra/create_data_sourceCreates 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. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDName (string) required
IndexId (string) required
Type (string) required
Configuration: {
. S3Configuration (object)
. SharePointConfiguration (object)
. DatabaseConfiguration (object)
. SalesforceConfiguration (object)
. OneDriveConfiguration (object)
. ServiceNowConfiguration (object)
. ConfluenceConfiguration (object)
. GoogleDriveConfiguration (object)
. WebCrawlerConfiguration (object)
. WorkDocsConfiguration (object)
. FsxConfiguration (object)
. SlackConfiguration (object)
. BoxConfiguration (object)
. QuipConfiguration (object)
. JiraConfiguration (object)
. GitHubConfiguration (object)
. AlfrescoConfiguration (object)
. TemplateConfiguration (object)
} (object)
VpcConfiguration: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object)
Description (string)
Schedule (string)
RoleArn (string)
Tags (array)
ClientToken (string)
LanguageCode (string)
CustomDocumentEnrichmentConfiguration: {
. InlineConfigurations (array)
. PreExtractionHookConfiguration (object)
. PostExtractionHookConfiguration (object)
. RoleArn (string)
} (object)
kendra/create_experienceCreates 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.Name (string) required
IndexId (string) required
RoleArn (string)
Configuration: {
. ContentSourceConfiguration (object)
. UserIdentityConfiguration (object)
} (object)
Description (string)
ClientToken (string)
kendra/create_faqCreates a set of frequently ask questions FAQs using a specified FAQ file stored in an Amazon S3 bucket. 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.IndexId (string) required
Name (string) required
Description (string)
S3Path: {
. Bucket (string)
. Key (string)
} (object) required
RoleArn (string) required
Tags (array)
FileFormat (string)
ClientToken (string)
LanguageCode (string)
kendra/create_featured_results_setCreates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results. You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.IndexId (string) required
FeaturedResultsSetName (string) required
Description (string)
ClientToken (string)
Status (string)
QueryTexts (array)
FeaturedDocuments (array)
Tags (array)
kendra/create_indexCreates 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 exampleName (string) required
Edition (string)
RoleArn (string) required
ServerSideEncryptionConfiguration: {
. KmsKeyId (string)
} (object)
Description (string)
ClientToken (string)
Tags (array)
UserTokenConfigurations (array)
UserContextPolicy (string)
UserGroupResolutionConfiguration: {
. UserGroupResolutionMode (string)
} (object)
kendra/create_query_suggestions_block_listCreates 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 supportIndexId (string) required
Name (string) required
Description (string)
SourceS3Path: {
. Bucket (string)
. Key (string)
} (object) required
ClientToken (string)
RoleArn (string) required
Tags (array)
kendra/create_thesaurusCreates 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.IndexId (string) required
Name (string) required
Description (string)
RoleArn (string) required
Tags (array)
SourceS3Path: {
. Bucket (string)
. Key (string)
} (object) required
ClientToken (string)
kendra/delete_access_control_configurationDeletes 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.IndexId (string) required
Id (string) required
kendra/delete_data_sourceDeletes 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. Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.Id (string) required
IndexId (string) required
kendra/delete_experienceDeletes 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.Id (string) required
IndexId (string) required
kendra/delete_faqRemoves a FAQ from an index.Id (string) required
IndexId (string) required
kendra/delete_indexDeletes an 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.Id (string) required
kendra/delete_principal_mappingDeletes a group so that all users 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 pIndexId (string) required
DataSourceId (string)
GroupId (string) required
OrderingId (integer)
kendra/delete_query_suggestions_block_listDeletes 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.IndexId (string) required
Id (string) required
kendra/delete_thesaurusDeletes an Amazon Kendra thesaurus.Id (string) required
IndexId (string) required
kendra/describe_access_control_configurationGets 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.IndexId (string) required
Id (string) required
kendra/describe_data_sourceGets information about an Amazon Kendra data source connector.Id (string) required
IndexId (string) required
kendra/describe_experienceGets 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.Id (string) required
IndexId (string) required
kendra/describe_faqGets information about a FAQ.Id (string) required
IndexId (string) required
kendra/describe_featured_results_setGets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.IndexId (string) required
FeaturedResultsSetId (string) required
kendra/describe_indexGets information about an Amazon Kendra index.Id (string) required
kendra/describe_principal_mappingDescribes 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.IndexId (string) required
DataSourceId (string)
GroupId (string) required
kendra/describe_query_suggestions_block_listGets 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.IndexId (string) required
Id (string) required
kendra/describe_query_suggestions_configGets 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.IndexId (string) required
kendra/describe_thesaurusGets information about an Amazon Kendra thesaurus.Id (string) required
IndexId (string) required
kendra/disassociate_entities_from_experiencePrevents 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.Id (string) required
IndexId (string) required
EntityList (array) required
kendra/disassociate_personas_from_entitiesRemoves 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.Id (string) required
IndexId (string) required
EntityIds (array) required
kendra/get_query_suggestionsFetches the queries that are suggested to your users. GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud US-West region.IndexId (string) required
QueryText (string) required
MaxSuggestionsCount (integer)
SuggestionTypes (array)
AttributeSuggestionsConfig: {
. SuggestionAttributes (array)
. AdditionalResponseAttributes (array)
. AttributeFilter (object)
. UserContext (object)
} (object)
kendra/get_snapshotsRetrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.IndexId (string) required
Interval (string) required
MetricType (string) required
NextToken (string)
MaxResults (integer)
kendra/list_access_control_configurationsLists 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.IndexId (string) required
NextToken (string)
MaxResults (integer)
kendra/list_data_sourcesLists the data source connectors that you have created.IndexId (string) required
NextToken (string)
MaxResults (integer)
kendra/list_data_source_sync_jobsGets statistics about synchronizing a data source connector.Id (string) required
IndexId (string) required
NextToken (string)
MaxResults (integer)
StartTimeFilter: {
. StartTime (string)
. EndTime (string)
} (object)
StatusFilter (string)
kendra/list_entity_personasLists specific permissions of users and groups with access to your Amazon Kendra experience.Id (string) required
IndexId (string) required
NextToken (string)
MaxResults (integer)
kendra/list_experience_entitiesLists 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.Id (string) required
IndexId (string) required
NextToken (string)
kendra/list_experiencesLists 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.IndexId (string) required
NextToken (string)
MaxResults (integer)
kendra/list_faqsGets a list of FAQs associated with an index.IndexId (string) required
NextToken (string)
MaxResults (integer)
kendra/list_featured_results_setsLists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.IndexId (string) required
NextToken (string)
MaxResults (integer)
kendra/list_groups_older_than_ordering_idProvides 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.IndexId (string) required
DataSourceId (string)
OrderingId (integer) required
NextToken (string)
MaxResults (integer)
kendra/list_indicesLists the Amazon Kendra indexes that you created.NextToken (string)
MaxResults (integer)
kendra/list_query_suggestions_block_listsLists 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.IndexId (string) required
NextToken (string)
MaxResults (integer)
kendra/list_tags_for_resourceGets a list of tags associated with a resource. Indexes, FAQs, data sources, and other resources can have tags associated with them.ResourceARN (string) required
kendra/list_thesauriLists the thesauri for an index.IndexId (string) required
NextToken (string)
MaxResults (integer)
kendra/put_principal_mappingMaps 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.IndexId (string) required
DataSourceId (string)
GroupId (string) required
GroupMembers: {
. MemberGroups (array)
. MemberUsers (array)
. S3PathforGroupMembers (object)
} (object) required
OrderingId (integer)
RoleArn (string)
kendra/querySearches an index given an input query. If you are working with large language models LLMs or implementing retrieval augmented generation RAG systems, you can use Amazon Kendra's Retrieve API, which can return longer semantically relevant passages. We recommend using the Retrieve API instead of filing a service limit increase to increase the Query API document excerpt length. You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based oIndexId (string) required
QueryText (string)
AttributeFilter: {
. AndAllFilters (array)
. OrAllFilters (array)
. NotFilter (object)
. EqualsTo (object)
. ContainsAll (object)
. ContainsAny (object)
. GreaterThan (object)
. GreaterThanOrEquals (object)
. LessThan (object)
. LessThanOrEquals (object)
} (object)
Facets (array)
RequestedDocumentAttributes (array)
QueryResultTypeFilter (string)
DocumentRelevanceOverrideConfigurations (array)
PageNumber (integer)
PageSize (integer)
SortingConfiguration: {
. DocumentAttributeKey (string)
. SortOrder (string)
} (object)
SortingConfigurations (array)
UserContext: {
. Token (string)
. UserId (string)
. Groups (array)
. DataSourceGroups (array)
} (object)
VisitorId (string)
SpellCorrectionConfiguration: {
. IncludeQuerySpellCheckSuggestions (boolean)
} (object)
CollapseConfiguration: {
. DocumentAttributeKey (string)
. SortingConfigurations (array)
. MissingAttributeKeyStrategy (string)
. Expand (boolean)
. ExpandConfiguration (object)
} (object)
kendra/retrieveRetrieves relevant passages or text excerpts given an input query. This API is similar to the Query API. However, by default, the Query API only returns excerpt passages of up to 100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiplIndexId (string) required
QueryText (string) required
AttributeFilter: {
. AndAllFilters (array)
. OrAllFilters (array)
. NotFilter (object)
. EqualsTo (object)
. ContainsAll (object)
. ContainsAny (object)
. GreaterThan (object)
. GreaterThanOrEquals (object)
. LessThan (object)
. LessThanOrEquals (object)
} (object)
RequestedDocumentAttributes (array)
DocumentRelevanceOverrideConfigurations (array)
PageNumber (integer)
PageSize (integer)
UserContext: {
. Token (string)
. UserId (string)
. Groups (array)
. DataSourceGroups (array)
} (object)
kendra/start_data_source_sync_jobStarts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception. Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.Id (string) required
IndexId (string) required
kendra/stop_data_source_sync_jobStops a synchronization job that is currently running. You can't stop a scheduled synchronization job.Id (string) required
IndexId (string) required
kendra/submit_feedbackEnables 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.IndexId (string) required
QueryId (string) required
ClickFeedbackItems (array)
RelevanceFeedbackItems (array)
kendra/tag_resourceAdds the specified tag to the specified index, FAQ, data source, or other resource. If the tag already exists, the existing value is replaced with the new value.ResourceARN (string) required
Tags (array) required
kendra/untag_resourceRemoves a tag from an index, FAQ, data source, or other resource.ResourceARN (string) required
TagKeys (array) required
kendra/update_access_control_configurationUpdates 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 createIndexId (string) required
Id (string) required
Name (string)
Description (string)
AccessControlList (array)
HierarchicalAccessControlList (array)
kendra/update_data_sourceUpdates an Amazon Kendra data source connector.Id (string) required
Name (string)
IndexId (string) required
Configuration: {
. S3Configuration (object)
. SharePointConfiguration (object)
. DatabaseConfiguration (object)
. SalesforceConfiguration (object)
. OneDriveConfiguration (object)
. ServiceNowConfiguration (object)
. ConfluenceConfiguration (object)
. GoogleDriveConfiguration (object)
. WebCrawlerConfiguration (object)
. WorkDocsConfiguration (object)
. FsxConfiguration (object)
. SlackConfiguration (object)
. BoxConfiguration (object)
. QuipConfiguration (object)
. JiraConfiguration (object)
. GitHubConfiguration (object)
. AlfrescoConfiguration (object)
. TemplateConfiguration (object)
} (object)
VpcConfiguration: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object)
Description (string)
Schedule (string)
RoleArn (string)
LanguageCode (string)
CustomDocumentEnrichmentConfiguration: {
. InlineConfigurations (array)
. PreExtractionHookConfiguration (object)
. PostExtractionHookConfiguration (object)
. RoleArn (string)
} (object)
kendra/update_experienceUpdates 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.Id (string) required
Name (string)
IndexId (string) required
RoleArn (string)
Configuration: {
. ContentSourceConfiguration (object)
. UserIdentityConfiguration (object)
} (object)
Description (string)
kendra/update_featured_results_setUpdates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.IndexId (string) required
FeaturedResultsSetId (string) required
FeaturedResultsSetName (string)
Description (string)
Status (string)
QueryTexts (array)
FeaturedDocuments (array)
kendra/update_indexUpdates an Amazon Kendra index.Id (string) required
Name (string)
RoleArn (string)
Description (string)
DocumentMetadataConfigurationUpdates (array)
CapacityUnits: {
. StorageCapacityUnits (integer)
. QueryCapacityUnits (integer)
} (object)
UserTokenConfigurations (array)
UserContextPolicy (string)
UserGroupResolutionConfiguration: {
. UserGroupResolutionMode (string)
} (object)
kendra/update_query_suggestions_block_listUpdates 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. UpdIndexId (string) required
Id (string) required
Name (string)
Description (string)
SourceS3Path: {
. Bucket (string)
. Key (string)
} (object)
RoleArn (string)
kendra/update_query_suggestions_configUpdates 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, 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 suIndexId (string) required
Mode (string)
QueryLogLookBackWindowInDays (integer)
IncludeQueriesWithoutUserInformation (boolean)
MinimumNumberOfQueryingUsers (integer)
MinimumQueryCount (integer)
AttributeSuggestionsConfig: {
. SuggestableConfigList (array)
. AttributeSuggestionsMode (string)
} (object)
kendra/update_thesaurusUpdates a thesaurus for an index.Id (string) required
Name (string)
IndexId (string) required
Description (string)
RoleArn (string)
SourceS3Path: {
. Bucket (string)
. Key (string)
} (object)
keyspaces/create_keyspaceThe 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 Create a keyspace in the Amazon Keyspaces Developer Guide.keyspaceName (string) required
tags (array)
replicationSpecification: {
. replicationStrategy (string)
. regionList (array)
} (object)
keyspaces/create_tableThe 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 Create a table in the Amazon Keyspaces Developer GuidkeyspaceName (string) required
tableName (string) required
schemaDefinition: {
. allColumns (array)
. partitionKeys (array)
. clusteringKeys (array)
. staticColumns (array)
} (object) required
comment: {
. message (string)
} (object)
capacitySpecification: {
. throughputMode (string)
. readCapacityUnits (integer)
. writeCapacityUnits (integer)
} (object)
encryptionSpecification: {
. type (string)
. kmsKeyIdentifier (string)
} (object)
pointInTimeRecovery: {
. status (string)
} (object)
ttl: {
. status (string)
} (object)
defaultTimeToLive (integer)
tags (array)
clientSideTimestamps: {
. status (string)
} (object)
autoScalingSpecification: {
. writeCapacityAutoScaling (object)
. readCapacityAutoScaling (object)
} (object)
replicaSpecifications (array)
cdcSpecification: {
. status (string)
. viewType (string)
. tags (array)
. propagateTags (string)
} (object)
warmThroughputSpecification: {
. readUnitsPerSecond (integer)
. writeUnitsPerSecond (integer)
} (object)
keyspaces/create_typeThe CreateType operation creates a new user-defined type in the specified keyspace. To configure the required permissions, see Permissions to create a UDT in the Amazon Keyspaces Developer Guide. For more information, see User-defined types UDTs in the Amazon Keyspaces Developer Guide.keyspaceName (string) required
typeName (string) required
fieldDefinitions (array) required
keyspaces/delete_keyspaceThe DeleteKeyspace operation deletes a keyspace and all of its tables.keyspaceName (string) required
keyspaces/delete_tableThe 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 stkeyspaceName (string) required
tableName (string) required
keyspaces/delete_typeThe DeleteType operation deletes a user-defined type UDT. You can only delete a type that is not used in a table or another UDT. To configure the required permissions, see Permissions to delete a UDT in the Amazon Keyspaces Developer Guide.keyspaceName (string) required
typeName (string) required
keyspaces/get_keyspaceReturns the name of the specified keyspace, the Amazon Resource Name ARN, the replication strategy, the Amazon Web Services Regions of a multi-Region keyspace, and the status of newly added Regions after an UpdateKeyspace operation.keyspaceName (string) required
keyspaces/get_tableReturns 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, the IAM principal needs Select action permissions for the table and the system keyspace.keyspaceName (string) required
tableName (string) required
keyspaces/get_table_auto_scaling_settingsReturns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with AkeyspaceName (string) required
tableName (string) required
keyspaces/get_typeThe GetType operation returns information about the type, for example the field definitions, the timestamp when the type was last modified, the level of nesting, the status, and details about if the type is used in other types and tables. To read keyspace metadata using GetType, the IAM principal needs Select action permissions for the system keyspace. To configure the required permissions, see Permissions to view a UDT in the Amazon Keyspaces Developer Guide.keyspaceName (string) required
typeName (string) required
keyspaces/list_keyspacesThe ListKeyspaces operation returns a list of keyspaces.nextToken (string)
maxResults (integer)
keyspaces/list_tablesThe ListTables operation returns a list of tables for a specified keyspace. To read keyspace metadata using ListTables, the IAM principal needs Select action permissions for the system keyspace.nextToken (string)
maxResults (integer)
keyspaceName (string) required
keyspaces/list_tags_for_resourceReturns a list of all tags associated with the specified Amazon Keyspaces resource. To read keyspace metadata using ListTagsForResource, the IAM principal needs Select action permissions for the specified resource and the system keyspace.resourceArn (string) required
nextToken (string)
maxResults (integer)
keyspaces/list_typesThe ListTypes operation returns a list of types for a specified keyspace. To read keyspace metadata using ListTypes, the IAM principal needs Select action permissions for the system keyspace. To configure the required permissions, see Permissions to view a UDT in the Amazon Keyspaces Developer Guide.nextToken (string)
maxResults (integer)
keyspaceName (string) required
keyspaces/restore_tableRestores the 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:hsourceKeyspaceName (string) required
sourceTableName (string) required
targetKeyspaceName (string) required
targetTableName (string) required
restoreTimestamp (string)
capacitySpecificationOverride: {
. throughputMode (string)
. readCapacityUnits (integer)
. writeCapacityUnits (integer)
} (object)
encryptionSpecificationOverride: {
. type (string)
. kmsKeyIdentifier (string)
} (object)
pointInTimeRecoveryOverride: {
. status (string)
} (object)
tagsOverride (array)
autoScalingSpecification: {
. writeCapacityAutoScaling (object)
. readCapacityAutoScaling (object)
} (object)
replicaSpecifications (array)
keyspaces/tag_resourceAssociates 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.resourceArn (string) required
tags (array) required
keyspaces/untag_resourceRemoves the association of tags from a Amazon Keyspaces resource.resourceArn (string) required
tags (array) required
keyspaces/update_keyspaceAdds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. Amazon Keyspaces is going to replicate all tables in the keyspace to the new Region. To successfully replicate all tables to the new Region, they must use client-side timestamps for conflict resolution. To enable client-side timestamps, specify clientSideTimestamps.status = enabled when invoking the API. For more information about client-side timestampkeyspaceName (string) required
replicationSpecification: {
. replicationStrategy (string)
. regionList (array)
} (object) required
clientSideTimestamps: {
. status (string)
} (object)
keyspaces/update_tableAdds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.keyspaceName (string) required
tableName (string) required
addColumns (array)
capacitySpecification: {
. throughputMode (string)
. readCapacityUnits (integer)
. writeCapacityUnits (integer)
} (object)
encryptionSpecification: {
. type (string)
. kmsKeyIdentifier (string)
} (object)
pointInTimeRecovery: {
. status (string)
} (object)
ttl: {
. status (string)
} (object)
defaultTimeToLive (integer)
clientSideTimestamps: {
. status (string)
} (object)
autoScalingSpecification: {
. writeCapacityAutoScaling (object)
. readCapacityAutoScaling (object)
} (object)
replicaSpecifications (array)
cdcSpecification: {
. status (string)
. viewType (string)
. tags (array)
. propagateTags (string)
} (object)
warmThroughputSpecification: {
. readUnitsPerSecond (integer)
. writeUnitsPerSecond (integer)
} (object)
keyspacesstreams/get_recordsRetrieves data records from a specified shard in an Amazon Keyspaces data stream. This operation returns a collection of data records from the shard, including the primary key columns and information about modifications made to the captured table data. Each record represents a single data modification in the Amazon Keyspaces table and includes metadata about when the change occurred.shardIterator (string) required
maxResults (integer)
keyspacesstreams/get_shard_iteratorReturns a shard iterator that serves as a bookmark for reading data from a specific position in an Amazon Keyspaces data stream's shard. The shard iterator specifies the shard position from which to start reading data records sequentially. You can specify whether to begin reading at the latest record, the oldest record, or at a particular sequence number within the shard.streamArn (string) required
shardId (string) required
shardIteratorType (string) required
sequenceNumber (string)
keyspacesstreams/get_streamReturns detailed information about a specific data capture stream for an Amazon Keyspaces table. The information includes the stream's Amazon Resource Name ARN, creation time, current status, retention period, shard composition, and associated table details. This operation helps you monitor and manage the configuration of your Amazon Keyspaces data streams.streamArn (string) required
maxResults (integer)
shardFilter: {
. type (string)
. shardId (string)
} (object)
nextToken (string)
keyspacesstreams/list_streamsReturns a list of all data capture streams associated with your Amazon Keyspaces account or for a specific keyspace or table. The response includes information such as stream ARNs, table associations, creation timestamps, and current status. This operation helps you discover and manage all active data streams in your Amazon Keyspaces environment.keyspaceName (string)
tableName (string)
maxResults (integer)
nextToken (string)
kinesis_analytics_v2/add_application_cloud_watch_logging_optionAdds an Amazon CloudWatch log stream to monitor application configuration errors.ApplicationName (string) required
CurrentApplicationVersionId (integer)
CloudWatchLoggingOption: {
. LogStreamARN (string)
} (object) required
ConditionalToken (string)
kinesis_analytics_v2/add_application_inputAdds 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.ApplicationName (string) required
CurrentApplicationVersionId (integer) required
Input: {
. NamePrefix (string)
. InputProcessingConfiguration (object)
. KinesisStreamsInput (object)
. KinesisFirehoseInput (object)
. InputParallelism (object)
. InputSchema (object)
} (object) required
kinesis_analytics_v2/add_application_input_processing_configurationAdds 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.ApplicationName (string) required
CurrentApplicationVersionId (integer) required
InputId (string) required
InputProcessingConfiguration: {
. InputLambdaProcessor (object)
} (object) required
kinesis_analytics_v2/add_application_outputAdds 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-applicatApplicationName (string) required
CurrentApplicationVersionId (integer) required
Output: {
. Name (string)
. KinesisStreamsOutput (object)
. KinesisFirehoseOutput (object)
. LambdaOutput (object)
. DestinationSchema (object)
} (object) required
kinesis_analytics_v2/add_application_reference_data_sourceAdds 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.ApplicationName (string) required
CurrentApplicationVersionId (integer) required
ReferenceDataSource: {
. TableName (string)
. S3ReferenceDataSource (object)
. ReferenceSchema (object)
} (object) required
kinesis_analytics_v2/add_application_vpc_configurationAdds 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 Managed Service for Apache Flink applications: VPC configurations are not supported for SQL applications. When a VPC is added to a Managed Service for Apache Flink application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway toApplicationName (string) required
CurrentApplicationVersionId (integer)
VpcConfiguration: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object) required
ConditionalToken (string)
kinesis_analytics_v2/create_applicationCreates a Managed Service for Apache Flink application. For information about creating a Managed Service for Apache Flink application, see Creating an Application.ApplicationName (string) required
ApplicationDescription (string)
RuntimeEnvironment (string) required
ServiceExecutionRole (string) required
ApplicationConfiguration: {
. SqlApplicationConfiguration (object)
. FlinkApplicationConfiguration (object)
. EnvironmentProperties (object)
. ApplicationCodeConfiguration (object)
. ApplicationSnapshotConfiguration (object)
. ApplicationSystemRollbackConfiguration (object)
. VpcConfigurations (array)
. ZeppelinApplicationConfiguration (object)
. ApplicationEncryptionConfiguration (object)
} (object)
CloudWatchLoggingOptions (array)
Tags (array)
ApplicationMode (string)
kinesis_analytics_v2/create_application_presigned_urlCreates and returns a URL that you can use to connect to an application's extension. 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 parApplicationName (string) required
UrlType (string) required
SessionExpirationDurationInSeconds (integer)
kinesis_analytics_v2/create_application_snapshotCreates a snapshot of the application's state data.ApplicationName (string) required
SnapshotName (string) required
kinesis_analytics_v2/delete_applicationDeletes the specified application. Managed Service for Apache Flink halts application execution and deletes the application.ApplicationName (string) required
CreateTimestamp (string) required
kinesis_analytics_v2/delete_application_cloud_watch_logging_optionDeletes an Amazon CloudWatch log stream from an SQL-based Kinesis Data Analytics application.ApplicationName (string) required
CurrentApplicationVersionId (integer)
CloudWatchLoggingOptionId (string) required
ConditionalToken (string)
kinesis_analytics_v2/delete_application_input_processing_configurationDeletes an InputProcessingConfiguration from an input.ApplicationName (string) required
CurrentApplicationVersionId (integer) required
InputId (string) required
kinesis_analytics_v2/delete_application_outputDeletes 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.ApplicationName (string) required
CurrentApplicationVersionId (integer) required
OutputId (string) required
kinesis_analytics_v2/delete_application_reference_data_sourceDeletes 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.ApplicationName (string) required
CurrentApplicationVersionId (integer) required
ReferenceId (string) required
kinesis_analytics_v2/delete_application_snapshotDeletes a snapshot of application state.ApplicationName (string) required
SnapshotName (string) required
SnapshotCreationTimestamp (string) required
kinesis_analytics_v2/delete_application_vpc_configurationRemoves a VPC configuration from a Managed Service for Apache Flink application.ApplicationName (string) required
CurrentApplicationVersionId (integer)
VpcConfigurationId (string) required
ConditionalToken (string)
kinesis_analytics_v2/describe_applicationReturns information about a specific Managed Service for Apache Flink application. If you want to retrieve a list of all applications in your account, use the ListApplications operation.ApplicationName (string) required
IncludeAdditionalDetails (boolean)
kinesis_analytics_v2/describe_application_operationProvides a detailed description of a specified application operation. To see a list of all the operations of an application, invoke the ListApplicationOperations operation. This operation is supported only for Managed Service for Apache Flink.ApplicationName (string) required
OperationId (string) required
kinesis_analytics_v2/describe_application_snapshotReturns information about a snapshot of application state data.ApplicationName (string) required
SnapshotName (string) required
kinesis_analytics_v2/describe_application_versionProvides 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 Managed Service for Apache Flink.ApplicationName (string) required
ApplicationVersionId (integer) required
kinesis_analytics_v2/discover_input_schemaInfers 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 coResourceARN (string)
ServiceExecutionRole (string) required
InputStartingPositionConfiguration: {
. InputStartingPosition (string)
} (object)
S3Configuration: {
. BucketARN (string)
. FileKey (string)
} (object)
InputProcessingConfiguration: {
. InputLambdaProcessor (object)
} (object)
kinesis_analytics_v2/list_application_operationsLists all the operations performed for the specified application such as UpdateApplication, StartApplication etc. The response also includes a summary of the operation. To get the complete description of a specific operation, invoke the DescribeApplicationOperation operation. This operation is supported only for Managed Service for Apache Flink.ApplicationName (string) required
Limit (integer)
NextToken (string)
Operation (string)
OperationStatus (string)
kinesis_analytics_v2/list_applicationsReturns a list of Managed Service for Apache Flink 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.Limit (integer)
NextToken (string)
kinesis_analytics_v2/list_application_snapshotsLists information about the current application snapshots.ApplicationName (string) required
Limit (integer)
NextToken (string)
kinesis_analytics_v2/list_application_versionsLists 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 Managed Service for Apache Flink.ApplicationName (string) required
Limit (integer)
NextToken (string)
kinesis_analytics_v2/list_tags_for_resourceRetrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.ResourceARN (string) required
kinesis_analytics_v2/rollback_applicationReverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status or in the running status. You can roll back an application only if it is in the UPDATING, AUTOSCALING, or RUNNING statuses. When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Managed Service for Apache Flink rejects the rollback request.ApplicationName (string) required
CurrentApplicationVersionId (integer) required
kinesis_analytics_v2/start_applicationStarts the specified Managed Service for Apache Flink application. After creating an application, you must exclusively call this operation to start your application.ApplicationName (string) required
RunConfiguration: {
. FlinkRunConfiguration (object)
. SqlRunConfigurations (array)
. ApplicationRestoreConfiguration (object)
} (object)
kinesis_analytics_v2/stop_applicationStops 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. Managed Service for Apache Flink takes a snapshot when the application is stopped, unless Force is set to true.ApplicationName (string) required
Force (boolean)
kinesis_analytics_v2/tag_resourceAdds one or more key-value tags to a Managed Service for Apache Flink 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.ResourceARN (string) required
Tags (array) required
kinesis_analytics_v2/untag_resourceRemoves one or more tags from a Managed Service for Apache Flink application. For more information, see Using Tagging.ResourceARN (string) required
TagKeys (array) required
kinesis_analytics_v2/update_applicationUpdates an existing Managed Service for Apache Flink application. Using this operation, you can update application code, input configuration, and output configuration. Managed Service for Apache Flink updates the ApplicationVersionId each time you update your application.ApplicationName (string) required
CurrentApplicationVersionId (integer)
ApplicationConfigurationUpdate: {
. SqlApplicationConfigurationUpdate (object)
. ApplicationCodeConfigurationUpdate (object)
. FlinkApplicationConfigurationUpdate (object)
. EnvironmentPropertyUpdates (object)
. ApplicationSnapshotConfigurationUpdate (object)
. ApplicationSystemRollbackConfigurationUpdate (object)
. VpcConfigurationUpdates (array)
. ZeppelinApplicationConfigurationUpdate (object)
. ApplicationEncryptionConfigurationUpdate (object)
} (object)
ServiceExecutionRoleUpdate (string)
RunConfigurationUpdate: {
. FlinkRunConfiguration (object)
. ApplicationRestoreConfiguration (object)
} (object)
CloudWatchLoggingOptionUpdates (array)
ConditionalToken (string)
RuntimeEnvironmentUpdate (string)
kinesis_analytics_v2/update_application_maintenance_configurationUpdates the maintenance configuration of the Managed Service for Apache Flink 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, tApplicationName (string) required
ApplicationMaintenanceConfigurationUpdate: {
. ApplicationMaintenanceWindowStartTimeUpdate (string)
} (object) required
kinesis_analytics/add_application_cloud_watch_logging_optionThis 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.ApplicationName (string) required
CurrentApplicationVersionId (integer) required
CloudWatchLoggingOption: {
. LogStreamARN (string)
. RoleARN (string)
} (object) required
kinesis_analytics/add_application_inputThis 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 stApplicationName (string) required
CurrentApplicationVersionId (integer) required
Input: {
. NamePrefix (string)
. InputProcessingConfiguration (object)
. KinesisStreamsInput (object)
. KinesisFirehoseInput (object)
. InputParallelism (object)
. InputSchema (object)
} (object) required
kinesis_analytics/add_application_input_processing_configurationThis 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.ApplicationName (string) required
CurrentApplicationVersionId (integer) required
InputId (string) required
InputProcessingConfiguration: {
. InputLambdaProcessor (object)
} (object) required
kinesis_analytics/add_application_outputThis 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 KinesiApplicationName (string) required
CurrentApplicationVersionId (integer) required
Output: {
. Name (string)
. KinesisStreamsOutput (object)
. KinesisFirehoseOutput (object)
. LambdaOutput (object)
. DestinationSchema (object)
} (object) required
kinesis_analytics/add_application_reference_data_sourceThis 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 SApplicationName (string) required
CurrentApplicationVersionId (integer) required
ReferenceDataSource: {
. TableName (string)
. S3ReferenceDataSource (object)
. ReferenceSchema (object)
} (object) required
kinesis_analytics/create_applicationThis 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 wrApplicationName (string) required
ApplicationDescription (string)
Inputs (array)
Outputs (array)
CloudWatchLoggingOptions (array)
ApplicationCode (string)
Tags (array)
kinesis_analytics/delete_applicationThis 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 operApplicationName (string) required
CreateTimestamp (string) required
kinesis_analytics/delete_application_cloud_watch_logging_optionThis 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.ApplicationName (string) required
CurrentApplicationVersionId (integer) required
CloudWatchLoggingOptionId (string) required
kinesis_analytics/delete_application_input_processing_configurationThis 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.ApplicationName (string) required
CurrentApplicationVersionId (integer) required
InputId (string) required
kinesis_analytics/delete_application_outputThis 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 requiresApplicationName (string) required
CurrentApplicationVersionId (integer) required
OutputId (string) required
kinesis_analytics/delete_application_reference_data_sourceThis 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 AddApplicatioApplicationName (string) required
CurrentApplicationVersionId (integer) required
ReferenceId (string) required
kinesis_analytics/describe_applicationThis 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 kinApplicationName (string) required
kinesis_analytics/discover_input_schemaThis 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 samResourceARN (string)
RoleARN (string)
InputStartingPositionConfiguration: {
. InputStartingPosition (string)
} (object)
S3Configuration: {
. RoleARN (string)
. BucketARN (string)
. FileKey (string)
} (object)
InputProcessingConfiguration: {
. InputLambdaProcessor (object)
} (object)
kinesis_analytics/list_applicationsThis 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 asLimit (integer)
ExclusiveStartApplicationName (string)
kinesis_analytics/list_tags_for_resourceRetrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.ResourceARN (string) required
kinesis_analytics/start_applicationThis 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, processesApplicationName (string) required
InputConfigurations (array) required
kinesis_analytics/stop_applicationThis 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 KApplicationName (string) required
kinesis_analytics/tag_resourceAdds 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.ResourceARN (string) required
Tags (array) required
kinesis_analytics/untag_resourceRemoves one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.ResourceARN (string) required
TagKeys (array) required
kinesis_analytics/update_applicationThis 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 eachApplicationName (string) required
CurrentApplicationVersionId (integer) required
ApplicationUpdate: {
. InputUpdates (array)
. ApplicationCodeUpdate (string)
. OutputUpdates (array)
. ReferenceDataSourceUpdates (array)
. CloudWatchLoggingOptionUpdates (array)
} (object) required
kinesis_video_archived_media/get_clipDownloads 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 providinStreamName (string)
StreamARN (string)
ClipFragmentSelector: {
. FragmentSelectorType (string)
. TimestampRange (object)
} (object) required
kinesis_video_archived_media/get_dashstreaming_session_urlRetrieves 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 encodedStreamName (string)
StreamARN (string)
PlaybackMode (string)
DisplayFragmentTimestamp (string)
DisplayFragmentNumber (string)
DASHFragmentSelector: {
. FragmentSelectorType (string)
. TimestampRange (object)
} (object)
Expires (integer)
MaxManifestFragmentResults (integer)
kinesis_video_archived_media/get_hlsstreaming_session_urlRetrieves 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: For streaming video, the media must contain H.264 or H.265 encoded video and, optionally, AAC encoded audio.StreamName (string)
StreamARN (string)
PlaybackMode (string)
HLSFragmentSelector: {
. FragmentSelectorType (string)
. TimestampRange (object)
} (object)
ContainerFormat (string)
DiscontinuityMode (string)
DisplayFragmentTimestamp (string)
Expires (integer)
MaxMediaPlaylistFragmentResults (integer)
kinesis_video_archived_media/get_imagesRetrieves a list of images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.StreamName (string)
StreamARN (string)
ImageSelectorType (string) required
StartTimestamp (string) required
EndTimestamp (string) required
SamplingInterval (integer)
Format (string) required
FormatConfig (object)
WidthPixels (integer)
HeightPixels (integer)
MaxResults (integer)
NextToken (string)
kinesis_video_archived_media/get_media_for_fragment_listGets 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 piStreamName (string)
StreamARN (string)
Fragments (array) required
kinesis_video_archived_media/list_fragmentsReturns 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 enStreamName (string)
StreamARN (string)
MaxResults (integer)
NextToken (string)
FragmentSelector: {
. FragmentSelectorType (string)
. TimestampRange (object)
} (object)
kinesis_video_media/get_mediaUse 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 fragmStreamName (string)
StreamARN (string)
StartSelector: {
. StartSelectorType (string)
. AfterFragmentNumber (string)
. StartTimestamp (string)
. ContinuationToken (string)
} (object) required
kinesis_video_signaling/get_ice_server_configGets 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 thaChannelARN (string) required
ClientId (string)
Service (string)
Username (string)
kinesis_video_signaling/send_alexa_offer_to_masterThis 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.ChannelARN (string) required
SenderClientId (string) required
MessagePayload (string) required
kinesis_video_webrtc_storage/join_storage_sessionBefore using this API, you must call the GetSignalingChannelEndpoint API to request the WEBRTC endpoint. You then specify the endpoint and region in your JoinStorageSession API request. Join the ongoing one way-video and/or multi-way audio WebRTC session as a video producing device for an input channel. If there’s no existing session for the channel, a new streaming session needs to be created, and the Amazon Resource Name ARN of the signaling channel must be provided. Currently for the SINGLE_MchannelArn (string) required
kinesis_video_webrtc_storage/join_storage_session_as_viewerJoin the ongoing one way-video and/or multi-way audio WebRTC session as a viewer for an input channel. If there’s no existing session for the channel, create a new streaming session and provide the Amazon Resource Name ARN of the signaling channel channelArn and client id clientId. Currently for SINGLE_MASTER type, a video producing device is able to ingest both audio and video media into a stream, while viewers can only ingest audio. Both a video producing device and viewers can join a sessionchannelArn (string) required
clientId (string) required
kinesis_video/create_signaling_channelCreates a signaling channel. CreateSignalingChannel is an asynchronous operation.ChannelName (string) required
ChannelType (string)
SingleMasterConfiguration: {
. MessageTtlSeconds (integer)
} (object)
Tags (array)
kinesis_video/create_streamCreates 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.DeviceName (string)
StreamName (string) required
MediaType (string)
KmsKeyId (string)
DataRetentionInHours (integer)
Tags (object)
StreamStorageConfiguration: {
. DefaultStorageTier (string)
} (object)
kinesis_video/delete_edge_configurationAn asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent. When you invoke this API, the sync status is set to DELETING. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes to DELETE_FAILED. You will need to re-try the deletion. When the delStreamName (string)
StreamARN (string)
kinesis_video/delete_signaling_channelDeletes 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.ChannelARN (string) required
CurrentVersion (string)
kinesis_video/delete_streamDeletes 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 requiStreamARN (string) required
CurrentVersion (string)
kinesis_video/describe_edge_configurationDescribes a stream’s edge configuration that was set using the StartEdgeConfigurationUpdate API and the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent.StreamName (string)
StreamARN (string)
kinesis_video/describe_image_generation_configurationGets the ImageGenerationConfiguration for a given Kinesis video stream.StreamName (string)
StreamARN (string)
kinesis_video/describe_mapped_resource_configurationReturns the most current information about the stream. The streamName or streamARN should be provided in the input.StreamName (string)
StreamARN (string)
MaxResults (integer)
NextToken (string)
kinesis_video/describe_media_storage_configurationReturns the most current information about the channel. Specify the ChannelName or ChannelARN in the input.ChannelName (string)
ChannelARN (string)
kinesis_video/describe_notification_configurationGets the NotificationConfiguration for a given Kinesis video stream.StreamName (string)
StreamARN (string)
kinesis_video/describe_signaling_channelReturns 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.ChannelName (string)
ChannelARN (string)
kinesis_video/describe_streamReturns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.StreamName (string)
StreamARN (string)
kinesis_video/describe_stream_storage_configurationRetrieves the current storage configuration for the specified Kinesis video stream. In the request, you must specify either the StreamName or the StreamARN. You must have permissions for the KinesisVideo:DescribeStreamStorageConfiguration action.StreamName (string)
StreamARN (string)
kinesis_video/get_data_endpointGets 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.StreamName (string)
StreamARN (string)
APIName (string) required
kinesis_video/get_signaling_channel_endpointProvides 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. If you specify WEBRTC as the protocol, but the signaChannelARN (string) required
SingleMasterChannelEndpointConfiguration: {
. Protocols (array)
. Role (string)
} (object)
kinesis_video/list_edge_agent_configurationsReturns an array of edge configurations associated with the specified Edge Agent. In the request, you must specify the Edge Agent HubDeviceArn.HubDeviceArn (string) required
MaxResults (integer)
NextToken (string)
kinesis_video/list_signaling_channelsReturns 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.MaxResults (integer)
NextToken (string)
ChannelNameCondition: {
. ComparisonOperator (string)
. ComparisonValue (string)
} (object)
kinesis_video/list_streamsReturns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.MaxResults (integer)
NextToken (string)
StreamNameCondition: {
. ComparisonOperator (string)
. ComparisonValue (string)
} (object)
kinesis_video/list_tags_for_resourceReturns a list of tags associated with the specified signaling channel.NextToken (string)
ResourceARN (string) required
kinesis_video/list_tags_for_streamReturns a list of tags associated with the specified stream. In the request, you must specify either the StreamName or the StreamARN.NextToken (string)
StreamARN (string)
StreamName (string)
kinesis_video/start_edge_configuration_updateAn asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The SyncStatus will be updated as the edge configuration is acknowledged, and synced with the Edge Agent. If this API is invoked for the first time, a new edge configuration will be cStreamName (string)
StreamARN (string)
EdgeConfig: {
. HubDeviceArn (string)
. RecorderConfig (object)
. UploaderConfig (object)
. DeletionConfig (object)
} (object) required
kinesis_video/tag_resourceAdds 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.ResourceARN (string) required
Tags (array) required
kinesis_video/tag_streamAdds 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:TagStreamARN (string)
StreamName (string)
Tags (object) required
kinesis_video/untag_resourceRemoves 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.ResourceARN (string) required
TagKeyList (array) required
kinesis_video/untag_streamRemoves 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.StreamARN (string)
StreamName (string)
TagKeyList (array) required
kinesis_video/update_data_retentionIncreases 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. 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,StreamName (string)
StreamARN (string)
CurrentVersion (string) required
Operation (string) required
DataRetentionChangeInHours (integer) required
kinesis_video/update_image_generation_configurationUpdates the StreamInfo and ImageProcessingConfiguration fields.StreamName (string)
StreamARN (string)
ImageGenerationConfiguration: {
. Status (string)
. ImageSelectorType (string)
. DestinationConfig (object)
. SamplingInterval (integer)
. Format (string)
. FormatConfig (object)
. WidthPixels (integer)
. HeightPixels (integer)
} (object)
kinesis_video/update_media_storage_configurationAssociates a SignalingChannel to a stream to store the media. There are two signaling modes that you can specify : If StorageStatus is enabled, the data will be stored in the StreamARN provided. In order for WebRTC Ingestion to work, the stream must have data retention enabled. If StorageStatus is disabled, no data will be stored, and the StreamARN parameter will not be needed. If StorageStatus is enabled, direct peer-to-peer master-viewer connections no longer occur. Peers connect directly to tChannelARN (string) required
MediaStorageConfiguration: {
. StreamARN (string)
. Status (string)
} (object) required
kinesis_video/update_notification_configurationUpdates the notification information for a stream.StreamName (string)
StreamARN (string)
NotificationConfiguration: {
. Status (string)
. DestinationConfig (object)
} (object)
kinesis_video/update_signaling_channelUpdates 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.ChannelARN (string) required
CurrentVersion (string) required
SingleMasterConfiguration: {
. MessageTtlSeconds (integer)
} (object)
kinesis_video/update_streamUpdates 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,StreamName (string)
StreamARN (string)
CurrentVersion (string) required
DeviceName (string)
MediaType (string)
kinesis_video/update_stream_storage_configurationUpdates the storage configuration for an existing Kinesis video stream. This operation allows you to modify the storage tier settings for a stream, enabling you to optimize storage costs and performance based on your access patterns. UpdateStreamStorageConfiguration is an asynchronous operation. You must have permissions for the KinesisVideo:UpdateStreamStorageConfiguration action.StreamName (string)
StreamARN (string)
CurrentVersion (string) required
StreamStorageConfiguration: {
. DefaultStorageTier (string)
} (object) required
kinesis/add_tags_to_streamAdds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. 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.StreamName (string)
Tags (object) required
StreamARN (string)
StreamId (string)
kinesis/create_streamCreates 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 can create your data stream using either on-demand or provisioned capacity mode. Data streams with an on-demand mode require no capacity planning and automatically scale to handle gigabytes of write and read thrStreamName (string) required
ShardCount (integer)
StreamModeDetails: {
. StreamMode (string)
} (object)
Tags (object)
WarmThroughputMiBps (integer)
MaxRecordSizeInKiB (integer)
kinesis/decrease_stream_retention_periodDecreases 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. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decrStreamName (string)
RetentionPeriodHours (integer) required
StreamARN (string)
StreamId (string)
kinesis/delete_resource_policyDelete a policy for the specified data stream or consumer. Request patterns can be one of the following: Data stream pattern: arn:aws.:kinesis:.:d12:.stream/S+ Consumer pattern: ^arn:aws.:kinesis:.:d12:.stream/a-zA-Z0-9_.-+/consumer/a-zA-Z0-9_.-+:0-9+ResourceARN (string) required
StreamId (string)
kinesis/delete_streamDeletes 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. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. If the stream is in the ACTIVE state, you can dStreamName (string)
EnforceConsumerDeletion (boolean)
StreamARN (string)
StreamId (string)
kinesis/deregister_stream_consumerTo 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 descriptiStreamARN (string)
ConsumerName (string)
ConsumerARN (string)
StreamId (string)
kinesis/describe_account_settingsDescribes the account-level settings for Amazon Kinesis Data Streams. This operation returns information about the minimum throughput billing commitments and other account-level configurations. This API has a call limit of 5 transactions per second TPS for each Amazon Web Services account. TPS over 5 will initiate the LimitExceededException.No parameters
kinesis/describe_limitsDescribes 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.No parameters
kinesis/describe_streamDescribes 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. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.StreamName (string)
Limit (integer)
ExclusiveStartShardId (string)
StreamARN (string)
StreamId (string)
kinesis/describe_stream_consumerTo 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 wiStreamARN (string)
ConsumerName (string)
ConsumerARN (string)
StreamId (string)
kinesis/describe_stream_summaryProvides a summarized description of the specified Kinesis data stream without the shard list. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. 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 limStreamName (string)
StreamARN (string)
StreamId (string)
kinesis/disable_enhanced_monitoringDisables enhanced monitoring. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.StreamName (string)
ShardLevelMetrics (array) required
StreamARN (string)
StreamId (string)
kinesis/enable_enhanced_monitoringEnables enhanced Kinesis data stream monitoring for shard-level metrics. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.StreamName (string)
ShardLevelMetrics (array) required
StreamARN (string)
StreamId (string)
kinesis/get_recordsGets data records from a Kinesis data stream's shard. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. 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 poinShardIterator (string) required
Limit (integer)
StreamARN (string)
StreamId (string)
kinesis/get_resource_policyReturns a policy attached to the specified data stream or consumer. Request patterns can be one of the following: Data stream pattern: arn:aws.:kinesis:.:d12:.stream/S+ Consumer pattern: ^arn:aws.:kinesis:.:d12:.stream/a-zA-Z0-9_.-+/consumer/a-zA-Z0-9_.-+:0-9+ResourceARN (string) required
StreamId (string)
kinesis/get_shard_iteratorGets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. 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 tStreamName (string)
ShardId (string) required
ShardIteratorType (string) required
StartingSequenceNumber (string)
Timestamp (string)
StreamARN (string)
StreamId (string)
kinesis/increase_stream_retention_periodIncreases 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. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. If you choose a longer stream retention period, this operation increases the time period during whStreamName (string)
RetentionPeriodHours (integer) required
StreamARN (string)
StreamId (string)
kinesis/list_shardsLists the shards in a stream and provides information about each shard. This operation has a limit of 1000 transactions per second per data stream. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. 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 opStreamName (string)
NextToken (string)
ExclusiveStartShardId (string)
MaxResults (integer)
StreamCreationTimestamp (string)
ShardFilter: {
. Type (string)
. ShardId (string)
. Timestamp (string)
} (object)
StreamARN (string)
StreamId (string)
kinesis/list_stream_consumersLists 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.StreamARN (string) required
NextToken (string)
MaxResults (integer)
StreamCreationTimestamp (string)
StreamId (string)
kinesis/list_streamsLists 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 byLimit (integer)
ExclusiveStartStreamName (string)
NextToken (string)
kinesis/list_tags_for_resourceList all tags added to the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources. For more information about tagging Kinesis resources, see Tag your Amazon Kinesis Data Streams resources.ResourceARN (string) required
StreamId (string)
kinesis/list_tags_for_streamLists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.StreamName (string)
ExclusiveStartTagKey (string)
Limit (integer)
StreamARN (string)
StreamId (string)
kinesis/merge_shardsMerges 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. This API is only supported for the data streams with the provisioned capacity mode. 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 couStreamName (string)
ShardToMerge (string) required
AdjacentShardToMerge (string) required
StreamARN (string)
StreamId (string)
kinesis/put_recordWrites 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 10 MiB per second. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. You must specify thStreamName (string)
Data (string) required
PartitionKey (string) required
ExplicitHashKey (string)
SequenceNumberForOrdering (string)
StreamARN (string)
StreamId (string)
kinesis/put_recordsWrites 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. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. Each PutRecords request can support up to 500 records. Each record in the request can be as large as 10 MiB, up to a liRecords (array) required
StreamName (string)
StreamARN (string)
StreamId (string)
kinesis/put_resource_policyAttaches a resource-based policy to a data stream or registered consumer. If you are using an identity other than the root user of the Amazon Web Services account that owns the resource, the calling identity must have the PutResourcePolicy permissions on the specified Kinesis Data Streams resource and belong to the owner's account in order to use this operation. If you don't have PutResourcePolicy permissions, Amazon Kinesis Data Streams returns a 403 Access Denied error. If you receive a ResourResourceARN (string) required
StreamId (string)
Policy (string) required
kinesis/register_stream_consumerRegisters 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 add tags to the registered consumer when making a RegisterStreamConsumer request by setting the Tags parameter. If you pass the Tags parameterStreamARN (string) required
ConsumerName (string) required
StreamId (string)
Tags (object)
kinesis/remove_tags_from_streamRemoves tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. If you specify a tag that does not exist, it is ignored. RemoveTagsFromStream has a limit of five transactions per second per account.StreamName (string)
TagKeys (array) required
StreamARN (string)
StreamId (string)
kinesis/split_shardSplits 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. This API is only supported for the data streams with the provisioned capacity mode. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you uStreamName (string)
ShardToSplit (string) required
NewStartingHashKey (string) required
StreamARN (string)
StreamId (string)
kinesis/start_stream_encryptionEnables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. 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 StreaStreamName (string)
EncryptionType (string) required
KeyId (string) required
StreamARN (string)
StreamId (string)
kinesis/stop_stream_encryptionDisables server-side encryption for a specified stream. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. 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 ACTIVEStreamName (string)
EncryptionType (string) required
KeyId (string) required
StreamARN (string)
StreamId (string)
kinesis/subscribe_to_shardThis operation establishes an HTTP/2 connection between the consumer you specify in the ConsumerARN parameter and the shard you specify in the ShardId parameter. After the connection is successfully established, Kinesis Data Streams pushes records from the shard to the consumer over this connection. Before you call this operation, call RegisterStreamConsumer to register the consumer with Kinesis Data Streams. When the SubscribeToShard call succeeds, your consumer starts receiving events of typeConsumerARN (string) required
StreamId (string)
ShardId (string) required
StartingPosition: {
. Type (string)
. SequenceNumber (string)
. Timestamp (string)
} (object) required
kinesis/tag_resourceAdds or updates tags for the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources. You can assign up to 50 tags to a Kinesis resource.Tags (object) required
ResourceARN (string) required
StreamId (string)
kinesis/untag_resourceRemoves tags from the specified Kinesis resource. Removed tags are deleted and can't be recovered after this operation completes successfully.TagKeys (array) required
ResourceARN (string) required
StreamId (string)
kinesis/update_account_settingsUpdates the account-level settings for Amazon Kinesis Data Streams. Updating account settings is a synchronous operation. Upon receiving the request, Kinesis Data Streams will return immediately with your account’s updated settings. API limits Certain account configurations have minimum commitment windows. Attempting to update your settings prior to the end of the minimum commitment window might have certain restrictions. This API has a call limit of 5 transactions per second TPS for each AmazonMinimumThroughputBillingCommitment: {
. Status (string)
} (object) required
kinesis/update_max_record_sizeThis allows you to update the MaxRecordSize of a single record that you can write to, and read from a stream. You can ingest and digest single records up to 10240 KiB.StreamARN (string)
StreamId (string)
MaxRecordSizeInKiB (integer) required
kinesis/update_shard_countUpdates the shard count of the specified stream to the specified number of shards. This API is only supported for the data streams with the provisioned capacity mode. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of theStreamName (string)
TargetShardCount (integer) required
ScalingType (string) required
StreamARN (string)
StreamId (string)
kinesis/update_stream_modeUpdates 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. If you'd still like to proactively scale your on-demand data stream’s capacity, you can unlock the warm throughput feature for on-demand data streams by enabling MinimumThroughputBillingCommitment for your account. Once your account has MinimumThroughputBillingCommitment enabled, you can specify the warm throughpStreamARN (string) required
StreamId (string)
StreamModeDetails: {
. StreamMode (string)
} (object) required
WarmThroughputMiBps (integer)
kinesis/update_stream_warm_throughputUpdates the warm throughput configuration for the specified Amazon Kinesis Data Streams on-demand data stream. This operation allows you to proactively scale your on-demand data stream to a specified throughput level, enabling better performance for sudden traffic spikes. When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API. Updating the warm throughput is an asynchronStreamARN (string)
StreamName (string)
StreamId (string)
WarmThroughputMiBps (integer) required
kms/cancel_key_deletionCancels 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 thiKeyId (string) required
kms/connect_custom_key_storeConnects or reconnects a custom key store to its backing key store. For an CloudHSM key store, ConnectCustomKeyStore connects the key store to its associated CloudHSM cluster. For an external key store, ConnectCustomKeyStore connects the key store to the external key store proxy that communicates with your external key manager. 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 storCustomKeyStoreId (string) required
kms/create_aliasCreates 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 for 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 operationsAliasName (string) required
TargetKeyId (string) required
kms/create_custom_key_storeCreates a custom key store backed by a key store that you own and manage. When you use a KMS key in a custom key store for a cryptographic operation, the cryptographic operation is actually performed in your key store using your keys. KMS supports CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an external key store proxy and external key manager outside of Amazon Web Services. This operation is part of the custom key stores feature in KMS, which combines theCustomKeyStoreName (string) required
CloudHsmClusterId (string)
TrustAnchorCertificate (string)
KeyStorePassword (string)
CustomKeyStoreType (string)
XksProxyUriEndpoint (string)
XksProxyUriPath (string)
XksProxyVpcEndpointServiceName (string)
XksProxyVpcEndpointServiceOwner (string)
XksProxyAuthenticationCredential: {
. AccessKeyId (string)
. RawSecretAccessKey (string)
} (object)
XksProxyConnectivity (string)
kms/create_grantAdds 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 deKeyId (string) required
GranteePrincipal (string) required
RetiringPrincipal (string)
Operations (array) required
Constraints: {
. EncryptionContextSubset (object)
. EncryptionContextEquals (object)
} (object)
GrantTokens (array)
Name (string)
DryRun (boolean)
kms/create_keyCreates a unique customer managed KMS key in your Amazon Web Services account and Region. You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services services let you use KMS keys that you create and manage to protect your service resources. A KMS key is a logical representation of a cryptographic key. In addition to the key material used in cryptographic operations, a KMS key includes metadata, such as the key ID, key policy, creation date, descriPolicy (string)
Description (string)
KeyUsage (string)
CustomerMasterKeySpec (string)
KeySpec (string)
Origin (string)
CustomKeyStoreId (string)
BypassPolicyLockoutSafetyCheck (boolean)
Tags (array)
MultiRegion (boolean)
XksKeyId (string)
kms/decryptDecrypts 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 asCiphertextBlob (string) required
EncryptionContext (object)
GrantTokens (array)
KeyId (string)
EncryptionAlgorithm (string)
Recipient: {
. KeyEncryptionAlgorithm (string)
. AttestationDocument (string)
} (object)
DryRun (boolean)
kms/delete_aliasDeletes the specified alias. Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC for 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 aliasAliasName (string) required
kms/delete_custom_key_storeDeletes a custom key store. This operation does not affect any backing elements of the custom key store. It does not delete the CloudHSM cluster that is associated with an CloudHSM key store, or affect any users or keys in the cluster. For an external key store, it does not affect the external key store proxy, external key manager, or any external keys. This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolatiCustomKeyStoreId (string) required
kms/delete_imported_key_materialDeletes key material that was previously imported. This operation makes the specified KMS key temporarily unusable. To restore the usability of the KMS key, reimport the same key material. 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. ConsiKeyId (string) required
KeyMaterialId (string)
kms/derive_shared_secretDerives a shared secret using a key agreement algorithm. You must use an asymmetric NIST-standard elliptic curve ECC or SM2 China Regions only KMS key pair with a KeyUsage value of KEY_AGREEMENT to call DeriveSharedSecret. DeriveSharedSecret uses the Elliptic Curve Cryptography Cofactor Diffie-Hellman Primitive ECDH to establish a key agreement between two peers by deriving a shared secret from their elliptic curve public-private key pairs. You can use the raw shared secret that DeriveSharedSecrKeyId (string) required
KeyAgreementAlgorithm (string) required
PublicKey (string) required
GrantTokens (array)
DryRun (boolean)
Recipient: {
. KeyEncryptionAlgorithm (string)
. AttestationDocument (string)
} (object)
kms/describe_custom_key_storesGets information about custom key stores in the account and Region. This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage. 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 noCustomKeyStoreId (string)
CustomKeyStoreName (string)
Limit (integer)
Marker (string)
kms/describe_keyProvides 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 algorithKeyId (string) required
GrantTokens (array)
kms/disable_keySets the state of a KMS key to disabled. This change temporarily prevents use of the KMS key for cryptographic operations. The KMS key that you use for this operation must be in a compatible key state. 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 . Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. Required permissions: kms:DisableKey kKeyId (string) required
kms/disable_key_rotationDisables 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 automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. 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 ofKeyId (string) required
kms/disconnect_custom_key_storeDisconnects the custom key store from its backing key store. This operation disconnects an CloudHSM key store from its associated CloudHSM cluster or disconnects an external key store from the external key store proxy that communicates with your external key manager. This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage. While a custom key store is discoCustomKeyStoreId (string) required
kms/enable_keySets 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 Eventual consistency: The KMS APIKeyId (string) required
kms/enable_key_rotationEnables automatic rotation of the key material of the specified symmetric encryption KMS key. By default, when you enable automatic rotation of a customer 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 use the optional RotationPeriodInDays parameter to specify a custom rotation period when you enable key rotation, or you can use RotationPeriodInDays to modify the rotation period of a key that yoKeyId (string) required
RotationPeriodInDays (integer)
kms/encryptEncrypts 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 symKeyId (string) required
Plaintext (string) required
EncryptionContext (object)
GrantTokens (array)
EncryptionAlgorithm (string)
DryRun (boolean)
kms/generate_data_keyReturns 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 usedKeyId (string) required
EncryptionContext (object)
NumberOfBytes (integer)
KeySpec (string)
GrantTokens (array)
Recipient: {
. KeyEncryptionAlgorithm (string)
. AttestationDocument (string)
} (object)
DryRun (boolean)
kms/generate_data_key_pairReturns 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 are not related to the caller or to the KMS key that is used to encrypt the private key. You can use the publEncryptionContext (object)
KeyId (string) required
KeyPairSpec (string) required
GrantTokens (array)
Recipient: {
. KeyEncryptionAlgorithm (string)
. AttestationDocument (string)
} (object)
DryRun (boolean)
kms/generate_data_key_pair_without_plaintextReturns 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 returnsEncryptionContext (object)
KeyId (string) required
KeyPairSpec (string) required
GrantTokens (array)
DryRun (boolean)
kms/generate_data_key_without_plaintextReturns 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. WhenKeyId (string) required
EncryptionContext (object)
KeySpec (string)
NumberOfBytes (integer)
GrantTokens (array)
DryRun (boolean)
kms/generate_macGenerates a hash-based message authentication code HMAC for a message using an HMAC KMS key and a MAC algorithm that the key supports. HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104. You can use value that GenerateMac returns in 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 kMessage (string) required
KeyId (string) required
MacAlgorithm (string) required
GrantTokens (array)
DryRun (boolean)
kms/generate_randomReturns 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 associated with an CloudHSM key store, use the CustomKeyStoreId parameter. GenerateRandom also supports Amazon Web Services Nitro Enclaves, which provide an isolated compute environment in AmazoNumberOfBytes (integer)
CustomKeyStoreId (string)
Recipient: {
. KeyEncryptionAlgorithm (string)
. AttestationDocument (string)
} (object)
kms/get_key_policyGets 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 Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.KeyId (string) required
PolicyName (string)
kms/get_key_rotation_statusProvides detailed information about the rotation status for a KMS key, including whether automatic rotation of the key material is enabled for the specified KMS key, the rotation period, and the next scheduled rotation date. Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set ofKeyId (string) required
kms/get_parameters_for_importReturns the public key and an import token you need to import or reimport key material for a KMS key. By default, KMS keys are created with key material that KMS generates. This operation supports Importing key material, an advanced feature that lets you generate and import the cryptographic key material for a KMS key. Before calling GetParametersForImport, use the CreateKey operation with an Origin value of EXTERNAL to create a KMS key with no key material. You can import key material for a symKeyId (string) required
WrappingAlgorithm (string) required
WrappingKeySpec (string) required
kms/get_public_keyReturns 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, yoKeyId (string) required
GrantTokens (array)
kms/import_key_materialImports or reimports key material into an existing KMS key that was created without key material. You can also use this operation to set or update the expiration model and expiration date of the imported key material. By default, KMS creates KMS keys with key material that it generates. You can also generate and import your own key material. For more information about importing key material, see Importing key material. For asymmetric and HMAC keys, you cannot change the key material after the inKeyId (string) required
ImportToken (string) required
EncryptedKeyMaterial (string) required
ValidTo (string)
ExpirationModel (string)
ImportType (string)
KeyMaterialDescription (string)
KeyMaterialId (string)
kms/list_aliasesGets 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 mKeyId (string)
Limit (integer)
Marker (string)
kms/list_grantsGets 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 creating grants in several programming languages, see Use CreateGrant with an Amazon Web Services SDK or CLI. The GranteePrincipal field in the ListGrants response usually contains the usLimit (integer)
Marker (string)
KeyId (string) required
GrantId (string)
GranteePrincipal (string)
kms/list_key_policiesGets 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 Eventual consistency: The KMS API follows an eventual consistency model. For moKeyId (string) required
Limit (integer)
Marker (string)
kms/list_key_rotationsReturns information about the key materials associated with the specified KMS key. You can use the optional IncludeKeyMaterial parameter to control which key materials are included in the response. You must specify the KMS key in all requests. You can refine the key rotations list by limiting the number of rotations returned. For detailed information about automatic and on-demand key rotations, see Rotate KMS keys in the Key Management Service Developer Guide. Cross-account use: No. You cannot pKeyId (string) required
IncludeKeyMaterial (string)
Limit (integer)
Marker (string)
kms/list_keysGets 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 Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.Limit (integer)
Marker (string)
kms/list_resource_tagsReturns 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 Tags in KMS. 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 EventKeyId (string) required
Limit (integer)
Marker (string)
kms/list_retirable_grantsReturns 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 graLimit (integer)
Marker (string)
RetiringPrincipal (string) required
kms/put_key_policyAttaches 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 Use PutKeyPolicy with an Amazon Web Services SDK or CLI in the Key Management Service Developer Guide. Cross-account use: No. You cKeyId (string) required
PolicyName (string)
Policy (string) required
BypassPolicyLockoutSafetyCheck (boolean)
kms/re_encryptDecrypts 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 GenerateDataCiphertextBlob (string) required
SourceEncryptionContext (object)
SourceKeyId (string)
DestinationKeyId (string) required
DestinationEncryptionContext (object)
SourceEncryptionAlgorithm (string)
DestinationEncryptionAlgorithm (string)
GrantTokens (array)
DryRun (boolean)
kms/replicate_keyReplicates 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 WebKeyId (string) required
ReplicaRegion (string) required
Policy (string)
BypassPolicyLockoutSafetyCheck (boolean)
Description (string)
Tags (array)
kms/retire_grantDeletes 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 prGrantToken (string)
KeyId (string)
GrantId (string)
DryRun (boolean)
kms/revoke_grantDeletes 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 inKeyId (string) required
GrantId (string) required
DryRun (boolean)
kms/rotate_key_on_demandImmediately initiates rotation of the key material of the specified symmetric encryption KMS key. You can perform on-demand rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. On-demand rotations do not change existing automatic rotation schedules. For example, consider a KMS key that has automatic key rotation enabled with a rotation period of 730 days. If the key is scheduled to automatically rotate on April 14, 2024, and yKeyId (string) required
kms/schedule_key_deletionSchedules 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 deletesKeyId (string) required
PendingWindowInDays (integer)
kms/signCreates 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, ECC, or ML-DSA pair that is represented by an asymmetriKeyId (string) required
Message (string) required
MessageType (string)
GrantTokens (array)
SigningAlgorithm (string) required
DryRun (boolean)
kms/tag_resourceAdds 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 for 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 manageKeyId (string) required
Tags (array) required
kms/untag_resourceDeletes 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 for 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 operKeyId (string) required
TagKeys (array) required
kms/update_aliasAssociates 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 for KMS in the Key Management Service Developer Guide. The current and new KMS key must be the same type both symmetric or both asymmetric or botAliasName (string) required
TargetKeyId (string) required
kms/update_custom_key_storeChanges the properties of a custom key store. You can use this operation to change the properties of an CloudHSM key store or an external key store. Use the required CustomKeyStoreId parameter to identify the custom key store. Use the remaining optional parameters to change its properties. This operation does not return any property values. To verify the updated property values, use the DescribeCustomKeyStores operation. This operation is part of the custom key stores feature in KMS, which combiCustomKeyStoreId (string) required
NewCustomKeyStoreName (string)
KeyStorePassword (string)
CloudHsmClusterId (string)
XksProxyUriEndpoint (string)
XksProxyUriPath (string)
XksProxyVpcEndpointServiceName (string)
XksProxyVpcEndpointServiceOwner (string)
XksProxyAuthenticationCredential: {
. AccessKeyId (string)
. RawSecretAccessKey (string)
} (object)
XksProxyConnectivity (string)
kms/update_key_descriptionUpdates 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 Eventual consistency: The KMSKeyId (string) required
Description (string) required
kms/update_primary_regionChanges 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 Change the primary key in a set of multi-Region kKeyId (string) required
PrimaryRegion (string) required
kms/verifyVerifies 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 keyKeyId (string) required
Message (string) required
MessageType (string)
Signature (string) required
SigningAlgorithm (string) required
GrantTokens (array)
DryRun (boolean)
kms/verify_macVerifies 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 andMessage (string) required
KeyId (string) required
MacAlgorithm (string) required
Mac (string) required
GrantTokens (array)
DryRun (boolean)
lakeformation/add_lftags_to_resourceAttaches one or more LF-tags to an existing resource.CatalogId (string)
Resource: {
. Catalog (object)
. Database (object)
. Table (object)
. TableWithColumns (object)
. DataLocation (object)
. DataCellsFilter (object)
. LFTag (object)
. LFTagPolicy (object)
. LFTagExpression (object)
} (object) required
LFTags (array) required
lakeformation/assume_decorated_role_with_samlAllows 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 incluSAMLAssertion (string) required
RoleArn (string) required
PrincipalArn (string) required
DurationSeconds (integer)
lakeformation/batch_grant_permissionsBatch operation to grant permissions to the principal.CatalogId (string)
Entries (array) required
lakeformation/batch_revoke_permissionsBatch operation to revoke permissions from the principal.CatalogId (string)
Entries (array) required
lakeformation/cancel_transactionAttempts to cancel the specified transaction. Returns an exception if the transaction was previously committed.TransactionId (string) required
lakeformation/commit_transactionAttempts 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.TransactionId (string) required
lakeformation/create_data_cells_filterCreates a data cell filter to allow one to grant access to certain columns on certain rows.TableData: {
. TableCatalogId (string)
. DatabaseName (string)
. TableName (string)
. Name (string)
. RowFilter (object)
. ColumnNames (array)
. ColumnWildcard (object)
. VersionId (string)
} (object) required
lakeformation/create_lake_formation_identity_center_configurationCreates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.CatalogId (string)
InstanceArn (string)
ExternalFiltering: {
. Status (string)
. AuthorizedTargets (array)
} (object)
ShareRecipients (array)
ServiceIntegrations (array)
lakeformation/create_lake_formation_opt_inEnforce Lake Formation permissions for the given databases, tables, and principals.Principal: {
. DataLakePrincipalIdentifier (string)
} (object) required
Resource: {
. Catalog (object)
. Database (object)
. Table (object)
. TableWithColumns (object)
. DataLocation (object)
. DataCellsFilter (object)
. LFTag (object)
. LFTagPolicy (object)
. LFTagExpression (object)
} (object) required
Condition: {
. Expression (string)
} (object)
lakeformation/create_lftagCreates an LF-tag with the specified name and values.CatalogId (string)
TagKey (string) required
TagValues (array) required
lakeformation/create_lftag_expressionCreates a new LF-Tag expression with the provided name, description, catalog ID, and expression body. This call fails if a LF-Tag expression with the same name already exists in the caller’s account or if the underlying LF-Tags don't exist. To call this API operation, caller needs the following Lake Formation permissions: CREATE_LF_TAG_EXPRESSION on the root catalog resource. GRANT_WITH_LF_TAG_EXPRESSION on all underlying LF-Tag key:value pairs included in the expression.Name (string) required
Description (string)
CatalogId (string)
Expression (array) required
lakeformation/delete_data_cells_filterDeletes a data cell filter.TableCatalogId (string)
DatabaseName (string)
TableName (string)
Name (string)
lakeformation/delete_lake_formation_identity_center_configurationDeletes an IAM Identity Center connection with Lake Formation.CatalogId (string)
lakeformation/delete_lake_formation_opt_inRemove the Lake Formation permissions enforcement of the given databases, tables, and principals.Principal: {
. DataLakePrincipalIdentifier (string)
} (object) required
Resource: {
. Catalog (object)
. Database (object)
. Table (object)
. TableWithColumns (object)
. DataLocation (object)
. DataCellsFilter (object)
. LFTag (object)
. LFTagPolicy (object)
. LFTagExpression (object)
} (object) required
Condition: {
. Expression (string)
} (object)
lakeformation/delete_lftagDeletes an LF-tag by its key name. The operation fails if the specified tag key doesn't exist. When you delete an LF-Tag: The associated LF-Tag policy becomes invalid. Resources that had this tag assigned will no longer have the tag policy applied to them.CatalogId (string)
TagKey (string) required
lakeformation/delete_lftag_expressionDeletes the LF-Tag expression. The caller must be a data lake admin or have DROP permissions on the LF-Tag expression. Deleting a LF-Tag expression will also delete all LFTagPolicy permissions referencing the LF-Tag expression.Name (string) required
CatalogId (string)
lakeformation/delete_objects_on_cancelFor 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.CatalogId (string)
DatabaseName (string) required
TableName (string) required
TransactionId (string) required
Objects (array) required
lakeformation/deregister_resourceDeregisters 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.ResourceArn (string) required
lakeformation/describe_lake_formation_identity_center_configurationRetrieves the instance ARN and application ARN for the connection.CatalogId (string)
lakeformation/describe_resourceRetrieves the current data access role for the given resource registered in Lake Formation.ResourceArn (string) required
lakeformation/describe_transactionReturns the details of a single transaction.TransactionId (string) required
lakeformation/extend_transactionIndicates 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.TransactionId (string)
lakeformation/get_data_cells_filterReturns a data cells filter.TableCatalogId (string) required
DatabaseName (string) required
TableName (string) required
Name (string) required
lakeformation/get_data_lake_principalReturns the identity of the invoking principal.No parameters
lakeformation/get_data_lake_settingsRetrieves the list of the data lake administrators of a Lake Formation-managed data lake.CatalogId (string)
lakeformation/get_effective_permissions_for_pathReturns 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.CatalogId (string)
ResourceArn (string) required
NextToken (string)
MaxResults (integer)
lakeformation/get_lftagReturns an LF-tag definition.CatalogId (string)
TagKey (string) required
lakeformation/get_lftag_expressionReturns the details about the LF-Tag expression. The caller must be a data lake admin or must have DESCRIBE permission on the LF-Tag expression resource.Name (string) required
CatalogId (string)
lakeformation/get_query_stateReturns 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.QueryId (string) required
lakeformation/get_query_statisticsRetrieves statistics on the planning and execution of a query.QueryId (string) required
lakeformation/get_resource_lftagsReturns the LF-tags applied to a resource.CatalogId (string)
Resource: {
. Catalog (object)
. Database (object)
. Table (object)
. TableWithColumns (object)
. DataLocation (object)
. DataCellsFilter (object)
. LFTag (object)
. LFTagPolicy (object)
. LFTagExpression (object)
} (object) required
ShowAssignedLFTags (boolean)
lakeformation/get_table_objectsReturns 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.CatalogId (string)
DatabaseName (string) required
TableName (string) required
TransactionId (string)
QueryAsOfTime (string)
PartitionPredicate (string)
MaxResults (integer)
NextToken (string)
lakeformation/get_temporary_data_location_credentialsAllows a user or application in a secure environment to access data in a specific Amazon S3 location registered with Lake Formation by providing temporary scoped credentials that are limited to the requested data location and the caller's authorized access level. The API operation returns an error in the following scenarios: The data location is not registered with Lake Formation. No Glue table is associated with the data location. The caller doesn't have required permissions on the associated tDurationSeconds (integer)
AuditContext: {
. AdditionalAuditContext (string)
} (object)
DataLocations (array)
CredentialsScope (string)
lakeformation/get_temporary_glue_partition_credentialsThis 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.TableArn (string) required
Partition: {
. Values (array)
} (object) required
Permissions (array)
DurationSeconds (integer)
AuditContext: {
. AdditionalAuditContext (string)
} (object)
SupportedPermissionTypes (array)
lakeformation/get_temporary_glue_table_credentialsAllows 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. To call this API, the role that the service assumes must have lakeformation:GetDataAccess permission on the resource.TableArn (string) required
Permissions (array)
DurationSeconds (integer)
AuditContext: {
. AdditionalAuditContext (string)
} (object)
SupportedPermissionTypes (array)
S3Path (string)
QuerySessionContext: {
. QueryId (string)
. QueryStartTime (string)
. ClusterId (string)
. QueryAuthorizationId (string)
. AdditionalContext (object)
} (object)
lakeformation/get_work_unit_resultsReturns the work units resulting from the query. Work units can be executed in any order and in parallel.QueryId (string) required
WorkUnitId (integer) required
WorkUnitToken (string) required
lakeformation/get_work_unitsRetrieves the work units generated by the StartQueryPlanning operation.NextToken (string)
PageSize (integer)
QueryId (string) required
lakeformation/grant_permissionsGrants 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.CatalogId (string)
Principal: {
. DataLakePrincipalIdentifier (string)
} (object) required
Resource: {
. Catalog (object)
. Database (object)
. Table (object)
. TableWithColumns (object)
. DataLocation (object)
. DataCellsFilter (object)
. LFTag (object)
. LFTagPolicy (object)
. LFTagExpression (object)
} (object) required
Permissions (array) required
Condition: {
. Expression (string)
} (object)
PermissionsWithGrantOption (array)
lakeformation/list_data_cells_filterLists all the data cell filters on a table.Table: {
. CatalogId (string)
. DatabaseName (string)
. Name (string)
. TableWildcard (object)
} (object)
NextToken (string)
MaxResults (integer)
lakeformation/list_lake_formation_opt_insRetrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.Principal: {
. DataLakePrincipalIdentifier (string)
} (object)
Resource: {
. Catalog (object)
. Database (object)
. Table (object)
. TableWithColumns (object)
. DataLocation (object)
. DataCellsFilter (object)
. LFTag (object)
. LFTagPolicy (object)
. LFTagExpression (object)
} (object)
MaxResults (integer)
NextToken (string)
lakeformation/list_lftag_expressionsReturns the LF-Tag expressions in caller’s account filtered based on caller's permissions. Data Lake and read only admins implicitly can see all tag expressions in their account, else caller needs DESCRIBE permissions on tag expression.CatalogId (string)
MaxResults (integer)
NextToken (string)
lakeformation/list_lftagsLists LF-tags that the requester has permission to view.CatalogId (string)
ResourceShareType (string)
MaxResults (integer)
NextToken (string)
lakeformation/list_permissionsReturns 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. If both Principal and Resource parameters are provided, the response returns effective permissions rather than the explicitly granted permissions. For information about permissions, see Security and ACatalogId (string)
Principal: {
. DataLakePrincipalIdentifier (string)
} (object)
ResourceType (string)
Resource: {
. Catalog (object)
. Database (object)
. Table (object)
. TableWithColumns (object)
. DataLocation (object)
. DataCellsFilter (object)
. LFTag (object)
. LFTagPolicy (object)
. LFTagExpression (object)
} (object)
NextToken (string)
MaxResults (integer)
IncludeRelated (string)
lakeformation/list_resourcesLists the resources registered to be managed by the Data Catalog.FilterConditionList (array)
MaxResults (integer)
NextToken (string)
lakeformation/list_table_storage_optimizersReturns the configuration of all storage optimizers associated with a specified table.CatalogId (string)
DatabaseName (string) required
TableName (string) required
StorageOptimizerType (string)
MaxResults (integer)
NextToken (string)
lakeformation/list_transactionsReturns 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.CatalogId (string)
StatusFilter (string)
MaxResults (integer)
NextToken (string)
lakeformation/put_data_lake_settingsSets 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.CatalogId (string)
DataLakeSettings: {
. DataLakeAdmins (array)
. ReadOnlyAdmins (array)
. CreateDatabaseDefaultPermissions (array)
. CreateTableDefaultPermissions (array)
. Parameters (object)
. TrustedResourceOwners (array)
. AllowExternalDataFiltering (boolean)
. AllowFullTableExternalDataAccess (boolean)
. ExternalDataFilteringAllowList (array)
. AuthorizedSessionTagValueList (array)
} (object) required
lakeformation/register_resourceRegisters the resource as managed by the Data Catalog. To add or update data, Lake Formation needs read/write access to the chosen data location. 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. WheResourceArn (string) required
UseServiceLinkedRole (boolean)
RoleArn (string)
WithFederation (boolean)
HybridAccessEnabled (boolean)
WithPrivilegedAccess (boolean)
ExpectedResourceOwnerAccount (string)
lakeformation/remove_lftags_from_resourceRemoves 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.CatalogId (string)
Resource: {
. Catalog (object)
. Database (object)
. Table (object)
. TableWithColumns (object)
. DataLocation (object)
. DataCellsFilter (object)
. LFTag (object)
. LFTagPolicy (object)
. LFTagExpression (object)
} (object) required
LFTags (array) required
lakeformation/revoke_permissionsRevokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.CatalogId (string)
Principal: {
. DataLakePrincipalIdentifier (string)
} (object) required
Resource: {
. Catalog (object)
. Database (object)
. Table (object)
. TableWithColumns (object)
. DataLocation (object)
. DataCellsFilter (object)
. LFTag (object)
. LFTagPolicy (object)
. LFTagExpression (object)
} (object) required
Permissions (array) required
Condition: {
. Expression (string)
} (object)
PermissionsWithGrantOption (array)
lakeformation/search_databases_by_lftagsThis 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.NextToken (string)
MaxResults (integer)
CatalogId (string)
Expression (array) required
lakeformation/search_tables_by_lftagsThis 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.NextToken (string)
MaxResults (integer)
CatalogId (string)
Expression (array) required
lakeformation/start_query_planningSubmits 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.QueryPlanningContext: {
. CatalogId (string)
. DatabaseName (string)
. QueryAsOfTime (string)
. QueryParameters (object)
. TransactionId (string)
} (object) required
QueryString (string) required
lakeformation/start_transactionStarts a new transaction and returns its transaction ID. Transaction IDs are opaque objects that you can use to identify a transaction.TransactionType (string)
lakeformation/update_data_cells_filterUpdates a data cell filter.TableData: {
. TableCatalogId (string)
. DatabaseName (string)
. TableName (string)
. Name (string)
. RowFilter (object)
. ColumnNames (array)
. ColumnWildcard (object)
. VersionId (string)
} (object) required
lakeformation/update_lake_formation_identity_center_configurationUpdates the IAM Identity Center connection parameters.CatalogId (string)
ShareRecipients (array)
ServiceIntegrations (array)
ApplicationStatus (string)
ExternalFiltering: {
. Status (string)
. AuthorizedTargets (array)
} (object)
lakeformation/update_lftagUpdates 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.CatalogId (string)
TagKey (string) required
TagValuesToDelete (array)
TagValuesToAdd (array)
lakeformation/update_lftag_expressionUpdates the name of the LF-Tag expression to the new description and expression body provided. Updating a LF-Tag expression immediately changes the permission boundaries of all existing LFTagPolicy permission grants that reference the given LF-Tag expression.Name (string) required
Description (string)
CatalogId (string)
Expression (array) required
lakeformation/update_resourceUpdates the data access role used for vending access to the given registered resource in Lake Formation.RoleArn (string) required
ResourceArn (string) required
WithFederation (boolean)
HybridAccessEnabled (boolean)
ExpectedResourceOwnerAccount (string)
lakeformation/update_table_objectsUpdates the manifest of Amazon S3 objects that make up the specified governed table.CatalogId (string)
DatabaseName (string) required
TableName (string) required
TransactionId (string)
WriteOperations (array) required
lakeformation/update_table_storage_optimizerUpdates the configuration of the storage optimizers for a table.CatalogId (string)
DatabaseName (string) required
TableName (string) required
StorageOptimizerConfig (object) required
lambda/checkpoint_durable_executionSaves the progress of a durable function execution during runtime. This API is used by the Lambda durable functions SDK to checkpoint completed steps and schedule asynchronous operations. You typically don't need to call this API directly as the SDK handles checkpointing automatically. Each checkpoint operation consumes the current checkpoint token and returns a new one for the next checkpoint. This ensures that checkpoints are applied in the correct order and prevents duplicate or out-of-orderDurableExecutionArn (string) required
CheckpointToken (string) required
Updates (array)
ClientToken (string)
lambda/delete_functionDeletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit permissions for DeleteAlias. A deleted Lambda function cannot be recovered. Ensure that you specify the correct function name and version before deleting. To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke yoFunctionName (string) required
Qualifier (string)
lambda/delete_function_event_invoke_configDeletes the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.FunctionName (string) required
Qualifier (string)
lambda/get_account_settingsRetrieves details about your account's limits and usage in an Amazon Web Services Region.No parameters
lambda/get_durable_executionRetrieves detailed information about a specific durable execution, including its current status, input payload, result or error information, and execution metadata such as start time and usage statistics.DurableExecutionArn (string) required
lambda/get_durable_execution_historyRetrieves the execution history for a durable execution, showing all the steps, callbacks, and events that occurred during the execution. This provides a detailed audit trail of the execution's progress over time. The history is available while the execution is running and for a retention period after it completes 1-90 days, default 30 days. You can control whether to include execution data such as step results and callback payloads.DurableExecutionArn (string) required
IncludeExecutionData (boolean)
MaxItems (integer)
Marker (string)
ReverseOrder (boolean)
lambda/get_durable_execution_stateRetrieves the current execution state required for the replay process during durable function execution. This API is used by the Lambda durable functions SDK to get state information needed for replay. You typically don't need to call this API directly as the SDK handles state management automatically. The response contains operations ordered by start sequence number in ascending order. Completed operations with children don't include child operation details since they don't need to be replayed.DurableExecutionArn (string) required
CheckpointToken (string) required
Marker (string)
MaxItems (integer)
lambda/get_function_event_invoke_configRetrieves the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.FunctionName (string) required
Qualifier (string)
lambda/list_durable_executions_by_functionReturns a list of durable executions for a specified Lambda function. You can filter the results by execution name, status, and start time range. This API supports pagination for large result sets.FunctionName (string) required
Qualifier (string)
DurableExecutionName (string)
Statuses (array)
StartedAfter (string)
StartedBefore (string)
ReverseOrder (boolean)
Marker (string)
MaxItems (integer)
lambda/list_function_event_invoke_configsRetrieves a list of configurations for asynchronous invocation for a function. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.FunctionName (string) required
Marker (string)
MaxItems (integer)
lambda/list_tagsReturns a function, event source mapping, or code signing configuration's tags. You can also view function tags with GetFunction.Resource (string) required
lambda/put_function_event_invoke_configConfigures 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 failsFunctionName (string) required
Qualifier (string)
MaximumRetryAttempts (integer)
MaximumEventAgeInSeconds (integer)
DestinationConfig: {
. OnSuccess (object)
. OnFailure (object)
} (object)
lambda/send_durable_execution_callback_failureSends a failure response for a callback operation in a durable execution. Use this API when an external system cannot complete a callback operation successfully.CallbackId (string) required
Error: {
. ErrorMessage (string)
. ErrorType (string)
. ErrorData (string)
. StackTrace (array)
} (object)
lambda/send_durable_execution_callback_heartbeatSends a heartbeat signal for a long-running callback operation to prevent timeout. Use this API to extend the callback timeout period while the external operation is still in progress.CallbackId (string) required
lambda/send_durable_execution_callback_successSends a successful completion response for a callback operation in a durable execution. Use this API when an external system has successfully completed a callback operation.CallbackId (string) required
Result (string)
lambda/stop_durable_executionStops a running durable execution. The execution transitions to STOPPED status and cannot be resumed. Any in-progress operations are terminated.DurableExecutionArn (string) required
Error: {
. ErrorMessage (string)
. ErrorType (string)
. ErrorData (string)
. StackTrace (array)
} (object)
lambda/tag_resourceAdds tags to a function, event source mapping, or code signing configuration.Resource (string) required
Tags (object) required
lambda/untag_resourceRemoves tags from a function, event source mapping, or code signing configuration.Resource (string) required
TagKeys (array) required
lambda/update_function_event_invoke_configUpdates the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.FunctionName (string) required
Qualifier (string)
MaximumRetryAttempts (integer)
MaximumEventAgeInSeconds (integer)
DestinationConfig: {
. OnSuccess (object)
. OnFailure (object)
} (object)
lambda/list_function_versions_by_capacity_providerReturns a list of function versions that are configured to use a specific capacity provider.CapacityProviderName (string) required
Marker (string)
MaxItems (integer)
lambda/get_capacity_providerRetrieves information about a specific capacity provider, including its configuration, state, and associated resources.CapacityProviderName (string) required
lambda/update_capacity_providerUpdates the configuration of an existing capacity provider.CapacityProviderName (string) required
CapacityProviderScalingConfig: {
. MaxVCpuCount (integer)
. ScalingMode (string)
. ScalingPolicies (array)
} (object)
lambda/delete_capacity_providerDeletes a capacity provider. You cannot delete a capacity provider that is currently being used by Lambda functions.CapacityProviderName (string) required
lambda/list_capacity_providersReturns a list of capacity providers in your account.State (string)
Marker (string)
MaxItems (integer)
lambda/create_capacity_providerCreates a capacity provider that manages compute resources for Lambda functionsCapacityProviderName (string) required
VpcConfig: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object) required
PermissionsConfig: {
. CapacityProviderOperatorRoleArn (string)
} (object) required
InstanceRequirements: {
. Architectures (array)
. AllowedInstanceTypes (array)
. ExcludedInstanceTypes (array)
} (object)
CapacityProviderScalingConfig: {
. MaxVCpuCount (integer)
. ScalingMode (string)
. ScalingPolicies (array)
} (object)
KmsKeyArn (string)
Tags (object)
lambda/delete_code_signing_configDeletes the code signing configuration. You can delete the code signing configuration only if no function is using it.CodeSigningConfigArn (string) required
lambda/get_code_signing_configReturns information about the specified code signing configuration.CodeSigningConfigArn (string) required
lambda/list_functions_by_code_signing_configList 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.CodeSigningConfigArn (string) required
Marker (string)
MaxItems (integer)
lambda/update_code_signing_configUpdate 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.CodeSigningConfigArn (string) required
Description (string)
AllowedPublishers: {
. SigningProfileVersionArns (array)
} (object)
CodeSigningPolicies: {
. UntrustedArtifactOnDeployment (string)
} (object)
lambda/create_code_signing_configCreates 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.Description (string)
AllowedPublishers: {
. SigningProfileVersionArns (array)
} (object) required
CodeSigningPolicies: {
. UntrustedArtifactOnDeployment (string)
} (object)
Tags (object)
lambda/list_code_signing_configsReturns 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.Marker (string)
MaxItems (integer)
lambda/create_event_source_mappingCreates 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 Amazon DocumentDB The following error handling options are available for stream sources DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka: BisectBatchOnFunctionError – If thEventSourceArn (string)
FunctionName (string) required
Enabled (boolean)
BatchSize (integer)
FilterCriteria: {
. Filters (array)
} (object)
MaximumBatchingWindowInSeconds (integer)
ParallelizationFactor (integer)
StartingPosition (string)
StartingPositionTimestamp (string)
DestinationConfig: {
. OnSuccess (object)
. OnFailure (object)
} (object)
MaximumRecordAgeInSeconds (integer)
BisectBatchOnFunctionError (boolean)
MaximumRetryAttempts (integer)
Tags (object)
TumblingWindowInSeconds (integer)
Topics (array)
Queues (array)
SourceAccessConfigurations (array)
SelfManagedEventSource: {
. Endpoints (object)
} (object)
FunctionResponseTypes (array)
AmazonManagedKafkaEventSourceConfig: {
. ConsumerGroupId (string)
. SchemaRegistryConfig (object)
} (object)
SelfManagedKafkaEventSourceConfig: {
. ConsumerGroupId (string)
. SchemaRegistryConfig (object)
} (object)
ScalingConfig: {
. MaximumConcurrency (integer)
} (object)
DocumentDBEventSourceConfig: {
. DatabaseName (string)
. CollectionName (string)
. FullDocument (string)
} (object)
KMSKeyArn (string)
MetricsConfig: {
. Metrics (array)
} (object)
LoggingConfig: {
. SystemLogLevel (string)
} (object)
ProvisionedPollerConfig: {
. MinimumPollers (integer)
. MaximumPollers (integer)
. PollerGroupName (string)
} (object)
lambda/get_event_source_mappingReturns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.UUID (string) required
lambda/update_event_source_mappingUpdates 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 Amazon DocumentDB The following error handling options are available for stream sources DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka: BisectBatchOnFunctionErrUUID (string) required
FunctionName (string)
Enabled (boolean)
BatchSize (integer)
FilterCriteria: {
. Filters (array)
} (object)
MaximumBatchingWindowInSeconds (integer)
DestinationConfig: {
. OnSuccess (object)
. OnFailure (object)
} (object)
MaximumRecordAgeInSeconds (integer)
BisectBatchOnFunctionError (boolean)
MaximumRetryAttempts (integer)
ParallelizationFactor (integer)
SourceAccessConfigurations (array)
TumblingWindowInSeconds (integer)
FunctionResponseTypes (array)
ScalingConfig: {
. MaximumConcurrency (integer)
} (object)
AmazonManagedKafkaEventSourceConfig: {
. ConsumerGroupId (string)
. SchemaRegistryConfig (object)
} (object)
SelfManagedKafkaEventSourceConfig: {
. ConsumerGroupId (string)
. SchemaRegistryConfig (object)
} (object)
DocumentDBEventSourceConfig: {
. DatabaseName (string)
. CollectionName (string)
. FullDocument (string)
} (object)
KMSKeyArn (string)
MetricsConfig: {
. Metrics (array)
} (object)
LoggingConfig: {
. SystemLogLevel (string)
} (object)
ProvisionedPollerConfig: {
. MinimumPollers (integer)
. MaximumPollers (integer)
. PollerGroupName (string)
} (object)
lambda/delete_event_source_mappingDeletes 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.UUID (string) required
lambda/list_event_source_mappingsLists event source mappings. Specify an EventSourceArn to show only event source mappings for a single event source.EventSourceArn (string)
FunctionName (string)
Marker (string)
MaxItems (integer)
lambda/create_function_url_configCreates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTPS endpoint that you can use to invoke your function.FunctionName (string) required
Qualifier (string)
AuthType (string) required
Cors: {
. AllowCredentials (boolean)
. AllowHeaders (array)
. AllowMethods (array)
. AllowOrigins (array)
. ExposeHeaders (array)
. MaxAge (integer)
} (object)
InvokeMode (string)
lambda/delete_function_concurrencyRemoves a concurrent execution limit from a function.FunctionName (string) required
lambda/delete_function_url_configDeletes 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.FunctionName (string) required
Qualifier (string)
lambda/get_function_concurrencyReturns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.FunctionName (string) required
lambda/get_function_url_configReturns details about a Lambda function URL.FunctionName (string) required
Qualifier (string)
lambda/list_function_url_configsReturns a list of Lambda function URLs for the specified function.FunctionName (string) required
Marker (string)
MaxItems (integer)
lambda/list_provisioned_concurrency_configsRetrieves a list of provisioned concurrency configurations for a function.FunctionName (string) required
Marker (string)
MaxItems (integer)
lambda/put_function_concurrencySets 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 yourFunctionName (string) required
ReservedConcurrentExecutions (integer) required
lambda/update_function_codeUpdates 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 for Lambda. If the function's package type is Image, then 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, then you must specify the deployment package as a .zip file archive. Enter the Amazon S3 bucket and key of theFunctionName (string) required
ZipFile (string)
S3Bucket (string)
S3Key (string)
S3ObjectVersion (string)
ImageUri (string)
Publish (boolean)
DryRun (boolean)
RevisionId (string)
Architectures (array)
SourceKMSKeyArn (string)
PublishTo (string)
lambda/update_function_configurationModify 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 procFunctionName (string) required
Role (string)
Handler (string)
Description (string)
Timeout (integer)
MemorySize (integer)
VpcConfig: {
. SubnetIds (array)
. SecurityGroupIds (array)
. Ipv6AllowedForDualStack (boolean)
} (object)
Environment: {
. Variables (object)
} (object)
Runtime (string)
DeadLetterConfig: {
. TargetArn (string)
} (object)
KMSKeyArn (string)
TracingConfig: {
. Mode (string)
} (object)
RevisionId (string)
Layers (array)
FileSystemConfigs (array)
ImageConfig: {
. EntryPoint (array)
. Command (array)
. WorkingDirectory (string)
} (object)
EphemeralStorage: {
. Size (integer)
} (object)
SnapStart: {
. ApplyOn (string)
} (object)
LoggingConfig: {
. LogFormat (string)
. ApplicationLogLevel (string)
. SystemLogLevel (string)
. LogGroup (string)
} (object)
CapacityProviderConfig: {
. LambdaManagedInstancesCapacityProviderConfig (object)
} (object)
DurableConfig: {
. RetentionPeriodInDays (integer)
. ExecutionTimeout (integer)
} (object)
lambda/update_function_url_configUpdates the configuration for a Lambda function URL.FunctionName (string) required
Qualifier (string)
AuthType (string)
Cors: {
. AllowCredentials (boolean)
. AllowHeaders (array)
. AllowMethods (array)
. AllowOrigins (array)
. ExposeHeaders (array)
. MaxAge (integer)
} (object)
InvokeMode (string)
lambda/delete_function_code_signing_configRemoves the code signing configuration from the function.FunctionName (string) required
lambda/get_functionReturns 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.FunctionName (string) required
Qualifier (string)
lambda/get_function_code_signing_configReturns the code signing configuration for the specified function.FunctionName (string) required
lambda/get_function_configurationReturns 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.FunctionName (string) required
Qualifier (string)
lambda/get_function_recursion_configReturns your function's recursive loop detection configuration.FunctionName (string) required
lambda/get_function_scaling_configRetrieves the scaling configuration for a Lambda Managed Instances function.FunctionName (string) required
Qualifier (string) required
lambda/get_policyReturns the resource-based IAM policy for a function, version, or alias.FunctionName (string) required
Qualifier (string)
lambda/get_runtime_management_configRetrieves the runtime management configuration for a function's version. If the runtime update mode is Manual, this includes the ARN of the runtime version and the runtime update mode. If the runtime update mode is Auto or Function update, this includes the runtime update mode and null is returned for the ARN. For more information, see Runtime updates.FunctionName (string) required
Qualifier (string)
lambda/invokeInvokes a Lambda function. You can invoke a function synchronously and wait for the response, or asynchronously. By default, Lambda invokes your function synchronously i.e. theInvocationType is RequestResponse. To invoke a function asynchronously, set InvocationType to Event. Lambda passes the ClientContext object to your function for synchronous invocations only. For synchronous invocations, the maximum payload size is 6 MB. For asynchronous invocations, the maximum payload size is 1 MB. For syFunctionName (string) required
InvocationType (string)
LogType (string)
ClientContext (string)
DurableExecutionName (string)
Payload (string)
Qualifier (string)
TenantId (string)
lambda/invoke_asyncFor asynchronous function invocation, use Invoke. Invokes a function asynchronously. The payload limit is 256KB. For larger payloads, for up to 1MB, use Invoke. If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not propagated to the function, even if X-Ray active tracing is turned on.FunctionName (string) required
InvokeArgs (string) required
lambda/invoke_with_response_streamConfigure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses. 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.FunctionName (string) required
InvocationType (string)
LogType (string)
ClientContext (string)
Qualifier (string)
Payload (string)
TenantId (string)
lambda/put_function_code_signing_configUpdate 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.CodeSigningConfigArn (string) required
FunctionName (string) required
lambda/put_function_recursion_configSets your function's recursive loop detection configuration. When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service Amazon SQS queue, which then invokes the same function. This invocation causes the function to write another message to the queue, which in turn invokes the function again. Lambda can detect cerFunctionName (string) required
RecursiveLoop (string) required
lambda/put_function_scaling_configSets the scaling configuration for a Lambda Managed Instances function. The scaling configuration defines the minimum and maximum number of execution environments that can be provisioned for the function, allowing you to control scaling behavior and resource allocation.FunctionName (string) required
Qualifier (string) required
FunctionScalingConfig: {
. MinExecutionEnvironments (integer)
. MaxExecutionEnvironments (integer)
} (object)
lambda/put_runtime_management_configSets the runtime management configuration for a function's version. For more information, see Runtime updates.FunctionName (string) required
Qualifier (string)
UpdateRuntimeOn (string) required
RuntimeVersionArn (string)
lambda/list_functionsReturns 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 operation returns a subset of the FunctionConfiguration fields. To get the additional fields State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode, RuntimeVersionConfig for a functionMasterRegion (string)
FunctionVersion (string)
Marker (string)
MaxItems (integer)
lambda/create_functionCreates 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. If the deployment package is a container image, then you set the package type to Image. For a container image, the code property musFunctionName (string) required
Runtime (string)
Role (string) required
Handler (string)
Code: {
. ZipFile (string)
. S3Bucket (string)
. S3Key (string)
. S3ObjectVersion (string)
. ImageUri (string)
. SourceKMSKeyArn (string)
} (object) required
Description (string)
Timeout (integer)
MemorySize (integer)
Publish (boolean)
VpcConfig: {
. SubnetIds (array)
. SecurityGroupIds (array)
. Ipv6AllowedForDualStack (boolean)
} (object)
PackageType (string)
DeadLetterConfig: {
. TargetArn (string)
} (object)
Environment: {
. Variables (object)
} (object)
KMSKeyArn (string)
TracingConfig: {
. Mode (string)
} (object)
Tags (object)
Layers (array)
FileSystemConfigs (array)
ImageConfig: {
. EntryPoint (array)
. Command (array)
. WorkingDirectory (string)
} (object)
CodeSigningConfigArn (string)
Architectures (array)
EphemeralStorage: {
. Size (integer)
} (object)
SnapStart: {
. ApplyOn (string)
} (object)
LoggingConfig: {
. LogFormat (string)
. ApplicationLogLevel (string)
. SystemLogLevel (string)
. LogGroup (string)
} (object)
CapacityProviderConfig: {
. LambdaManagedInstancesCapacityProviderConfig (object)
} (object)
PublishTo (string)
DurableConfig: {
. RetentionPeriodInDays (integer)
. ExecutionTimeout (integer)
} (object)
TenancyConfig: {
. TenantIsolationMode (string)
} (object)
lambda/get_aliasReturns details about a Lambda function alias.FunctionName (string) required
Name (string) required
lambda/update_aliasUpdates the configuration of a Lambda function alias.FunctionName (string) required
Name (string) required
FunctionVersion (string)
Description (string)
RoutingConfig: {
. AdditionalVersionWeights (object)
} (object)
RevisionId (string)
lambda/delete_aliasDeletes a Lambda function alias.FunctionName (string) required
Name (string) required
lambda/list_aliasesReturns a list of aliases for a Lambda function.FunctionName (string) required
FunctionVersion (string)
Marker (string)
MaxItems (integer)
lambda/create_aliasCreates 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.FunctionName (string) required
Name (string) required
FunctionVersion (string) required
Description (string)
RoutingConfig: {
. AdditionalVersionWeights (object)
} (object)
lambda/list_versions_by_functionReturns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.FunctionName (string) required
Marker (string)
MaxItems (integer)
lambda/publish_versionCreates 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.FunctionName (string) required
CodeSha256 (string)
Description (string)
RevisionId (string)
PublishTo (string)
lambda/list_layersLists 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.CompatibleRuntime (string)
Marker (string)
MaxItems (integer)
CompatibleArchitecture (string)
lambda/add_layer_version_permissionAdds 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.LayerName (string) required
VersionNumber (integer) required
StatementId (string) required
Action (string) required
Principal (string) required
OrganizationId (string)
RevisionId (string)
lambda/delete_layer_versionDeletes 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.LayerName (string) required
VersionNumber (integer) required
lambda/get_layer_versionReturns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.LayerName (string) required
VersionNumber (integer) required
lambda/get_layer_version_by_arnReturns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.Arn (string) required
lambda/get_layer_version_policyReturns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.LayerName (string) required
VersionNumber (integer) required
lambda/publish_layer_versionCreates 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.LayerName (string) required
Description (string)
Content: {
. S3Bucket (string)
. S3Key (string)
. S3ObjectVersion (string)
. ZipFile (string)
} (object) required
CompatibleRuntimes (array)
LicenseInfo (string)
CompatibleArchitectures (array)
lambda/remove_layer_version_permissionRemoves a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.LayerName (string) required
VersionNumber (integer) required
StatementId (string) required
RevisionId (string)
lambda/list_layer_versionsLists 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.CompatibleRuntime (string)
LayerName (string) required
Marker (string)
MaxItems (integer)
CompatibleArchitecture (string)
lambda/add_permissionGrants a principal 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 OrganiFunctionName (string) required
StatementId (string) required
Action (string) required
Principal (string) required
SourceArn (string)
SourceAccount (string)
EventSourceToken (string)
Qualifier (string)
RevisionId (string)
PrincipalOrgID (string)
FunctionUrlAuthType (string)
InvokedViaFunctionUrl (boolean)
lambda/remove_permissionRevokes function-use permission from an Amazon Web Services service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy.FunctionName (string) required
StatementId (string) required
Qualifier (string)
RevisionId (string)
lambda/get_provisioned_concurrency_configRetrieves the provisioned concurrency configuration for a function's alias or version.FunctionName (string) required
Qualifier (string) required
lambda/delete_provisioned_concurrency_configDeletes the provisioned concurrency configuration for a function.FunctionName (string) required
Qualifier (string) required
lambda/put_provisioned_concurrency_configAdds a provisioned concurrency configuration to a function's alias or version.FunctionName (string) required
Qualifier (string) required
ProvisionedConcurrentExecutions (integer) required
launch_wizard/list_tags_for_resourceLists the tags associated with a specified resource.resourceArn (string) required
launch_wizard/tag_resourceAdds the specified tags to the given resource.resourceArn (string) required
tags (object) required
launch_wizard/untag_resourceRemoves the specified tags from the given resource.resourceArn (string) required
tagKeys (array) required
launch_wizard/create_deploymentCreates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.workloadName (string) required
deploymentPatternName (string) required
name (string) required
specifications (object) required
dryRun (boolean)
tags (object)
launch_wizard/get_deploymentReturns information about the deployment.deploymentId (string) required
launch_wizard/update_deploymentUpdates a deployment.deploymentId (string) required
specifications (object) required
workloadVersionName (string)
deploymentPatternVersionName (string)
dryRun (boolean)
force (boolean)
launch_wizard/delete_deploymentDeletes a deployment.deploymentId (string) required
launch_wizard/list_deploymentsLists the deployments that have been created.filters (array)
maxResults (integer)
nextToken (string)
launch_wizard/list_deployment_eventsLists the events of a deployment.deploymentId (string) required
maxResults (integer)
nextToken (string)
launch_wizard/get_workloadReturns information about a workload.workloadName (string) required
launch_wizard/list_workloadsLists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.maxResults (integer)
nextToken (string)
launch_wizard/get_workload_deployment_patternReturns details for a given workload and deployment pattern, including the available specifications. You can use the ListWorkloads operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment pattern names of a given workload.workloadName (string) required
deploymentPatternName (string) required
launch_wizard/list_workload_deployment_patternsLists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.workloadName (string) required
maxResults (integer)
nextToken (string)
launch_wizard/get_deployment_pattern_versionReturns information about a deployment pattern version.workloadName (string) required
deploymentPatternName (string) required
deploymentPatternVersionName (string) required
launch_wizard/list_deployment_pattern_versionsLists the deployment pattern versions.workloadName (string) required
deploymentPatternName (string) required
maxResults (integer)
nextToken (string)
filters (array)
lex_model_building_service/create_bot_versionCreates 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 iname (string) required
checksum (string)
lex_model_building_service/create_intent_versionCreates 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.name (string) required
checksum (string)
lex_model_building_service/create_slot_type_versionCreates 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 versionname (string) required
checksum (string)
lex_model_building_service/delete_botDeletes 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 haname (string) required
lex_model_building_service/delete_bot_aliasDeletes 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 DeleteBotAliasname (string) required
botName (string) required
lex_model_building_service/delete_bot_channel_associationDeletes the association between an Amazon Lex bot and a messaging platform. This operation requires permission for the lex:DeleteBotChannelAssociation action.name (string) required
botName (string) required
botAlias (string) required
lex_model_building_service/delete_bot_versionDeletes 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.name (string) required
version (string) required
lex_model_building_service/delete_intentDeletes 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,name (string) required
lex_model_building_service/delete_intent_versionDeletes 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.name (string) required
version (string) required
lex_model_building_service/delete_slot_typeDeletes 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 rename (string) required
lex_model_building_service/delete_slot_type_versionDeletes 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.name (string) required
version (string) required
lex_model_building_service/delete_utterancesDeletes 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 immedbotName (string) required
userId (string) required
lex_model_building_service/get_botReturns 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.name (string) required
versionOrAlias (string) required
lex_model_building_service/get_bot_aliasReturns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:GetBotAlias action.name (string) required
botName (string) required
lex_model_building_service/get_bot_aliasesReturns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the lex:GetBotAliases action.botName (string) required
nextToken (string)
maxResults (integer)
nameContains (string)
lex_model_building_service/get_bot_channel_associationReturns information about the association between an Amazon Lex bot and a messaging platform. This operation requires permissions for the lex:GetBotChannelAssociation action.name (string) required
botName (string) required
botAlias (string) required
lex_model_building_service/get_bot_channel_associationsReturns a list of all of the channels associated with the specified bot. The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.botName (string) required
botAlias (string) required
nextToken (string)
maxResults (integer)
nameContains (string)
lex_model_building_service/get_botsReturns 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.nextToken (string)
maxResults (integer)
nameContains (string)
lex_model_building_service/get_bot_versionsGets 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.name (string) required
nextToken (string)
maxResults (integer)
lex_model_building_service/get_builtin_intentReturns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent action.signature (string) required
lex_model_building_service/get_builtin_intentsGets a list of built-in intents that meet the specified criteria. This operation requires permission for the lex:GetBuiltinIntents action.locale (string)
signatureContains (string)
nextToken (string)
maxResults (integer)
lex_model_building_service/get_builtin_slot_typesGets 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.locale (string)
signatureContains (string)
nextToken (string)
maxResults (integer)
lex_model_building_service/get_exportExports the contents of a Amazon Lex resource in a specified format.name (string) required
version (string) required
resourceType (string) required
exportType (string) required
lex_model_building_service/get_importGets information about an import job started with the StartImport operation.importId (string) required
lex_model_building_service/get_intentReturns 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.name (string) required
version (string) required
lex_model_building_service/get_intentsReturns 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.nextToken (string)
maxResults (integer)
nameContains (string)
lex_model_building_service/get_intent_versionsGets 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:GetIntname (string) required
nextToken (string)
maxResults (integer)
lex_model_building_service/get_migrationProvides 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.migrationId (string) required
lex_model_building_service/get_migrationsGets a list of migrations between Amazon Lex V1 and Amazon Lex V2.sortByAttribute (string)
sortByOrder (string)
v1BotNameContains (string)
migrationStatusEquals (string)
maxResults (integer)
nextToken (string)
lex_model_building_service/get_slot_typeReturns 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.name (string) required
version (string) required
lex_model_building_service/get_slot_typesReturns 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.nextToken (string)
maxResults (integer)
nameContains (string)
lex_model_building_service/get_slot_type_versionsGets 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 lename (string) required
nextToken (string)
maxResults (integer)
lex_model_building_service/get_utterances_viewUse 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 couldbotName (string) required
botVersions (array) required
statusType (string) required
lex_model_building_service/list_tags_for_resourceGets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.resourceArn (string) required
lex_model_building_service/put_botCreates 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 informationname (string) required
description (string)
intents (array)
enableModelImprovements (boolean)
nluIntentConfidenceThreshold (number)
clarificationPrompt: {
. messages (array)
. maxAttempts (integer)
. responseCard (string)
} (object)
abortStatement: {
. messages (array)
. responseCard (string)
} (object)
idleSessionTTLInSeconds (integer)
voiceId (string)
checksum (string)
processBehavior (string)
locale (string) required
childDirected (boolean) required
detectSentiment (boolean)
createVersion (boolean)
tags (array)
lex_model_building_service/put_bot_aliasCreates 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.name (string) required
description (string)
botVersion (string) required
botName (string) required
checksum (string)
conversationLogs: {
. logSettings (array)
. iamRoleArn (string)
} (object)
tags (array)
lex_model_building_service/put_intentCreates 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 informationname (string) required
description (string)
slots (array)
sampleUtterances (array)
confirmationPrompt: {
. messages (array)
. maxAttempts (integer)
. responseCard (string)
} (object)
rejectionStatement: {
. messages (array)
. responseCard (string)
} (object)
followUpPrompt: {
. prompt (object)
. rejectionStatement (object)
} (object)
conclusionStatement: {
. messages (array)
. responseCard (string)
} (object)
dialogCodeHook: {
. uri (string)
. messageVersion (string)
} (object)
fulfillmentActivity: {
. type (string)
. codeHook (object)
} (object)
parentIntentSignature (string)
checksum (string)
createVersion (boolean)
kendraConfiguration: {
. kendraIndex (string)
. queryFilterString (string)
. role (string)
} (object)
inputContexts (array)
outputContexts (array)
lex_model_building_service/put_slot_typeCreates 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 rename (string) required
description (string)
enumerationValues (array)
checksum (string)
valueSelectionStrategy (string)
createVersion (boolean)
parentSlotTypeSignature (string)
slotTypeConfigurations (array)
lex_model_building_service/start_importStarts a job to import a resource to Amazon Lex.payload (string) required
resourceType (string) required
mergeStrategy (string) required
tags (array)
lex_model_building_service/start_migrationStarts 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.v1BotName (string) required
v1BotVersion (string) required
v2BotName (string) required
v2BotRole (string) required
migrationStrategy (string) required
lex_model_building_service/tag_resourceAdds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.resourceArn (string) required
tags (array) required
lex_model_building_service/untag_resourceRemoves tags from a bot, bot alias or bot channel.resourceArn (string) required
tagKeys (array) required
lex_models_v2/batch_create_custom_vocabulary_itemCreate a batch of custom vocabulary items for a given bot locale's custom vocabulary.botId (string) required
botVersion (string) required
localeId (string) required
customVocabularyItemList (array) required
lex_models_v2/batch_delete_custom_vocabulary_itemDelete a batch of custom vocabulary items for a given bot locale's custom vocabulary.botId (string) required
botVersion (string) required
localeId (string) required
customVocabularyItemList (array) required
lex_models_v2/batch_update_custom_vocabulary_itemUpdate a batch of custom vocabulary items for a given bot locale's custom vocabulary.botId (string) required
botVersion (string) required
localeId (string) required
customVocabularyItemList (array) required
lex_models_v2/build_bot_localeBuilds 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.botId (string) required
botVersion (string) required
localeId (string) required
lex_models_v2/create_botCreates an Amazon Lex conversational bot.botName (string) required
description (string)
roleArn (string) required
dataPrivacy: {
. childDirected (boolean)
} (object) required
idleSessionTTLInSeconds (integer) required
botTags (object)
testBotAliasTags (object)
botType (string)
botMembers (array)
errorLogSettings: {
. enabled (boolean)
} (object)
lex_models_v2/create_bot_aliasCreates 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.botAliasName (string) required
description (string)
botVersion (string)
botAliasLocaleSettings (object)
conversationLogSettings: {
. textLogSettings (array)
. audioLogSettings (array)
} (object)
sentimentAnalysisSettings: {
. detectSentiment (boolean)
} (object)
botId (string) required
tags (object)
lex_models_v2/create_bot_localeCreates 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.botId (string) required
botVersion (string) required
localeId (string) required
description (string)
nluIntentConfidenceThreshold (number) required
voiceSettings: {
. engine (string)
. voiceId (string)
} (object)
unifiedSpeechSettings: {
. speechFoundationModel (object)
} (object)
speechRecognitionSettings: {
. speechModelPreference (string)
. speechModelConfig (object)
} (object)
generativeAISettings: {
. runtimeSettings (object)
. buildtimeSettings (object)
} (object)
speechDetectionSensitivity (string)
lex_models_v2/create_bot_replicaAction to create a replication of the source bot in the secondary region.botId (string) required
replicaRegion (string) required
lex_models_v2/create_bot_versionCreates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.botId (string) required
description (string)
botVersionLocaleSpecification (object) required
lex_models_v2/create_exportCreates 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 botsresourceSpecification: {
. botExportSpecification (object)
. botLocaleExportSpecification (object)
. customVocabularyExportSpecification (object)
. testSetExportSpecification (object)
} (object) required
fileFormat (string) required
filePassword (string)
lex_models_v2/create_intentCreates 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 requesintentName (string) required
intentDisplayName (string)
description (string)
parentIntentSignature (string)
sampleUtterances (array)
dialogCodeHook: {
. enabled (boolean)
} (object)
fulfillmentCodeHook: {
. enabled (boolean)
. postFulfillmentStatusSpecification (object)
. fulfillmentUpdatesSpecification (object)
. active (boolean)
} (object)
intentConfirmationSetting: {
. promptSpecification (object)
. declinationResponse (object)
. active (boolean)
. confirmationResponse (object)
. confirmationNextStep (object)
. confirmationConditional (object)
. declinationNextStep (object)
. declinationConditional (object)
. failureResponse (object)
. failureNextStep (object)
. failureConditional (object)
. codeHook (object)
. elicitationCodeHook (object)
} (object)
intentClosingSetting: {
. closingResponse (object)
. active (boolean)
. nextStep (object)
. conditional (object)
} (object)
inputContexts (array)
outputContexts (array)
kendraConfiguration: {
. kendraIndex (string)
. queryFilterStringEnabled (boolean)
. queryFilterString (string)
} (object)
botId (string) required
botVersion (string) required
localeId (string) required
initialResponseSetting: {
. initialResponse (object)
. nextStep (object)
. conditional (object)
. codeHook (object)
} (object)
qnAIntentConfiguration: {
. dataSourceConfiguration (object)
. bedrockModelConfiguration (object)
} (object)
qInConnectIntentConfiguration: {
. qInConnectAssistantConfiguration (object)
} (object)
lex_models_v2/create_resource_policyCreates a new resource policy with the specified policy statements.resourceArn (string) required
policy (string) required
lex_models_v2/create_resource_policy_statementAdds 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. You need to add the CreateResourcePolicy or UpdateResourcePolicy action to the bot role in order to call the API.resourceArn (string) required
statementId (string) required
effect (string) required
principal (array) required
action (array) required
condition (object)
expectedRevisionId (string)
lex_models_v2/create_slotCreates 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.slotName (string) required
description (string)
slotTypeId (string)
valueElicitationSetting: {
. defaultValueSpecification (object)
. slotConstraint (string)
. promptSpecification (object)
. sampleUtterances (array)
. waitAndContinueSpecification (object)
. slotCaptureSetting (object)
. slotResolutionSetting (object)
} (object) required
obfuscationSetting: {
. obfuscationSettingType (string)
} (object)
botId (string) required
botVersion (string) required
localeId (string) required
intentId (string) required
multipleValuesSetting: {
. allowMultipleValues (boolean)
} (object)
subSlotSetting: {
. expression (string)
. slotSpecifications (object)
} (object)
lex_models_v2/create_slot_typeCreates 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.slotTypeName (string) required
description (string)
slotTypeValues (array)
valueSelectionSetting: {
. resolutionStrategy (string)
. regexFilter (object)
. advancedRecognitionSetting (object)
} (object)
parentSlotTypeSignature (string)
botId (string) required
botVersion (string) required
localeId (string) required
externalSourceSetting: {
. grammarSlotTypeSetting (object)
} (object)
compositeSlotTypeSetting: {
. subSlots (array)
} (object)
lex_models_v2/create_test_set_discrepancy_reportCreate a report that describes the differences between the bot and the test set.testSetId (string) required
target: {
. botAliasTarget (object)
} (object) required
lex_models_v2/create_upload_urlGets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.No parameters
lex_models_v2/delete_botDeletes 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.botId (string) required
skipResourceInUseCheck (boolean)
lex_models_v2/delete_bot_aliasDeletes the specified bot alias.botAliasId (string) required
botId (string) required
skipResourceInUseCheck (boolean)
lex_models_v2/delete_bot_localeRemoves a locale from a bot. When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.botId (string) required
botVersion (string) required
localeId (string) required
lex_models_v2/delete_bot_replicaThe action to delete the replicated bot in the secondary region.botId (string) required
replicaRegion (string) required
lex_models_v2/delete_bot_versionDeletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.botId (string) required
botVersion (string) required
skipResourceInUseCheck (boolean)
lex_models_v2/delete_custom_vocabularyRemoves a custom vocabulary from the specified locale in the specified bot.botId (string) required
botVersion (string) required
localeId (string) required
lex_models_v2/delete_exportRemoves a previous export and the associated files stored in an S3 bucket.exportId (string) required
lex_models_v2/delete_importRemoves a previous import and the associated file stored in an S3 bucket.importId (string) required
lex_models_v2/delete_intentRemoves the specified intent. Deleting an intent also deletes the slots associated with the intent.intentId (string) required
botId (string) required
botVersion (string) required
localeId (string) required
lex_models_v2/delete_resource_policyRemoves an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.resourceArn (string) required
expectedRevisionId (string)
lex_models_v2/delete_resource_policy_statementDeletes 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. You need to add the DeleteResourcePolicy or UpdateResourcePolicy action to the bot role in order to call the API.resourceArn (string) required
statementId (string) required
expectedRevisionId (string)
lex_models_v2/delete_slotDeletes the specified slot from an intent.slotId (string) required
botId (string) required
botVersion (string) required
localeId (string) required
intentId (string) required
lex_models_v2/delete_slot_typeDeletes 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.slotTypeId (string) required
botId (string) required
botVersion (string) required
localeId (string) required
skipResourceInUseCheck (boolean)
lex_models_v2/delete_test_setThe action to delete the selected test set.testSetId (string) required
lex_models_v2/delete_utterancesDeletes 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 ibotId (string) required
localeId (string)
sessionId (string)
lex_models_v2/describe_botProvides metadata information about a bot.botId (string) required
lex_models_v2/describe_bot_aliasGet information about a specific bot alias.botAliasId (string) required
botId (string) required
lex_models_v2/describe_bot_localeDescribes the settings that a bot has for a specific locale.botId (string) required
botVersion (string) required
localeId (string) required
lex_models_v2/describe_bot_recommendationProvides 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.botId (string) required
botVersion (string) required
localeId (string) required
botRecommendationId (string) required
lex_models_v2/describe_bot_replicaMonitors the bot replication status through the UI console.botId (string) required
replicaRegion (string) required
lex_models_v2/describe_bot_resource_generationReturns information about a request to generate a bot through natural language description, made through the StartBotResource API. Use the generatedBotLocaleUrl to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.botId (string) required
botVersion (string) required
localeId (string) required
generationId (string) required
lex_models_v2/describe_bot_versionProvides metadata about a version of a bot.botId (string) required
botVersion (string) required
lex_models_v2/describe_custom_vocabulary_metadataProvides metadata information about a custom vocabulary.botId (string) required
botVersion (string) required
localeId (string) required
lex_models_v2/describe_exportGets information about a specific export.exportId (string) required
lex_models_v2/describe_importGets information about a specific import.importId (string) required
lex_models_v2/describe_intentReturns metadata about an intent.intentId (string) required
botId (string) required
botVersion (string) required
localeId (string) required
lex_models_v2/describe_resource_policyGets the resource policy and policy revision for a bot or bot alias.resourceArn (string) required
lex_models_v2/describe_slotGets metadata information about a slot.slotId (string) required
botId (string) required
botVersion (string) required
localeId (string) required
intentId (string) required
lex_models_v2/describe_slot_typeGets metadata information about a slot type.slotTypeId (string) required
botId (string) required
botVersion (string) required
localeId (string) required
lex_models_v2/describe_test_executionGets metadata information about the test execution.testExecutionId (string) required
lex_models_v2/describe_test_setGets metadata information about the test set.testSetId (string) required
lex_models_v2/describe_test_set_discrepancy_reportGets metadata information about the test set discrepancy report.testSetDiscrepancyReportId (string) required
lex_models_v2/describe_test_set_generationGets metadata information about the test set generation.testSetGenerationId (string) required
lex_models_v2/generate_bot_elementGenerates sample utterances for an intent.intentId (string) required
botId (string) required
botVersion (string) required
localeId (string) required
lex_models_v2/get_test_execution_artifacts_urlThe pre-signed Amazon S3 URL to download the test execution result artifacts.testExecutionId (string) required
lex_models_v2/list_aggregated_utterancesProvides 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 intentbotId (string) required
botAliasId (string)
botVersion (string)
localeId (string) required
aggregationDuration: {
. relativeAggregationDuration (object)
} (object) required
sortBy: {
. attribute (string)
. order (string)
} (object)
filters (array)
maxResults (integer)
nextToken (string)
lex_models_v2/list_bot_aliasesGets a list of aliases for the specified bot.botId (string) required
maxResults (integer)
nextToken (string)
lex_models_v2/list_bot_alias_replicasThe action to list the replicated bots created from the source bot alias.botId (string) required
replicaRegion (string) required
maxResults (integer)
nextToken (string)
lex_models_v2/list_bot_localesGets a list of locales for the specified bot.botId (string) required
botVersion (string) required
sortBy: {
. attribute (string)
. order (string)
} (object)
filters (array)
maxResults (integer)
nextToken (string)
lex_models_v2/list_bot_recommendationsGet a list of bot recommendations that meet the specified criteria.botId (string) required
botVersion (string) required
localeId (string) required
maxResults (integer)
nextToken (string)
lex_models_v2/list_bot_replicasThe action to list the replicated bots.botId (string) required
lex_models_v2/list_bot_resource_generationsLists the generation requests made for a bot locale.botId (string) required
botVersion (string) required
localeId (string) required
sortBy: {
. attribute (string)
. order (string)
} (object)
maxResults (integer)
nextToken (string)
lex_models_v2/list_botsGets a list of available bots.sortBy: {
. attribute (string)
. order (string)
} (object)
filters (array)
maxResults (integer)
nextToken (string)
lex_models_v2/list_bot_version_replicasContains information about all the versions replication statuses applicable for Global Resiliency.botId (string) required
replicaRegion (string) required
maxResults (integer)
nextToken (string)
sortBy: {
. attribute (string)
. order (string)
} (object)
lex_models_v2/list_bot_versionsGets 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.botId (string) required
sortBy: {
. attribute (string)
. order (string)
} (object)
maxResults (integer)
nextToken (string)
lex_models_v2/list_built_in_intentsGets 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.localeId (string) required
sortBy: {
. attribute (string)
. order (string)
} (object)
maxResults (integer)
nextToken (string)
lex_models_v2/list_built_in_slot_typesGets a list of built-in slot types that meet the specified criteria.localeId (string) required
sortBy: {
. attribute (string)
. order (string)
} (object)
maxResults (integer)
nextToken (string)
lex_models_v2/list_custom_vocabulary_itemsPaginated list of custom vocabulary items for a given bot locale's custom vocabulary.botId (string) required
botVersion (string) required
localeId (string) required
maxResults (integer)
nextToken (string)
lex_models_v2/list_exportsLists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.botId (string)
botVersion (string)
sortBy: {
. attribute (string)
. order (string)
} (object)
filters (array)
maxResults (integer)
nextToken (string)
localeId (string)
lex_models_v2/list_importsLists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.botId (string)
botVersion (string)
sortBy: {
. attribute (string)
. order (string)
} (object)
filters (array)
maxResults (integer)
nextToken (string)
localeId (string)
lex_models_v2/list_intent_metricsRetrieves summary metrics for the intents in your bot. The following fields are required: metrics – A list of AnalyticsIntentMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fibotId (string) required
startDateTime (string) required
endDateTime (string) required
metrics (array) required
binBy (array)
groupBy (array)
filters (array)
maxResults (integer)
nextToken (string)
lex_models_v2/list_intent_pathsRetrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required: startDateTime and endDateTime – Define a time range for which you want to retrieve results. intentPath – Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate the intentPath field with /BookCar/BookHotel to see details about how many times users invoked the BookCar and BookHotel intbotId (string) required
startDateTime (string) required
endDateTime (string) required
intentPath (string) required
filters (array)
lex_models_v2/list_intentsGet a list of intents that meet the specified criteria.botId (string) required
botVersion (string) required
localeId (string) required
sortBy: {
. attribute (string)
. order (string)
} (object)
filters (array)
maxResults (integer)
nextToken (string)
lex_models_v2/list_intent_stage_metricsRetrieves summary metrics for the stages within intents in your bot. The following fields are required: metrics – A list of AnalyticsIntentStageMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results.botId (string) required
startDateTime (string) required
endDateTime (string) required
metrics (array) required
binBy (array)
groupBy (array)
filters (array)
maxResults (integer)
nextToken (string)
lex_models_v2/list_recommended_intentsGets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.botId (string) required
botVersion (string) required
localeId (string) required
botRecommendationId (string) required
nextToken (string)
maxResults (integer)
lex_models_v2/list_session_analytics_dataRetrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways: Use the filters field to filter the results and the sortBy field to specify the values by which to sort the results. Use the maxResults field to limit the number of results to return in a single response and the nextToken fbotId (string) required
startDateTime (string) required
endDateTime (string) required
sortBy: {
. name (string)
. order (string)
} (object)
filters (array)
maxResults (integer)
nextToken (string)
lex_models_v2/list_session_metricsRetrieves summary metrics for the user sessions with your bot. The following fields are required: metrics – A list of AnalyticsSessionMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whether to calculate the Sum, Average, or Max number, and the order field to specify whether to sort the results in Ascending or Descending order. startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the opbotId (string) required
startDateTime (string) required
endDateTime (string) required
metrics (array) required
binBy (array)
groupBy (array)
filters (array)
maxResults (integer)
nextToken (string)
lex_models_v2/list_slotsGets a list of slots that match the specified criteria.botId (string) required
botVersion (string) required
localeId (string) required
intentId (string) required
sortBy: {
. attribute (string)
. order (string)
} (object)
filters (array)
maxResults (integer)
nextToken (string)
lex_models_v2/list_slot_typesGets a list of slot types that match the specified criteria.botId (string) required
botVersion (string) required
localeId (string) required
sortBy: {
. attribute (string)
. order (string)
} (object)
filters (array)
maxResults (integer)
nextToken (string)
lex_models_v2/list_tags_for_resourceGets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.resourceARN (string) required
lex_models_v2/list_test_execution_result_itemsGets a list of test execution result items.testExecutionId (string) required
resultFilterBy: {
. resultTypeFilter (string)
. conversationLevelTestResultsFilterBy (object)
} (object) required
maxResults (integer)
nextToken (string)
lex_models_v2/list_test_executionsThe list of test set executions.sortBy: {
. attribute (string)
. order (string)
} (object)
maxResults (integer)
nextToken (string)
lex_models_v2/list_test_set_recordsThe list of test set records.testSetId (string) required
maxResults (integer)
nextToken (string)
lex_models_v2/list_test_setsThe list of the test setssortBy: {
. attribute (string)
. order (string)
} (object)
maxResults (integer)
nextToken (string)
lex_models_v2/list_utterance_analytics_dataTo use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role. Retrieves a list of metadata for individual user utterances to your bot. The following fields are required: startDateTime and endDateTime – Define a time range for which you want to retrieve results. Of the optional fields, you can organize the results ibotId (string) required
startDateTime (string) required
endDateTime (string) required
sortBy: {
. name (string)
. order (string)
} (object)
filters (array)
maxResults (integer)
nextToken (string)
lex_models_v2/list_utterance_metricsTo use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role. Retrieves summary metrics for the utterances in your bot. The following fields are required: metrics – A list of AnalyticsUtteranceMetric objects. In each object, use the name field to specify the metric to calculate, the statistic field to specify whethbotId (string) required
startDateTime (string) required
endDateTime (string) required
metrics (array) required
binBy (array)
groupBy (array)
attributes (array)
filters (array)
maxResults (integer)
nextToken (string)
lex_models_v2/search_associated_transcriptsSearch for associated transcripts that meet the specified criteria.botId (string) required
botVersion (string) required
localeId (string) required
botRecommendationId (string) required
searchOrder (string)
filters (array) required
maxResults (integer)
nextIndex (integer)
lex_models_v2/start_bot_recommendationUse this to provide your transcript data, and to start the bot recommendation process.botId (string) required
botVersion (string) required
localeId (string) required
transcriptSourceSetting: {
. s3BucketTranscriptSource (object)
} (object) required
encryptionSetting: {
. kmsKeyArn (string)
. botLocaleExportPassword (string)
. associatedTranscriptsPassword (string)
} (object)
lex_models_v2/start_bot_resource_generationStarts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the DescribeBotResourceGeneration operation to check on the status of the generation and for the generatedBotLocaleUrl when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.generationInputPrompt (string) required
botId (string) required
botVersion (string) required
localeId (string) required
lex_models_v2/start_importStarts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.importId (string) required
resourceSpecification: {
. botImportSpecification (object)
. botLocaleImportSpecification (object)
. customVocabularyImportSpecification (object)
. testSetImportResourceSpecification (object)
} (object) required
mergeStrategy (string) required
filePassword (string)
lex_models_v2/start_test_executionThe action to start test set execution.testSetId (string) required
target: {
. botAliasTarget (object)
} (object) required
apiMode (string) required
testExecutionModality (string)
lex_models_v2/start_test_set_generationThe action to start the generation of test set.testSetName (string) required
description (string)
storageLocation: {
. s3BucketName (string)
. s3Path (string)
. kmsKeyArn (string)
} (object) required
generationDataSource: {
. conversationLogsDataSource (object)
} (object) required
roleArn (string) required
testSetTags (object)
lex_models_v2/stop_bot_recommendationStop an already running Bot Recommendation request.botId (string) required
botVersion (string) required
localeId (string) required
botRecommendationId (string) required
lex_models_v2/tag_resourceAdds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.resourceARN (string) required
tags (object) required
lex_models_v2/untag_resourceRemoves tags from a bot, bot alias, or bot channel.resourceARN (string) required
tagKeys (array) required
lex_models_v2/update_botUpdates the configuration of an existing bot.botId (string) required
botName (string) required
description (string)
roleArn (string) required
dataPrivacy: {
. childDirected (boolean)
} (object) required
idleSessionTTLInSeconds (integer) required
botType (string)
botMembers (array)
errorLogSettings: {
. enabled (boolean)
} (object)
lex_models_v2/update_bot_aliasUpdates the configuration of an existing bot alias.botAliasId (string) required
botAliasName (string) required
description (string)
botVersion (string)
botAliasLocaleSettings (object)
conversationLogSettings: {
. textLogSettings (array)
. audioLogSettings (array)
} (object)
sentimentAnalysisSettings: {
. detectSentiment (boolean)
} (object)
botId (string) required
lex_models_v2/update_bot_localeUpdates the settings that a bot has for a specific locale.botId (string) required
botVersion (string) required
localeId (string) required
description (string)
nluIntentConfidenceThreshold (number) required
voiceSettings: {
. engine (string)
. voiceId (string)
} (object)
unifiedSpeechSettings: {
. speechFoundationModel (object)
} (object)
speechRecognitionSettings: {
. speechModelPreference (string)
. speechModelConfig (object)
} (object)
generativeAISettings: {
. runtimeSettings (object)
. buildtimeSettings (object)
} (object)
speechDetectionSensitivity (string)
lex_models_v2/update_bot_recommendationUpdates an existing bot recommendation request.botId (string) required
botVersion (string) required
localeId (string) required
botRecommendationId (string) required
encryptionSetting: {
. kmsKeyArn (string)
. botLocaleExportPassword (string)
. associatedTranscriptsPassword (string)
} (object) required
lex_models_v2/update_exportUpdates 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.exportId (string) required
filePassword (string)
lex_models_v2/update_intentUpdates the settings for an intent.intentId (string) required
intentName (string) required
intentDisplayName (string)
description (string)
parentIntentSignature (string)
sampleUtterances (array)
dialogCodeHook: {
. enabled (boolean)
} (object)
fulfillmentCodeHook: {
. enabled (boolean)
. postFulfillmentStatusSpecification (object)
. fulfillmentUpdatesSpecification (object)
. active (boolean)
} (object)
slotPriorities (array)
intentConfirmationSetting: {
. promptSpecification (object)
. declinationResponse (object)
. active (boolean)
. confirmationResponse (object)
. confirmationNextStep (object)
. confirmationConditional (object)
. declinationNextStep (object)
. declinationConditional (object)
. failureResponse (object)
. failureNextStep (object)
. failureConditional (object)
. codeHook (object)
. elicitationCodeHook (object)
} (object)
intentClosingSetting: {
. closingResponse (object)
. active (boolean)
. nextStep (object)
. conditional (object)
} (object)
inputContexts (array)
outputContexts (array)
kendraConfiguration: {
. kendraIndex (string)
. queryFilterStringEnabled (boolean)
. queryFilterString (string)
} (object)
botId (string) required
botVersion (string) required
localeId (string) required
initialResponseSetting: {
. initialResponse (object)
. nextStep (object)
. conditional (object)
. codeHook (object)
} (object)
qnAIntentConfiguration: {
. dataSourceConfiguration (object)
. bedrockModelConfiguration (object)
} (object)
qInConnectIntentConfiguration: {
. qInConnectAssistantConfiguration (object)
} (object)
lex_models_v2/update_resource_policyReplaces 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.resourceArn (string) required
policy (string) required
expectedRevisionId (string)
lex_models_v2/update_slotUpdates the settings for a slot.slotId (string) required
slotName (string) required
description (string)
slotTypeId (string)
valueElicitationSetting: {
. defaultValueSpecification (object)
. slotConstraint (string)
. promptSpecification (object)
. sampleUtterances (array)
. waitAndContinueSpecification (object)
. slotCaptureSetting (object)
. slotResolutionSetting (object)
} (object) required
obfuscationSetting: {
. obfuscationSettingType (string)
} (object)
botId (string) required
botVersion (string) required
localeId (string) required
intentId (string) required
multipleValuesSetting: {
. allowMultipleValues (boolean)
} (object)
subSlotSetting: {
. expression (string)
. slotSpecifications (object)
} (object)
lex_models_v2/update_slot_typeUpdates the configuration of an existing slot type.slotTypeId (string) required
slotTypeName (string) required
description (string)
slotTypeValues (array)
valueSelectionSetting: {
. resolutionStrategy (string)
. regexFilter (object)
. advancedRecognitionSetting (object)
} (object)
parentSlotTypeSignature (string)
botId (string) required
botVersion (string) required
localeId (string) required
externalSourceSetting: {
. grammarSlotTypeSetting (object)
} (object)
compositeSlotTypeSetting: {
. subSlots (array)
} (object)
lex_models_v2/update_test_setThe action to update the test set.testSetId (string) required
testSetName (string) required
description (string)
lex_runtime_service/delete_sessionRemoves session information for a specified bot, alias, and user ID.botName (string) required
botAlias (string) required
userId (string) required
lex_runtime_service/get_sessionReturns session information for a specified bot, alias, and user ID.botName (string) required
botAlias (string) required
userId (string) required
checkpointLabelFilter (string)
lex_runtime_service/post_contentSends 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 messagbotName (string) required
botAlias (string) required
userId (string) required
sessionAttributes (string)
requestAttributes (string)
contentType (string) required
accept (string)
inputStream (string) required
activeContexts (string)
lex_runtime_service/post_textSends 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 sbotName (string) required
botAlias (string) required
userId (string) required
sessionAttributes (object)
requestAttributes (object)
inputText (string) required
activeContexts (array)
lex_runtime_service/put_sessionCreates 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.botName (string) required
botAlias (string) required
userId (string) required
sessionAttributes (object)
dialogAction: {
. type (string)
. intentName (string)
. slots (object)
. slotToElicit (string)
. fulfillmentState (string)
. message (string)
. messageFormat (string)
} (object)
recentIntentSummaryView (array)
accept (string)
activeContexts (array)
lex_runtime_v2/delete_sessionRemoves 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 ebotId (string) required
botAliasId (string) required
localeId (string) required
sessionId (string) required
lex_runtime_v2/get_sessionReturns 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.botId (string) required
botAliasId (string) required
localeId (string) required
sessionId (string) required
lex_runtime_v2/put_sessionCreates 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.botId (string) required
botAliasId (string) required
localeId (string) required
sessionId (string) required
messages (array)
sessionState: {
. dialogAction (object)
. intent (object)
. activeContexts (array)
. sessionAttributes (object)
. originatingRequestId (string)
. runtimeHints (object)
} (object) required
requestAttributes (object)
responseContentType (string)
lex_runtime_v2/recognize_textSends 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 mbotId (string) required
botAliasId (string) required
localeId (string) required
sessionId (string) required
text (string) required
sessionState: {
. dialogAction (object)
. intent (object)
. activeContexts (array)
. sessionAttributes (object)
. originatingRequestId (string)
. runtimeHints (object)
} (object)
requestAttributes (object)
lex_runtime_v2/recognize_utteranceSends 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 cbotId (string) required
botAliasId (string) required
localeId (string) required
sessionId (string) required
sessionState (string)
requestAttributes (string)
requestContentType (string) required
responseContentType (string)
inputStream (string)
lex_runtime_v2/start_conversationStarts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time. After your application starts a conversation, users send input to Amazon Lex V2 as a stream of events. Amazon Lex V2 processes the incoming events and responds with streaming text or audio events. Audio input must be in the following format: audio/lpcm sample-rate=8000 sample-size-bits=16 channel-count=1; is-big-endian=false. If the optional post-fulfillment response is specified, the mebotId (string) required
botAliasId (string) required
localeId (string) required
sessionId (string) required
conversationMode (string)
requestEventStream (undefined) required
license_manager_linux_subscriptions/deregister_subscription_providerRemove a third-party subscription provider from the Bring Your Own License BYOL subscriptions registered to your account.SubscriptionProviderArn (string) required
license_manager_linux_subscriptions/get_registered_subscription_providerGet details for a Bring Your Own License BYOL subscription that's registered to your account.SubscriptionProviderArn (string) required
license_manager_linux_subscriptions/get_service_settingsLists the Linux subscriptions service settings for your account.No parameters
license_manager_linux_subscriptions/list_linux_subscription_instancesLists the running Amazon EC2 instances that were discovered with commercial Linux subscriptions.Filters (array)
MaxResults (integer)
NextToken (string)
license_manager_linux_subscriptions/list_linux_subscriptionsLists the Linux subscriptions that have been discovered. If you have linked your organization, the returned results will include data aggregated across your accounts in Organizations.Filters (array)
MaxResults (integer)
NextToken (string)
license_manager_linux_subscriptions/list_registered_subscription_providersList Bring Your Own License BYOL subscription registration resources for your account.SubscriptionProviderSources (array)
MaxResults (integer)
NextToken (string)
license_manager_linux_subscriptions/list_tags_for_resourceList the metadata tags that are assigned to the specified Amazon Web Services resource.resourceArn (string) required
license_manager_linux_subscriptions/register_subscription_providerRegister the supported third-party subscription provider for your Bring Your Own License BYOL subscription.SubscriptionProviderSource (string) required
SecretArn (string) required
Tags (object)
license_manager_linux_subscriptions/tag_resourceAdd metadata tags to the specified Amazon Web Services resource.resourceArn (string) required
tags (object) required
license_manager_linux_subscriptions/untag_resourceRemove one or more metadata tag from the specified Amazon Web Services resource.resourceArn (string) required
tagKeys (array) required
license_manager_linux_subscriptions/update_service_settingsUpdates the service settings for Linux subscriptions.LinuxSubscriptionsDiscovery (string) required
LinuxSubscriptionsDiscoverySettings: {
. SourceRegions (array)
. OrganizationIntegration (string)
} (object) required
AllowUpdate (boolean)
license_manager_user_subscriptions/associate_userAssociates the user to an EC2 instance to utilize user-based subscriptions. Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed marked as Pending billing status in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.Username (string) required
InstanceId (string) required
IdentityProvider (undefined) required
Domain (string)
Tags (object)
license_manager_user_subscriptions/create_license_server_endpointCreates a network endpoint for the Remote Desktop Services RDS license server.IdentityProviderArn (string) required
LicenseServerSettings: {
. ServerType (string)
. ServerSettings
} (object) required
Tags (object)
license_manager_user_subscriptions/delete_license_server_endpointDeletes a LicenseServerEndpoint resource.LicenseServerEndpointArn (string) required
ServerType (string) required
license_manager_user_subscriptions/deregister_identity_providerDeregisters the Active Directory identity provider from License Manager user-based subscriptions.IdentityProvider (undefined)
Product (string)
IdentityProviderArn (string)
license_manager_user_subscriptions/disassociate_userDisassociates the user from an EC2 instance providing user-based subscriptions.Username (string)
InstanceId (string)
IdentityProvider (undefined)
InstanceUserArn (string)
Domain (string)
license_manager_user_subscriptions/list_identity_providersLists the Active Directory identity providers for user-based subscriptions.MaxResults (integer)
Filters (array)
NextToken (string)
license_manager_user_subscriptions/list_instancesLists the EC2 instances providing user-based subscriptions.MaxResults (integer)
NextToken (string)
Filters (array)
license_manager_user_subscriptions/list_license_server_endpointsList the Remote Desktop Services RDS License Server endpointsMaxResults (integer)
Filters (array)
NextToken (string)
license_manager_user_subscriptions/list_product_subscriptionsLists the user-based subscription products available from an identity provider.Product (string)
IdentityProvider (undefined) required
MaxResults (integer)
Filters (array)
NextToken (string)
license_manager_user_subscriptions/list_tags_for_resourceReturns the list of tags for the specified resource.ResourceArn (string) required
license_manager_user_subscriptions/list_user_associationsLists user associations for an identity provider.InstanceId (string) required
IdentityProvider (undefined) required
MaxResults (integer)
Filters (array)
NextToken (string)
license_manager_user_subscriptions/register_identity_providerRegisters an identity provider for user-based subscriptions.IdentityProvider (undefined) required
Product (string) required
Settings: {
. Subnets (array)
. SecurityGroupId (string)
} (object)
Tags (object)
license_manager_user_subscriptions/start_product_subscriptionStarts a product subscription for a user with the specified identity provider. Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed marked as Pending billing status in Amazon Web Services Billing. For more information, see Viewing your monthly charges in the Amazon Web Services Billing User Guide.Username (string) required
IdentityProvider (undefined) required
Product (string) required
Domain (string)
Tags (object)
license_manager_user_subscriptions/stop_product_subscriptionStops a product subscription for a user with the specified identity provider.Username (string)
IdentityProvider (undefined)
Product (string)
ProductUserArn (string)
Domain (string)
license_manager_user_subscriptions/tag_resourceAdds tags to a resource.ResourceArn (string) required
Tags (object) required
license_manager_user_subscriptions/untag_resourceRemoves tags from a resource.ResourceArn (string) required
TagKeys (array) required
license_manager_user_subscriptions/update_identity_provider_settingsUpdates additional product configuration settings for the registered identity provider.IdentityProvider (undefined)
Product (string)
IdentityProviderArn (string)
UpdateSettings: {
. AddSubnets (array)
. RemoveSubnets (array)
. SecurityGroupId (string)
} (object) required
license_manager/accept_grantAccepts the specified grant.GrantArn (string) required
license_manager/check_in_licenseChecks in the specified license. Check in a license when it is no longer in use.LicenseConsumptionToken (string) required
Beneficiary (string)
license_manager/checkout_borrow_licenseChecks out the specified license for offline use.LicenseArn (string) required
Entitlements (array) required
DigitalSignatureMethod (string) required
NodeId (string)
CheckoutMetadata (array)
ClientToken (string) required
license_manager/checkout_licenseChecks out the specified license. If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.ProductSKU (string) required
CheckoutType (string) required
KeyFingerprint (string) required
Entitlements (array) required
ClientToken (string) required
Beneficiary (string)
NodeId (string)
license_manager/create_grantCreates a grant for the specified license. A grant shares the use of license entitlements with a specific Amazon Web Services account, an organization, or an organizational unit OU. For more information, see Granted licenses in License Manager in the License Manager User Guide.ClientToken (string) required
GrantName (string) required
LicenseArn (string) required
Principals (array) required
HomeRegion (string) required
AllowedOperations (array) required
Tags (array)
license_manager/create_grant_versionCreates a new version of the specified grant. For more information, see Granted licenses in License Manager in the License Manager User Guide.ClientToken (string) required
GrantArn (string) required
GrantName (string)
AllowedOperations (array)
Status (string)
StatusReason (string)
SourceVersion (string)
Options: {
. ActivationOverrideBehavior (string)
} (object)
license_manager/create_licenseCreates a license.LicenseName (string) required
ProductName (string) required
ProductSKU (string) required
Issuer: {
. Name (string)
. SignKey (string)
} (object) required
HomeRegion (string) required
Validity: {
. Begin (string)
. End (string)
} (object) required
Entitlements (array) required
Beneficiary (string) required
ConsumptionConfiguration: {
. RenewType (string)
. ProvisionalConfiguration (object)
. BorrowConfiguration (object)
} (object) required
LicenseMetadata (array)
ClientToken (string) required
Tags (array)
license_manager/create_license_asset_groupCreates a license asset group.Name (string) required
Description (string)
LicenseAssetGroupConfigurations (array) required
AssociatedLicenseAssetRulesetARNs (array) required
Properties (array)
Tags (array)
ClientToken (string) required
license_manager/create_license_asset_rulesetCreates a license asset ruleset.Name (string) required
Description (string)
Rules (array) required
Tags (array)
ClientToken (string) required
license_manager/create_license_configurationCreates 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.Name (string) required
Description (string)
LicenseCountingType (string) required
LicenseCount (integer)
LicenseCountHardLimit (boolean)
LicenseRules (array)
Tags (array)
DisassociateWhenNotFound (boolean)
ProductInformationList (array)
LicenseExpiry (integer)
license_manager/create_license_conversion_task_for_resourceCreates a new license conversion task.ResourceArn (string) required
SourceLicenseContext: {
. UsageOperation (string)
. ProductCodes (array)
} (object) required
DestinationLicenseContext: {
. UsageOperation (string)
. ProductCodes (array)
} (object) required
license_manager/create_license_manager_report_generatorCreates a report generator.ReportGeneratorName (string) required
Type (array) required
ReportContext: {
. licenseConfigurationArns (array)
. licenseAssetGroupArns (array)
. reportStartDate (string)
. reportEndDate (string)
} (object) required
ReportFrequency: {
. value (integer)
. period (string)
} (object) required
ClientToken (string) required
Description (string)
Tags (array)
license_manager/create_license_versionCreates a new version of the specified license.LicenseArn (string) required
LicenseName (string) required
ProductName (string) required
Issuer: {
. Name (string)
. SignKey (string)
} (object) required
HomeRegion (string) required
Validity: {
. Begin (string)
. End (string)
} (object) required
LicenseMetadata (array)
Entitlements (array) required
ConsumptionConfiguration: {
. RenewType (string)
. ProvisionalConfiguration (object)
. BorrowConfiguration (object)
} (object) required
Status (string) required
ClientToken (string) required
SourceVersion (string)
license_manager/create_tokenCreates 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.LicenseArn (string) required
RoleArns (array)
ExpirationInDays (integer)
TokenProperties (array)
ClientToken (string) required
license_manager/delete_grantDeletes the specified grant.GrantArn (string) required
StatusReason (string)
Version (string) required
license_manager/delete_licenseDeletes the specified license.LicenseArn (string) required
SourceVersion (string) required
license_manager/delete_license_asset_groupDeletes a license asset group.LicenseAssetGroupArn (string) required
license_manager/delete_license_asset_rulesetDeletes a license asset ruleset.LicenseAssetRulesetArn (string) required
license_manager/delete_license_configurationDeletes the specified license configuration. You cannot delete a license configuration that is in use.LicenseConfigurationArn (string) required
license_manager/delete_license_manager_report_generatorDeletes 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.LicenseManagerReportGeneratorArn (string) required
license_manager/delete_tokenDeletes the specified token. Must be called in the license home Region.TokenId (string) required
license_manager/extend_license_consumptionExtends the expiration date for license consumption.LicenseConsumptionToken (string) required
DryRun (boolean)
license_manager/get_access_tokenGets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour.Token (string) required
TokenProperties (array)
license_manager/get_grantGets detailed information about the specified grant.GrantArn (string) required
Version (string)
license_manager/get_licenseGets detailed information about the specified license.LicenseArn (string) required
Version (string)
license_manager/get_license_asset_groupGets a license asset group.LicenseAssetGroupArn (string) required
license_manager/get_license_asset_rulesetGets a license asset ruleset.LicenseAssetRulesetArn (string) required
license_manager/get_license_configurationGets detailed information about the specified license configuration.LicenseConfigurationArn (string) required
license_manager/get_license_conversion_taskGets information about the specified license type conversion task.LicenseConversionTaskId (string) required
license_manager/get_license_manager_report_generatorGets information about the specified report generator.LicenseManagerReportGeneratorArn (string) required
license_manager/get_license_usageGets detailed information about the usage of the specified license.LicenseArn (string) required
license_manager/get_service_settingsGets the License Manager settings for the current Region.No parameters
license_manager/list_assets_for_license_asset_groupLists assets for a license asset group.LicenseAssetGroupArn (string) required
AssetType (string) required
MaxResults (integer)
NextToken (string)
license_manager/list_associations_for_license_configurationLists 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.LicenseConfigurationArn (string) required
MaxResults (integer)
NextToken (string)
license_manager/list_distributed_grantsLists the grants distributed for the specified license.GrantArns (array)
Filters (array)
NextToken (string)
MaxResults (integer)
license_manager/list_failures_for_license_configuration_operationsLists the license configuration operations that failed.LicenseConfigurationArn (string) required
MaxResults (integer)
NextToken (string)
license_manager/list_license_asset_groupsLists license asset groups.Filters (array)
MaxResults (integer)
NextToken (string)
license_manager/list_license_asset_rulesetsLists license asset rulesets.Filters (array)
ShowAWSManagedLicenseAssetRulesets (boolean)
MaxResults (integer)
NextToken (string)
license_manager/list_license_configurationsLists the license configurations for your account.LicenseConfigurationArns (array)
MaxResults (integer)
NextToken (string)
Filters (array)
license_manager/list_license_configurations_for_organizationLists license configurations for an organization.LicenseConfigurationArns (array)
MaxResults (integer)
NextToken (string)
Filters (array)
license_manager/list_license_conversion_tasksLists the license type conversion tasks for your account.NextToken (string)
MaxResults (integer)
Filters (array)
license_manager/list_license_manager_report_generatorsLists the report generators for your account.Filters (array)
NextToken (string)
MaxResults (integer)
license_manager/list_licensesLists the licenses for your account.LicenseArns (array)
Filters (array)
NextToken (string)
MaxResults (integer)
license_manager/list_license_specifications_for_resourceDescribes the license configurations for the specified resource.ResourceArn (string) required
MaxResults (integer)
NextToken (string)
license_manager/list_license_versionsLists all versions of the specified license.LicenseArn (string) required
NextToken (string)
MaxResults (integer)
license_manager/list_received_grantsLists grants that are received. Received grants are grants created while specifying the recipient as this Amazon Web Services account, your organization, or an organizational unit OU to which this member account belongs.GrantArns (array)
Filters (array)
NextToken (string)
MaxResults (integer)
license_manager/list_received_grants_for_organizationLists the grants received for all accounts in the organization.LicenseArn (string) required
Filters (array)
NextToken (string)
MaxResults (integer)
license_manager/list_received_licensesLists received licenses.LicenseArns (array)
Filters (array)
NextToken (string)
MaxResults (integer)
license_manager/list_received_licenses_for_organizationLists the licenses received for all accounts in the organization.Filters (array)
NextToken (string)
MaxResults (integer)
license_manager/list_resource_inventoryLists resources managed using Systems Manager inventory.MaxResults (integer)
NextToken (string)
Filters (array)
license_manager/list_tags_for_resourceLists the tags for the specified resource. For more information about tagging support in License Manager, see the TagResource operation.ResourceArn (string) required
license_manager/list_tokensLists your tokens.TokenIds (array)
Filters (array)
NextToken (string)
MaxResults (integer)
license_manager/list_usage_for_license_configurationLists 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.LicenseConfigurationArn (string) required
MaxResults (integer)
NextToken (string)
Filters (array)
license_manager/reject_grantRejects the specified grant.GrantArn (string) required
license_manager/tag_resourceAdds the specified tags to the specified resource. The following resources support tagging in License Manager: Licenses Grants License configurations Report generatorsResourceArn (string) required
Tags (array) required
license_manager/untag_resourceRemoves the specified tags from the specified resource.ResourceArn (string) required
TagKeys (array) required
license_manager/update_license_asset_groupUpdates a license asset group.Name (string)
Description (string)
LicenseAssetGroupConfigurations (array)
AssociatedLicenseAssetRulesetARNs (array) required
Properties (array)
LicenseAssetGroupArn (string) required
Status (string)
ClientToken (string) required
license_manager/update_license_asset_rulesetUpdates a license asset ruleset.Name (string)
Description (string)
Rules (array) required
LicenseAssetRulesetArn (string) required
ClientToken (string) required
license_manager/update_license_configurationModifies the attributes of an existing license configuration.LicenseConfigurationArn (string) required
LicenseConfigurationStatus (string)
LicenseRules (array)
LicenseCount (integer)
LicenseCountHardLimit (boolean)
Name (string)
Description (string)
ProductInformationList (array)
DisassociateWhenNotFound (boolean)
LicenseExpiry (integer)
license_manager/update_license_manager_report_generatorUpdates a report generator. After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.LicenseManagerReportGeneratorArn (string) required
ReportGeneratorName (string) required
Type (array) required
ReportContext: {
. licenseConfigurationArns (array)
. licenseAssetGroupArns (array)
. reportStartDate (string)
. reportEndDate (string)
} (object) required
ReportFrequency: {
. value (integer)
. period (string)
} (object) required
ClientToken (string) required
Description (string)
license_manager/update_license_specifications_for_resourceAdds 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.ResourceArn (string) required
AddLicenseSpecifications (array)
RemoveLicenseSpecifications (array)
license_manager/update_service_settingsUpdates License Manager settings for the current Region.S3BucketArn (string)
SnsTopicArn (string)
OrganizationConfiguration: {
. EnableIntegration (boolean)
} (object)
EnableCrossAccountsDiscovery (boolean)
EnabledDiscoverySourceRegions (array)
lightsail/allocate_static_ipAllocates a static IP address.staticIpName (string) required
lightsail/attach_certificate_to_distributionAttaches 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 thdistributionName (string) required
certificateName (string) required
lightsail/attach_diskAttaches 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.diskName (string) required
instanceName (string) required
diskPath (string) required
autoMounting (boolean)
lightsail/attach_instances_to_load_balancerAttaches 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.loadBalancerName (string) required
instanceNames (array) required
lightsail/attach_load_balancer_tls_certificateAttaches 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 oloadBalancerName (string) required
certificateName (string) required
lightsail/attach_static_ipAttaches a static IP address to a specific Amazon Lightsail instance.staticIpName (string) required
instanceName (string) required
lightsail/close_instance_public_portsCloses 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.portInfo: {
. fromPort (integer)
. toPort (integer)
. protocol (string)
. cidrs (array)
. ipv6Cidrs (array)
. cidrListAliases (array)
} (object) required
instanceName (string) required
lightsail/copy_snapshotCopies 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 tsourceSnapshotName (string)
sourceResourceName (string)
restoreDate (string)
useLatestRestorableAutoSnapshot (boolean)
targetSnapshotName (string) required
sourceRegion (string) required
lightsail/create_bucketCreates 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.bucketName (string) required
bundleId (string) required
tags (array)
enableObjectVersioning (boolean)
lightsail/create_bucket_access_keyCreates 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 LightsailbucketName (string) required
lightsail/create_certificateCreates 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 discertificateName (string) required
domainName (string) required
subjectAlternativeNames (array)
tags (array)
lightsail/create_cloud_formation_stackCreates 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 recoinstances (array) required
lightsail/create_contact_methodCreates 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.protocol (string) required
contactEndpoint (string) required
lightsail/create_container_serviceCreates 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.serviceName (string) required
power (string) required
scale (integer) required
tags (array)
publicDomainNames (object)
deployment: {
. containers (object)
. publicEndpoint (object)
} (object)
privateRegistryAccess: {
. ecrImagePullerRole (object)
} (object)
lightsail/create_container_service_deploymentCreates 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 userviceName (string) required
containers (object)
publicEndpoint: {
. containerName (string)
. containerPort (integer)
. healthCheck (object)
} (object)
lightsail/create_container_service_registry_loginCreates 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 cNo parameters
lightsail/create_diskCreates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone us-east-2a. The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.diskName (string) required
availabilityZone (string) required
sizeInGb (integer) required
tags (array)
addOns (array)
lightsail/create_disk_from_snapshotCreates 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 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.diskName (string) required
diskSnapshotName (string)
availabilityZone (string) required
sizeInGb (integer) required
tags (array)
addOns (array)
sourceDiskName (string)
restoreDate (string)
useLatestRestorableAutoSnapshot (boolean)
lightsail/create_disk_snapshotCreates 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 adiskName (string)
diskSnapshotName (string) required
instanceName (string)
tags (array)
lightsail/create_distributionCreates 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.distributionName (string) required
origin: {
. name (string)
. regionName (string)
. protocolPolicy (string)
. responseTimeout (integer)
} (object) required
defaultCacheBehavior: {
. behavior (string)
} (object) required
cacheBehaviorSettings: {
. defaultTTL (integer)
. minimumTTL (integer)
. maximumTTL (integer)
. allowedHTTPMethods (string)
. cachedHTTPMethods (string)
. forwardedCookies (object)
. forwardedHeaders (object)
. forwardedQueryStrings (object)
} (object)
cacheBehaviors (array)
bundleId (string) required
ipAddressType (string)
tags (array)
certificateName (string)
viewerMinimumTlsProtocolVersion (string)
lightsail/create_domainCreates a domain resource for the specified domain example.com. The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.domainName (string) required
tags (array)
lightsail/create_domain_entryCreates 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.domainName (string) required
domainEntry: {
. id (string)
. name (string)
. target (string)
. isAlias (boolean)
. type (string)
. options (object)
} (object) required
lightsail/create_guisession_access_detailsCreates two URLs that are used to access a virtual computer’s graphical user interface GUI session. The primary URL initiates a web-based Amazon DCV session to the virtual computer's application. The secondary URL initiates a web-based Amazon DCV session to the virtual computer's operating session. Use StartGUISession to open the session.resourceName (string) required
lightsail/create_instancesCreates 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.instanceNames (array) required
availabilityZone (string) required
customImageName (string)
blueprintId (string) required
bundleId (string) required
userData (string)
keyPairName (string)
tags (array)
addOns (array)
ipAddressType (string)
lightsail/create_instances_from_snapshotCreates 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.instanceNames (array) required
attachedDiskMapping (object)
availabilityZone (string) required
instanceSnapshotName (string)
bundleId (string) required
userData (string)
keyPairName (string)
tags (array)
addOns (array)
ipAddressType (string)
sourceInstanceName (string)
restoreDate (string)
useLatestRestorableAutoSnapshot (boolean)
lightsail/create_instance_snapshotCreates 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.instanceSnapshotName (string) required
instanceName (string) required
tags (array)
lightsail/create_key_pairCreates 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.keyPairName (string) required
tags (array)
lightsail/create_load_balancerCreates 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 10 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. ForloadBalancerName (string) required
instancePort (integer) required
healthCheckPath (string)
certificateName (string)
certificateDomainName (string)
certificateAlternativeNames (array)
tags (array)
ipAddressType (string)
tlsPolicyName (string)
lightsail/create_load_balancer_tls_certificateCreates 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.loadBalancerName (string) required
certificateName (string) required
certificateDomainName (string) required
certificateAlternativeNames (array)
tags (array)
lightsail/create_relational_databaseCreates 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.relationalDatabaseName (string) required
availabilityZone (string)
relationalDatabaseBlueprintId (string) required
relationalDatabaseBundleId (string) required
masterDatabaseName (string) required
masterUsername (string) required
masterUserPassword (string)
preferredBackupWindow (string)
preferredMaintenanceWindow (string)
publiclyAccessible (boolean)
tags (array)
lightsail/create_relational_database_from_snapshotCreates 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 LightrelationalDatabaseName (string) required
availabilityZone (string)
publiclyAccessible (boolean)
relationalDatabaseSnapshotName (string)
relationalDatabaseBundleId (string)
sourceRelationalDatabaseName (string)
restoreTime (string)
useLatestRestorableTime (boolean)
tags (array)
lightsail/create_relational_database_snapshotCreates 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.relationalDatabaseName (string) required
relationalDatabaseSnapshotName (string) required
tags (array)
lightsail/delete_alarmDeletes 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.alarmName (string) required
lightsail/delete_auto_snapshotDeletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.resourceName (string) required
date (string) required
lightsail/delete_bucketDeletes 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.bucketName (string) required
forceDelete (boolean)
lightsail/delete_bucket_access_keyDeletes 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.bucketName (string) required
accessKeyId (string) required
lightsail/delete_certificateDeletes 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.certificateName (string) required
lightsail/delete_contact_methodDeletes 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.protocol (string) required
lightsail/delete_container_imageDeletes a container image that is registered to your Amazon Lightsail container service.serviceName (string) required
image (string) required
lightsail/delete_container_serviceDeletes your Amazon Lightsail container service.serviceName (string) required
lightsail/delete_diskDeletes 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.diskName (string) required
forceDeleteAddOns (boolean)
lightsail/delete_disk_snapshotDeletes 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 tdiskSnapshotName (string) required
lightsail/delete_distributionDeletes your Amazon Lightsail content delivery network CDN distribution.distributionName (string)
lightsail/delete_domainDeletes 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.domainName (string) required
lightsail/delete_domain_entryDeletes 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.domainName (string) required
domainEntry: {
. id (string)
. name (string)
. target (string)
. isAlias (boolean)
. type (string)
. options (object)
} (object) required
lightsail/delete_instanceDeletes 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.instanceName (string) required
forceDeleteAddOns (boolean)
lightsail/delete_instance_snapshotDeletes 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.instanceSnapshotName (string) required
lightsail/delete_key_pairDeletes 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 paikeyPairName (string) required
expectedFingerprint (string)
lightsail/delete_known_host_keysDeletes 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 AmazinstanceName (string) required
lightsail/delete_load_balancerDeletes 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.loadBalancerName (string) required
lightsail/delete_load_balancer_tls_certificateDeletes 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.loadBalancerName (string) required
certificateName (string) required
force (boolean)
lightsail/delete_relational_databaseDeletes 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.relationalDatabaseName (string) required
skipFinalSnapshot (boolean)
finalRelationalDatabaseSnapshotName (string)
lightsail/delete_relational_database_snapshotDeletes 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.relationalDatabaseSnapshotName (string) required
lightsail/detach_certificate_from_distributionDetaches 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.distributionName (string) required
lightsail/detach_diskDetaches 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.diskName (string) required
lightsail/detach_instances_from_load_balancerDetaches 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.loadBalancerName (string) required
instanceNames (array) required
lightsail/detach_static_ipDetaches a static IP from the Amazon Lightsail instance to which it is attached.staticIpName (string) required
lightsail/disable_add_onDisables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.addOnType (string) required
resourceName (string) required
lightsail/download_default_key_pairDownloads 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.No parameters
lightsail/enable_add_onEnables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.resourceName (string) required
addOnRequest: {
. addOnType (string)
. autoSnapshotAddOnRequest (object)
. stopInstanceOnIdleRequest (object)
} (object) required
lightsail/export_snapshotExports 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 volumessourceSnapshotName (string) required
lightsail/get_active_namesReturns the names of all active not deleted resources.pageToken (string)
lightsail/get_alarmsReturns 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.alarmName (string)
pageToken (string)
monitoredResourceName (string)
lightsail/get_auto_snapshotsReturns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.resourceName (string) required
lightsail/get_blueprintsReturns 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 inaincludeInactive (boolean)
pageToken (string)
appCategory (string)
lightsail/get_bucket_access_keysReturns 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.bucketName (string) required
lightsail/get_bucket_bundlesReturns 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.includeInactive (boolean)
lightsail/get_bucket_metric_dataReturns 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.bucketName (string) required
metricName (string) required
startTime (string) required
endTime (string) required
period (integer) required
statistics (array) required
unit (string) required
lightsail/get_bucketsReturns 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.bucketName (string)
pageToken (string)
includeConnectedResources (boolean)
includeCors (boolean)
lightsail/get_bundlesReturns 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.includeInactive (boolean)
pageToken (string)
appCategory (string)
lightsail/get_certificatesReturns information about one or more Amazon Lightsail SSL/TLS certificates. To get a summary of a certificate, omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name ARN, certificate name, domain name, and tags.certificateStatuses (array)
includeCertificateDetails (boolean)
certificateName (string)
pageToken (string)
lightsail/get_cloud_formation_stack_recordsReturns 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.pageToken (string)
lightsail/get_contact_methodsReturns 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 morprotocols (array)
lightsail/get_container_apimetadataReturns information about Amazon Lightsail containers, such as the current version of the Lightsail Control lightsailctl plugin.No parameters
lightsail/get_container_imagesReturns 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.serviceName (string) required
lightsail/get_container_logReturns 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 Amazon Web Services General Reference.serviceName (string) required
containerName (string) required
startTime (string)
endTime (string)
filterPattern (string)
pageToken (string)
lightsail/get_container_service_deploymentsReturns 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 Amazon Web ServicesserviceName (string) required
lightsail/get_container_service_metric_dataReturns 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.serviceName (string) required
metricName (string) required
startTime (string) required
endTime (string) required
period (integer) required
statistics (array) required
lightsail/get_container_service_powersReturns 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.No parameters
lightsail/get_container_servicesReturns information about one or more of your Amazon Lightsail container services.serviceName (string)
lightsail/get_cost_estimateRetrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.resourceName (string) required
startTime (string) required
endTime (string) required
lightsail/get_diskReturns information about a specific block storage disk.diskName (string) required
lightsail/get_disksReturns information about all block storage disks in your AWS account and region.pageToken (string)
lightsail/get_disk_snapshotReturns information about a specific block storage disk snapshot.diskSnapshotName (string) required
lightsail/get_disk_snapshotsReturns information about all block storage disk snapshots in your AWS account and region.pageToken (string)
lightsail/get_distribution_bundlesReturns 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.No parameters
lightsail/get_distribution_latest_cache_resetReturns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network CDN distribution.distributionName (string)
lightsail/get_distribution_metric_dataReturns 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.distributionName (string) required
metricName (string) required
startTime (string) required
endTime (string) required
period (integer) required
unit (string) required
statistics (array) required
lightsail/get_distributionsReturns information about one or more of your Amazon Lightsail content delivery network CDN distributions.distributionName (string)
pageToken (string)
lightsail/get_domainReturns information about a specific domain recordset.domainName (string) required
lightsail/get_domainsReturns a list of all domains in the user's account.pageToken (string)
lightsail/get_export_snapshot_recordsReturns 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.pageToken (string)
lightsail/get_instanceReturns information about a specific Amazon Lightsail instance, which is a virtual private server.instanceName (string) required
lightsail/get_instance_access_detailsReturns 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.instanceName (string) required
protocol (string)
lightsail/get_instance_metric_dataReturns 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.instanceName (string) required
metricName (string) required
period (integer) required
startTime (string) required
endTime (string) required
unit (string) required
statistics (array) required
lightsail/get_instance_port_statesReturns 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.instanceName (string) required
lightsail/get_instancesReturns information about all Amazon Lightsail virtual private servers, or instances.pageToken (string)
lightsail/get_instance_snapshotReturns information about a specific instance snapshot.instanceSnapshotName (string) required
lightsail/get_instance_snapshotsReturns all instance snapshots for the user's account.pageToken (string)
lightsail/get_instance_stateReturns the state of a specific instance. Works on one instance at a time.instanceName (string) required
lightsail/get_key_pairReturns information about a specific key pair.keyPairName (string) required
lightsail/get_key_pairsReturns information about all key pairs in the user's account.pageToken (string)
includeDefaultKeyPair (boolean)
lightsail/get_load_balancerReturns information about the specified Lightsail load balancer.loadBalancerName (string) required
lightsail/get_load_balancer_metric_dataReturns 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.loadBalancerName (string) required
metricName (string) required
period (integer) required
startTime (string) required
endTime (string) required
unit (string) required
statistics (array) required
lightsail/get_load_balancersReturns information about all load balancers in an account.pageToken (string)
lightsail/get_load_balancer_tls_certificatesReturns 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.loadBalancerName (string) required
lightsail/get_load_balancer_tls_policiesReturns 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.pageToken (string)
lightsail/get_operationReturns 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.operationId (string) required
lightsail/get_operationsReturns 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.pageToken (string)
lightsail/get_operations_for_resourceGets operations for a specific resource an instance or a static IP.resourceName (string) required
pageToken (string)
lightsail/get_regionsReturns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region.includeAvailabilityZones (boolean)
includeRelationalDatabaseAvailabilityZones (boolean)
lightsail/get_relational_databaseReturns information about a specific database in Amazon Lightsail.relationalDatabaseName (string) required
lightsail/get_relational_database_blueprintsReturns 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.pageToken (string)
lightsail/get_relational_database_bundlesReturns 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.pageToken (string)
includeInactive (boolean)
lightsail/get_relational_database_eventsReturns a list of events for a specific database in Amazon Lightsail.relationalDatabaseName (string) required
durationInMinutes (integer)
pageToken (string)
lightsail/get_relational_database_log_eventsReturns a list of log events for a database in Amazon Lightsail.relationalDatabaseName (string) required
logStreamName (string) required
startTime (string)
endTime (string)
startFromHead (boolean)
pageToken (string)
lightsail/get_relational_database_log_streamsReturns a list of available log streams for a specific database in Amazon Lightsail.relationalDatabaseName (string) required
lightsail/get_relational_database_master_user_passwordReturns 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.relationalDatabaseName (string) required
passwordVersion (string)
lightsail/get_relational_database_metric_dataReturns 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.relationalDatabaseName (string) required
metricName (string) required
period (integer) required
startTime (string) required
endTime (string) required
unit (string) required
statistics (array) required
lightsail/get_relational_database_parametersReturns 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.relationalDatabaseName (string) required
pageToken (string)
lightsail/get_relational_databasesReturns information about all of your databases in Amazon Lightsail.pageToken (string)
lightsail/get_relational_database_snapshotReturns information about a specific database snapshot in Amazon Lightsail.relationalDatabaseSnapshotName (string) required
lightsail/get_relational_database_snapshotsReturns information about all of your database snapshots in Amazon Lightsail.pageToken (string)
lightsail/get_setup_historyReturns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance.resourceName (string) required
pageToken (string)
lightsail/get_static_ipReturns information about an Amazon Lightsail static IP.staticIpName (string) required
lightsail/get_static_ipsReturns information about all static IPs in the user's account.pageToken (string)
lightsail/import_key_pairImports a public SSH key from a specific key pair.keyPairName (string) required
publicKeyBase64 (string) required
lightsail/is_vpc_peeredReturns a Boolean value indicating whether your Lightsail VPC is peered.No parameters
lightsail/open_instance_public_portsOpens 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.portInfo: {
. fromPort (integer)
. toPort (integer)
. protocol (string)
. cidrs (array)
. ipv6Cidrs (array)
. cidrListAliases (array)
} (object) required
instanceName (string) required
lightsail/peer_vpcPeers the Lightsail VPC with the user's default VPC.No parameters
lightsail/put_alarmCreates 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. AnyalarmName (string) required
metricName (string) required
monitoredResourceName (string) required
comparisonOperator (string) required
threshold (number) required
evaluationPeriods (integer) required
datapointsToAlarm (integer)
treatMissingData (string)
contactProtocols (array)
notificationTriggers (array)
notificationEnabled (boolean)
lightsail/put_instance_public_portsOpens 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 conportInfos (array) required
instanceName (string) required
lightsail/reboot_instanceRestarts 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.instanceName (string) required
lightsail/reboot_relational_databaseRestarts 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.relationalDatabaseName (string) required
lightsail/register_container_imageRegisters 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.serviceName (string) required
label (string) required
digest (string) required
lightsail/release_static_ipDeletes a specific static IP from your account.staticIpName (string) required
lightsail/reset_distribution_cacheDeletes 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.distributionName (string)
lightsail/send_contact_method_verificationSends 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 infoprotocol (string) required
lightsail/set_ip_address_typeSets 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.resourceType (string) required
resourceName (string) required
ipAddressType (string) required
acceptBundleUpdate (boolean)
lightsail/set_resource_access_for_bucketSets 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.resourceName (string) required
bucketName (string) required
access (string) required
lightsail/setup_instance_httpsCreates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified Lightsail instance. If you provide more than one domain name in the request, at least one name must be less than or equal to 63 characters in length.instanceName (string) required
emailAddress (string) required
domainNames (array) required
certificateProvider (string) required
lightsail/start_guisessionInitiates a graphical user interface GUI session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.resourceName (string) required
lightsail/start_instanceStarts 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 toinstanceName (string) required
lightsail/start_relational_databaseStarts 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.relationalDatabaseName (string) required
lightsail/stop_guisessionTerminates a web-based Amazon DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.resourceName (string) required
lightsail/stop_instanceStops 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 infoinstanceName (string) required
force (boolean)
lightsail/stop_relational_databaseStops a specific database that is currently running in Amazon Lightsail. If you don't manually start your database instance after it has been stopped for seven consecutive days, Amazon Lightsail automatically starts it for you. This action helps ensure that your database instance doesn't fall behind on any required maintenance updates. The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For morerelationalDatabaseName (string) required
relationalDatabaseSnapshotName (string)
lightsail/tag_resourceAdds 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.resourceName (string) required
resourceArn (string)
tags (array) required
lightsail/test_alarmTests 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 LialarmName (string) required
state (string) required
lightsail/unpeer_vpcUnpeers the Lightsail VPC from the user's default VPC.No parameters
lightsail/untag_resourceDeletes 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.resourceName (string) required
resourceArn (string)
tagKeys (array) required
lightsail/update_bucketUpdates 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.bucketName (string) required
accessRules: {
. getObject (string)
. allowPublicOverrides (boolean)
} (object)
versioning (string)
readonlyAccessAccounts (array)
accessLogConfig: {
. enabled (boolean)
. destination (string)
. prefix (string)
} (object)
cors: {
. rules (array)
} (object)
lightsail/update_bucket_bundleUpdates 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 Amazon Web Services 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 cobucketName (string) required
bundleId (string) required
lightsail/update_container_serviceUpdates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.serviceName (string) required
power (string)
scale (integer)
isDisabled (boolean)
publicDomainNames (object)
privateRegistryAccess: {
. ecrImagePullerRole (object)
} (object)
lightsail/update_distributionUpdates an existing Amazon Lightsail content delivery network CDN distribution. Use this action to update the configuration of your existing distribution.distributionName (string) required
origin: {
. name (string)
. regionName (string)
. protocolPolicy (string)
. responseTimeout (integer)
} (object)
defaultCacheBehavior: {
. behavior (string)
} (object)
cacheBehaviorSettings: {
. defaultTTL (integer)
. minimumTTL (integer)
. maximumTTL (integer)
. allowedHTTPMethods (string)
. cachedHTTPMethods (string)
. forwardedCookies (object)
. forwardedHeaders (object)
. forwardedQueryStrings (object)
} (object)
cacheBehaviors (array)
isEnabled (boolean)
viewerMinimumTlsProtocolVersion (string)
certificateName (string)
useDefaultCertificate (boolean)
lightsail/update_distribution_bundleUpdates 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 Amazon Web Services billing cycle. To determine if you can update your distribution's bundle,distributionName (string)
bundleId (string)
lightsail/update_domain_entryUpdates 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.domainName (string) required
domainEntry: {
. id (string)
. name (string)
. target (string)
. isAlias (boolean)
. type (string)
. options (object)
} (object) required
lightsail/update_instance_metadata_optionsModifies 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.instanceName (string) required
httpTokens (string)
httpEndpoint (string)
httpPutResponseHopLimit (integer)
httpProtocolIpv6 (string)
lightsail/update_load_balancer_attributeUpdates 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.loadBalancerName (string) required
attributeName (string) required
attributeValue (string) required
lightsail/update_relational_databaseAllows 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.relationalDatabaseName (string) required
masterUserPassword (string)
rotateMasterUserPassword (boolean)
preferredBackupWindow (string)
preferredMaintenanceWindow (string)
enableBackupRetention (boolean)
disableBackupRetention (boolean)
publiclyAccessible (boolean)
applyImmediately (boolean)
caCertificateIdentifier (string)
relationalDatabaseBlueprintId (string)
lightsail/update_relational_database_parametersAllows 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 orelationalDatabaseName (string) required
parameters (array) required
location/describe_keyRetrieves the API key resource details. For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.KeyName (string) required
location/update_keyUpdates the specified properties of a given API key resource.KeyName (string) required
Description (string)
ExpireTime (string)
NoExpiry (boolean)
ForceUpdate (boolean)
Restrictions: {
. AllowActions (array)
. AllowResources (array)
. AllowReferers (array)
. AllowAndroidApps (array)
. AllowAppleApps (array)
} (object)
location/delete_keyDeletes the specified API key. The API key must have been deactivated more than 90 days previously. For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.KeyName (string) required
ForceDelete (boolean)
location/list_keysLists API key resources in your Amazon Web Services account. For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.MaxResults (integer)
NextToken (string)
Filter: {
. KeyStatus (string)
} (object)
location/create_keyCreates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer. For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.KeyName (string) required
Restrictions: {
. AllowActions (array)
. AllowResources (array)
. AllowReferers (array)
. AllowAndroidApps (array)
. AllowAppleApps (array)
} (object) required
Description (string)
ExpireTime (string)
NoExpiry (boolean)
Tags (object)
location/list_tags_for_resourceReturns a list of tags that are applied to the specified Amazon Location resource.ResourceArn (string) required
location/tag_resourceAssigns one or more tags key-value pairs to the specified Amazon Location Service 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 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 rResourceArn (string) required
Tags (object) required
location/untag_resourceRemoves one or more tags from the specified Amazon Location resource.ResourceArn (string) required
TagKeys (array) required
location/batch_delete_geofenceDeletes a batch of geofences from a geofence collection. This operation deletes the resource permanently.CollectionName (string) required
GeofenceIds (array) required
location/batch_evaluate_geofencesEvaluates 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 aCollectionName (string) required
DevicePositionUpdates (array) required
location/batch_put_geofenceA 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.CollectionName (string) required
Entries (array) required
location/forecast_geofence_eventsThis action forecasts future geofence events that are likely to occur within a specified time horizon if a device continues moving at its current speed. Each forecasted event is associated with a geofence from a provided geofence collection. A forecast event can have one of the following states: ENTER: The device position is outside the referenced geofence, but the device may cross into the geofence during the forecasting time horizon if it maintains its current speed. EXIT: The device positionCollectionName (string) required
DeviceState: {
. Position (array)
. Speed (number)
} (object) required
TimeHorizonMinutes (number)
DistanceUnit (string)
SpeedUnit (string)
NextToken (string)
MaxResults (integer)
location/get_geofenceRetrieves the geofence details from a geofence collection. The returned geometry will always match the geometry format used when the geofence was created.CollectionName (string) required
GeofenceId (string) required
location/list_geofencesLists geofences stored in a given geofence collection.CollectionName (string) required
NextToken (string)
MaxResults (integer)
location/put_geofenceStores 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.CollectionName (string) required
GeofenceId (string) required
Geometry: {
. Polygon (array)
. Circle (object)
. Geobuf (string)
. MultiPolygon (array)
} (object) required
GeofenceProperties (object)
location/describe_geofence_collectionRetrieves the geofence collection details.CollectionName (string) required
location/update_geofence_collectionUpdates the specified properties of a given geofence collection.CollectionName (string) required
PricingPlan (string)
PricingPlanDataSource (string)
Description (string)
location/delete_geofence_collectionDeletes a geofence collection from your Amazon Web Services 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.CollectionName (string) required
location/list_geofence_collectionsLists geofence collections in your Amazon Web Services account.MaxResults (integer)
NextToken (string)
location/create_geofence_collectionCreates a geofence collection, which manages and stores geofences.CollectionName (string) required
PricingPlan (string)
PricingPlanDataSource (string)
Description (string)
Tags (object)
KmsKeyId (string)
location/get_map_glyphsThis operation is no longer current and may be deprecated in the future. We recommend upgrading to GetGlyphs unless you require Grab data. GetMapGlyphs is part of a previous Amazon Location Service Maps API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The version 2 GetGlyphs operation gives a better user experience and is compatible with the remainder of the V2 Maps API. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2MapName (string) required
FontStack (string) required
FontUnicodeRange (string) required
Key (string)
location/get_map_spritesThis operation is no longer current and may be deprecated in the future. We recommend upgrading to GetSprites unless you require Grab data. GetMapSprites is part of a previous Amazon Location Service Maps API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The version 2 GetSprites operation gives a better user experience and is compatible with the remainder of the V2 Maps API. If you are using an AWS SDK or the AWS CLI, note that the Maps API versioMapName (string) required
FileName (string) required
Key (string)
location/get_map_style_descriptorThis operation is no longer current and may be deprecated in the future. We recommend upgrading to GetStyleDescriptor unless you require Grab data. GetMapStyleDescriptor is part of a previous Amazon Location Service Maps API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The version 2 GetStyleDescriptor operation gives a better user experience and is compatible with the remainder of the V2 Maps API. If you are using an AWS SDK or the AWS CLI, noteMapName (string) required
Key (string)
location/get_map_tileThis operation is no longer current and may be deprecated in the future. We recommend upgrading to GetTile unless you require Grab data. GetMapTile is part of a previous Amazon Location Service Maps API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The version 2 GetTile operation gives a better user experience and is compatible with the remainder of the V2 Maps API. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is foMapName (string) required
Z (string) required
X (string) required
Y (string) required
Key (string)
location/describe_mapThis operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. DescribeMap is part of a previous Amazon Location Service Maps API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is foMapName (string) required
location/update_mapThis operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. UpdateMap is part of a previous Amazon Location Service Maps API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is founMapName (string) required
PricingPlan (string)
Description (string)
ConfigurationUpdate: {
. PoliticalView (string)
. CustomLayers (array)
} (object)
location/delete_mapThis operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. DeleteMap is part of a previous Amazon Location Service Maps API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is founMapName (string) required
location/list_mapsThis operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. ListMaps is part of a previous Amazon Location Service Maps API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is foundMaxResults (integer)
NextToken (string)
location/create_mapThis operation is no longer current and may be deprecated in the future. We recommend upgrading to the Maps API V2 unless you require Grab data. CreateMap is part of a previous Amazon Location Service Maps API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Maps API version 2 has a simplified interface that can be used without creating or managing map resources. If you are using an AWS SDK or the AWS CLI, note that the Maps API version 2 is founMapName (string) required
Configuration: {
. Style (string)
. PoliticalView (string)
. CustomLayers (array)
} (object) required
PricingPlan (string)
Description (string)
Tags (object)
location/get_placeThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to the V2 GetPlace operation unless you require Grab data. This version of GetPlace is part of a previous Amazon Location Service Places API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. Version 2 of the GetPlace operation interoperates with the rest of the Places V2 API, while this version does not. If you are using an Amazon Web Services SDK or theIndexName (string) required
PlaceId (string) required
Language (string)
Key (string)
location/search_place_index_for_positionThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to ReverseGeocode or SearchNearby unless you require Grab data. SearchPlaceIndexForPosition is part of a previous Amazon Location Service Places API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The version 2 ReverseGeocode operation gives better results in the address reverse-geocoding use case, while the version 2 SearchNearby operation gives betterIndexName (string) required
Position (array) required
MaxResults (integer)
Language (string)
Key (string)
location/search_place_index_for_suggestionsThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to Suggest or Autocomplete unless you require Grab data. SearchPlaceIndexForSuggestions is part of a previous Amazon Location Service Places API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The version 2 Suggest operation gives better results for typeahead place search suggestions with fuzzy matching, while the version 2 Autocomplete operation givesIndexName (string) required
Text (string) required
BiasPosition (array)
FilterBBox (array)
FilterCountries (array)
MaxResults (integer)
Language (string)
FilterCategories (array)
Key (string)
location/search_place_index_for_textThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to Geocode or SearchText unless you require Grab data. SearchPlaceIndexForText is part of a previous Amazon Location Service Places API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The version 2 Geocode operation gives better results in the address geocoding use case, while the version 2 SearchText operation gives better results when searching for buIndexName (string) required
Text (string) required
BiasPosition (array)
FilterBBox (array)
FilterCountries (array)
MaxResults (integer)
Language (string)
FilterCategories (array)
Key (string)
location/describe_place_indexThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data. DescribePlaceIndex is part of a previous Amazon Location Service Places API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Places API version 2 has a simplified interface that can be used without creating or managing place index resources. If you are using an Amazon Web Services SDK or the Amazon WIndexName (string) required
location/update_place_indexThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data. UpdatePlaceIndex is part of a previous Amazon Location Service Places API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Places API version 2 has a simplified interface that can be used without creating or managing place index resources. If you are using an Amazon Web Services SDK or the Amazon WebIndexName (string) required
PricingPlan (string)
Description (string)
DataSourceConfiguration: {
. IntendedUse (string)
} (object)
location/delete_place_indexThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data. DeletePlaceIndex is part of a previous Amazon Location Service Places API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Places API version 2 has a simplified interface that can be used without creating or managing place index resources. If you are using an Amazon Web Services SDK or the Amazon WebIndexName (string) required
location/list_place_indexesThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data. ListPlaceIndexes is part of a previous Amazon Location Service Places API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Places API version 2 has a simplified interface that can be used without creating or managing place index resources. If you are using an Amazon Web Services SDK or the Amazon WebMaxResults (integer)
NextToken (string)
location/create_place_indexThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data. CreatePlaceIndex is part of a previous Amazon Location Service Places API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Places API version 2 has a simplified interface that can be used without creating or managing place index resources. If you are using an Amazon Web Services SDK or the Amazon WebIndexName (string) required
DataSource (string) required
PricingPlan (string)
Description (string)
DataSourceConfiguration: {
. IntendedUse (string)
} (object)
Tags (object)
location/calculate_routeThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to CalculateRoutes or CalculateIsolines unless you require Grab data. CalculateRoute is part of a previous Amazon Location Service Routes API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The version 2 CalculateRoutes operation gives better results for point-to-point routing, while the version 2 CalculateIsolines operation adds support for calculatingCalculatorName (string) required
DeparturePosition (array) required
DestinationPosition (array) required
WaypointPositions (array)
TravelMode (string)
DepartureTime (string)
DepartNow (boolean)
DistanceUnit (string)
IncludeLegGeometry (boolean)
CarModeOptions: {
. AvoidFerries (boolean)
. AvoidTolls (boolean)
} (object)
TruckModeOptions: {
. AvoidFerries (boolean)
. AvoidTolls (boolean)
. Dimensions (object)
. Weight (object)
} (object)
ArrivalTime (string)
OptimizeFor (string)
Key (string)
location/calculate_route_matrixThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to the V2 CalculateRouteMatrix unless you require Grab data. This version of CalculateRouteMatrix is part of a previous Amazon Location Service Routes API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The version 2 CalculateRouteMatrix operation gives better results for matrix routing calculations. If you are using an Amazon Web Services SDK or the AmCalculatorName (string) required
DeparturePositions (array) required
DestinationPositions (array) required
TravelMode (string)
DepartureTime (string)
DepartNow (boolean)
DistanceUnit (string)
CarModeOptions: {
. AvoidFerries (boolean)
. AvoidTolls (boolean)
} (object)
TruckModeOptions: {
. AvoidFerries (boolean)
. AvoidTolls (boolean)
. Dimensions (object)
. Weight (object)
} (object)
Key (string)
location/describe_route_calculatorThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data. DescribeRouteCalculator is part of a previous Amazon Location Service Routes API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources. If you are using an Amazon Web Services SDK or thCalculatorName (string) required
location/update_route_calculatorThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data. UpdateRouteCalculator is part of a previous Amazon Location Service Routes API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources. If you are using an Amazon Web Services SDK or theCalculatorName (string) required
PricingPlan (string)
Description (string)
location/delete_route_calculatorThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data. DeleteRouteCalculator is part of a previous Amazon Location Service Routes API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources. If you are using an Amazon Web Services SDK or theCalculatorName (string) required
location/list_route_calculatorsThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data. ListRouteCalculators is part of a previous Amazon Location Service Routes API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources. If you are using an Amazon Web Services SDK or the AMaxResults (integer)
NextToken (string)
location/create_route_calculatorThis operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Routes API V2 unless you require Grab data. CreateRouteCalculator is part of a previous Amazon Location Service Routes API version 1 which has been superseded by a more intuitive, powerful, and complete API version 2. The Routes API version 2 has a simplified interface that can be used without creating or managing route calculator resources. If you are using an Amazon Web Services SDK or theCalculatorName (string) required
DataSource (string) required
PricingPlan (string)
Description (string)
Tags (object)
location/associate_tracker_consumerCreates 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.TrackerName (string) required
ConsumerArn (string) required
location/batch_delete_device_position_historyDeletes the position history of one or more devices from a tracker resource.TrackerName (string) required
DeviceIds (array) required
location/batch_get_device_positionLists the latest device positions for requested devices.TrackerName (string) required
DeviceIds (array) required
location/batch_update_device_positionUploads position update data for one or more devices to a tracker resource up to 10 devices per batch. 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 peTrackerName (string) required
Updates (array) required
location/disassociate_tracker_consumerRemoves 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.TrackerName (string) required
ConsumerArn (string) required
location/get_device_positionRetrieves a device's most recent position according to its sample time. Device positions are deleted after 30 days.TrackerName (string) required
DeviceId (string) required
location/get_device_position_historyRetrieves the device position history from a tracker resource within a specified range of time. Device positions are deleted after 30 days.TrackerName (string) required
DeviceId (string) required
NextToken (string)
StartTimeInclusive (string)
EndTimeExclusive (string)
MaxResults (integer)
location/list_device_positionsA batch request to retrieve all device positions.TrackerName (string) required
MaxResults (integer)
NextToken (string)
FilterGeometry: {
. Polygon (array)
} (object)
location/list_tracker_consumersLists geofence collections currently associated to the given tracker resource.TrackerName (string) required
MaxResults (integer)
NextToken (string)
location/verify_device_positionVerifies the integrity of the device's position by determining if it was reported behind a proxy, and by comparing it to an inferred position estimated based on the device's state. The Location Integrity SDK provides enhanced features related to device verification, and it is available for use by request. To get access to the SDK, contact Sales Support.TrackerName (string) required
DeviceState: {
. DeviceId (string)
. SampleTime (string)
. Position (array)
. Accuracy (object)
. Ipv4Address (string)
. WiFiAccessPoints (array)
. CellSignals (object)
} (object) required
DistanceUnit (string)
location/describe_trackerRetrieves the tracker resource details.TrackerName (string) required
location/update_trackerUpdates the specified properties of a given tracker resource.TrackerName (string) required
PricingPlan (string)
PricingPlanDataSource (string)
Description (string)
PositionFiltering (string)
EventBridgeEnabled (boolean)
KmsKeyEnableGeospatialQueries (boolean)
location/delete_trackerDeletes a tracker resource from your Amazon Web Services 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.TrackerName (string) required
location/list_trackersLists tracker resources in your Amazon Web Services account.MaxResults (integer)
NextToken (string)
location/create_trackerCreates a tracker resource in your Amazon Web Services account, which lets you retrieve current and historical location of devices.TrackerName (string) required
PricingPlan (string)
KmsKeyId (string)
PricingPlanDataSource (string)
Description (string)
Tags (object)
PositionFiltering (string)
EventBridgeEnabled (boolean)
KmsKeyEnableGeospatialQueries (boolean)
lookoutequipment/create_datasetCreates 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. For example, 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.DatasetName (string) required
DatasetSchema: {
. InlineDataSchema (string)
} (object)
ServerSideKmsKeyId (string)
ClientToken (string) required
Tags (array)
lookoutequipment/create_inference_schedulerCreates 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.ModelName (string) required
InferenceSchedulerName (string) required
DataDelayOffsetInMinutes (integer)
DataUploadFrequency (string) required
DataInputConfiguration: {
. S3InputConfiguration (object)
. InputTimeZoneOffset (string)
. InferenceInputNameConfiguration (object)
} (object) required
DataOutputConfiguration: {
. S3OutputConfiguration (object)
. KmsKeyId (string)
} (object) required
RoleArn (string) required
ServerSideKmsKeyId (string)
ClientToken (string) required
Tags (array)
lookoutequipment/create_labelCreates a label for an event.LabelGroupName (string) required
StartTime (string) required
EndTime (string) required
Rating (string) required
FaultCode (string)
Notes (string)
Equipment (string)
ClientToken (string) required
lookoutequipment/create_label_groupCreates a group of labels.LabelGroupName (string) required
FaultCodes (array)
ClientToken (string) required
Tags (array)
lookoutequipment/create_modelCreates a machine learning 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 uModelName (string) required
DatasetName (string) required
DatasetSchema: {
. InlineDataSchema (string)
} (object)
LabelsInputConfiguration: {
. S3InputConfiguration (object)
. LabelGroupName (string)
} (object)
ClientToken (string) required
TrainingDataStartTime (string)
TrainingDataEndTime (string)
EvaluationDataStartTime (string)
EvaluationDataEndTime (string)
RoleArn (string)
DataPreProcessingConfiguration: {
. TargetSamplingRate (string)
} (object)
ServerSideKmsKeyId (string)
Tags (array)
OffCondition (string)
ModelDiagnosticsOutputConfiguration: {
. S3OutputConfiguration (object)
. KmsKeyId (string)
} (object)
lookoutequipment/create_retraining_schedulerCreates a retraining scheduler on the specified model.ModelName (string) required
RetrainingStartDate (string)
RetrainingFrequency (string) required
LookbackWindow (string) required
PromoteMode (string)
ClientToken (string) required
lookoutequipment/delete_datasetDeletes 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.DatasetName (string) required
lookoutequipment/delete_inference_schedulerDeletes an inference scheduler that has been set up. Prior inference results will not be deleted.InferenceSchedulerName (string) required
lookoutequipment/delete_labelDeletes a label.LabelGroupName (string) required
LabelId (string) required
lookoutequipment/delete_label_groupDeletes a group of labels.LabelGroupName (string) required
lookoutequipment/delete_modelDeletes a machine learning 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.ModelName (string) required
lookoutequipment/delete_resource_policyDeletes the resource policy attached to the resource.ResourceArn (string) required
lookoutequipment/delete_retraining_schedulerDeletes a retraining scheduler from a model. The retraining scheduler must be in the STOPPED status.ModelName (string) required
lookoutequipment/describe_data_ingestion_jobProvides information on a specific data ingestion job such as creation time, dataset ARN, and status.JobId (string) required
lookoutequipment/describe_datasetProvides a JSON description of the data in each time series dataset, including names, column names, and data types.DatasetName (string) required
lookoutequipment/describe_inference_schedulerSpecifies information about the inference scheduler being used, including name, model, status, and associated metadataInferenceSchedulerName (string) required
lookoutequipment/describe_labelReturns the name of the label.LabelGroupName (string) required
LabelId (string) required
lookoutequipment/describe_label_groupReturns information about the label group.LabelGroupName (string) required
lookoutequipment/describe_modelProvides a JSON containing the overall information about a specific machine learning model, including model name and ARN, dataset, training and evaluation information, status, and so on.ModelName (string) required
lookoutequipment/describe_model_versionRetrieves information about a specific machine learning model version.ModelName (string) required
ModelVersion (integer) required
lookoutequipment/describe_resource_policyProvides the details of a resource policy attached to a resource.ResourceArn (string) required
lookoutequipment/describe_retraining_schedulerProvides a description of the retraining scheduler, including information such as the model name and retraining parameters.ModelName (string) required
lookoutequipment/import_datasetImports a dataset.SourceDatasetArn (string) required
DatasetName (string)
ClientToken (string) required
ServerSideKmsKeyId (string)
Tags (array)
lookoutequipment/import_model_versionImports a model that has been trained successfully.SourceModelVersionArn (string) required
ModelName (string)
DatasetName (string) required
LabelsInputConfiguration: {
. S3InputConfiguration (object)
. LabelGroupName (string)
} (object)
ClientToken (string) required
RoleArn (string)
ServerSideKmsKeyId (string)
Tags (array)
InferenceDataImportStrategy (string)
lookoutequipment/list_data_ingestion_jobsProvides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.DatasetName (string)
NextToken (string)
MaxResults (integer)
Status (string)
lookoutequipment/list_datasetsLists all datasets currently available in your account, filtering on the dataset name.NextToken (string)
MaxResults (integer)
DatasetNameBeginsWith (string)
lookoutequipment/list_inference_eventsLists all inference events that have been found for the specified inference scheduler.NextToken (string)
MaxResults (integer)
InferenceSchedulerName (string) required
IntervalStartTime (string) required
IntervalEndTime (string) required
lookoutequipment/list_inference_executionsLists all inference executions that have been performed by the specified inference scheduler.NextToken (string)
MaxResults (integer)
InferenceSchedulerName (string) required
DataStartTimeAfter (string)
DataEndTimeBefore (string)
Status (string)
lookoutequipment/list_inference_schedulersRetrieves a list of all inference schedulers currently available for your account.NextToken (string)
MaxResults (integer)
InferenceSchedulerNameBeginsWith (string)
ModelName (string)
Status (string)
lookoutequipment/list_label_groupsReturns a list of the label groups.LabelGroupNameBeginsWith (string)
NextToken (string)
MaxResults (integer)
lookoutequipment/list_labelsProvides a list of labels.LabelGroupName (string) required
IntervalStartTime (string)
IntervalEndTime (string)
FaultCode (string)
Equipment (string)
NextToken (string)
MaxResults (integer)
lookoutequipment/list_modelsGenerates a list of all models in the account, including model name and ARN, dataset, and status.NextToken (string)
MaxResults (integer)
Status (string)
ModelNameBeginsWith (string)
DatasetNameBeginsWith (string)
lookoutequipment/list_model_versionsGenerates a list of all model versions for a given model, including the model version, model version ARN, and status. To list a subset of versions, use the MaxModelVersion and MinModelVersion fields.ModelName (string) required
NextToken (string)
MaxResults (integer)
Status (string)
SourceType (string)
CreatedAtEndTime (string)
CreatedAtStartTime (string)
MaxModelVersion (integer)
MinModelVersion (integer)
lookoutequipment/list_retraining_schedulersLists all retraining schedulers in your account, filtering by model name prefix and status.ModelNameBeginsWith (string)
Status (string)
NextToken (string)
MaxResults (integer)
lookoutequipment/list_sensor_statisticsLists 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.DatasetName (string) required
IngestionJobId (string)
MaxResults (integer)
NextToken (string)
lookoutequipment/list_tags_for_resourceLists all the tags for a specified resource, including key and value.ResourceArn (string) required
lookoutequipment/put_resource_policyCreates a resource control policy for a given resource.ResourceArn (string) required
ResourcePolicy (string) required
PolicyRevisionId (string)
ClientToken (string) required
lookoutequipment/start_data_ingestion_jobStarts a data ingestion job. Amazon Lookout for Equipment returns the job status.DatasetName (string) required
IngestionInputConfiguration: {
. S3InputConfiguration (object)
} (object) required
RoleArn (string) required
ClientToken (string) required
lookoutequipment/start_inference_schedulerStarts an inference scheduler.InferenceSchedulerName (string) required
lookoutequipment/start_retraining_schedulerStarts a retraining scheduler.ModelName (string) required
lookoutequipment/stop_inference_schedulerStops an inference scheduler.InferenceSchedulerName (string) required
lookoutequipment/stop_retraining_schedulerStops a retraining scheduler.ModelName (string) required
lookoutequipment/tag_resourceAssociates 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.ResourceArn (string) required
Tags (array) required
lookoutequipment/untag_resourceRemoves a specific tag from a given resource. The tag is specified by its key.ResourceArn (string) required
TagKeys (array) required
lookoutequipment/update_active_model_versionSets the active model version for a given machine learning model.ModelName (string) required
ModelVersion (integer) required
lookoutequipment/update_inference_schedulerUpdates an inference scheduler.InferenceSchedulerName (string) required
DataDelayOffsetInMinutes (integer)
DataUploadFrequency (string)
DataInputConfiguration: {
. S3InputConfiguration (object)
. InputTimeZoneOffset (string)
. InferenceInputNameConfiguration (object)
} (object)
DataOutputConfiguration: {
. S3OutputConfiguration (object)
. KmsKeyId (string)
} (object)
RoleArn (string)
lookoutequipment/update_label_groupUpdates the label group.LabelGroupName (string) required
FaultCodes (array)
lookoutequipment/update_modelUpdates a model in the account.ModelName (string) required
LabelsInputConfiguration: {
. S3InputConfiguration (object)
. LabelGroupName (string)
} (object)
RoleArn (string)
ModelDiagnosticsOutputConfiguration: {
. S3OutputConfiguration (object)
. KmsKeyId (string)
} (object)
lookoutequipment/update_retraining_schedulerUpdates a retraining scheduler.ModelName (string) required
RetrainingStartDate (string)
RetrainingFrequency (string)
LookbackWindow (string)
PromoteMode (string)
m2/get_signed_bluinsights_urlGets a single sign-on URL that can be used to connect to AWS Blu Insights.No parameters
m2/list_engine_versionsLists the available engine versions.engineType (string)
nextToken (string)
maxResults (integer)
m2/list_tags_for_resourceLists the tags for the specified resource.resourceArn (string) required
m2/tag_resourceAdds one or more tags to the specified resource.resourceArn (string) required
tags (object) required
m2/untag_resourceRemoves one or more tags from the specified resource.resourceArn (string) required
tagKeys (array) required
m2/cancel_batch_job_executionCancels the running of a specific batch job execution.applicationId (string) required
executionId (string) required
authSecretsManagerArn (string)
m2/create_data_set_export_taskStarts a data set export task for a specific application.applicationId (string) required
exportConfig (undefined) required
clientToken (string)
kmsKeyId (string)
m2/create_data_set_import_taskStarts a data set import task for a specific application.applicationId (string) required
importConfig (undefined) required
clientToken (string)
m2/create_deploymentCreates and starts a deployment to deploy an application into a runtime environment.environmentId (string) required
applicationId (string) required
applicationVersion (integer) required
clientToken (string)
m2/delete_application_from_environmentDeletes a specific application from the specific runtime environment where it was previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any application has ever been deployed to it. This API removes the association of the application with the runtime environment so you can delete the environment smoothly.applicationId (string) required
environmentId (string) required
m2/get_application_versionReturns details about a specific version of a specific application.applicationId (string) required
applicationVersion (integer) required
m2/get_batch_job_executionGets the details of a specific batch job execution for a specific application.applicationId (string) required
executionId (string) required
m2/get_data_set_detailsGets the details of a specific data set.applicationId (string) required
dataSetName (string) required
m2/get_data_set_export_taskGets the status of a data set import task initiated with the CreateDataSetExportTask operation.applicationId (string) required
taskId (string) required
m2/get_data_set_import_taskGets the status of a data set import task initiated with the CreateDataSetImportTask operation.applicationId (string) required
taskId (string) required
m2/get_deploymentGets details of a specific deployment with a given deployment identifier.deploymentId (string) required
applicationId (string) required
m2/list_application_versionsReturns a list of the application versions for a specific application.nextToken (string)
maxResults (integer)
applicationId (string) required
m2/list_batch_job_definitionsLists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.nextToken (string)
maxResults (integer)
applicationId (string) required
prefix (string)
m2/list_batch_job_executionsLists historical, current, and scheduled batch job executions for a specific application.nextToken (string)
maxResults (integer)
applicationId (string) required
executionIds (array)
jobName (string)
status (string)
startedAfter (string)
startedBefore (string)
m2/list_batch_job_restart_pointsLists all the job steps for a JCL file to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.applicationId (string) required
executionId (string) required
authSecretsManagerArn (string)
m2/list_data_set_export_historyLists the data set exports for the specified application.nextToken (string)
maxResults (integer)
applicationId (string) required
m2/list_data_set_import_historyLists the data set imports for the specified application.nextToken (string)
maxResults (integer)
applicationId (string) required
m2/list_data_setsLists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on runtime environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.applicationId (string) required
nextToken (string)
maxResults (integer)
prefix (string)
nameFilter (string)
m2/list_deploymentsReturns 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.nextToken (string)
maxResults (integer)
applicationId (string) required
m2/start_applicationStarts an application that is currently stopped.applicationId (string) required
m2/start_batch_jobStarts 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.applicationId (string) required
batchJobIdentifier (undefined) required
jobParams (object)
authSecretsManagerArn (string)
m2/stop_applicationStops a running application.applicationId (string) required
forceStop (boolean)
m2/create_applicationCreates a new application with given parameters. Requires an existing runtime environment and application definition file.name (string) required
description (string)
engineType (string) required
definition (undefined) required
tags (object)
clientToken (string)
kmsKeyId (string)
roleArn (string)
m2/get_applicationDescribes the details of a specific application.applicationId (string) required
m2/update_applicationUpdates an application and creates a new version.applicationId (string) required
description (string)
currentApplicationVersion (integer) required
definition (undefined)
m2/delete_applicationDeletes a specific application. You cannot delete a running application.applicationId (string) required
m2/list_applicationsLists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.nextToken (string)
maxResults (integer)
names (array)
environmentId (string)
m2/create_environmentCreates a runtime environment for a given runtime engine.name (string) required
instanceType (string) required
description (string)
engineType (string) required
engineVersion (string)
subnetIds (array)
securityGroupIds (array)
storageConfigurations (array)
publiclyAccessible (boolean)
highAvailabilityConfig: {
. desiredCapacity (integer)
} (object)
tags (object)
preferredMaintenanceWindow (string)
networkType (string)
clientToken (string)
kmsKeyId (string)
m2/get_environmentDescribes a specific runtime environment.environmentId (string) required
m2/update_environmentUpdates the configuration details for a specific runtime environment.environmentId (string) required
desiredCapacity (integer)
instanceType (string)
engineVersion (string)
preferredMaintenanceWindow (string)
applyDuringMaintenanceWindow (boolean)
forceUpdate (boolean)
m2/delete_environmentDeletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.environmentId (string) required
m2/list_environmentsLists the runtime environments.nextToken (string)
maxResults (integer)
names (array)
engineType (string)
machine_learning/add_tagsAdds 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.Tags (array) required
ResourceId (string) required
ResourceType (string) required
machine_learning/create_batch_predictionGenerates 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 complBatchPredictionId (string) required
BatchPredictionName (string)
MLModelId (string) required
BatchPredictionDataSourceId (string) required
OutputUri (string) required
machine_learning/create_data_source_from_rdsCreates 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 COMPLETEDDataSourceId (string) required
DataSourceName (string)
RDSData: {
. DatabaseInformation (object)
. SelectSqlQuery (string)
. DatabaseCredentials (object)
. S3StagingLocation (string)
. DataRearrangement (string)
. DataSchema (string)
. DataSchemaUri (string)
. ResourceRole (string)
. ServiceRole (string)
. SubnetId (string)
. SecurityGroupIds (array)
} (object) required
RoleARN (string) required
ComputeStatistics (boolean)
machine_learning/create_data_source_from_redshiftCreates 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 toDataSourceId (string) required
DataSourceName (string)
DataSpec: {
. DatabaseInformation (object)
. SelectSqlQuery (string)
. DatabaseCredentials (object)
. S3StagingLocation (string)
. DataRearrangement (string)
. DataSchema (string)
. DataSchemaUri (string)
} (object) required
RoleARN (string) required
ComputeStatistics (boolean)
machine_learning/create_data_source_from_s3Creates 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 stateDataSourceId (string) required
DataSourceName (string)
DataSpec: {
. DataLocationS3 (string)
. DataRearrangement (string)
. DataSchema (string)
. DataSchemaLocationS3 (string)
} (object) required
ComputeStatistics (boolean)
machine_learning/create_evaluationCreates 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 MultEvaluationId (string) required
EvaluationName (string)
MLModelId (string) required
EvaluationDataSourceId (string) required
machine_learning/create_mlmodelCreates 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 thMLModelId (string) required
MLModelName (string)
MLModelType (string) required
Parameters (object)
TrainingDataSourceId (string) required
Recipe (string)
RecipeUri (string)
machine_learning/create_realtime_endpointCreates 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.MLModelId (string) required
machine_learning/delete_batch_predictionAssigns 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.BatchPredictionId (string) required
machine_learning/delete_data_sourceAssigns 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.DataSourceId (string) required
machine_learning/delete_evaluationAssigns 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.EvaluationId (string) required
machine_learning/delete_mlmodelAssigns 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.MLModelId (string) required
machine_learning/delete_realtime_endpointDeletes a real time endpoint of an MLModel.MLModelId (string) required
machine_learning/delete_tagsDeletes 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.TagKeys (array) required
ResourceId (string) required
ResourceType (string) required
machine_learning/describe_batch_predictionsReturns a list of BatchPrediction operations that match the search criteria in the request.FilterVariable (string)
EQ (string)
GT (string)
LT (string)
GE (string)
LE (string)
NE (string)
Prefix (string)
SortOrder (string)
NextToken (string)
Limit (integer)
machine_learning/describe_data_sourcesReturns a list of DataSource that match the search criteria in the request.FilterVariable (string)
EQ (string)
GT (string)
LT (string)
GE (string)
LE (string)
NE (string)
Prefix (string)
SortOrder (string)
NextToken (string)
Limit (integer)
machine_learning/describe_evaluationsReturns a list of DescribeEvaluations that match the search criteria in the request.FilterVariable (string)
EQ (string)
GT (string)
LT (string)
GE (string)
LE (string)
NE (string)
Prefix (string)
SortOrder (string)
NextToken (string)
Limit (integer)
machine_learning/describe_mlmodelsReturns a list of MLModel that match the search criteria in the request.FilterVariable (string)
EQ (string)
GT (string)
LT (string)
GE (string)
LE (string)
NE (string)
Prefix (string)
SortOrder (string)
NextToken (string)
Limit (integer)
machine_learning/describe_tagsDescribes one or more of the tags for your Amazon ML object.ResourceId (string) required
ResourceType (string) required
machine_learning/get_batch_predictionReturns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request.BatchPredictionId (string) required
machine_learning/get_data_sourceReturns 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.DataSourceId (string) required
Verbose (boolean)
machine_learning/get_evaluationReturns an Evaluation that includes metadata as well as the current status of the Evaluation.EvaluationId (string) required
machine_learning/get_mlmodelReturns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel. GetMLModel provides results in normal or verbose format.MLModelId (string) required
Verbose (boolean)
machine_learning/predictGenerates 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.MLModelId (string) required
Record (object) required
PredictEndpoint (string) required
machine_learning/update_batch_predictionUpdates the BatchPredictionName of a BatchPrediction. You can use the GetBatchPrediction operation to view the contents of the updated data element.BatchPredictionId (string) required
BatchPredictionName (string) required
machine_learning/update_data_sourceUpdates the DataSourceName of a DataSource. You can use the GetDataSource operation to view the contents of the updated data element.DataSourceId (string) required
DataSourceName (string) required
machine_learning/update_evaluationUpdates the EvaluationName of an Evaluation. You can use the GetEvaluation operation to view the contents of the updated data element.EvaluationId (string) required
EvaluationName (string) required
machine_learning/update_mlmodelUpdates the MLModelName and the ScoreThreshold of an MLModel. You can use the GetMLModel operation to view the contents of the updated data element.MLModelId (string) required
MLModelName (string)
ScoreThreshold (number)
macie2/accept_invitationAccepts an Amazon Macie membership invitation that was received from a specific account.administratorAccountId (string)
invitationId (string) required
masterAccount (string)
macie2/batch_get_custom_data_identifiersRetrieves information about one or more custom data identifiers.ids (array)
macie2/batch_update_automated_discovery_accountsChanges the status of automated sensitive data discovery for one or more accounts.accounts (array)
macie2/create_allow_listCreates and defines the settings for an allow list.clientToken (string) required
criteria: {
. regex (string)
. s3WordsList (object)
} (object) required
description (string)
name (string) required
tags (object)
macie2/create_classification_jobCreates and defines the settings for a classification job.allowListIds (array)
clientToken (string) required
customDataIdentifierIds (array)
description (string)
initialRun (boolean)
jobType (string) required
managedDataIdentifierIds (array)
managedDataIdentifierSelector (string)
name (string) required
s3JobDefinition: {
. bucketCriteria (object)
. bucketDefinitions (array)
. scoping (object)
} (object) required
samplingPercentage (integer)
scheduleFrequency: {
. dailySchedule (object)
. monthlySchedule (object)
. weeklySchedule (object)
} (object)
tags (object)
macie2/create_custom_data_identifierCreates and defines the criteria and other settings for a custom data identifier.clientToken (string)
description (string)
ignoreWords (array)
keywords (array)
maximumMatchDistance (integer)
name (string) required
regex (string) required
severityLevels (array)
tags (object)
macie2/create_findings_filterCreates and defines the criteria and other settings for a findings filter.action (string) required
clientToken (string)
description (string)
findingCriteria: {
. criterion (object)
} (object) required
name (string) required
position (integer)
tags (object)
macie2/create_invitationsSends an Amazon Macie membership invitation to one or more accounts.accountIds (array) required
disableEmailNotification (boolean)
message (string)
macie2/create_memberAssociates an account with an Amazon Macie administrator account.account: {
. accountId (string)
. email (string)
} (object) required
tags (object)
macie2/create_sample_findingsCreates sample findings.findingTypes (array)
macie2/decline_invitationsDeclines Amazon Macie membership invitations that were received from specific accounts.accountIds (array) required
macie2/delete_allow_listDeletes an allow list.id (string) required
ignoreJobChecks (string)
macie2/delete_custom_data_identifierSoft deletes a custom data identifier.id (string) required
macie2/delete_findings_filterDeletes a findings filter.id (string) required
macie2/delete_invitationsDeletes Amazon Macie membership invitations that were received from specific accounts.accountIds (array) required
macie2/delete_memberDeletes the association between an Amazon Macie administrator account and an account.id (string) required
macie2/describe_bucketsRetrieves queries statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.criteria (object)
maxResults (integer)
nextToken (string)
sortCriteria: {
. attributeName (string)
. orderBy (string)
} (object)
macie2/describe_classification_jobRetrieves the status and settings for a classification job.jobId (string) required
macie2/describe_organization_configurationRetrieves the Amazon Macie configuration settings for an organization in Organizations.No parameters
macie2/disable_macieDisables Amazon Macie and deletes all settings and resources for a Macie account.No parameters
macie2/disable_organization_admin_accountDisables an account as the delegated Amazon Macie administrator account for an organization in Organizations.adminAccountId (string) required
macie2/disassociate_from_administrator_accountDisassociates a member account from its Amazon Macie administrator account.No parameters
macie2/disassociate_from_master_accountDeprecated Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation.No parameters
macie2/disassociate_memberDisassociates an Amazon Macie administrator account from a member account.id (string) required
macie2/enable_macieEnables Amazon Macie and specifies the configuration settings for a Macie account.clientToken (string)
findingPublishingFrequency (string)
status (string)
macie2/enable_organization_admin_accountDesignates an account as the delegated Amazon Macie administrator account for an organization in Organizations.adminAccountId (string) required
clientToken (string)
macie2/get_administrator_accountRetrieves information about the Amazon Macie administrator account for an account.No parameters
macie2/get_allow_listRetrieves the settings and status of an allow list.id (string) required
macie2/get_automated_discovery_configurationRetrieves the configuration settings and status of automated sensitive data discovery for an organization or standalone account.No parameters
macie2/get_bucket_statisticsRetrieves queries aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account.accountId (string)
macie2/get_classification_export_configurationRetrieves the configuration settings for storing data classification results.No parameters
macie2/get_classification_scopeRetrieves the classification scope settings for an account.id (string) required
macie2/get_custom_data_identifierRetrieves the criteria and other settings for a custom data identifier.id (string) required
macie2/get_findingsRetrieves the details of one or more findings.findingIds (array) required
sortCriteria: {
. attributeName (string)
. orderBy (string)
} (object)
macie2/get_findings_filterRetrieves the criteria and other settings for a findings filter.id (string) required
macie2/get_findings_publication_configurationRetrieves the configuration settings for publishing findings to Security Hub.No parameters
macie2/get_finding_statisticsRetrieves queries aggregated statistical data about findings.findingCriteria: {
. criterion (object)
} (object)
groupBy (string) required
size (integer)
sortCriteria: {
. attributeName (string)
. orderBy (string)
} (object)
macie2/get_invitations_countRetrieves the count of Amazon Macie membership invitations that were received by an account.No parameters
macie2/get_macie_sessionRetrieves the status and configuration settings for an Amazon Macie account.No parameters
macie2/get_master_accountDeprecated Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation.No parameters
macie2/get_memberRetrieves information about an account that's associated with an Amazon Macie administrator account.id (string) required
macie2/get_resource_profileRetrieves queries sensitive data discovery statistics and the sensitivity score for an S3 bucket.resourceArn (string) required
macie2/get_reveal_configurationRetrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.No parameters
macie2/get_sensitive_data_occurrencesRetrieves occurrences of sensitive data reported by a finding.findingId (string) required
macie2/get_sensitive_data_occurrences_availabilityChecks whether occurrences of sensitive data can be retrieved for a finding.findingId (string) required
macie2/get_sensitivity_inspection_templateRetrieves the settings for the sensitivity inspection template for an account.id (string) required
macie2/get_usage_statisticsRetrieves queries quotas and aggregated usage data for one or more accounts.filterBy (array)
maxResults (integer)
nextToken (string)
sortBy: {
. key (string)
. orderBy (string)
} (object)
timeRange (string)
macie2/get_usage_totalsRetrieves queries aggregated usage data for an account.timeRange (string)
macie2/list_allow_listsRetrieves a subset of information about all the allow lists for an account.maxResults (integer)
nextToken (string)
macie2/list_automated_discovery_accountsRetrieves the status of automated sensitive data discovery for one or more accounts.accountIds (array)
maxResults (integer)
nextToken (string)
macie2/list_classification_jobsRetrieves a subset of information about one or more classification jobs.filterCriteria: {
. excludes (array)
. includes (array)
} (object)
maxResults (integer)
nextToken (string)
sortCriteria: {
. attributeName (string)
. orderBy (string)
} (object)
macie2/list_classification_scopesRetrieves a subset of information about the classification scope for an account.name (string)
nextToken (string)
macie2/list_custom_data_identifiersRetrieves a subset of information about the custom data identifiers for an account.maxResults (integer)
nextToken (string)
macie2/list_findingsRetrieves a subset of information about one or more findings.findingCriteria: {
. criterion (object)
} (object)
maxResults (integer)
nextToken (string)
sortCriteria: {
. attributeName (string)
. orderBy (string)
} (object)
macie2/list_findings_filtersRetrieves a subset of information about all the findings filters for an account.maxResults (integer)
nextToken (string)
macie2/list_invitationsRetrieves information about Amazon Macie membership invitations that were received by an account.maxResults (integer)
nextToken (string)
macie2/list_managed_data_identifiersRetrieves information about all the managed data identifiers that Amazon Macie currently provides.nextToken (string)
macie2/list_membersRetrieves information about the accounts that are associated with an Amazon Macie administrator account.maxResults (integer)
nextToken (string)
onlyAssociated (string)
macie2/list_organization_admin_accountsRetrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.maxResults (integer)
nextToken (string)
macie2/list_resource_profile_artifactsRetrieves information about objects that Amazon Macie selected from an S3 bucket for automated sensitive data discovery.nextToken (string)
resourceArn (string) required
macie2/list_resource_profile_detectionsRetrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.maxResults (integer)
nextToken (string)
resourceArn (string) required
macie2/list_sensitivity_inspection_templatesRetrieves a subset of information about the sensitivity inspection template for an account.maxResults (integer)
nextToken (string)
macie2/list_tags_for_resourceRetrieves the tags keys and values that are associated with an Amazon Macie resource.resourceArn (string) required
macie2/put_classification_export_configurationAdds or updates the configuration settings for storing data classification results.configuration: {
. s3Destination (object)
} (object) required
macie2/put_findings_publication_configurationUpdates the configuration settings for publishing findings to Security Hub.clientToken (string)
securityHubConfiguration: {
. publishClassificationFindings (boolean)
. publishPolicyFindings (boolean)
} (object)
macie2/search_resourcesRetrieves queries statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes for an account.bucketCriteria: {
. excludes (object)
. includes (object)
} (object)
maxResults (integer)
nextToken (string)
sortCriteria: {
. attributeName (string)
. orderBy (string)
} (object)
macie2/tag_resourceAdds or updates one or more tags keys and values that are associated with an Amazon Macie resource.resourceArn (string) required
tags (object) required
macie2/test_custom_data_identifierTests criteria for a custom data identifier.ignoreWords (array)
keywords (array)
maximumMatchDistance (integer)
regex (string) required
sampleText (string) required
macie2/untag_resourceRemoves one or more tags keys and values from an Amazon Macie resource.resourceArn (string) required
tagKeys (array) required
macie2/update_allow_listUpdates the settings for an allow list.criteria: {
. regex (string)
. s3WordsList (object)
} (object) required
description (string)
id (string) required
name (string) required
macie2/update_automated_discovery_configurationChanges the configuration settings and status of automated sensitive data discovery for an organization or standalone account.autoEnableOrganizationMembers (string)
status (string) required
macie2/update_classification_jobChanges the status of a classification job.jobId (string) required
jobStatus (string) required
macie2/update_classification_scopeUpdates the classification scope settings for an account.id (string) required
s3: {
. excludes (object)
} (object)
macie2/update_findings_filterUpdates the criteria and other settings for a findings filter.action (string)
clientToken (string)
description (string)
findingCriteria: {
. criterion (object)
} (object)
id (string) required
name (string)
position (integer)
macie2/update_macie_sessionSuspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.findingPublishingFrequency (string)
status (string)
macie2/update_member_sessionEnables an Amazon Macie administrator to suspend or re-enable Macie for a member account.id (string) required
status (string) required
macie2/update_organization_configurationUpdates the Amazon Macie configuration settings for an organization in Organizations.autoEnable (boolean) required
macie2/update_resource_profileUpdates the sensitivity score for an S3 bucket.resourceArn (string) required
sensitivityScoreOverride (integer)
macie2/update_resource_profile_detectionsUpdates the sensitivity scoring settings for an S3 bucket.resourceArn (string) required
suppressDataIdentifiers (array)
macie2/update_reveal_configurationUpdates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.configuration: {
. kmsKeyId (string)
. status (string)
} (object) required
retrievalConfiguration: {
. retrievalMode (string)
. roleName (string)
} (object)
macie2/update_sensitivity_inspection_templateUpdates the settings for the sensitivity inspection template for an account.description (string)
excludes: {
. managedDataIdentifierIds (array)
} (object)
id (string) required
includes: {
. allowListIds (array)
. customDataIdentifierIds (array)
. managedDataIdentifierIds (array)
} (object)
mailmanager/create_address_list_import_jobCreates an import job for an address list.ClientToken (string)
AddressListId (string) required
Name (string) required
ImportDataFormat: {
. ImportDataType (string)
} (object) required
mailmanager/deregister_member_from_address_listRemoves a member from an address list.AddressListId (string) required
Address (string) required
mailmanager/get_address_list_import_jobFetch attributes of an import job.JobId (string) required
mailmanager/get_archive_exportRetrieves the details and current status of a specific email archive export job.ExportId (string) required
mailmanager/get_archive_messageReturns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.ArchivedMessageId (string) required
mailmanager/get_archive_message_contentReturns the textual content of a specific email message stored in the archive. Attachments are not included.ArchivedMessageId (string) required
mailmanager/get_archive_searchRetrieves the details and current status of a specific email archive search job.SearchId (string) required
mailmanager/get_archive_search_resultsReturns the results of a completed email archive search job.SearchId (string) required
mailmanager/get_member_of_address_listFetch attributes of a member in an address list.AddressListId (string) required
Address (string) required
mailmanager/list_address_list_import_jobsLists jobs for an address list.AddressListId (string) required
NextToken (string)
PageSize (integer)
mailmanager/list_archive_exportsReturns a list of email archive export jobs.ArchiveId (string) required
NextToken (string)
PageSize (integer)
mailmanager/list_archive_searchesReturns a list of email archive search jobs.ArchiveId (string) required
NextToken (string)
PageSize (integer)
mailmanager/list_members_of_address_listLists members of an address list.AddressListId (string) required
Filter: {
. AddressPrefix (string)
} (object)
NextToken (string)
PageSize (integer)
mailmanager/list_tags_for_resourceRetrieves the list of tags keys and values assigned to the resource.ResourceArn (string) required
mailmanager/register_member_to_address_listAdds a member to an address list.AddressListId (string) required
Address (string) required
mailmanager/start_address_list_import_jobStarts an import job for an address list.JobId (string) required
mailmanager/start_archive_exportInitiates an export of emails from the specified archive.ArchiveId (string) required
Filters: {
. Include (array)
. Unless (array)
} (object)
FromTimestamp (string) required
ToTimestamp (string) required
MaxResults (integer)
ExportDestinationConfiguration (undefined) required
IncludeMetadata (boolean)
mailmanager/start_archive_searchInitiates a search across emails in the specified archive.ArchiveId (string) required
Filters: {
. Include (array)
. Unless (array)
} (object)
FromTimestamp (string) required
ToTimestamp (string) required
MaxResults (integer) required
mailmanager/stop_address_list_import_jobStops an ongoing import job for an address list.JobId (string) required
mailmanager/stop_archive_exportStops an in-progress export of emails from an archive.ExportId (string) required
mailmanager/stop_archive_searchStops an in-progress archive search job.SearchId (string) required
mailmanager/tag_resourceAdds one or more tags keys and values to a specified resource.ResourceArn (string) required
Tags (array) required
mailmanager/untag_resourceRemove one or more tags keys and values from a specified resource.ResourceArn (string) required
TagKeys (array) required
mailmanager/create_addon_instanceCreates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name ARN can be used in a conditional statement for a rule set or traffic policy.ClientToken (string)
AddonSubscriptionId (string) required
Tags (array)
mailmanager/get_addon_instanceGets detailed information about an Add On instance.AddonInstanceId (string) required
mailmanager/delete_addon_instanceDeletes an Add On instance.AddonInstanceId (string) required
mailmanager/list_addon_instancesLists all Add On instances in your account.NextToken (string)
PageSize (integer)
mailmanager/create_addon_subscriptionCreates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.ClientToken (string)
AddonName (string) required
Tags (array)
mailmanager/get_addon_subscriptionGets detailed information about an Add On subscription.AddonSubscriptionId (string) required
mailmanager/delete_addon_subscriptionDeletes an Add On subscription.AddonSubscriptionId (string) required
mailmanager/list_addon_subscriptionsLists all Add On subscriptions in your account.NextToken (string)
PageSize (integer)
mailmanager/create_address_listCreates a new address list.ClientToken (string)
AddressListName (string) required
Tags (array)
mailmanager/get_address_listFetch attributes of an address list.AddressListId (string) required
mailmanager/delete_address_listDeletes an address list.AddressListId (string) required
mailmanager/list_address_listsLists address lists for this account.NextToken (string)
PageSize (integer)
mailmanager/create_archiveCreates a new email archive resource for storing and retaining emails.ClientToken (string)
ArchiveName (string) required
Retention (undefined)
KmsKeyArn (string)
Tags (array)
mailmanager/get_archiveRetrieves the full details and current state of a specified email archive.ArchiveId (string) required
mailmanager/update_archiveUpdates the attributes of an existing email archive.ArchiveId (string) required
ArchiveName (string)
Retention (undefined)
mailmanager/delete_archiveInitiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible search, export, download. The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period.ArchiveId (string) required
mailmanager/list_archivesReturns a list of all email archives in your account.NextToken (string)
PageSize (integer)
mailmanager/create_ingress_pointProvision a new ingress endpoint resource.ClientToken (string)
IngressPointName (string) required
Type (string) required
RuleSetId (string) required
TrafficPolicyId (string) required
IngressPointConfiguration (undefined)
NetworkConfiguration (undefined)
Tags (array)
mailmanager/get_ingress_pointFetch ingress endpoint resource attributes.IngressPointId (string) required
mailmanager/update_ingress_pointUpdate attributes of a provisioned ingress endpoint resource.IngressPointId (string) required
IngressPointName (string)
StatusToUpdate (string)
RuleSetId (string)
TrafficPolicyId (string)
IngressPointConfiguration (undefined)
mailmanager/delete_ingress_pointDelete an ingress endpoint resource.IngressPointId (string) required
mailmanager/list_ingress_pointsList all ingress endpoint resources.PageSize (integer)
NextToken (string)
mailmanager/create_relayCreates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.ClientToken (string)
RelayName (string) required
ServerName (string) required
ServerPort (integer) required
Authentication (undefined) required
Tags (array)
mailmanager/get_relayFetch the relay resource and it's attributes.RelayId (string) required
mailmanager/update_relayUpdates the attributes of an existing relay resource.RelayId (string) required
RelayName (string)
ServerName (string)
ServerPort (integer)
Authentication (undefined)
mailmanager/delete_relayDeletes an existing relay resource.RelayId (string) required
mailmanager/list_relaysLists all the existing relay resources.PageSize (integer)
NextToken (string)
mailmanager/create_rule_setProvision a new rule set.ClientToken (string)
RuleSetName (string) required
Rules (array) required
Tags (array)
mailmanager/get_rule_setFetch attributes of a rule set.RuleSetId (string) required
mailmanager/update_rule_setUpdate attributes of an already provisioned rule set.RuleSetId (string) required
RuleSetName (string)
Rules (array)
mailmanager/delete_rule_setDelete a rule set.RuleSetId (string) required
mailmanager/list_rule_setsList rule sets for this account.NextToken (string)
PageSize (integer)
mailmanager/create_traffic_policyProvision a new traffic policy resource.ClientToken (string)
TrafficPolicyName (string) required
PolicyStatements (array) required
DefaultAction (string) required
MaxMessageSizeBytes (integer)
Tags (array)
mailmanager/get_traffic_policyFetch attributes of a traffic policy resource.TrafficPolicyId (string) required
mailmanager/update_traffic_policyUpdate attributes of an already provisioned traffic policy resource.TrafficPolicyId (string) required
TrafficPolicyName (string)
PolicyStatements (array)
DefaultAction (string)
MaxMessageSizeBytes (integer)
mailmanager/delete_traffic_policyDelete a traffic policy resource.TrafficPolicyId (string) required
mailmanager/list_traffic_policiesList traffic policy resources.PageSize (integer)
NextToken (string)
managedblockchain_query/batch_get_token_balanceGets the token balance for a batch of tokens by using the BatchGetTokenBalance action for every token in the request. Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.getTokenBalanceInputs (array)
managedblockchain_query/get_asset_contractGets the information about a specific contract deployed on the blockchain. The Bitcoin blockchain networks do not support this operation. Metadata is currently only available for some ERC-20 contracts. Metadata will be available for additional contracts in the future.contractIdentifier: {
. network (string)
. contractAddress (string)
} (object) required
managedblockchain_query/get_token_balanceGets the balance of a specific token, including native tokens, for a given address wallet or contract on the blockchain. Only the native tokens BTC and ETH, and the ERC-20, ERC-721, and ERC 1155 token standards are supported.tokenIdentifier: {
. network (string)
. contractAddress (string)
. tokenId (string)
} (object) required
ownerIdentifier: {
. address (string)
} (object) required
atBlockchainInstant: {
. time (string)
} (object)
managedblockchain_query/get_transactionGets the details of a transaction. This action will return transaction details for all transactions that are confirmed on the blockchain, even if they have not reached finality.transactionHash (string)
transactionId (string)
network (string) required
managedblockchain_query/list_asset_contractsLists all the contracts for a given contract type deployed by an address either a contract address or a wallet address. The Bitcoin blockchain networks do not support this operation.contractFilter: {
. network (string)
. tokenStandard (string)
. deployerAddress (string)
} (object) required
nextToken (string)
maxResults (integer)
managedblockchain_query/list_filtered_transaction_eventsLists all the transaction events for an address on the blockchain. This operation is only supported on the Bitcoin networks.network (string) required
addressIdentifierFilter: {
. transactionEventToAddress (array)
} (object) required
timeFilter: {
. from (object)
. to (object)
} (object)
voutFilter: {
. voutSpent (boolean)
} (object)
confirmationStatusFilter: {
. include (array)
} (object)
sort: {
. sortBy (string)
. sortOrder (string)
} (object)
nextToken (string)
maxResults (integer)
managedblockchain_query/list_token_balancesThis action returns the following for a given blockchain network: Lists all token balances owned by an address either a contract address or a wallet address. Lists all token balances for all tokens created by a contract. Lists all token balances for a given token. You must always specify the network property of the tokenFilter when using this operation.ownerFilter: {
. address (string)
} (object)
tokenFilter: {
. network (string)
. contractAddress (string)
. tokenId (string)
} (object) required
nextToken (string)
maxResults (integer)
managedblockchain_query/list_transaction_eventsLists all the transaction events for a transaction This action will return transaction details for all transactions that are confirmed on the blockchain, even if they have not reached finality.transactionHash (string)
transactionId (string)
network (string) required
nextToken (string)
maxResults (integer)
managedblockchain_query/list_transactionsLists all the transaction events for a transaction.address (string) required
network (string) required
fromBlockchainInstant: {
. time (string)
} (object)
toBlockchainInstant: {
. time (string)
} (object)
sort: {
. sortBy (string)
. sortOrder (string)
} (object)
nextToken (string)
maxResults (integer)
confirmationStatusFilter: {
. include (array)
} (object)
managedblockchain/create_accessorCreates a new accessor for use with Amazon Managed Blockchain service that supports token based access. The accessor contains information required for token based access.ClientRequestToken (string) required
AccessorType (string) required
Tags (object)
NetworkType (string)
managedblockchain/create_memberCreates a member within a Managed Blockchain network. Applies only to Hyperledger Fabric.ClientRequestToken (string) required
InvitationId (string) required
NetworkId (string) required
MemberConfiguration: {
. Name (string)
. Description (string)
. FrameworkConfiguration (object)
. LogPublishingConfiguration (object)
. Tags (object)
. KmsKeyArn (string)
} (object) required
managedblockchain/create_networkCreates a new blockchain network using Amazon Managed Blockchain. Applies only to Hyperledger Fabric.ClientRequestToken (string) required
Name (string) required
Description (string)
Framework (string) required
FrameworkVersion (string) required
FrameworkConfiguration: {
. Fabric (object)
} (object)
VotingPolicy: {
. ApprovalThresholdPolicy (object)
} (object) required
MemberConfiguration: {
. Name (string)
. Description (string)
. FrameworkConfiguration (object)
. LogPublishingConfiguration (object)
. Tags (object)
. KmsKeyArn (string)
} (object) required
Tags (object)
managedblockchain/create_nodeCreates a node on the specified blockchain network. Applies to Hyperledger Fabric and Ethereum.ClientRequestToken (string) required
NetworkId (string) required
MemberId (string)
NodeConfiguration: {
. InstanceType (string)
. AvailabilityZone (string)
. LogPublishingConfiguration (object)
. StateDB (string)
} (object) required
Tags (object)
managedblockchain/create_proposalCreates 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.ClientRequestToken (string) required
NetworkId (string) required
MemberId (string) required
Actions: {
. Invitations (array)
. Removals (array)
} (object) required
Description (string)
Tags (object)
managedblockchain/delete_accessorDeletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the information required for token based access to your Ethereum nodes including, the BILLING_TOKEN. After an accessor is deleted, the status of the accessor changes from AVAILABLE to PENDING_DELETION. An accessor in the PENDING_DELETION state can’t be used for new WebSocket requests or HTTP requests. However, WebSocket connections that were initiated while the accessor was in the AVAILABLEAccessorId (string) required
managedblockchain/delete_memberDeletes 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 Amazon Web Services 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 Amazon Web Services account, the network is deNetworkId (string) required
MemberId (string) required
managedblockchain/delete_nodeDeletes a node that your Amazon Web Services account owns. All data on the node is lost and cannot be recovered. Applies to Hyperledger Fabric and Ethereum.NetworkId (string) required
MemberId (string)
NodeId (string) required
managedblockchain/get_accessorReturns detailed information about an accessor. An accessor object is a container that has the information required for token based access to your Ethereum nodes.AccessorId (string) required
managedblockchain/get_memberReturns detailed information about a member. Applies only to Hyperledger Fabric.NetworkId (string) required
MemberId (string) required
managedblockchain/get_networkReturns detailed information about a network. Applies to Hyperledger Fabric and Ethereum.NetworkId (string) required
managedblockchain/get_nodeReturns detailed information about a node. Applies to Hyperledger Fabric and Ethereum.NetworkId (string) required
MemberId (string)
NodeId (string) required
managedblockchain/get_proposalReturns detailed information about a proposal. Applies only to Hyperledger Fabric.NetworkId (string) required
ProposalId (string) required
managedblockchain/list_accessorsReturns a list of the accessors and their properties. Accessor objects are containers that have the information required for token based access to your Ethereum nodes.MaxResults (integer)
NextToken (string)
NetworkType (string)
managedblockchain/list_invitationsReturns a list of all invitations for the current Amazon Web Services account. Applies only to Hyperledger Fabric.MaxResults (integer)
NextToken (string)
managedblockchain/list_membersReturns a list of the members in a network and properties of their configurations. Applies only to Hyperledger Fabric.NetworkId (string) required
Name (string)
Status (string)
IsOwned (boolean)
MaxResults (integer)
NextToken (string)
managedblockchain/list_networksReturns information about the networks in which the current Amazon Web Services account participates. Applies to Hyperledger Fabric and Ethereum.Name (string)
Framework (string)
Status (string)
MaxResults (integer)
NextToken (string)
managedblockchain/list_nodesReturns information about the nodes within a network. Applies to Hyperledger Fabric and Ethereum.NetworkId (string) required
MemberId (string)
Status (string)
MaxResults (integer)
NextToken (string)
managedblockchain/list_proposalsReturns a list of proposals for the network. Applies only to Hyperledger Fabric.NetworkId (string) required
MaxResults (integer)
NextToken (string)
managedblockchain/list_proposal_votesReturns 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.NetworkId (string) required
ProposalId (string) required
MaxResults (integer)
NextToken (string)
managedblockchain/list_tags_for_resourceReturns 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.ResourceArn (string) required
managedblockchain/reject_invitationRejects an invitation to join a network. This action can be called by a principal in an Amazon Web Services account that has received an invitation to create a member and join a network. Applies only to Hyperledger Fabric.InvitationId (string) required
managedblockchain/tag_resourceAdds 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 EthereuResourceArn (string) required
Tags (object) required
managedblockchain/untag_resourceRemoves 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.ResourceArn (string) required
TagKeys (array) required
managedblockchain/update_memberUpdates a member configuration with new parameters. Applies only to Hyperledger Fabric.NetworkId (string) required
MemberId (string) required
LogPublishingConfiguration: {
. Fabric (object)
} (object)
managedblockchain/update_nodeUpdates a node configuration with new parameters. Applies only to Hyperledger Fabric.NetworkId (string) required
MemberId (string)
NodeId (string) required
LogPublishingConfiguration: {
. Fabric (object)
} (object)
managedblockchain/vote_on_proposalCasts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId, must be in the same Amazon Web Services account as the principal that calls the action. Applies only to Hyperledger Fabric.NetworkId (string) required
ProposalId (string) required
VoterMemberId (string) required
Vote (string) required
marketplace_agreement/describe_agreementProvides details about an agreement, such as the proposer, acceptor, start date, and end date.agreementId (string) required
marketplace_agreement/get_agreement_termsObtains details about the terms in an agreement that you participated in as proposer or acceptor. The details include: TermType – The type of term, such as LegalTerm, RenewalTerm, or ConfigurableUpfrontPricingTerm. TermID – The ID of the particular term, which is common between offer and agreement. TermPayload – The key information contained in the term, such as the EULA for LegalTerm or pricing and dimensions for various pricing terms, such as ConfigurableUpfrontPricingTerm or UsageBasedPricingagreementId (string) required
maxResults (integer)
nextToken (string)
marketplace_agreement/search_agreementsSearches across all agreements that a proposer has in AWS Marketplace. The search returns a list of agreements with basic agreement information. The following filter combinations are supported when the PartyType is Proposer: AgreementType AgreementType + EndTime AgreementType + ResourceType AgreementType + ResourceType + EndTime AgreementType + ResourceType + Status AgreementType + ResourceType + Status + EndTime AgreementType + ResourceId AgreementType + ResourceId + EndTime AgreementType + Rescatalog (string)
filters (array)
sort: {
. sortBy (string)
. sortOrder (string)
} (object)
maxResults (integer)
nextToken (string)
marketplace_catalog/batch_describe_entitiesReturns metadata and content for multiple entities. This is the Batch version of the DescribeEntity API and uses the same IAM permission action as DescribeEntity API.EntityRequestList (array) required
marketplace_catalog/cancel_change_setUsed 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.Catalog (string) required
ChangeSetId (string) required
marketplace_catalog/delete_resource_policyDeletes a resource-based policy on an entity that is identified by its resource ARN.ResourceArn (string) required
marketplace_catalog/describe_change_setProvides information about a given change set.Catalog (string) required
ChangeSetId (string) required
marketplace_catalog/describe_entityReturns the metadata and content of the entity.Catalog (string) required
EntityId (string) required
marketplace_catalog/get_resource_policyGets a resource-based policy of an entity that is identified by its resource ARN.ResourceArn (string) required
marketplace_catalog/list_change_setsReturns 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.Catalog (string) required
FilterList (array)
Sort: {
. SortBy (string)
. SortOrder (string)
} (object)
MaxResults (integer)
NextToken (string)
marketplace_catalog/list_entitiesProvides the list of entities of a given type.Catalog (string) required
EntityType (string) required
FilterList (array)
Sort: {
. SortBy (string)
. SortOrder (string)
} (object)
NextToken (string)
MaxResults (integer)
OwnershipType (string)
EntityTypeFilters (undefined)
EntityTypeSort (undefined)
marketplace_catalog/list_tags_for_resourceLists all tags that have been added to a resource either an entity or change set.ResourceArn (string) required
marketplace_catalog/put_resource_policyAttaches a resource-based policy to an entity. Examples of an entity include: AmiProduct and ContainerProduct.ResourceArn (string) required
Policy (string) required
marketplace_catalog/start_change_setAllows you to request changes for your entities. Within a single ChangeSet, you can't 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 change set has completed either succeeded, cancelled, or failed. If you try to start a change set containing a change against an entity that is already locked, you will receive a ResourceInUseException error. For example, you can'tCatalog (string) required
ChangeSet (array) required
ChangeSetName (string)
ClientRequestToken (string)
ChangeSetTags (array)
Intent (string)
marketplace_catalog/tag_resourceTags a resource either an entity or change set.ResourceArn (string) required
Tags (array) required
marketplace_catalog/untag_resourceRemoves a tag or list of tags from a resource either an entity or change set.ResourceArn (string) required
TagKeys (array) required
marketplace_commerce_analytics/generate_data_setGiven 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 requesdataSetType (string) required
dataSetPublicationDate (string) required
roleNameArn (string) required
destinationS3BucketName (string) required
destinationS3Prefix (string)
snsTopicArn (string) required
customerDefinedValues (object)
marketplace_commerce_analytics/start_support_data_exportThis target has been deprecated. 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 alredataSetType (string) required
fromDate (string) required
roleNameArn (string) required
destinationS3BucketName (string) required
destinationS3Prefix (string)
snsTopicArn (string) required
customerDefinedValues (object)
marketplace_deployment/list_tags_for_resourceLists all tags that have been added to a deployment parameter resource.resourceArn (string) required
marketplace_deployment/tag_resourceTags a resource.resourceArn (string) required
tags (object)
marketplace_deployment/untag_resourceRemoves a tag or list of tags from a resource.resourceArn (string) required
tagKeys (array) required
marketplace_deployment/put_deployment_parameterCreates or updates a deployment parameter and is targeted by catalog and agreementId.catalog (string) required
productId (string) required
agreementId (string) required
deploymentParameter: {
. name (string)
. secretString (string)
} (object) required
tags (object)
expirationDate (string)
clientToken (string)
marketplace_entitlement_service/get_entitlementsGetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier, AWS account ID, or product dimensions. The CustomerIdentifier parameter is on path for deprecation. Use CustomerAWSAccountID instead. These parameters are mutually exclusive. You can't specify both CustomerIdentifier and CustomerAWSAccountID in the same request.ProductCode (string) required
Filter (object)
NextToken (string)
MaxResults (integer)
marketplace_metering/batch_meter_usageThe CustomerIdentifier and CustomerAWSAccountID are mutually exclusive parameters. You must use one or the other, but not both in the same API request. For new implementations, we recommend using the CustomerAWSAccountID. Your current integration will continue to work. When updating your implementation, consider migrating to CustomerAWSAccountID for improved integration. To post metering records for customers, SaaS applications call BatchMeterUsage, which is used for metering SaaS flexible consuUsageRecords (array) required
ProductCode (string) required
marketplace_metering/meter_usageAs a seller, your software hosted in the buyer's Amazon Web Services account uses this API action to emit metering records directly to Amazon Web Services Marketplace. You must use the following buyer Amazon Web Services account credentials to sign the API request. For Amazon EC2 deployments, your software must use the IAM role for Amazon EC2 to sign the API call for MeterUsage API operation. For Amazon EKS deployments, your software must use IAM roles for service accounts IRSA to sign the API cProductCode (string) required
Timestamp (string) required
UsageDimension (string) required
UsageQuantity (integer)
DryRun (boolean)
UsageAllocations (array)
ClientToken (string)
marketplace_metering/register_usagePaid container software products sold through Amazon Web Services Marketplace must integrate with the Amazon Web Services 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 primaProductCode (string) required
PublicKeyVersion (integer) required
Nonce (string)
marketplace_metering/resolve_customerResolveCustomer 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. To successfully resolve the token, the API must be called from the account that was used to publish the SaaS application. For an example of using ResolveCuRegistrationToken (string) required
marketplace_reporting/get_buyer_dashboardGenerates an embedding URL for an Amazon QuickSight dashboard for an anonymous user. This API is available only to Amazon Web Services Organization management accounts or delegated administrators registered for the procurement insights procurement-insights.marketplace.amazonaws.com feature. The following rules apply to a generated URL: It contains a temporary bearer token, valid for 5 minutes after it is generated. Once redeemed within that period, it cannot be re-used again. It has a session lidashboardIdentifier (string) required
embeddingDomains (array) required
mediaconnect/list_entitlementsDisplays a list of all entitlements that have been granted to this account. This request returns 20 results per page.MaxResults (integer)
NextToken (string)
mediaconnect/list_tags_for_global_resourceLists the tags associated with a global resource in AWS Elemental MediaConnect. The API supports the following global resources: router inputs, router outputs and router network interfaces.ResourceArn (string) required
mediaconnect/list_tags_for_resourceList all tags on a MediaConnect resource in the current region.ResourceArn (string) required
mediaconnect/tag_global_resourceAdds tags to a global resource in AWS Elemental MediaConnect. The API supports the following global resources: router inputs, router outputs and router network interfaces.ResourceArn (string) required
Tags (object) required
mediaconnect/tag_resourceAssociates the specified tags to a resource with the specified resourceArn in the current region. 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.ResourceArn (string) required
Tags (object) required
mediaconnect/untag_global_resourceRemoves tags from a global resource in AWS Elemental MediaConnect. The API supports the following global resources: router inputs, router outputs and router network interfaces.ResourceArn (string) required
TagKeys (array) required
mediaconnect/untag_resourceDeletes specified tags from a resource in the current region.ResourceArn (string) required
TagKeys (array) required
mediaconnect/add_bridge_outputsAdds outputs to an existing bridge.BridgeArn (string) required
Outputs (array) required
mediaconnect/add_bridge_sourcesAdds sources to an existing bridge.BridgeArn (string) required
Sources (array) required
mediaconnect/remove_bridge_outputRemoves an output from a bridge.BridgeArn (string) required
OutputName (string) required
mediaconnect/remove_bridge_sourceRemoves a source from a bridge.BridgeArn (string) required
SourceName (string) required
mediaconnect/update_bridge_outputUpdates an existing bridge output.BridgeArn (string) required
NetworkOutput: {
. IpAddress (string)
. NetworkName (string)
. Port (integer)
. Protocol (string)
. Ttl (integer)
} (object)
OutputName (string) required
mediaconnect/update_bridge_sourceUpdates an existing bridge source.BridgeArn (string) required
FlowSource: {
. FlowArn (string)
. FlowVpcInterfaceAttachment (object)
} (object)
NetworkSource: {
. MulticastIp (string)
. MulticastSourceSettings (object)
. NetworkName (string)
. Port (integer)
. Protocol (string)
} (object)
SourceName (string) required
mediaconnect/update_bridge_stateUpdates the bridge state.BridgeArn (string) required
DesiredState (string) required
mediaconnect/create_bridgeCreates a new bridge. The request must include one source.EgressGatewayBridge: {
. MaxBitrate (integer)
} (object)
IngressGatewayBridge: {
. MaxBitrate (integer)
. MaxOutputs (integer)
} (object)
Name (string) required
Outputs (array)
PlacementArn (string) required
SourceFailoverConfig: {
. FailoverMode (string)
. RecoveryWindow (integer)
. SourcePriority (object)
. State (string)
} (object)
Sources (array) required
mediaconnect/describe_bridgeDisplays the details of a bridge.BridgeArn (string) required
mediaconnect/update_bridgeUpdates the bridge.BridgeArn (string) required
EgressGatewayBridge: {
. MaxBitrate (integer)
} (object)
IngressGatewayBridge: {
. MaxBitrate (integer)
. MaxOutputs (integer)
} (object)
SourceFailoverConfig: {
. FailoverMode (string)
. RecoveryWindow (integer)
. SourcePriority (object)
. State (string)
} (object)
mediaconnect/delete_bridgeDeletes a bridge. Before you can delete a bridge, you must stop the bridge.BridgeArn (string) required
mediaconnect/list_bridgesDisplays a list of bridges that are associated with this account and an optionally specified Amazon Resource Name ARN. This request returns a paginated result.FilterArn (string)
MaxResults (integer)
NextToken (string)
mediaconnect/add_flow_media_streamsAdds 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.FlowArn (string) required
MediaStreams (array) required
mediaconnect/add_flow_outputsAdds outputs to an existing flow. You can create up to 50 outputs per flow.FlowArn (string) required
Outputs (array) required
mediaconnect/add_flow_sourcesAdds sources to a flow.FlowArn (string) required
Sources (array) required
mediaconnect/add_flow_vpc_interfacesAdds VPC interfaces to a flow.FlowArn (string) required
VpcInterfaces (array) required
mediaconnect/describe_flow_source_metadataThe DescribeFlowSourceMetadata API is used to view information about the flow's source transport stream and programs. This API displays status messages about the flow's source as well as details about the program's video, audio, and other data.FlowArn (string) required
mediaconnect/describe_flow_source_thumbnailDescribes the thumbnail for the flow source.FlowArn (string) required
mediaconnect/grant_flow_entitlementsGrants entitlements to an existing flow.Entitlements (array) required
FlowArn (string) required
mediaconnect/remove_flow_media_streamRemoves a media stream from a flow. This action is only available if the media stream is not associated with a source or output.FlowArn (string) required
MediaStreamName (string) required
mediaconnect/remove_flow_outputRemoves 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.FlowArn (string) required
OutputArn (string) required
mediaconnect/remove_flow_sourceRemoves a source from an existing flow. This request can be made only if there is more than one source on the flow.FlowArn (string) required
SourceArn (string) required
mediaconnect/remove_flow_vpc_interfaceRemoves 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.FlowArn (string) required
VpcInterfaceName (string) required
mediaconnect/revoke_flow_entitlementRevokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.EntitlementArn (string) required
FlowArn (string) required
mediaconnect/start_flowStarts a flow.FlowArn (string) required
mediaconnect/stop_flowStops a flow.FlowArn (string) required
mediaconnect/update_flow_entitlementUpdates an entitlement. 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.Description (string)
Encryption: {
. Algorithm (string)
. ConstantInitializationVector (string)
. DeviceId (string)
. KeyType (string)
. Region (string)
. ResourceId (string)
. RoleArn (string)
. SecretArn (string)
. Url (string)
} (object)
EntitlementArn (string) required
EntitlementStatus (string)
FlowArn (string) required
Subscribers (array)
mediaconnect/update_flow_media_streamUpdates an existing media stream.Attributes: {
. Fmtp (object)
. Lang (string)
} (object)
ClockRate (integer)
Description (string)
FlowArn (string) required
MediaStreamName (string) required
MediaStreamType (string)
VideoFormat (string)
mediaconnect/update_flow_outputUpdates an existing flow output.CidrAllowList (array)
Description (string)
Destination (string)
Encryption: {
. Algorithm (string)
. ConstantInitializationVector (string)
. DeviceId (string)
. KeyType (string)
. Region (string)
. ResourceId (string)
. RoleArn (string)
. SecretArn (string)
. Url (string)
} (object)
FlowArn (string) required
MaxLatency (integer)
MediaStreamOutputConfigurations (array)
MinLatency (integer)
OutputArn (string) required
Port (integer)
Protocol (string)
RemoteId (string)
SenderControlPort (integer)
SenderIpAddress (string)
SmoothingLatency (integer)
StreamId (string)
VpcInterfaceAttachment: {
. VpcInterfaceName (string)
} (object)
OutputStatus (string)
NdiProgramName (string)
NdiSpeedHqQuality (integer)
RouterIntegrationState (string)
RouterIntegrationTransitEncryption: {
. EncryptionKeyType (string)
. EncryptionKeyConfiguration
} (object)
mediaconnect/update_flow_sourceUpdates the source of a flow. Because UpdateFlowSources and UpdateFlow are separate operations, you can't change both the source type AND the flow size in a single request. If you have a MEDIUM flow and you want to change the flow source to NDI®: First, use the UpdateFlow operation to upgrade the flow size to LARGE. After that, you can then use the UpdateFlowSource operation to configure the NDI source. If you're switching from an NDI source to a transport stream TS source and want to downgradeDecryption: {
. Algorithm (string)
. ConstantInitializationVector (string)
. DeviceId (string)
. KeyType (string)
. Region (string)
. ResourceId (string)
. RoleArn (string)
. SecretArn (string)
. Url (string)
} (object)
Description (string)
EntitlementArn (string)
FlowArn (string) required
IngestPort (integer)
MaxBitrate (integer)
MaxLatency (integer)
MaxSyncBuffer (integer)
MediaStreamSourceConfigurations (array)
MinLatency (integer)
Protocol (string)
SenderControlPort (integer)
SenderIpAddress (string)
SourceArn (string) required
SourceListenerAddress (string)
SourceListenerPort (integer)
StreamId (string)
VpcInterfaceName (string)
WhitelistCidr (string)
GatewayBridgeSource: {
. BridgeArn (string)
. VpcInterfaceAttachment (object)
} (object)
NdiSourceSettings: {
. SourceName (string)
} (object)
RouterIntegrationState (string)
RouterIntegrationTransitDecryption: {
. EncryptionKeyType (string)
. EncryptionKeyConfiguration
} (object)
mediaconnect/create_flowCreates a new flow. The request must include one source. The request optionally can include outputs up to 50 and entitlements up to 50.AvailabilityZone (string)
Entitlements (array)
MediaStreams (array)
Name (string) required
Outputs (array)
Source: {
. Decryption (object)
. Description (string)
. EntitlementArn (string)
. IngestPort (integer)
. MaxBitrate (integer)
. MaxLatency (integer)
. MaxSyncBuffer (integer)
. MediaStreamSourceConfigurations (array)
. MinLatency (integer)
. Name (string)
. Protocol (string)
. SenderControlPort (integer)
. SenderIpAddress (string)
. SourceListenerAddress (string)
. SourceListenerPort (integer)
. StreamId (string)
. VpcInterfaceName (string)
. WhitelistCidr (string)
. GatewayBridgeSource (object)
. NdiSourceSettings (object)
. SourceTags (object)
. RouterIntegrationState (string)
. RouterIntegrationTransitDecryption (object)
} (object)
SourceFailoverConfig: {
. FailoverMode (string)
. RecoveryWindow (integer)
. SourcePriority (object)
. State (string)
} (object)
Sources (array)
VpcInterfaces (array)
Maintenance: {
. MaintenanceDay (string)
. MaintenanceStartHour (string)
} (object)
SourceMonitoringConfig: {
. ThumbnailState (string)
. AudioMonitoringSettings (array)
. ContentQualityAnalysisState (string)
. VideoMonitoringSettings (array)
} (object)
FlowSize (string)
NdiConfig: {
. NdiState (string)
. MachineName (string)
. NdiDiscoveryServers (array)
} (object)
EncodingConfig: {
. EncodingProfile (string)
. VideoMaxBitrate (integer)
} (object)
FlowTags (object)
mediaconnect/describe_flowDisplays the details of a flow. The response includes the flow Amazon Resource Name ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.FlowArn (string) required
mediaconnect/update_flowUpdates an existing flow. Because UpdateFlowSources and UpdateFlow are separate operations, you can't change both the source type AND the flow size in a single request. If you have a MEDIUM flow and you want to change the flow source to NDI®: First, use the UpdateFlow operation to upgrade the flow size to LARGE. After that, you can then use the UpdateFlowSource operation to configure the NDI source. If you're switching from an NDI source to a transport stream TS source and want to downgrade theFlowArn (string) required
SourceFailoverConfig: {
. FailoverMode (string)
. RecoveryWindow (integer)
. SourcePriority (object)
. State (string)
} (object)
Maintenance: {
. MaintenanceDay (string)
. MaintenanceScheduledDate (string)
. MaintenanceStartHour (string)
} (object)
SourceMonitoringConfig: {
. ThumbnailState (string)
. AudioMonitoringSettings (array)
. ContentQualityAnalysisState (string)
. VideoMonitoringSettings (array)
} (object)
NdiConfig: {
. NdiState (string)
. MachineName (string)
. NdiDiscoveryServers (array)
} (object)
FlowSize (string)
EncodingConfig: {
. EncodingProfile (string)
. VideoMaxBitrate (integer)
} (object)
mediaconnect/delete_flowDeletes a flow. Before you can delete a flow, you must stop the flow.FlowArn (string) required
mediaconnect/list_flowsDisplays a list of flows that are associated with this account. This request returns a paginated result.MaxResults (integer)
NextToken (string)
mediaconnect/describe_gateway_instanceDisplays the details of an instance.GatewayInstanceArn (string) required
mediaconnect/update_gateway_instanceUpdates an existing gateway instance.BridgePlacement (string)
GatewayInstanceArn (string) required
mediaconnect/deregister_gateway_instanceDeregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.Force (boolean)
GatewayInstanceArn (string) required
mediaconnect/list_gateway_instancesDisplays a list of instances associated with the Amazon Web Services account. This request returns a paginated result. You can use the filterArn property to display only the instances associated with the selected Gateway Amazon Resource Name ARN.FilterArn (string)
MaxResults (integer)
NextToken (string)
mediaconnect/create_gatewayCreates a new gateway. The request must include at least one network up to four.EgressCidrBlocks (array) required
Name (string) required
Networks (array) required
mediaconnect/describe_gatewayDisplays the details of a gateway. The response includes the gateway Amazon Resource Name ARN, name, and CIDR blocks, as well as details about the networks.GatewayArn (string) required
mediaconnect/delete_gatewayDeletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.GatewayArn (string) required
mediaconnect/list_gatewaysDisplays a list of gateways that are associated with this account. This request returns a paginated result.MaxResults (integer)
NextToken (string)
mediaconnect/describe_offeringDisplays the details of an offering. The response includes the offering description, duration, outbound bandwidth, price, and Amazon Resource Name ARN.OfferingArn (string) required
mediaconnect/list_offeringsDisplays a list of all offerings that are available to this account in the current Amazon Web Services 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.MaxResults (integer)
NextToken (string)
mediaconnect/purchase_offeringSubmits a request to purchase an offering. If you already have an active reservation, you can't purchase another offering.OfferingArn (string) required
ReservationName (string) required
Start (string) required
mediaconnect/describe_reservationDisplays 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.ReservationArn (string) required
mediaconnect/list_reservationsDisplays a list of all reservations that have been purchased by this account in the current Amazon Web Services Region. This list includes all reservations in all states such as active and expired.MaxResults (integer)
NextToken (string)
mediaconnect/get_router_input_source_metadataRetrieves detailed metadata information about a specific router input source, including stream details and connection state.Arn (string) required
mediaconnect/get_router_input_thumbnailRetrieves the thumbnail for a router input in AWS Elemental MediaConnect.Arn (string) required
mediaconnect/restart_router_inputRestarts a router input. This operation can be used to recover from errors or refresh the input state.Arn (string) required
mediaconnect/start_router_inputStarts a router input in AWS Elemental MediaConnect.Arn (string) required
mediaconnect/stop_router_inputStops a router input in AWS Elemental MediaConnect.Arn (string) required
mediaconnect/batch_get_router_inputRetrieves information about multiple router inputs in AWS Elemental MediaConnect.Arns (array) required
mediaconnect/create_router_inputCreates a new router input in AWS Elemental MediaConnect.Name (string) required
Configuration (undefined) required
MaximumBitrate (integer) required
RoutingScope (string) required
Tier (string) required
RegionName (string)
AvailabilityZone (string)
TransitEncryption: {
. EncryptionKeyType (string)
. EncryptionKeyConfiguration
} (object)
MaintenanceConfiguration (undefined)
Tags (object)
ClientToken (string)
mediaconnect/get_router_inputRetrieves information about a specific router input in AWS Elemental MediaConnect.Arn (string) required
mediaconnect/update_router_inputUpdates the configuration of an existing router input in AWS Elemental MediaConnect.Arn (string) required
Name (string)
Configuration (undefined)
MaximumBitrate (integer)
RoutingScope (string)
Tier (string)
TransitEncryption: {
. EncryptionKeyType (string)
. EncryptionKeyConfiguration
} (object)
MaintenanceConfiguration (undefined)
mediaconnect/delete_router_inputDeletes a router input from AWS Elemental MediaConnect.Arn (string) required
mediaconnect/list_router_inputsRetrieves a list of router inputs in AWS Elemental MediaConnect.MaxResults (integer)
NextToken (string)
Filters (array)
mediaconnect/batch_get_router_network_interfaceRetrieves information about multiple router network interfaces in AWS Elemental MediaConnect.Arns (array) required
mediaconnect/create_router_network_interfaceCreates a new router network interface in AWS Elemental MediaConnect.Name (string) required
Configuration (undefined) required
RegionName (string)
Tags (object)
ClientToken (string)
mediaconnect/get_router_network_interfaceRetrieves information about a specific router network interface in AWS Elemental MediaConnect.Arn (string) required
mediaconnect/update_router_network_interfaceUpdates the configuration of an existing router network interface in AWS Elemental MediaConnect.Arn (string) required
Name (string)
Configuration (undefined)
mediaconnect/delete_router_network_interfaceDeletes a router network interface from AWS Elemental MediaConnect.Arn (string) required
mediaconnect/list_router_network_interfacesRetrieves a list of router network interfaces in AWS Elemental MediaConnect.MaxResults (integer)
NextToken (string)
Filters (array)
mediaconnect/restart_router_outputRestarts a router output. This operation can be used to recover from errors or refresh the output state.Arn (string) required
mediaconnect/start_router_outputStarts a router output in AWS Elemental MediaConnect.Arn (string) required
mediaconnect/stop_router_outputStops a router output in AWS Elemental MediaConnect.Arn (string) required
mediaconnect/take_router_inputAssociates a router input with a router output in AWS Elemental MediaConnect.RouterOutputArn (string) required
RouterInputArn (string)
mediaconnect/batch_get_router_outputRetrieves information about multiple router outputs in AWS Elemental MediaConnect.Arns (array) required
mediaconnect/create_router_outputCreates a new router output in AWS Elemental MediaConnect.Name (string) required
Configuration (undefined) required
MaximumBitrate (integer) required
RoutingScope (string) required
Tier (string) required
RegionName (string)
AvailabilityZone (string)
MaintenanceConfiguration (undefined)
Tags (object)
ClientToken (string)
mediaconnect/get_router_outputRetrieves information about a specific router output in AWS Elemental MediaConnect.Arn (string) required
mediaconnect/update_router_outputUpdates the configuration of an existing router output in AWS Elemental MediaConnect.Arn (string) required
Name (string)
Configuration (undefined)
MaximumBitrate (integer)
RoutingScope (string)
Tier (string)
MaintenanceConfiguration (undefined)
mediaconnect/delete_router_outputDeletes a router output from AWS Elemental MediaConnect.Arn (string) required
mediaconnect/list_router_outputsRetrieves a list of router outputs in AWS Elemental MediaConnect.MaxResults (integer)
NextToken (string)
Filters (array)
mediaconvert/associate_certificateAssociates an AWS Certificate Manager ACM Amazon Resource Name ARN with AWS Elemental MediaConvert.Arn (string) required
mediaconvert/cancel_jobPermanently cancel a job. Once you have canceled a job, you can't start it again.Id (string) required
mediaconvert/create_jobCreate 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.htmlAccelerationSettings: {
. Mode (string)
} (object)
BillingTagsSource (string)
ClientRequestToken (string)
HopDestinations (array)
JobEngineVersion (string)
JobTemplate (string)
Priority (integer)
Queue (string)
Role (string) required
Settings: {
. AdAvailOffset (integer)
. AvailBlanking (object)
. ColorConversion3DLUTSettings (array)
. Esam (object)
. ExtendedDataServices (object)
. FollowSource (integer)
. Inputs (array)
. KantarWatermark (object)
. MotionImageInserter (object)
. NielsenConfiguration (object)
. NielsenNonLinearWatermark (object)
. OutputGroups (array)
. TimecodeConfig (object)
. TimedMetadataInsertion (object)
} (object) required
SimulateReservedQueue (string)
StatusUpdateInterval (string)
Tags (object)
UserMetadata (object)
mediaconvert/create_job_templateCreate a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.htmlAccelerationSettings: {
. Mode (string)
} (object)
Category (string)
Description (string)
HopDestinations (array)
Name (string) required
Priority (integer)
Queue (string)
Settings: {
. AdAvailOffset (integer)
. AvailBlanking (object)
. ColorConversion3DLUTSettings (array)
. Esam (object)
. ExtendedDataServices (object)
. FollowSource (integer)
. Inputs (array)
. KantarWatermark (object)
. MotionImageInserter (object)
. NielsenConfiguration (object)
. NielsenNonLinearWatermark (object)
. OutputGroups (array)
. TimecodeConfig (object)
. TimedMetadataInsertion (object)
} (object) required
StatusUpdateInterval (string)
Tags (object)
mediaconvert/create_presetCreate a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.htmlCategory (string)
Description (string)
Name (string) required
Settings: {
. AudioDescriptions (array)
. CaptionDescriptions (array)
. ContainerSettings (object)
. VideoDescription (object)
} (object) required
Tags (object)
mediaconvert/create_queueCreate 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.htmlConcurrentJobs (integer)
Description (string)
Name (string) required
PricingPlan (string)
ReservationPlanSettings: {
. Commitment (string)
. RenewalType (string)
. ReservedSlots (integer)
} (object)
Status (string)
Tags (object)
mediaconvert/create_resource_shareCreate a new resource share request for MediaConvert resources with AWS Support.JobId (string) required
SupportCaseId (string) required
mediaconvert/delete_job_templatePermanently delete a job template you have created.Name (string) required
mediaconvert/delete_policyPermanently delete a policy that you created.No parameters
mediaconvert/delete_presetPermanently delete a preset you have created.Name (string) required
mediaconvert/delete_queuePermanently delete a queue you have created.Name (string) required
mediaconvert/describe_endpointsSend a request with an empty body to the regional API endpoint to get your account API endpoint. Note that DescribeEndpoints is no longer required. We recommend that you send your requests directly to the regional endpoint instead.MaxResults (integer)
Mode (string)
NextToken (string)
mediaconvert/disassociate_certificateRemoves an association between the Amazon Resource Name ARN of an AWS Certificate Manager ACM certificate and an AWS Elemental MediaConvert resource.Arn (string) required
mediaconvert/get_jobRetrieve the JSON for a specific transcoding job.Id (string) required
mediaconvert/get_jobs_query_resultsRetrieve a JSON array of up to twenty of your most recent jobs matched by a jobs query.Id (string) required
mediaconvert/get_job_templateRetrieve the JSON for a specific job template.Name (string) required
mediaconvert/get_policyRetrieve the JSON for your policy.No parameters
mediaconvert/get_presetRetrieve the JSON for a specific preset.Name (string) required
mediaconvert/get_queueRetrieve the JSON for a specific queue.Name (string) required
mediaconvert/list_jobsRetrieve 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.MaxResults (integer)
NextToken (string)
Order (string)
Queue (string)
Status (string)
mediaconvert/list_job_templatesRetrieve 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 arrayCategory (string)
ListBy (string)
MaxResults (integer)
NextToken (string)
Order (string)
mediaconvert/list_presetsRetrieve 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.Category (string)
ListBy (string)
MaxResults (integer)
NextToken (string)
Order (string)
mediaconvert/list_queuesRetrieve 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.ListBy (string)
MaxResults (integer)
NextToken (string)
Order (string)
mediaconvert/list_tags_for_resourceRetrieve the tags for a MediaConvert resource.Arn (string) required
mediaconvert/list_versionsRetrieve a JSON array of all available Job engine versions and the date they expire.MaxResults (integer)
NextToken (string)
mediaconvert/probeUse Probe to obtain detailed information about your input media files. Probe returns a JSON that includes container, codec, frame rate, resolution, track count, audio layout, captions, and more. You can use this information to learn more about your media files, or to help make decisions while automating your transcoding workflow.InputFiles (array)
mediaconvert/put_policyCreate or change your policy. For more information about policies, see the user guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.htmlPolicy: {
. HttpInputs (string)
. HttpsInputs (string)
. S3Inputs (string)
} (object) required
mediaconvert/search_jobsRetrieve a JSON array that includes job details for up to twenty of your most recent jobs. Optionally filter results further according to input file, queue, or status. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array.InputFile (string)
MaxResults (integer)
NextToken (string)
Order (string)
Queue (string)
Status (string)
mediaconvert/start_jobs_queryStart an asynchronous jobs query using the provided filters. To receive the list of jobs that match your query, call the GetJobsQueryResults API using the query ID returned by this API.FilterList (array)
MaxResults (integer)
NextToken (string)
Order (string)
mediaconvert/tag_resourceAdd 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.htmlArn (string) required
Tags (object) required
mediaconvert/untag_resourceRemove 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.htmlArn (string) required
TagKeys (array)
mediaconvert/update_job_templateModify one of your existing job templates.AccelerationSettings: {
. Mode (string)
} (object)
Category (string)
Description (string)
HopDestinations (array)
Name (string) required
Priority (integer)
Queue (string)
Settings: {
. AdAvailOffset (integer)
. AvailBlanking (object)
. ColorConversion3DLUTSettings (array)
. Esam (object)
. ExtendedDataServices (object)
. FollowSource (integer)
. Inputs (array)
. KantarWatermark (object)
. MotionImageInserter (object)
. NielsenConfiguration (object)
. NielsenNonLinearWatermark (object)
. OutputGroups (array)
. TimecodeConfig (object)
. TimedMetadataInsertion (object)
} (object)
StatusUpdateInterval (string)
mediaconvert/update_presetModify one of your existing presets.Category (string)
Description (string)
Name (string) required
Settings: {
. AudioDescriptions (array)
. CaptionDescriptions (array)
. ContainerSettings (object)
. VideoDescription (object)
} (object)
mediaconvert/update_queueModify one of your existing queues.ConcurrentJobs (integer)
Description (string)
Name (string) required
ReservationPlanSettings: {
. Commitment (string)
. RenewalType (string)
. ReservedSlots (integer)
} (object)
Status (string)
medialive/accept_input_device_transferAccept an incoming input device transfer. The ownership of the device will transfer to your AWS account.InputDeviceId (string) required
medialive/batch_deleteStarts delete of resources.ChannelIds (array)
InputIds (array)
InputSecurityGroupIds (array)
MultiplexIds (array)
medialive/batch_startStarts existing resourcesChannelIds (array)
MultiplexIds (array)
medialive/batch_stopStops running resourcesChannelIds (array)
MultiplexIds (array)
medialive/batch_update_scheduleUpdate a channel scheduleChannelId (string) required
Creates: {
. ScheduleActions (array)
} (object)
Deletes: {
. ActionNames (array)
} (object)
medialive/cancel_input_device_transferCancel an input device transfer that you have requested.InputDeviceId (string) required
medialive/claim_deviceSend 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.Id (string)
medialive/create_channelCreates a new channelCdiInputSpecification: {
. Resolution (string)
} (object)
ChannelClass (string)
Destinations (array)
EncoderSettings: {
. AudioDescriptions (array)
. AvailBlanking (object)
. AvailConfiguration (object)
. BlackoutSlate (object)
. CaptionDescriptions (array)
. FeatureActivations (object)
. GlobalConfiguration (object)
. MotionGraphicsConfiguration (object)
. NielsenConfiguration (object)
. OutputGroups (array)
. TimecodeConfig (object)
. VideoDescriptions (array)
. ThumbnailConfiguration (object)
. ColorCorrectionSettings (object)
} (object)
InputAttachments (array)
InputSpecification: {
. Codec (string)
. MaximumBitrate (string)
. Resolution (string)
} (object)
LogLevel (string)
Maintenance: {
. MaintenanceDay (string)
. MaintenanceStartTime (string)
} (object)
Name (string)
RequestId (string)
Reserved (string)
RoleArn (string)
Tags (object)
Vpc: {
. PublicAddressAllocationIds (array)
. SecurityGroupIds (array)
. SubnetIds (array)
} (object)
AnywhereSettings: {
. ChannelPlacementGroupId (string)
. ClusterId (string)
} (object)
ChannelEngineVersion: {
. Version (string)
} (object)
DryRun (boolean)
LinkedChannelSettings: {
. FollowerChannelSettings (object)
. PrimaryChannelSettings (object)
} (object)
ChannelSecurityGroups (array)
medialive/create_channel_placement_groupCreate a ChannelPlacementGroup in the specified Cluster. As part of the create operation, you specify the Nodes to attach the group to.After you create a ChannelPlacementGroup, you add Channels to the group you do this by modifying the Channels to add them to a specific group. You now have an association of Channels to ChannelPlacementGroup, and ChannelPlacementGroup to Nodes. This association means that all the Channels in the group are able to run on any of the Nodes associated with the group.ClusterId (string) required
Name (string)
Nodes (array)
RequestId (string)
Tags (object)
medialive/create_cloud_watch_alarm_templateCreates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on targeted resource types.ComparisonOperator (string) required
DatapointsToAlarm (integer)
Description (string)
EvaluationPeriods (integer) required
GroupIdentifier (string) required
MetricName (string) required
Name (string) required
Period (integer) required
Statistic (string) required
Tags (object)
TargetResourceType (string) required
Threshold (number) required
TreatMissingData (string) required
RequestId (string)
medialive/create_cloud_watch_alarm_template_groupCreates a cloudwatch alarm template group to group your cloudwatch alarm templates and to attach to signal maps for dynamically creating alarms.Description (string)
Name (string) required
Tags (object)
RequestId (string)
medialive/create_clusterCreate a new Cluster.ClusterType (string)
InstanceRoleArn (string)
Name (string)
NetworkSettings: {
. DefaultRoute (string)
. InterfaceMappings (array)
} (object)
RequestId (string)
Tags (object)
medialive/create_event_bridge_rule_templateCreates an eventbridge rule template to monitor events and send notifications to your targeted resources.Description (string)
EventTargets (array)
EventType (string) required
GroupIdentifier (string) required
Name (string) required
Tags (object)
RequestId (string)
medialive/create_event_bridge_rule_template_groupCreates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules.Description (string)
Name (string) required
Tags (object)
RequestId (string)
medialive/create_inputCreate an inputDestinations (array)
InputDevices (array)
InputSecurityGroups (array)
MediaConnectFlows (array)
Name (string)
RequestId (string)
RoleArn (string)
Sources (array)
Tags (object)
Type (string)
Vpc: {
. SecurityGroupIds (array)
. SubnetIds (array)
} (object)
SrtSettings: {
. SrtCallerSources (array)
. SrtListenerSettings (object)
} (object)
InputNetworkLocation (string)
MulticastSettings: {
. Sources (array)
} (object)
Smpte2110ReceiverGroupSettings: {
. Smpte2110ReceiverGroups (array)
} (object)
SdiSources (array)
RouterSettings: {
. Destinations (array)
. EncryptionType (string)
. SecretArn (string)
} (object)
medialive/create_input_security_groupCreates a Input Security GroupTags (object)
WhitelistRules (array)
medialive/create_multiplexCreate a new multiplex.AvailabilityZones (array) required
MultiplexSettings: {
. MaximumVideoBufferDelayMilliseconds (integer)
. TransportStreamBitrate (integer)
. TransportStreamId (integer)
. TransportStreamReservedBitrate (integer)
} (object) required
Name (string) required
RequestId (string) required
Tags (object)
medialive/create_multiplex_programCreate a new program in the multiplex.MultiplexId (string) required
MultiplexProgramSettings: {
. PreferredChannelPipeline (string)
. ProgramNumber (integer)
. ServiceDescriptor (object)
. VideoSettings (object)
} (object) required
ProgramName (string) required
RequestId (string) required
medialive/create_networkCreate as many Networks as you need. You will associate one or more Clusters with each Network.Each Network provides MediaLive Anywhere with required information about the network in your organization that you are using for video encoding using MediaLive.IpPools (array)
Name (string)
RequestId (string)
Routes (array)
Tags (object)
medialive/create_nodeCreate a Node in the specified Cluster. You can also create Nodes using the CreateNodeRegistrationScript. Note that you can't move a Node to another Cluster.ClusterId (string) required
Name (string)
NodeInterfaceMappings (array)
RequestId (string)
Role (string)
Tags (object)
medialive/create_node_registration_scriptCreate the Register Node script for all the nodes intended for a specific Cluster. You will then run the script on each hardware unit that is intended for that Cluster. The script creates a Node in the specified Cluster. It then binds the Node to this hardware unit, and activates the node hardware for use with MediaLive Anywhere.ClusterId (string) required
Id (string)
Name (string)
NodeInterfaceMappings (array)
RequestId (string)
Role (string)
medialive/create_partner_inputCreate a partner inputInputId (string) required
RequestId (string)
Tags (object)
medialive/create_sdi_sourceCreate an SdiSource for each video source that uses the SDI protocol. You will reference the SdiSource when you create an SDI input in MediaLive. You will also reference it in an SdiSourceMapping, in order to create a connection between the logical SdiSource and the physical SDI card and port that the physical SDI source uses.Mode (string)
Name (string)
RequestId (string)
Tags (object)
Type (string)
medialive/create_signal_mapInitiates the creation of a new signal map. Will discover a new mediaResourceMap based on the provided discoveryEntryPointArn.CloudWatchAlarmTemplateGroupIdentifiers (array)
Description (string)
DiscoveryEntryPointArn (string) required
EventBridgeRuleTemplateGroupIdentifiers (array)
Name (string) required
Tags (object)
RequestId (string)
medialive/create_tagsCreate tags for a resourceResourceArn (string) required
Tags (object)
medialive/delete_channelStarts deletion of channel. The associated outputs are also deleted.ChannelId (string) required
medialive/delete_channel_placement_groupDelete the specified ChannelPlacementGroup that exists in the specified Cluster.ChannelPlacementGroupId (string) required
ClusterId (string) required
medialive/delete_cloud_watch_alarm_templateDeletes a cloudwatch alarm template.Identifier (string) required
medialive/delete_cloud_watch_alarm_template_groupDeletes a cloudwatch alarm template group. You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.Identifier (string) required
medialive/delete_clusterDelete a Cluster. The Cluster must be idle.ClusterId (string) required
medialive/delete_event_bridge_rule_templateDeletes an eventbridge rule template.Identifier (string) required
medialive/delete_event_bridge_rule_template_groupDeletes an eventbridge rule template group. You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.Identifier (string) required
medialive/delete_inputDeletes the input end pointInputId (string) required
medialive/delete_input_security_groupDeletes an Input Security GroupInputSecurityGroupId (string) required
medialive/delete_multiplexDelete a multiplex. The multiplex must be idle.MultiplexId (string) required
medialive/delete_multiplex_programDelete a program from a multiplex.MultiplexId (string) required
ProgramName (string) required
medialive/delete_networkDelete a Network. The Network must have no resources associated with it.NetworkId (string) required
medialive/delete_nodeDelete a Node. The Node must be IDLE.ClusterId (string) required
NodeId (string) required
medialive/delete_reservationDelete an expired reservation.ReservationId (string) required
medialive/delete_scheduleDelete all schedule actions on a channel.ChannelId (string) required
medialive/delete_sdi_sourceDelete an SdiSource. The SdiSource must not be part of any SidSourceMapping and must not be attached to any input.SdiSourceId (string) required
medialive/delete_signal_mapDeletes the specified signal map.Identifier (string) required
medialive/delete_tagsRemoves tags for a resourceResourceArn (string) required
TagKeys (array) required
medialive/describe_account_configurationDescribe account configurationNo parameters
medialive/describe_channelGets details about a channelChannelId (string) required
medialive/describe_channel_placement_groupGet details about a ChannelPlacementGroup.ChannelPlacementGroupId (string) required
ClusterId (string) required
medialive/describe_clusterGet details about a Cluster.ClusterId (string) required
medialive/describe_inputProduces details about an inputInputId (string) required
medialive/describe_input_deviceGets the details for the input deviceInputDeviceId (string) required
medialive/describe_input_device_thumbnailGet the latest thumbnail data for the input device.InputDeviceId (string) required
Accept (string) required
medialive/describe_input_security_groupProduces a summary of an Input Security GroupInputSecurityGroupId (string) required
medialive/describe_multiplexGets details about a multiplex.MultiplexId (string) required
medialive/describe_multiplex_programGet the details for a program in a multiplex.MultiplexId (string) required
ProgramName (string) required
medialive/describe_networkGet details about a Network.NetworkId (string) required
medialive/describe_nodeGet details about a Node in the specified Cluster.ClusterId (string) required
NodeId (string) required
medialive/describe_offeringGet details for an offering.OfferingId (string) required
medialive/describe_reservationGet details for a reservation.ReservationId (string) required
medialive/describe_scheduleGet a channel scheduleChannelId (string) required
MaxResults (integer)
NextToken (string)
medialive/describe_sdi_sourceGets details about a SdiSource.SdiSourceId (string) required
medialive/describe_thumbnailsDescribe the latest thumbnails data.ChannelId (string) required
PipelineId (string) required
ThumbnailType (string) required
medialive/get_cloud_watch_alarm_templateRetrieves the specified cloudwatch alarm template.Identifier (string) required
medialive/get_cloud_watch_alarm_template_groupRetrieves the specified cloudwatch alarm template group.Identifier (string) required
medialive/get_event_bridge_rule_templateRetrieves the specified eventbridge rule template.Identifier (string) required
medialive/get_event_bridge_rule_template_groupRetrieves the specified eventbridge rule template group.Identifier (string) required
medialive/get_signal_mapRetrieves the specified signal map.Identifier (string) required
medialive/list_alertsList the alerts for a channel with optional filtering based on alert state.ChannelId (string) required
MaxResults (integer)
NextToken (string)
StateFilter (string)
medialive/list_channel_placement_groupsRetrieve the list of ChannelPlacementGroups in the specified Cluster.ClusterId (string) required
MaxResults (integer)
NextToken (string)
medialive/list_channelsProduces list of channels that have been createdMaxResults (integer)
NextToken (string)
medialive/list_cloud_watch_alarm_template_groupsLists cloudwatch alarm template groups.MaxResults (integer)
NextToken (string)
Scope (string)
SignalMapIdentifier (string)
medialive/list_cloud_watch_alarm_templatesLists cloudwatch alarm templates.GroupIdentifier (string)
MaxResults (integer)
NextToken (string)
Scope (string)
SignalMapIdentifier (string)
medialive/list_cluster_alertsList the alerts for a cluster with optional filtering based on alert state.ClusterId (string) required
MaxResults (integer)
NextToken (string)
StateFilter (string)
medialive/list_clustersRetrieve the list of Clusters.MaxResults (integer)
NextToken (string)
medialive/list_event_bridge_rule_template_groupsLists eventbridge rule template groups.MaxResults (integer)
NextToken (string)
SignalMapIdentifier (string)
medialive/list_event_bridge_rule_templatesLists eventbridge rule templates.GroupIdentifier (string)
MaxResults (integer)
NextToken (string)
SignalMapIdentifier (string)
medialive/list_input_devicesList input devicesMaxResults (integer)
NextToken (string)
medialive/list_input_device_transfersList 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.MaxResults (integer)
NextToken (string)
TransferType (string) required
medialive/list_inputsProduces list of inputs that have been createdMaxResults (integer)
NextToken (string)
medialive/list_input_security_groupsProduces a list of Input Security Groups for an accountMaxResults (integer)
NextToken (string)
medialive/list_multiplex_alertsList the alerts for a multiplex with optional filtering based on alert state.MaxResults (integer)
MultiplexId (string) required
NextToken (string)
StateFilter (string)
medialive/list_multiplexesRetrieve a list of the existing multiplexes.MaxResults (integer)
NextToken (string)
medialive/list_multiplex_programsList the programs that currently exist for a specific multiplex.MaxResults (integer)
MultiplexId (string) required
NextToken (string)
medialive/list_networksRetrieve the list of Networks.MaxResults (integer)
NextToken (string)
medialive/list_nodesRetrieve the list of Nodes.ClusterId (string) required
MaxResults (integer)
NextToken (string)
medialive/list_offeringsList offerings available for purchase.ChannelClass (string)
ChannelConfiguration (string)
Codec (string)
Duration (string)
MaxResults (integer)
MaximumBitrate (string)
MaximumFramerate (string)
NextToken (string)
Resolution (string)
ResourceType (string)
SpecialFeature (string)
VideoQuality (string)
medialive/list_reservationsList purchased reservations.ChannelClass (string)
Codec (string)
MaxResults (integer)
MaximumBitrate (string)
MaximumFramerate (string)
NextToken (string)
Resolution (string)
ResourceType (string)
SpecialFeature (string)
VideoQuality (string)
medialive/list_sdi_sourcesList all the SdiSources in the AWS account.MaxResults (integer)
NextToken (string)
medialive/list_signal_mapsLists signal maps.CloudWatchAlarmTemplateGroupIdentifier (string)
EventBridgeRuleTemplateGroupIdentifier (string)
MaxResults (integer)
NextToken (string)
medialive/list_tags_for_resourceProduces list of tags that have been created for a resourceResourceArn (string) required
medialive/list_versionsRetrieves an array of all the encoder engine versions that are available in this AWS account.No parameters
medialive/purchase_offeringPurchase an offering and create a reservation.Count (integer) required
Name (string)
OfferingId (string) required
RenewalSettings: {
. AutomaticRenewal (string)
. RenewalCount (integer)
} (object)
RequestId (string)
Start (string)
Tags (object)
medialive/reboot_input_deviceSend 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.Force (string)
InputDeviceId (string) required
medialive/reject_input_device_transferReject the transfer of the specified input device to your AWS account.InputDeviceId (string) required
medialive/restart_channel_pipelinesRestart pipelines in one channel that is currently running.ChannelId (string) required
PipelineIds (array)
medialive/start_channelStarts an existing channelChannelId (string) required
medialive/start_delete_monitor_deploymentInitiates a deployment to delete the monitor of the specified signal map.Identifier (string) required
medialive/start_input_deviceStart an input device that is attached to a MediaConnect flow. There is no need to start a device that is attached to a MediaLive input; MediaLive starts the device when the channel starts.InputDeviceId (string) required
medialive/start_input_device_maintenance_windowStart 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 mustInputDeviceId (string) required
medialive/start_monitor_deploymentInitiates a deployment to deploy the latest monitor of the specified signal map.DryRun (boolean)
Identifier (string) required
medialive/start_multiplexStart run the multiplex. Starting the multiplex does not start the channels. You must explicitly start each channel.MultiplexId (string) required
medialive/start_update_signal_mapInitiates an update for the specified signal map. Will discover a new signal map if a changed discoveryEntryPointArn is provided.CloudWatchAlarmTemplateGroupIdentifiers (array)
Description (string)
DiscoveryEntryPointArn (string)
EventBridgeRuleTemplateGroupIdentifiers (array)
ForceRediscovery (boolean)
Identifier (string) required
Name (string)
medialive/stop_channelStops a running channelChannelId (string) required
medialive/stop_input_deviceStop an input device that is attached to a MediaConnect flow. There is no need to stop a device that is attached to a MediaLive input; MediaLive automatically stops the device when the channel stops.InputDeviceId (string) required
medialive/stop_multiplexStops a running multiplex. If the multiplex isn't running, this action has no effect.MultiplexId (string) required
medialive/transfer_input_deviceStart an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.InputDeviceId (string) required
TargetCustomerId (string)
TargetRegion (string)
TransferMessage (string)
medialive/update_account_configurationUpdate account configurationAccountConfiguration: {
. KmsKeyId (string)
} (object)
medialive/update_channelUpdates a channel.CdiInputSpecification: {
. Resolution (string)
} (object)
ChannelId (string) required
Destinations (array)
EncoderSettings: {
. AudioDescriptions (array)
. AvailBlanking (object)
. AvailConfiguration (object)
. BlackoutSlate (object)
. CaptionDescriptions (array)
. FeatureActivations (object)
. GlobalConfiguration (object)
. MotionGraphicsConfiguration (object)
. NielsenConfiguration (object)
. OutputGroups (array)
. TimecodeConfig (object)
. VideoDescriptions (array)
. ThumbnailConfiguration (object)
. ColorCorrectionSettings (object)
} (object)
InputAttachments (array)
InputSpecification: {
. Codec (string)
. MaximumBitrate (string)
. Resolution (string)
} (object)
LogLevel (string)
Maintenance: {
. MaintenanceDay (string)
. MaintenanceScheduledDate (string)
. MaintenanceStartTime (string)
} (object)
Name (string)
RoleArn (string)
ChannelEngineVersion: {
. Version (string)
} (object)
DryRun (boolean)
AnywhereSettings: {
. ChannelPlacementGroupId (string)
. ClusterId (string)
} (object)
LinkedChannelSettings: {
. FollowerChannelSettings (object)
. PrimaryChannelSettings (object)
} (object)
ChannelSecurityGroups (array)
medialive/update_channel_classChanges the class of the channel.ChannelClass (string) required
ChannelId (string) required
Destinations (array)
medialive/update_channel_placement_groupChange the settings for a ChannelPlacementGroup.ChannelPlacementGroupId (string) required
ClusterId (string) required
Name (string)
Nodes (array)
medialive/update_cloud_watch_alarm_templateUpdates the specified cloudwatch alarm template.ComparisonOperator (string)
DatapointsToAlarm (integer)
Description (string)
EvaluationPeriods (integer)
GroupIdentifier (string)
Identifier (string) required
MetricName (string)
Name (string)
Period (integer)
Statistic (string)
TargetResourceType (string)
Threshold (number)
TreatMissingData (string)
medialive/update_cloud_watch_alarm_template_groupUpdates the specified cloudwatch alarm template group.Description (string)
Identifier (string) required
medialive/update_clusterChange the settings for a Cluster.ClusterId (string) required
Name (string)
NetworkSettings: {
. DefaultRoute (string)
. InterfaceMappings (array)
} (object)
medialive/update_event_bridge_rule_templateUpdates the specified eventbridge rule template.Description (string)
EventTargets (array)
EventType (string)
GroupIdentifier (string)
Identifier (string) required
Name (string)
medialive/update_event_bridge_rule_template_groupUpdates the specified eventbridge rule template group.Description (string)
Identifier (string) required
medialive/update_inputUpdates an input.Destinations (array)
InputDevices (array)
InputId (string) required
InputSecurityGroups (array)
MediaConnectFlows (array)
Name (string)
RoleArn (string)
Sources (array)
SrtSettings: {
. SrtCallerSources (array)
. SrtListenerSettings (object)
} (object)
MulticastSettings: {
. Sources (array)
} (object)
Smpte2110ReceiverGroupSettings: {
. Smpte2110ReceiverGroups (array)
} (object)
SdiSources (array)
SpecialRouterSettings: {
. RouterArn (string)
} (object)
medialive/update_input_deviceUpdates the parameters for the input device.HdDeviceSettings: {
. ConfiguredInput (string)
. MaxBitrate (integer)
. LatencyMs (integer)
. Codec (string)
. MediaconnectSettings (object)
. AudioChannelPairs (array)
. InputResolution (string)
} (object)
InputDeviceId (string) required
Name (string)
UhdDeviceSettings: {
. ConfiguredInput (string)
. MaxBitrate (integer)
. LatencyMs (integer)
. Codec (string)
. MediaconnectSettings (object)
. AudioChannelPairs (array)
. InputResolution (string)
} (object)
AvailabilityZone (string)
medialive/update_input_security_groupUpdate an Input Security Group's Whilelists.InputSecurityGroupId (string) required
Tags (object)
WhitelistRules (array)
medialive/update_multiplexUpdates a multiplex.MultiplexId (string) required
MultiplexSettings: {
. MaximumVideoBufferDelayMilliseconds (integer)
. TransportStreamBitrate (integer)
. TransportStreamId (integer)
. TransportStreamReservedBitrate (integer)
} (object)
Name (string)
PacketIdentifiersMapping (object)
medialive/update_multiplex_programUpdate a program in a multiplex.MultiplexId (string) required
MultiplexProgramSettings: {
. PreferredChannelPipeline (string)
. ProgramNumber (integer)
. ServiceDescriptor (object)
. VideoSettings (object)
} (object)
ProgramName (string) required
medialive/update_networkChange the settings for a Network.IpPools (array)
Name (string)
NetworkId (string) required
Routes (array)
medialive/update_nodeChange the settings for a Node.ClusterId (string) required
Name (string)
NodeId (string) required
Role (string)
SdiSourceMappings (array)
medialive/update_node_stateUpdate the state of a node.ClusterId (string) required
NodeId (string) required
State (string)
medialive/update_reservationUpdate reservation.Name (string)
RenewalSettings: {
. AutomaticRenewal (string)
. RenewalCount (integer)
} (object)
ReservationId (string) required
medialive/update_sdi_sourceChange some of the settings in an SdiSource.Mode (string)
Name (string)
SdiSourceId (string) required
Type (string)
mediapackage_vod/configure_logsChanges the packaging group's properities to configure log subscriptionEgressAccessLogs: {
. LogGroupName (string)
} (object)
Id (string) required
mediapackage_vod/create_assetCreates a new MediaPackage VOD Asset resource.Id (string) required
PackagingGroupId (string) required
ResourceId (string)
SourceArn (string) required
SourceRoleArn (string) required
Tags (object)
mediapackage_vod/create_packaging_configurationCreates a new MediaPackage VOD PackagingConfiguration resource.CmafPackage: {
. Encryption (object)
. HlsManifests (array)
. IncludeEncoderConfigurationInSegments (boolean)
. SegmentDurationSeconds (integer)
} (object)
DashPackage: {
. DashManifests (array)
. Encryption (object)
. IncludeEncoderConfigurationInSegments (boolean)
. IncludeIframeOnlyStream (boolean)
. PeriodTriggers (array)
. SegmentDurationSeconds (integer)
. SegmentTemplateFormat (string)
} (object)
HlsPackage: {
. Encryption (object)
. HlsManifests (array)
. IncludeDvbSubtitles (boolean)
. SegmentDurationSeconds (integer)
. UseAudioRenditionGroup (boolean)
} (object)
Id (string) required
MssPackage: {
. Encryption (object)
. MssManifests (array)
. SegmentDurationSeconds (integer)
} (object)
PackagingGroupId (string) required
Tags (object)
mediapackage_vod/create_packaging_groupCreates a new MediaPackage VOD PackagingGroup resource.Authorization: {
. CdnIdentifierSecret (string)
. SecretsRoleArn (string)
} (object)
EgressAccessLogs: {
. LogGroupName (string)
} (object)
Id (string) required
Tags (object)
mediapackage_vod/delete_assetDeletes an existing MediaPackage VOD Asset resource.Id (string) required
mediapackage_vod/delete_packaging_configurationDeletes a MediaPackage VOD PackagingConfiguration resource.Id (string) required
mediapackage_vod/delete_packaging_groupDeletes a MediaPackage VOD PackagingGroup resource.Id (string) required
mediapackage_vod/describe_assetReturns a description of a MediaPackage VOD Asset resource.Id (string) required
mediapackage_vod/describe_packaging_configurationReturns a description of a MediaPackage VOD PackagingConfiguration resource.Id (string) required
mediapackage_vod/describe_packaging_groupReturns a description of a MediaPackage VOD PackagingGroup resource.Id (string) required
mediapackage_vod/list_assetsReturns a collection of MediaPackage VOD Asset resources.MaxResults (integer)
NextToken (string)
PackagingGroupId (string)
mediapackage_vod/list_packaging_configurationsReturns a collection of MediaPackage VOD PackagingConfiguration resources.MaxResults (integer)
NextToken (string)
PackagingGroupId (string)
mediapackage_vod/list_packaging_groupsReturns a collection of MediaPackage VOD PackagingGroup resources.MaxResults (integer)
NextToken (string)
mediapackage_vod/list_tags_for_resourceReturns a list of the tags assigned to the specified resource.ResourceArn (string) required
mediapackage_vod/tag_resourceAdds tags to the specified resource. You can specify one or more tags to add.ResourceArn (string) required
Tags (object) required
mediapackage_vod/untag_resourceRemoves tags from the specified resource. You can specify one or more tags to remove.ResourceArn (string) required
TagKeys (array) required
mediapackage_vod/update_packaging_groupUpdates a specific packaging group. You can't change the id attribute or any other system-generated attributes.Authorization: {
. CdnIdentifierSecret (string)
. SecretsRoleArn (string)
} (object)
Id (string) required
mediapackage/configure_logsChanges the Channel's properities to configure log subscriptionEgressAccessLogs: {
. LogGroupName (string)
} (object)
Id (string) required
IngressAccessLogs: {
. LogGroupName (string)
} (object)
mediapackage/create_channelCreates a new Channel.Description (string)
Id (string) required
Tags (object)
mediapackage/create_harvest_jobCreates a new HarvestJob record.EndTime (string) required
Id (string) required
OriginEndpointId (string) required
S3Destination: {
. BucketName (string)
. ManifestKey (string)
. RoleArn (string)
} (object) required
StartTime (string) required
mediapackage/create_origin_endpointCreates a new OriginEndpoint record.Authorization: {
. CdnIdentifierSecret (string)
. SecretsRoleArn (string)
} (object)
ChannelId (string) required
CmafPackage: {
. Encryption (object)
. HlsManifests (array)
. SegmentDurationSeconds (integer)
. SegmentPrefix (string)
. StreamSelection (object)
} (object)
DashPackage: {
. AdTriggers (array)
. AdsOnDeliveryRestrictions (string)
. Encryption (object)
. IncludeIframeOnlyStream (boolean)
. ManifestLayout (string)
. ManifestWindowSeconds (integer)
. MinBufferTimeSeconds (integer)
. MinUpdatePeriodSeconds (integer)
. PeriodTriggers (array)
. Profile (string)
. SegmentDurationSeconds (integer)
. SegmentTemplateFormat (string)
. StreamSelection (object)
. SuggestedPresentationDelaySeconds (integer)
. UtcTiming (string)
. UtcTimingUri (string)
} (object)
Description (string)
HlsPackage: {
. AdMarkers (string)
. AdTriggers (array)
. AdsOnDeliveryRestrictions (string)
. Encryption (object)
. IncludeDvbSubtitles (boolean)
. IncludeIframeOnlyStream (boolean)
. PlaylistType (string)
. PlaylistWindowSeconds (integer)
. ProgramDateTimeIntervalSeconds (integer)
. SegmentDurationSeconds (integer)
. StreamSelection (object)
. UseAudioRenditionGroup (boolean)
} (object)
Id (string) required
ManifestName (string)
MssPackage: {
. Encryption (object)
. ManifestWindowSeconds (integer)
. SegmentDurationSeconds (integer)
. StreamSelection (object)
} (object)
Origination (string)
StartoverWindowSeconds (integer)
Tags (object)
TimeDelaySeconds (integer)
Whitelist (array)
mediapackage/delete_channelDeletes an existing Channel.Id (string) required
mediapackage/delete_origin_endpointDeletes an existing OriginEndpoint.Id (string) required
mediapackage/describe_channelGets details about a Channel.Id (string) required
mediapackage/describe_harvest_jobGets details about an existing HarvestJob.Id (string) required
mediapackage/describe_origin_endpointGets details about an existing OriginEndpoint.Id (string) required
mediapackage/list_channelsReturns a collection of Channels.MaxResults (integer)
NextToken (string)
mediapackage/list_harvest_jobsReturns a collection of HarvestJob records.IncludeChannelId (string)
IncludeStatus (string)
MaxResults (integer)
NextToken (string)
mediapackage/list_origin_endpointsReturns a collection of OriginEndpoint records.ChannelId (string)
MaxResults (integer)
NextToken (string)
mediapackage/list_tags_for_resourceNo description availableResourceArn (string) required
mediapackage/rotate_channel_credentialsChanges the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials insteadId (string) required
mediapackage/rotate_ingest_endpoint_credentialsRotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.Id (string) required
IngestEndpointId (string) required
mediapackage/tag_resourceNo description availableResourceArn (string) required
Tags (object) required
mediapackage/untag_resourceNo description availableResourceArn (string) required
TagKeys (array) required
mediapackage/update_channelUpdates an existing Channel.Description (string)
Id (string) required
mediapackage/update_origin_endpointUpdates an existing OriginEndpoint.Authorization: {
. CdnIdentifierSecret (string)
. SecretsRoleArn (string)
} (object)
CmafPackage: {
. Encryption (object)
. HlsManifests (array)
. SegmentDurationSeconds (integer)
. SegmentPrefix (string)
. StreamSelection (object)
} (object)
DashPackage: {
. AdTriggers (array)
. AdsOnDeliveryRestrictions (string)
. Encryption (object)
. IncludeIframeOnlyStream (boolean)
. ManifestLayout (string)
. ManifestWindowSeconds (integer)
. MinBufferTimeSeconds (integer)
. MinUpdatePeriodSeconds (integer)
. PeriodTriggers (array)
. Profile (string)
. SegmentDurationSeconds (integer)
. SegmentTemplateFormat (string)
. StreamSelection (object)
. SuggestedPresentationDelaySeconds (integer)
. UtcTiming (string)
. UtcTimingUri (string)
} (object)
Description (string)
HlsPackage: {
. AdMarkers (string)
. AdTriggers (array)
. AdsOnDeliveryRestrictions (string)
. Encryption (object)
. IncludeDvbSubtitles (boolean)
. IncludeIframeOnlyStream (boolean)
. PlaylistType (string)
. PlaylistWindowSeconds (integer)
. ProgramDateTimeIntervalSeconds (integer)
. SegmentDurationSeconds (integer)
. StreamSelection (object)
. UseAudioRenditionGroup (boolean)
} (object)
Id (string) required
ManifestName (string)
MssPackage: {
. Encryption (object)
. ManifestWindowSeconds (integer)
. SegmentDurationSeconds (integer)
. StreamSelection (object)
} (object)
Origination (string)
StartoverWindowSeconds (integer)
TimeDelaySeconds (integer)
Whitelist (array)
mediapackagev2/list_tags_for_resourceLists the tags assigned to a resource.ResourceArn (string) required
mediapackagev2/tag_resourceAssigns one of more tags key-value pairs to the specified MediaPackage 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 thResourceArn (string) required
Tags (object) required
mediapackagev2/untag_resourceRemoves one or more tags from the specified resource.ResourceArn (string) required
TagKeys (array) required
mediapackagev2/get_channel_groupRetrieves the specified channel group that's configured in AWS Elemental MediaPackage.ChannelGroupName (string) required
mediapackagev2/update_channel_groupUpdate the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group. Any edits you make that impact the video output may not be reflected for a few minutes.ChannelGroupName (string) required
ETag (string)
Description (string)
mediapackagev2/delete_channel_groupDelete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.ChannelGroupName (string) required
mediapackagev2/list_channel_groupsRetrieves all channel groups that are configured in Elemental MediaPackage.MaxResults (integer)
NextToken (string)
mediapackagev2/create_channel_groupCreate a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.ChannelGroupName (string) required
ClientToken (string)
Description (string)
Tags (object)
mediapackagev2/reset_channel_stateResetting the channel can help to clear errors from misconfigurations in the encoder. A reset refreshes the ingest stream and removes previous content. Be sure to stop the encoder before you reset the channel, and wait at least 30 seconds before you restart the encoder.ChannelGroupName (string) required
ChannelName (string) required
mediapackagev2/get_channelRetrieves the specified channel that's configured in AWS Elemental MediaPackage.ChannelGroupName (string) required
ChannelName (string) required
mediapackagev2/update_channelUpdate the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details. Any edits you make that impact the video output may not be reflected for a few minutes.ChannelGroupName (string) required
ChannelName (string) required
ETag (string)
Description (string)
InputSwitchConfiguration: {
. MQCSInputSwitching (boolean)
. PreferredInput (integer)
} (object)
OutputHeaderConfiguration: {
. PublishMQCS (boolean)
} (object)
mediapackagev2/delete_channelDelete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel.ChannelGroupName (string) required
ChannelName (string) required
mediapackagev2/list_channelsRetrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage.ChannelGroupName (string) required
MaxResults (integer)
NextToken (string)
mediapackagev2/create_channelCreate a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices such as video players or CDNs that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels iChannelGroupName (string) required
ChannelName (string) required
ClientToken (string)
InputType (string)
Description (string)
InputSwitchConfiguration: {
. MQCSInputSwitching (boolean)
. PreferredInput (integer)
} (object)
OutputHeaderConfiguration: {
. PublishMQCS (boolean)
} (object)
Tags (object)
mediapackagev2/get_channel_policyRetrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.ChannelGroupName (string) required
ChannelName (string) required
mediapackagev2/delete_channel_policyDelete a channel policy.ChannelGroupName (string) required
ChannelName (string) required
mediapackagev2/put_channel_policyAttaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.ChannelGroupName (string) required
ChannelName (string) required
Policy (string) required
mediapackagev2/reset_origin_endpoint_stateResetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you don't want the previous content to be available for viewing. A reset clears out all previous content from the origin endpoint. MediaPackage might return old content from this endpoint in the first 30 seconds after the endpoint reset. For best results, when possible, wait 30 seconds from endpoint reset to send playback requests to this endpoinChannelGroupName (string) required
ChannelName (string) required
OriginEndpointName (string) required
mediapackagev2/get_origin_endpointRetrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.ChannelGroupName (string) required
ChannelName (string) required
OriginEndpointName (string) required
mediapackagev2/update_origin_endpointUpdate the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint. Any edits you make that impact the video output may not be reflected for a few minutes.ChannelGroupName (string) required
ChannelName (string) required
OriginEndpointName (string) required
ContainerType (string) required
Segment: {
. SegmentDurationSeconds (integer)
. SegmentName (string)
. TsUseAudioRenditionGroup (boolean)
. IncludeIframeOnlyStreams (boolean)
. TsIncludeDvbSubtitles (boolean)
. Scte (object)
. Encryption (object)
} (object)
Description (string)
StartoverWindowSeconds (integer)
HlsManifests (array)
LowLatencyHlsManifests (array)
DashManifests (array)
MssManifests (array)
ForceEndpointErrorConfiguration: {
. EndpointErrorConditions (array)
} (object)
ETag (string)
mediapackagev2/delete_origin_endpointOrigin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel.ChannelGroupName (string) required
ChannelName (string) required
OriginEndpointName (string) required
mediapackagev2/list_origin_endpointsRetrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.ChannelGroupName (string) required
ChannelName (string) required
MaxResults (integer)
NextToken (string)
mediapackagev2/create_origin_endpointThe endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs such as Amazon CloudFront access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.ChannelGroupName (string) required
ChannelName (string) required
OriginEndpointName (string) required
ContainerType (string) required
Segment: {
. SegmentDurationSeconds (integer)
. SegmentName (string)
. TsUseAudioRenditionGroup (boolean)
. IncludeIframeOnlyStreams (boolean)
. TsIncludeDvbSubtitles (boolean)
. Scte (object)
. Encryption (object)
} (object)
ClientToken (string)
Description (string)
StartoverWindowSeconds (integer)
HlsManifests (array)
LowLatencyHlsManifests (array)
DashManifests (array)
MssManifests (array)
ForceEndpointErrorConfiguration: {
. EndpointErrorConditions (array)
} (object)
Tags (object)
mediapackagev2/get_origin_endpoint_policyRetrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.ChannelGroupName (string) required
ChannelName (string) required
OriginEndpointName (string) required
mediapackagev2/delete_origin_endpoint_policyDelete an origin endpoint policy.ChannelGroupName (string) required
ChannelName (string) required
OriginEndpointName (string) required
mediapackagev2/put_origin_endpoint_policyAttaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.ChannelGroupName (string) required
ChannelName (string) required
OriginEndpointName (string) required
Policy (string) required
CdnAuthConfiguration: {
. CdnIdentifierSecretArns (array)
. SecretsRoleArn (string)
} (object)
mediapackagev2/create_harvest_jobCreates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.ChannelGroupName (string) required
ChannelName (string) required
OriginEndpointName (string) required
Description (string)
HarvestedManifests: {
. HlsManifests (array)
. DashManifests (array)
. LowLatencyHlsManifests (array)
} (object) required
ScheduleConfiguration: {
. StartTime (string)
. EndTime (string)
} (object) required
Destination: {
. S3Destination (object)
} (object) required
ClientToken (string)
HarvestJobName (string)
Tags (object)
mediapackagev2/get_harvest_jobRetrieves the details of a specific harvest job.ChannelGroupName (string) required
ChannelName (string) required
OriginEndpointName (string) required
HarvestJobName (string) required
mediapackagev2/cancel_harvest_jobCancels an in-progress harvest job.ChannelGroupName (string) required
ChannelName (string) required
OriginEndpointName (string) required
HarvestJobName (string) required
ETag (string)
mediapackagev2/list_harvest_jobsRetrieves a list of harvest jobs that match the specified criteria.ChannelGroupName (string) required
ChannelName (string)
OriginEndpointName (string)
Status (string)
MaxResults (integer)
NextToken (string)
mediastore_data/delete_objectDeletes an object at the specified path.Path (string) required
mediastore_data/describe_objectGets the headers for an object at the specified path.Path (string) required
mediastore_data/get_objectDownloads 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.Path (string) required
Range (string)
mediastore_data/list_itemsProvides a list of metadata entries about folders and objects in the specified folder.Path (string)
MaxResults (integer)
NextToken (string)
mediastore_data/put_objectUploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.Body (string) required
Path (string) required
ContentType (string)
CacheControl (string)
StorageClass (string)
UploadAvailability (string)
mediastore/create_containerCreates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.ContainerName (string) required
Tags (array)
mediastore/delete_containerDeletes 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.ContainerName (string) required
mediastore/delete_container_policyDeletes the access policy that is associated with the specified container.ContainerName (string) required
mediastore/delete_cors_policyDeletes 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.ContainerName (string) required
mediastore/delete_lifecycle_policyRemoves an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.ContainerName (string) required
mediastore/delete_metric_policyDeletes 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.ContainerName (string) required
mediastore/describe_containerRetrieves 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.ContainerName (string)
mediastore/get_container_policyRetrieves 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.ContainerName (string) required
mediastore/get_cors_policyReturns 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.ContainerName (string) required
mediastore/get_lifecycle_policyRetrieves the object lifecycle policy that is assigned to a container.ContainerName (string) required
mediastore/get_metric_policyReturns the metric policy for the specified container.ContainerName (string) required
mediastore/list_containersLists 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 toNextToken (string)
MaxResults (integer)
mediastore/list_tags_for_resourceReturns a list of the tags assigned to the specified container.Resource (string) required
mediastore/put_container_policyCreates 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.ContainerName (string) required
Policy (string) required
mediastore/put_cors_policySets 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 methodContainerName (string) required
CorsPolicy (array) required
mediastore/put_lifecycle_policyWrites 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.ContainerName (string) required
LifecyclePolicy (string) required
mediastore/put_metric_policyThe 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.ContainerName (string) required
MetricPolicy: {
. ContainerLevelMetrics (string)
. MetricPolicyRules (array)
} (object) required
mediastore/start_access_loggingStarts 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.ContainerName (string) required
mediastore/stop_access_loggingStops 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.ContainerName (string) required
mediastore/tag_resourceAdds 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.Resource (string) required
Tags (array) required
mediastore/untag_resourceRemoves tags from the specified container. You can specify one or more tags to remove.Resource (string) required
TagKeys (array) required
mediatailor/configure_logs_for_playback_configurationDefines where AWS Elemental MediaTailor sends logs for the playback configuration.PercentEnabled (integer) required
PlaybackConfigurationName (string) required
EnabledLoggingStrategies (array)
AdsInteractionLog: {
. PublishOptInEventTypes (array)
. ExcludeEventTypes (array)
} (object)
ManifestServiceInteractionLog: {
. ExcludeEventTypes (array)
} (object)
mediatailor/list_alertsLists the alerts that are associated with a MediaTailor channel assembly resource.MaxResults (integer)
NextToken (string)
ResourceArn (string) required
mediatailor/list_tags_for_resourceA list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.ResourceArn (string) required
mediatailor/tag_resourceThe resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.ResourceArn (string) required
Tags (object) required
mediatailor/untag_resourceThe resource to untag.ResourceArn (string) required
TagKeys (array) required
mediatailor/configure_logs_for_channelConfigures Amazon CloudWatch log settings for a channel.ChannelName (string) required
LogTypes (array) required
mediatailor/create_channelCreates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.ChannelName (string) required
FillerSlate: {
. SourceLocationName (string)
. VodSourceName (string)
} (object)
Outputs (array) required
PlaybackMode (string) required
Tags (object)
Tier (string)
TimeShiftConfiguration: {
. MaxTimeDelaySeconds (integer)
} (object)
Audiences (array)
mediatailor/get_channel_scheduleRetrieves information about your channel's schedule.ChannelName (string) required
DurationMinutes (string)
MaxResults (integer)
NextToken (string)
Audience (string)
mediatailor/start_channelStarts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.ChannelName (string) required
mediatailor/stop_channelStops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.ChannelName (string) required
mediatailor/describe_channelDescribes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.ChannelName (string) required
mediatailor/update_channelUpdates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.ChannelName (string) required
FillerSlate: {
. SourceLocationName (string)
. VodSourceName (string)
} (object)
Outputs (array) required
TimeShiftConfiguration: {
. MaxTimeDelaySeconds (integer)
} (object)
Audiences (array)
mediatailor/delete_channelDeletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.ChannelName (string) required
mediatailor/list_channelsRetrieves information about the channels that are associated with the current AWS account.MaxResults (integer)
NextToken (string)
mediatailor/get_channel_policyReturns the channel's IAM policy. IAM policies are used to control access to your channel.ChannelName (string) required
mediatailor/delete_channel_policyThe channel policy to delete.ChannelName (string) required
mediatailor/put_channel_policyCreates an IAM policy for the channel. IAM policies are used to control access to your channel.ChannelName (string) required
Policy (string) required
mediatailor/describe_programDescribes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.ChannelName (string) required
ProgramName (string) required
mediatailor/update_programUpdates a program within a channel.AdBreaks (array)
ChannelName (string) required
ProgramName (string) required
ScheduleConfiguration: {
. Transition (object)
. ClipRange (object)
} (object) required
AudienceMedia (array)
mediatailor/delete_programDeletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.ChannelName (string) required
ProgramName (string) required
mediatailor/create_programCreates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.AdBreaks (array)
ChannelName (string) required
LiveSourceName (string)
ProgramName (string) required
ScheduleConfiguration: {
. Transition (object)
. ClipRange (object)
} (object) required
SourceLocationName (string) required
VodSourceName (string)
AudienceMedia (array)
mediatailor/describe_live_sourceThe live source to describe.LiveSourceName (string) required
SourceLocationName (string) required
mediatailor/update_live_sourceUpdates a live source's configuration.HttpPackageConfigurations (array) required
LiveSourceName (string) required
SourceLocationName (string) required
mediatailor/delete_live_sourceThe live source to delete.LiveSourceName (string) required
SourceLocationName (string) required
mediatailor/list_live_sourcesLists the live sources contained in a source location. A source represents a piece of content.MaxResults (integer)
NextToken (string)
SourceLocationName (string) required
mediatailor/create_live_sourceThe live source configuration.HttpPackageConfigurations (array) required
LiveSourceName (string) required
SourceLocationName (string) required
Tags (object)
mediatailor/get_playback_configurationRetrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.Name (string) required
mediatailor/delete_playback_configurationDeletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.Name (string) required
mediatailor/list_playback_configurationsRetrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.MaxResults (integer)
NextToken (string)
mediatailor/put_playback_configurationCreates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.AdDecisionServerUrl (string)
AvailSuppression: {
. Mode (string)
. Value (string)
. FillPolicy (string)
} (object)
Bumper: {
. EndUrl (string)
. StartUrl (string)
} (object)
CdnConfiguration: {
. AdSegmentUrlPrefix (string)
. ContentSegmentUrlPrefix (string)
} (object)
ConfigurationAliases (object)
DashConfiguration: {
. MpdLocation (string)
. OriginManifestType (string)
} (object)
InsertionMode (string)
LivePreRollConfiguration: {
. AdDecisionServerUrl (string)
. MaxDurationSeconds (integer)
} (object)
ManifestProcessingRules: {
. AdMarkerPassthrough (object)
} (object)
Name (string) required
PersonalizationThresholdSeconds (integer)
SlateAdUrl (string)
Tags (object)
TranscodeProfileName (string)
VideoContentSourceUrl (string)
AdConditioningConfiguration: {
. StreamingMediaFileConditioning (string)
} (object)
AdDecisionServerConfiguration: {
. HttpRequest (object)
} (object)
mediatailor/get_prefetch_scheduleRetrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.Name (string) required
PlaybackConfigurationName (string) required
mediatailor/delete_prefetch_scheduleDeletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.Name (string) required
PlaybackConfigurationName (string) required
mediatailor/list_prefetch_schedulesLists the prefetch schedules for a playback configuration.MaxResults (integer)
NextToken (string)
PlaybackConfigurationName (string) required
ScheduleType (string)
StreamId (string)
mediatailor/create_prefetch_scheduleCreates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.Consumption: {
. AvailMatchingCriteria (array)
. EndTime (string)
. StartTime (string)
} (object)
Name (string) required
PlaybackConfigurationName (string) required
Retrieval: {
. DynamicVariables (object)
. EndTime (string)
. StartTime (string)
. TrafficShapingType (string)
. TrafficShapingRetrievalWindow (object)
. TrafficShapingTpsConfiguration (object)
} (object)
RecurringPrefetchConfiguration: {
. StartTime (string)
. EndTime (string)
. RecurringConsumption (object)
. RecurringRetrieval (object)
} (object)
ScheduleType (string)
StreamId (string)
mediatailor/describe_source_locationDescribes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.SourceLocationName (string) required
mediatailor/update_source_locationUpdates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.AccessConfiguration: {
. AccessType (string)
. SecretsManagerAccessTokenConfiguration (object)
} (object)
DefaultSegmentDeliveryConfiguration: {
. BaseUrl (string)
} (object)
HttpConfiguration: {
. BaseUrl (string)
} (object) required
SegmentDeliveryConfigurations (array)
SourceLocationName (string) required
mediatailor/delete_source_locationDeletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.SourceLocationName (string) required
mediatailor/list_source_locationsLists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.MaxResults (integer)
NextToken (string)
mediatailor/create_source_locationCreates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.AccessConfiguration: {
. AccessType (string)
. SecretsManagerAccessTokenConfiguration (object)
} (object)
DefaultSegmentDeliveryConfiguration: {
. BaseUrl (string)
} (object)
HttpConfiguration: {
. BaseUrl (string)
} (object) required
SegmentDeliveryConfigurations (array)
SourceLocationName (string) required
Tags (object)
mediatailor/describe_vod_sourceProvides details about a specific video on demand VOD source in a specific source location.SourceLocationName (string) required
VodSourceName (string) required
mediatailor/update_vod_sourceUpdates a VOD source's configuration.HttpPackageConfigurations (array) required
SourceLocationName (string) required
VodSourceName (string) required
mediatailor/delete_vod_sourceThe video on demand VOD source to delete.SourceLocationName (string) required
VodSourceName (string) required
mediatailor/list_vod_sourcesLists the VOD sources contained in a source location. A source represents a piece of content.MaxResults (integer)
NextToken (string)
SourceLocationName (string) required
mediatailor/create_vod_sourceThe VOD source configuration parameters.HttpPackageConfigurations (array) required
SourceLocationName (string) required
Tags (object)
VodSourceName (string) required
medical_imaging/copy_image_setCopy an image set.datastoreId (string) required
sourceImageSetId (string) required
copyImageSetInformation: {
. sourceImageSet (object)
. destinationImageSet (object)
} (object) required
force (boolean)
promoteToPrimary (boolean)
medical_imaging/delete_image_setDelete an image set.datastoreId (string) required
imageSetId (string) required
medical_imaging/get_dicomimport_jobGet the import job properties to learn more about the job or job progress. The jobStatus refers to the execution of the import job. Therefore, an import job can return a jobStatus as COMPLETED even if validation issues are discovered during the import process. If a jobStatus returns as COMPLETED, we still recommend you review the output manifests written to S3, as they provide details on the success or failure of individual P10 object imports.datastoreId (string) required
jobId (string) required
medical_imaging/get_image_frameGet an image frame pixel data for an image set.datastoreId (string) required
imageSetId (string) required
imageFrameInformation: {
. imageFrameId (string)
} (object) required
medical_imaging/get_image_setGet image set properties.datastoreId (string) required
imageSetId (string) required
versionId (string)
medical_imaging/get_image_set_metadataGet metadata attributes for an image set.datastoreId (string) required
imageSetId (string) required
versionId (string)
medical_imaging/list_dicomimport_jobsList import jobs created for a specific data store.datastoreId (string) required
jobStatus (string)
nextToken (string)
maxResults (integer)
medical_imaging/list_image_set_versionsList image set versions.datastoreId (string) required
imageSetId (string) required
nextToken (string)
maxResults (integer)
medical_imaging/list_tags_for_resourceLists all tags associated with a medical imaging resource.resourceArn (string) required
medical_imaging/search_image_setsSearch image sets based on defined input attributes. SearchImageSets accepts a single search query parameter and returns a paginated response of all image sets that have the matching criteria. All date range queries must be input as lowerBound, upperBound. By default, SearchImageSets uses the updatedAt field for sorting in descending order from newest to oldest.datastoreId (string) required
searchCriteria: {
. filters (array)
. sort (object)
} (object)
maxResults (integer)
nextToken (string)
medical_imaging/start_dicomimport_jobStart importing bulk data into an ACTIVE data store. The import job imports DICOM P10 files found in the S3 prefix specified by the inputS3Uri parameter. The import job stores processing results in the file specified by the outputS3Uri parameter.jobName (string)
dataAccessRoleArn (string) required
clientToken (string) required
datastoreId (string) required
inputS3Uri (string) required
outputS3Uri (string) required
inputOwnerAccountId (string)
medical_imaging/tag_resourceAdds a user-specifed key and value tag to a medical imaging resource.resourceArn (string) required
tags (object) required
medical_imaging/untag_resourceRemoves tags from a medical imaging resource.resourceArn (string) required
tagKeys (array) required
medical_imaging/update_image_set_metadataUpdate image set metadata attributes.datastoreId (string) required
imageSetId (string) required
latestVersionId (string) required
force (boolean)
updateImageSetMetadataUpdates (undefined) required
medical_imaging/create_datastoreCreate a data store.datastoreName (string)
clientToken (string) required
tags (object)
kmsKeyArn (string)
lambdaAuthorizerArn (string)
losslessStorageFormat (string)
medical_imaging/get_datastoreGet data store properties.datastoreId (string) required
medical_imaging/delete_datastoreDelete a data store. Before a data store can be deleted, you must first delete all image sets within it.datastoreId (string) required
medical_imaging/list_datastoresList data stores.datastoreStatus (string)
nextToken (string)
maxResults (integer)
memorydb/batch_update_clusterApply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.ClusterNames (array) required
ServiceUpdate: {
. ServiceUpdateNameToApply (string)
} (object)
memorydb/copy_snapshotMakes a copy of an existing snapshot.SourceSnapshotName (string) required
TargetSnapshotName (string) required
TargetBucket (string)
KmsKeyId (string)
Tags (array)
memorydb/create_aclCreates an Access Control List. For more information, see Authenticating users with Access Contol Lists ACLs.ACLName (string) required
UserNames (array)
Tags (array)
memorydb/create_clusterCreates a cluster. All nodes in the cluster run the same protocol-compliant engine software.ClusterName (string) required
NodeType (string) required
MultiRegionClusterName (string)
ParameterGroupName (string)
Description (string)
NumShards (integer)
NumReplicasPerShard (integer)
SubnetGroupName (string)
SecurityGroupIds (array)
MaintenanceWindow (string)
Port (integer)
SnsTopicArn (string)
TLSEnabled (boolean)
KmsKeyId (string)
SnapshotArns (array)
SnapshotName (string)
SnapshotRetentionLimit (integer)
Tags (array)
SnapshotWindow (string)
ACLName (string) required
Engine (string)
EngineVersion (string)
AutoMinorVersionUpgrade (boolean)
DataTiering (boolean)
NetworkType (string)
IpDiscovery (string)
memorydb/create_multi_region_clusterCreates a new multi-Region cluster.MultiRegionClusterNameSuffix (string) required
Description (string)
Engine (string)
EngineVersion (string)
NodeType (string) required
MultiRegionParameterGroupName (string)
NumShards (integer)
TLSEnabled (boolean)
Tags (array)
memorydb/create_parameter_groupCreates 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.ParameterGroupName (string) required
Family (string) required
Description (string)
Tags (array)
memorydb/create_snapshotCreates a copy of an entire cluster at a specific moment in time.ClusterName (string) required
SnapshotName (string) required
KmsKeyId (string)
Tags (array)
memorydb/create_subnet_groupCreates 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.SubnetGroupName (string) required
Description (string)
SubnetIds (array) required
Tags (array)
memorydb/create_userCreates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists ACLs.UserName (string) required
AuthenticationMode: {
. Type (string)
. Passwords (array)
} (object) required
AccessString (string) required
Tags (array)
memorydb/delete_aclDeletes 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.ACLName (string) required
memorydb/delete_clusterDeletes a cluster. It also deletes all associated nodes and node endpoints. CreateSnapshot permission is required to create a final snapshot. Without this permission, the API call will fail with an Access Denied exception.ClusterName (string) required
MultiRegionClusterName (string)
FinalSnapshotName (string)
memorydb/delete_multi_region_clusterDeletes an existing multi-Region cluster.MultiRegionClusterName (string) required
memorydb/delete_parameter_groupDeletes 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.ParameterGroupName (string) required
memorydb/delete_snapshotDeletes 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.SnapshotName (string) required
memorydb/delete_subnet_groupDeletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.SubnetGroupName (string) required
memorydb/delete_userDeletes a user. The user will be removed from all ACLs and in turn removed from all clusters.UserName (string) required
memorydb/describe_aclsReturns a list of ACLs.ACLName (string)
MaxResults (integer)
NextToken (string)
memorydb/describe_clustersReturns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.ClusterName (string)
MaxResults (integer)
NextToken (string)
ShowShardDetails (boolean)
memorydb/describe_engine_versionsReturns a list of the available Redis OSS engine versions.Engine (string)
EngineVersion (string)
ParameterGroupFamily (string)
MaxResults (integer)
NextToken (string)
DefaultOnly (boolean)
memorydb/describe_eventsReturns 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.SourceName (string)
SourceType (string)
StartTime (string)
EndTime (string)
Duration (integer)
MaxResults (integer)
NextToken (string)
memorydb/describe_multi_region_clustersReturns details about one or more multi-Region clusters.MultiRegionClusterName (string)
MaxResults (integer)
NextToken (string)
ShowClusterDetails (boolean)
memorydb/describe_multi_region_parameter_groupsReturns a list of multi-region parameter groups.MultiRegionParameterGroupName (string)
MaxResults (integer)
NextToken (string)
memorydb/describe_multi_region_parametersReturns the detailed parameter list for a particular multi-region parameter group.MultiRegionParameterGroupName (string) required
Source (string)
MaxResults (integer)
NextToken (string)
memorydb/describe_parameter_groupsReturns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.ParameterGroupName (string)
MaxResults (integer)
NextToken (string)
memorydb/describe_parametersReturns the detailed parameter list for a particular parameter group.ParameterGroupName (string) required
MaxResults (integer)
NextToken (string)
memorydb/describe_reserved_nodesReturns information about reserved nodes for this account, or about a specified reserved node.ReservationId (string)
ReservedNodesOfferingId (string)
NodeType (string)
Duration (string)
OfferingType (string)
MaxResults (integer)
NextToken (string)
memorydb/describe_reserved_nodes_offeringsLists available reserved node offerings.ReservedNodesOfferingId (string)
NodeType (string)
Duration (string)
OfferingType (string)
MaxResults (integer)
NextToken (string)
memorydb/describe_service_updatesReturns details of the service updates.ServiceUpdateName (string)
ClusterNames (array)
Status (array)
MaxResults (integer)
NextToken (string)
memorydb/describe_snapshotsReturns 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.ClusterName (string)
SnapshotName (string)
Source (string)
NextToken (string)
MaxResults (integer)
ShowDetail (boolean)
memorydb/describe_subnet_groupsReturns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.SubnetGroupName (string)
MaxResults (integer)
NextToken (string)
memorydb/describe_usersReturns a list of users.UserName (string)
Filters (array)
MaxResults (integer)
NextToken (string)
memorydb/failover_shardUsed to failover a shard. This API is designed for testing the behavior of your application in case of MemoryDB failover. It is not designed to be used as a production-level 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.ClusterName (string) required
ShardName (string) required
memorydb/list_allowed_multi_region_cluster_updatesLists the allowed updates for a multi-Region cluster.MultiRegionClusterName (string) required
memorydb/list_allowed_node_type_updatesLists 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.ClusterName (string) required
memorydb/list_tagsLists 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. When you add or remove tags from multi region clusters, you might not immediately see the latest effective tags in the ListTags API response due to it being eventually consistent specifically for multi region clusters. For more information, see Tagging your MResourceArn (string) required
memorydb/purchase_reserved_nodes_offeringAllows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.ReservedNodesOfferingId (string) required
ReservationId (string)
NodeCount (integer)
Tags (array)
memorydb/reset_parameter_groupModifies 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.ParameterGroupName (string) required
AllParameters (boolean)
ParameterNames (array)
memorydb/tag_resourceUse this operation to add tags to a 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 MemoryDB resources. For more information, see Tagging your MemoryDB resources. When you add tags to multi region clusters, you might not immediately see the latest effective tags in the ListTags API response due to it being eventually consistent specifically for multi region clusters. For more information, see Tagging your MemoryDBResourceArn (string) required
Tags (array) required
memorydb/untag_resourceUse this operation to remove tags on a 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 MemoryDB resources. For more information, see Tagging your MemoryDB resources. When you remove tags from multi region clusters, you might not immediately see the latest effective tags in the ListTags API response due to it being eventually consistent specifically for multi region clusters. For more information, see Tagging your MResourceArn (string) required
TagKeys (array) required
memorydb/update_aclChanges the list of users that belong to the Access Control List.ACLName (string) required
UserNamesToAdd (array)
UserNamesToRemove (array)
memorydb/update_clusterModifies 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.ClusterName (string) required
Description (string)
SecurityGroupIds (array)
MaintenanceWindow (string)
SnsTopicArn (string)
SnsTopicStatus (string)
ParameterGroupName (string)
SnapshotWindow (string)
SnapshotRetentionLimit (integer)
NodeType (string)
Engine (string)
EngineVersion (string)
ReplicaConfiguration: {
. ReplicaCount (integer)
} (object)
ShardConfiguration: {
. ShardCount (integer)
} (object)
ACLName (string)
IpDiscovery (string)
memorydb/update_multi_region_clusterUpdates the configuration of an existing multi-Region cluster.MultiRegionClusterName (string) required
NodeType (string)
Description (string)
EngineVersion (string)
ShardConfiguration: {
. ShardCount (integer)
} (object)
MultiRegionParameterGroupName (string)
UpdateStrategy (string)
memorydb/update_parameter_groupUpdates 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.ParameterGroupName (string) required
ParameterNameValues (array) required
memorydb/update_subnet_groupUpdates a subnet group. For more information, see Updating a subnet groupSubnetGroupName (string) required
Description (string)
SubnetIds (array)
memorydb/update_userChanges user passwords and/or access string.UserName (string) required
AuthenticationMode: {
. Type (string)
. Passwords (array)
} (object)
AccessString (string)
mgn/initialize_serviceInitialize Application Migration Service.No parameters
mgn/list_managed_accountsList Managed Accounts.maxResults (integer)
nextToken (string)
mgn/list_tags_for_resourceList all tags for your Application Migration Service resources.resourceArn (string) required
mgn/tag_resourceAdds 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.resourceArn (string) required
tags (object) required
mgn/untag_resourceDeletes the specified set of tags from the specified set of Application Migration Service resources.resourceArn (string) required
tagKeys (array) required
mgn/archive_applicationArchive application.applicationID (string) required
accountID (string)
mgn/associate_source_serversAssociate source servers to application.applicationID (string) required
sourceServerIDs (array) required
accountID (string)
mgn/disassociate_source_serversDisassociate source servers from application.applicationID (string) required
sourceServerIDs (array) required
accountID (string)
mgn/unarchive_applicationUnarchive application.applicationID (string) required
accountID (string)
mgn/update_applicationUpdate application.applicationID (string) required
name (string)
description (string)
accountID (string)
mgn/create_applicationCreate application.name (string) required
description (string)
tags (object)
accountID (string)
mgn/delete_applicationDelete application.applicationID (string) required
accountID (string)
mgn/list_applicationsRetrieves all applications or multiple applications by ID.filters: {
. applicationIDs (array)
. isArchived (boolean)
. waveIDs (array)
} (object)
maxResults (integer)
nextToken (string)
accountID (string)
mgn/create_connectorCreate Connector.name (string) required
ssmInstanceID (string) required
tags (object)
ssmCommandConfig: {
. s3OutputEnabled (boolean)
. outputS3BucketName (string)
. cloudWatchOutputEnabled (boolean)
. cloudWatchLogGroupName (string)
} (object)
mgn/update_connectorUpdate Connector.connectorID (string) required
name (string)
ssmCommandConfig: {
. s3OutputEnabled (boolean)
. outputS3BucketName (string)
. cloudWatchOutputEnabled (boolean)
. cloudWatchLogGroupName (string)
} (object)
mgn/delete_connectorDelete Connector.connectorID (string) required
mgn/list_connectorsList Connectors.filters: {
. connectorIDs (array)
} (object)
maxResults (integer)
nextToken (string)
mgn/list_export_errorsList export errors.exportID (string) required
maxResults (integer)
nextToken (string)
mgn/start_exportStart export.s3Bucket (string) required
s3Key (string) required
s3BucketOwner (string)
tags (object)
mgn/list_exportsList exports.filters: {
. exportIDs (array)
} (object)
maxResults (integer)
nextToken (string)
mgn/list_import_errorsList import errors.importID (string) required
maxResults (integer)
nextToken (string)
mgn/start_importStart import.clientToken (string)
s3BucketSource: {
. s3Bucket (string)
. s3Key (string)
. s3BucketOwner (string)
} (object) required
tags (object)
mgn/list_importsList imports.filters: {
. importIDs (array)
} (object)
maxResults (integer)
nextToken (string)
mgn/describe_job_log_itemsRetrieves detailed job log items with paging.jobID (string) required
maxResults (integer)
nextToken (string)
accountID (string)
mgn/delete_jobDeletes a single Job by ID.jobID (string) required
accountID (string)
mgn/describe_jobsReturns 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.filters: {
. jobIDs (array)
. fromDate (string)
. toDate (string)
} (object)
maxResults (integer)
nextToken (string)
accountID (string)
mgn/list_template_actionsList template post migration custom actions.launchConfigurationTemplateID (string) required
filters: {
. actionIDs (array)
} (object)
maxResults (integer)
nextToken (string)
mgn/put_template_actionPut template post migration custom action.launchConfigurationTemplateID (string) required
actionName (string) required
documentIdentifier (string) required
order (integer) required
actionID (string) required
documentVersion (string)
active (boolean)
timeoutSeconds (integer)
mustSucceedForCutover (boolean)
parameters (object)
operatingSystem (string)
externalParameters (object)
description (string)
category (string)
mgn/remove_template_actionRemove template post migration custom action.launchConfigurationTemplateID (string) required
actionID (string) required
mgn/create_launch_configuration_templateCreates a new Launch Configuration Template.postLaunchActions: {
. deployment (string)
. s3LogBucket (string)
. s3OutputKeyPrefix (string)
. cloudWatchLogGroupName (string)
. ssmDocuments (array)
} (object)
enableMapAutoTagging (boolean)
mapAutoTaggingMpeID (string)
tags (object)
launchDisposition (string)
targetInstanceTypeRightSizingMethod (string)
copyPrivateIp (boolean)
associatePublicIpAddress (boolean)
copyTags (boolean)
licensing: {
. osByol (boolean)
} (object)
bootMode (string)
smallVolumeMaxSize (integer)
smallVolumeConf: {
. volumeType (string)
. iops (integer)
. throughput (integer)
} (object)
largeVolumeConf: {
. volumeType (string)
. iops (integer)
. throughput (integer)
} (object)
enableParametersEncryption (boolean)
parametersEncryptionKey (string)
mgn/update_launch_configuration_templateUpdates an existing Launch Configuration Template by ID.launchConfigurationTemplateID (string) required
postLaunchActions: {
. deployment (string)
. s3LogBucket (string)
. s3OutputKeyPrefix (string)
. cloudWatchLogGroupName (string)
. ssmDocuments (array)
} (object)
enableMapAutoTagging (boolean)
mapAutoTaggingMpeID (string)
launchDisposition (string)
targetInstanceTypeRightSizingMethod (string)
copyPrivateIp (boolean)
associatePublicIpAddress (boolean)
copyTags (boolean)
licensing: {
. osByol (boolean)
} (object)
bootMode (string)
smallVolumeMaxSize (integer)
smallVolumeConf: {
. volumeType (string)
. iops (integer)
. throughput (integer)
} (object)
largeVolumeConf: {
. volumeType (string)
. iops (integer)
. throughput (integer)
} (object)
enableParametersEncryption (boolean)
parametersEncryptionKey (string)
mgn/delete_launch_configuration_templateDeletes a single Launch Configuration Template by ID.launchConfigurationTemplateID (string) required
mgn/describe_launch_configuration_templatesLists all Launch Configuration Templates, filtered by Launch Configuration Template IDslaunchConfigurationTemplateIDs (array)
maxResults (integer)
nextToken (string)
mgn/create_replication_configuration_templateCreates a new ReplicationConfigurationTemplate.stagingAreaSubnetId (string) required
associateDefaultSecurityGroup (boolean) required
replicationServersSecurityGroupsIDs (array) required
replicationServerInstanceType (string) required
useDedicatedReplicationServer (boolean) required
defaultLargeStagingDiskType (string) required
ebsEncryption (string) required
ebsEncryptionKeyArn (string)
bandwidthThrottling (integer) required
dataPlaneRouting (string) required
createPublicIP (boolean) required
stagingAreaTags (object) required
useFipsEndpoint (boolean)
tags (object)
internetProtocol (string)
mgn/update_replication_configuration_templateUpdates multiple ReplicationConfigurationTemplates by ID.replicationConfigurationTemplateID (string) required
arn (string)
stagingAreaSubnetId (string)
associateDefaultSecurityGroup (boolean)
replicationServersSecurityGroupsIDs (array)
replicationServerInstanceType (string)
useDedicatedReplicationServer (boolean)
defaultLargeStagingDiskType (string)
ebsEncryption (string)
ebsEncryptionKeyArn (string)
bandwidthThrottling (integer)
dataPlaneRouting (string)
createPublicIP (boolean)
stagingAreaTags (object)
useFipsEndpoint (boolean)
internetProtocol (string)
mgn/delete_replication_configuration_templateDeletes a single Replication Configuration Template by IDreplicationConfigurationTemplateID (string) required
mgn/describe_replication_configuration_templatesLists all ReplicationConfigurationTemplates, filtered by Source Server IDs.replicationConfigurationTemplateIDs (array)
maxResults (integer)
nextToken (string)
mgn/change_server_life_cycle_stateAllows 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.sourceServerID (string) required
lifeCycle: {
. state (string)
} (object) required
accountID (string)
mgn/disconnect_from_serviceDisconnects 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 uninstallsourceServerID (string) required
accountID (string)
mgn/finalize_cutoverFinalizes 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 changedsourceServerID (string) required
accountID (string)
mgn/get_launch_configurationLists all LaunchConfigurations available, filtered by Source Server IDs.sourceServerID (string) required
accountID (string)
mgn/get_replication_configurationLists all ReplicationConfigurations, filtered by Source Server ID.sourceServerID (string) required
accountID (string)
mgn/list_source_server_actionsList source server post migration custom actions.sourceServerID (string) required
filters: {
. actionIDs (array)
} (object)
maxResults (integer)
nextToken (string)
accountID (string)
mgn/mark_as_archivedArchives 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.sourceServerID (string) required
accountID (string)
mgn/pause_replicationPause Replication.sourceServerID (string) required
accountID (string)
mgn/put_source_server_actionPut source server post migration custom action.sourceServerID (string) required
actionName (string) required
documentIdentifier (string) required
order (integer) required
actionID (string) required
documentVersion (string)
active (boolean)
timeoutSeconds (integer)
mustSucceedForCutover (boolean)
parameters (object)
externalParameters (object)
description (string)
category (string)
accountID (string)
mgn/remove_source_server_actionRemove source server post migration custom action.sourceServerID (string) required
actionID (string) required
accountID (string)
mgn/resume_replicationResume Replication.sourceServerID (string) required
accountID (string)
mgn/retry_data_replicationCauses 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.sourceServerID (string) required
accountID (string)
mgn/start_replicationStart replication for source server irrespective of its replication type.sourceServerID (string) required
accountID (string)
mgn/stop_replicationStop Replication.sourceServerID (string) required
accountID (string)
mgn/update_launch_configurationUpdates multiple LaunchConfigurations by Source Server ID. bootMode valid values are LEGACY_BIOS | UEFIsourceServerID (string) required
name (string)
launchDisposition (string)
targetInstanceTypeRightSizingMethod (string)
copyPrivateIp (boolean)
copyTags (boolean)
licensing: {
. osByol (boolean)
} (object)
bootMode (string)
postLaunchActions: {
. deployment (string)
. s3LogBucket (string)
. s3OutputKeyPrefix (string)
. cloudWatchLogGroupName (string)
. ssmDocuments (array)
} (object)
enableMapAutoTagging (boolean)
mapAutoTaggingMpeID (string)
accountID (string)
mgn/update_replication_configurationAllows you to update multiple ReplicationConfigurations by Source Server ID.sourceServerID (string) required
name (string)
stagingAreaSubnetId (string)
associateDefaultSecurityGroup (boolean)
replicationServersSecurityGroupsIDs (array)
replicationServerInstanceType (string)
useDedicatedReplicationServer (boolean)
defaultLargeStagingDiskType (string)
replicatedDisks (array)
ebsEncryption (string)
ebsEncryptionKeyArn (string)
bandwidthThrottling (integer)
dataPlaneRouting (string)
createPublicIP (boolean)
stagingAreaTags (object)
useFipsEndpoint (boolean)
accountID (string)
internetProtocol (string)
mgn/update_source_server_replication_typeAllows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type. SNAPSHOT_SHIPPING should be used for agentless replication.sourceServerID (string) required
replicationType (string) required
accountID (string)
mgn/start_cutoverLaunches 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.sourceServerIDs (array) required
tags (object)
accountID (string)
mgn/start_testLaunches 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.sourceServerIDs (array) required
tags (object)
accountID (string)
mgn/terminate_target_instancesStarts 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.sourceServerIDs (array) required
tags (object)
accountID (string)
mgn/update_source_serverUpdate Source Server.accountID (string)
sourceServerID (string) required
connectorAction: {
. credentialsSecretArn (string)
. connectorArn (string)
} (object)
mgn/delete_source_serverDeletes a single source server by ID.sourceServerID (string) required
accountID (string)
mgn/describe_source_serversRetrieves all SourceServers or multiple SourceServers by ID.filters: {
. sourceServerIDs (array)
. isArchived (boolean)
. replicationTypes (array)
. lifeCycleStates (array)
. applicationIDs (array)
} (object)
maxResults (integer)
nextToken (string)
accountID (string)
mgn/delete_vcenter_clientDeletes a given vCenter client by ID.vcenterClientID (string) required
mgn/describe_vcenter_clientsReturns a list of the installed vCenter clients.maxResults (integer)
nextToken (string)
mgn/archive_waveArchive wave.waveID (string) required
accountID (string)
mgn/associate_applicationsAssociate applications to wave.waveID (string) required
applicationIDs (array) required
accountID (string)
mgn/disassociate_applicationsDisassociate applications from wave.waveID (string) required
applicationIDs (array) required
accountID (string)
mgn/unarchive_waveUnarchive wave.waveID (string) required
accountID (string)
mgn/update_waveUpdate wave.waveID (string) required
name (string)
description (string)
accountID (string)
mgn/create_waveCreate wave.name (string) required
description (string)
tags (object)
accountID (string)
mgn/delete_waveDelete wave.waveID (string) required
accountID (string)
mgn/list_wavesRetrieves all waves or multiple waves by ID.filters: {
. waveIDs (array)
. isArchived (boolean)
} (object)
maxResults (integer)
nextToken (string)
accountID (string)
migration_hub_refactor_spaces/create_applicationCreates 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. In environments created with a CreateEnvironment:NetworkFabricType of NONE you need to configure VPC to VPC connectivity betweenName (string) required
EnvironmentIdentifier (string) required
VpcId (string) required
ProxyType (string) required
ApiGatewayProxy: {
. EndpointType (string)
. StageName (string)
} (object)
Tags (object)
ClientToken (string)
migration_hub_refactor_spaces/create_environmentCreates 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 with a CreateEnvironment:NetworkFabrName (string) required
Description (string)
NetworkFabricType (string) required
Tags (object)
ClientToken (string)
migration_hub_refactor_spaces/create_routeCreates 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 routeEnvironmentIdentifier (string) required
ApplicationIdentifier (string) required
ServiceIdentifier (string) required
RouteType (string) required
DefaultRoute: {
. ActivationState (string)
} (object)
UriPathRoute: {
. SourcePath (string)
. ActivationState (string)
. Methods (array)
. IncludeChildPaths (boolean)
. AppendSourcePath (boolean)
} (object)
Tags (object)
ClientToken (string)
migration_hub_refactor_spaces/create_serviceCreates 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 toName (string) required
Description (string)
EnvironmentIdentifier (string) required
ApplicationIdentifier (string) required
VpcId (string)
EndpointType (string) required
UrlEndpoint: {
. Url (string)
. HealthUrl (string)
} (object)
LambdaEndpoint: {
. Arn (string)
} (object)
Tags (object)
ClientToken (string)
migration_hub_refactor_spaces/delete_applicationDeletes 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.EnvironmentIdentifier (string) required
ApplicationIdentifier (string) required
migration_hub_refactor_spaces/delete_environmentDeletes 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.EnvironmentIdentifier (string) required
migration_hub_refactor_spaces/delete_resource_policyDeletes the resource policy set for the environment.Identifier (string) required
migration_hub_refactor_spaces/delete_routeDeletes an Amazon Web Services Migration Hub Refactor Spaces route.EnvironmentIdentifier (string) required
ApplicationIdentifier (string) required
RouteIdentifier (string) required
migration_hub_refactor_spaces/delete_serviceDeletes an Amazon Web Services Migration Hub Refactor Spaces service.EnvironmentIdentifier (string) required
ApplicationIdentifier (string) required
ServiceIdentifier (string) required
migration_hub_refactor_spaces/get_applicationGets an Amazon Web Services Migration Hub Refactor Spaces application.EnvironmentIdentifier (string) required
ApplicationIdentifier (string) required
migration_hub_refactor_spaces/get_environmentGets an Amazon Web Services Migration Hub Refactor Spaces environment.EnvironmentIdentifier (string) required
migration_hub_refactor_spaces/get_resource_policyGets the resource-based permission policy that is set for the given environment.Identifier (string) required
migration_hub_refactor_spaces/get_routeGets an Amazon Web Services Migration Hub Refactor Spaces route.EnvironmentIdentifier (string) required
ApplicationIdentifier (string) required
RouteIdentifier (string) required
migration_hub_refactor_spaces/get_serviceGets an Amazon Web Services Migration Hub Refactor Spaces service.EnvironmentIdentifier (string) required
ApplicationIdentifier (string) required
ServiceIdentifier (string) required
migration_hub_refactor_spaces/list_applicationsLists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.EnvironmentIdentifier (string) required
NextToken (string)
MaxResults (integer)
migration_hub_refactor_spaces/list_environmentsLists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.NextToken (string)
MaxResults (integer)
migration_hub_refactor_spaces/list_environment_vpcsLists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds VPCs that are part of the environment.EnvironmentIdentifier (string) required
NextToken (string)
MaxResults (integer)
migration_hub_refactor_spaces/list_routesLists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.EnvironmentIdentifier (string) required
ApplicationIdentifier (string) required
NextToken (string)
MaxResults (integer)
migration_hub_refactor_spaces/list_servicesLists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.EnvironmentIdentifier (string) required
ApplicationIdentifier (string) required
NextToken (string)
MaxResults (integer)
migration_hub_refactor_spaces/list_tags_for_resourceLists 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.ResourceArn (string) required
migration_hub_refactor_spaces/put_resource_policyAttaches 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🐏:aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment permission in Resource Access Manager. The policy must not contain new lines or blank lines.ResourceArn (string) required
Policy (string) required
migration_hub_refactor_spaces/tag_resourceRemoves 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.ResourceArn (string) required
Tags (object) required
migration_hub_refactor_spaces/untag_resourceAdds 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.ResourceArn (string) required
TagKeys (array) required
migration_hub_refactor_spaces/update_routeUpdates an Amazon Web Services Migration Hub Refactor Spaces route.EnvironmentIdentifier (string) required
ApplicationIdentifier (string) required
RouteIdentifier (string) required
ActivationState (string) required
migration_hub/associate_created_artifactAssociates 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/ProgressUpdateStream (string) required
MigrationTaskName (string) required
CreatedArtifact: {
. Name (string)
. Description (string)
} (object) required
DryRun (boolean)
migration_hub/associate_discovered_resourceAssociates a discovered resource ID from Application Discovery Service with a migration task.ProgressUpdateStream (string) required
MigrationTaskName (string) required
DiscoveredResource: {
. ConfigurationId (string)
. Description (string)
} (object) required
DryRun (boolean)
migration_hub/associate_source_resourceAssociates a source resource with a migration task. For example, the source resource can be a source server, an application, or a migration wave.ProgressUpdateStream (string) required
MigrationTaskName (string) required
SourceResource: {
. Name (string)
. Description (string)
. StatusDetail (string)
} (object) required
DryRun (boolean)
migration_hub/create_progress_update_streamCreates 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.ProgressUpdateStreamName (string) required
DryRun (boolean)
migration_hub/delete_progress_update_streamDeletes 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 dProgressUpdateStreamName (string) required
DryRun (boolean)
migration_hub/describe_application_stateGets the migration status of an application.ApplicationId (string) required
migration_hub/describe_migration_taskRetrieves a list of all attributes associated with a specific migration task.ProgressUpdateStream (string) required
MigrationTaskName (string) required
migration_hub/disassociate_created_artifactDisassociates 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-6d0ba87bProgressUpdateStream (string) required
MigrationTaskName (string) required
CreatedArtifactName (string) required
DryRun (boolean)
migration_hub/disassociate_discovered_resourceDisassociate an Application Discovery Service discovered resource from a migration task.ProgressUpdateStream (string) required
MigrationTaskName (string) required
ConfigurationId (string) required
DryRun (boolean)
migration_hub/disassociate_source_resourceRemoves the association between a source resource and a migration task.ProgressUpdateStream (string) required
MigrationTaskName (string) required
SourceResourceName (string) required
DryRun (boolean)
migration_hub/import_migration_taskRegisters 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.ProgressUpdateStream (string) required
MigrationTaskName (string) required
DryRun (boolean)
migration_hub/list_application_statesLists all the migration statuses for your applications. If you use the optional ApplicationIds parameter, only the migration statuses for those applications will be returned.ApplicationIds (array)
NextToken (string)
MaxResults (integer)
migration_hub/list_created_artifactsLists 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.ProgressUpdateStream (string) required
MigrationTaskName (string) required
NextToken (string)
MaxResults (integer)
migration_hub/list_discovered_resourcesLists discovered resources associated with the given MigrationTask.ProgressUpdateStream (string) required
MigrationTaskName (string) required
NextToken (string)
MaxResults (integer)
migration_hub/list_migration_tasksLists 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.NextToken (string)
MaxResults (integer)
ResourceName (string)
migration_hub/list_migration_task_updatesThis is a paginated API that returns all the migration-task states for the specified MigrationTaskName and ProgressUpdateStream.ProgressUpdateStream (string) required
MigrationTaskName (string) required
NextToken (string)
MaxResults (integer)
migration_hub/list_progress_update_streamsLists progress update streams associated with the user account making this call.NextToken (string)
MaxResults (integer)
migration_hub/list_source_resourcesLists all the source resource that are associated with the specified MigrationTaskName and ProgressUpdateStream.ProgressUpdateStream (string) required
MigrationTaskName (string) required
NextToken (string)
MaxResults (integer)
migration_hub/notify_application_stateSets 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.ApplicationId (string) required
Status (string) required
UpdateDateTime (string)
DryRun (boolean)
migration_hub/notify_migration_task_stateNotifies 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.ProgressUpdateStream (string) required
MigrationTaskName (string) required
Task: {
. Status (string)
. StatusDetail (string)
. ProgressPercent (integer)
} (object) required
UpdateDateTime (string) required
NextUpdateSeconds (integer) required
DryRun (boolean)
migration_hub/put_resource_attributesProvides 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 prevenProgressUpdateStream (string) required
MigrationTaskName (string) required
ResourceAttributeList (array) required
DryRun (boolean)
migrationhub_config/create_home_region_controlThis API sets up the home region for the calling account only.HomeRegion (string) required
Target: {
. Type (string)
. Id (string)
} (object) required
DryRun (boolean)
migrationhub_config/delete_home_region_controlThis operation deletes the home region configuration for the calling account. The operation does not delete discovery or migration tracking data in the home region.ControlId (string) required
migrationhub_config/describe_home_region_controlsThis API permits filtering on the ControlId and HomeRegion fields.ControlId (string)
HomeRegion (string)
Target: {
. Type (string)
. Id (string)
} (object)
MaxResults (integer)
NextToken (string)
migrationhub_config/get_home_regionReturns 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.No parameters
migrationhuborchestrator/list_tags_for_resourceList the tags added to a resource.resourceArn (string) required
migrationhuborchestrator/tag_resourceTag a resource by specifying its Amazon Resource Name ARN.resourceArn (string) required
tags (object) required
migrationhuborchestrator/untag_resourceDeletes the tags for a resource.resourceArn (string) required
tagKeys (array) required
migrationhuborchestrator/start_workflowStart a migration workflow.id (string) required
migrationhuborchestrator/stop_workflowStop an ongoing migration workflow.id (string) required
migrationhuborchestrator/create_workflowCreate a workflow to orchestrate your migrations.name (string) required
description (string)
templateId (string) required
applicationConfigurationId (string)
inputParameters (object) required
stepTargets (array)
tags (object)
migrationhuborchestrator/get_workflowGet migration workflow.id (string) required
migrationhuborchestrator/update_workflowUpdate a migration workflow.id (string) required
name (string)
description (string)
inputParameters (object)
stepTargets (array)
migrationhuborchestrator/delete_workflowDelete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.id (string) required
migrationhuborchestrator/list_workflowsList the migration workflows.maxResults (integer)
nextToken (string)
templateId (string)
adsApplicationConfigurationName (string)
status (string)
name (string)
migrationhuborchestrator/create_templateCreates a migration workflow template.templateName (string) required
templateDescription (string)
templateSource (undefined) required
clientToken (string)
tags (object)
migrationhuborchestrator/get_templateGet the template you want to use for creating a migration workflow.id (string) required
migrationhuborchestrator/update_templateUpdates a migration workflow template.id (string) required
templateName (string)
templateDescription (string)
clientToken (string)
migrationhuborchestrator/delete_templateDeletes a migration workflow template.id (string) required
migrationhuborchestrator/list_templatesList the templates available in Migration Hub Orchestrator to create a migration workflow.maxResults (integer)
nextToken (string)
name (string)
migrationhuborchestrator/list_pluginsList AWS Migration Hub Orchestrator plugins.maxResults (integer)
nextToken (string)
migrationhuborchestrator/get_template_stepGet a specific step in a template.id (string) required
templateId (string) required
stepGroupId (string) required
migrationhuborchestrator/list_template_stepsList the steps in a template.maxResults (integer)
nextToken (string)
templateId (string) required
stepGroupId (string) required
migrationhuborchestrator/get_template_step_groupGet a step group in a template.templateId (string) required
id (string) required
migrationhuborchestrator/list_template_step_groupsList the step groups in a template.maxResults (integer)
nextToken (string)
templateId (string) required
migrationhuborchestrator/retry_workflow_stepRetry a failed step in a migration workflow.workflowId (string) required
stepGroupId (string) required
id (string) required
migrationhuborchestrator/create_workflow_stepCreate a step in the migration workflow.name (string) required
stepGroupId (string) required
workflowId (string) required
stepActionType (string) required
description (string)
workflowStepAutomationConfiguration: {
. scriptLocationS3Bucket (string)
. scriptLocationS3Key (object)
. command (object)
. runEnvironment (string)
. targetType (string)
} (object)
stepTarget (array)
outputs (array)
previous (array)
next (array)
migrationhuborchestrator/get_workflow_stepGet a step in the migration workflow.workflowId (string) required
stepGroupId (string) required
id (string) required
migrationhuborchestrator/update_workflow_stepUpdate a step in a migration workflow.id (string) required
stepGroupId (string) required
workflowId (string) required
name (string)
description (string)
stepActionType (string)
workflowStepAutomationConfiguration: {
. scriptLocationS3Bucket (string)
. scriptLocationS3Key (object)
. command (object)
. runEnvironment (string)
. targetType (string)
} (object)
stepTarget (array)
outputs (array)
previous (array)
next (array)
status (string)
migrationhuborchestrator/delete_workflow_stepDelete a step in a migration workflow. Pause the workflow to delete a running step.id (string) required
stepGroupId (string) required
workflowId (string) required
migrationhuborchestrator/list_workflow_stepsList the steps in a workflow.nextToken (string)
maxResults (integer)
workflowId (string) required
stepGroupId (string) required
migrationhuborchestrator/create_workflow_step_groupCreate a step group in a migration workflow.workflowId (string) required
name (string) required
description (string)
next (array)
previous (array)
migrationhuborchestrator/get_workflow_step_groupGet the step group of a migration workflow.id (string) required
workflowId (string) required
migrationhuborchestrator/update_workflow_step_groupUpdate the step group in a migration workflow.workflowId (string) required
id (string) required
name (string)
description (string)
next (array)
previous (array)
migrationhuborchestrator/delete_workflow_step_groupDelete a step group in a migration workflow.workflowId (string) required
id (string) required
migrationhuborchestrator/list_workflow_step_groupsList the step groups in a migration workflow.nextToken (string)
maxResults (integer)
workflowId (string) required
migrationhubstrategy/get_application_component_detailsRetrieves details about an application component.applicationComponentId (string) required
migrationhubstrategy/get_application_component_strategiesRetrieves a list of all the recommended strategies and tools for an application component running on a server.applicationComponentId (string) required
migrationhubstrategy/get_assessmentRetrieves the status of an on-going assessment.id (string) required
migrationhubstrategy/get_import_file_taskRetrieves the details about a specific import task.id (string) required
migrationhubstrategy/get_latest_assessment_idRetrieve the latest ID of a specific assessment task.No parameters
migrationhubstrategy/get_portfolio_preferencesRetrieves your migration and modernization preferences.No parameters
migrationhubstrategy/get_portfolio_summaryRetrieves overall summary including the number of servers to rehost and the overall number of anti-patterns.No parameters
migrationhubstrategy/get_recommendation_report_detailsRetrieves detailed information about the specified recommendation report.id (string) required
migrationhubstrategy/get_server_detailsRetrieves detailed information about a specified server.serverId (string) required
nextToken (string)
maxResults (integer)
migrationhubstrategy/get_server_strategiesRetrieves recommended strategies and tools for the specified server.serverId (string) required
migrationhubstrategy/list_analyzable_serversRetrieves a list of all the servers fetched from customer vCenter using Strategy Recommendation Collector.sort (string)
nextToken (string)
maxResults (integer)
migrationhubstrategy/list_application_componentsRetrieves a list of all the application components processes.applicationComponentCriteria (string)
filterValue (string)
sort (string)
groupIdFilter (array)
nextToken (string)
maxResults (integer)
migrationhubstrategy/list_collectorsRetrieves a list of all the installed collectors.nextToken (string)
maxResults (integer)
migrationhubstrategy/list_import_file_taskRetrieves a list of all the imports performed.nextToken (string)
maxResults (integer)
migrationhubstrategy/list_serversReturns a list of all the servers.serverCriteria (string)
filterValue (string)
sort (string)
groupIdFilter (array)
nextToken (string)
maxResults (integer)
migrationhubstrategy/put_portfolio_preferencesSaves the specified migration and modernization preferences.prioritizeBusinessGoals: {
. businessGoals (object)
} (object)
applicationPreferences: {
. managementPreference
} (object)
databasePreferences: {
. databaseManagementPreference (string)
. databaseMigrationPreference
} (object)
applicationMode (string)
migrationhubstrategy/start_assessmentStarts the assessment of an on-premises environment.s3bucketForAnalysisData (string)
s3bucketForReportData (string)
assessmentTargets (array)
assessmentDataSourceType (string)
migrationhubstrategy/start_import_file_taskStarts a file import.name (string) required
S3Bucket (string) required
s3key (string) required
dataSourceType (string)
groupId (array)
s3bucketForReportData (string)
migrationhubstrategy/start_recommendation_report_generationStarts generating a recommendation report.outputFormat (string)
groupIdFilter (array)
migrationhubstrategy/stop_assessmentStops the assessment of an on-premises environment.assessmentId (string) required
migrationhubstrategy/update_application_component_configUpdates the configuration of an application component.applicationComponentId (string) required
inclusionStatus (string)
strategyOption: {
. strategy (string)
. toolName (string)
. targetDestination (string)
. isPreferred (boolean)
} (object)
sourceCodeList (array)
secretsManagerKey (string)
configureOnly (boolean)
appType (string)
migrationhubstrategy/update_server_configUpdates the configuration of the specified server.serverId (string) required
strategyOption: {
. strategy (string)
. toolName (string)
. targetDestination (string)
. isPreferred (boolean)
} (object)
mpa/get_policy_versionReturns details for the version of a policy. Policies define the permissions for team resources.PolicyVersionArn (string) required
mpa/get_resource_policyReturns details about a policy for a resource.ResourceArn (string) required
PolicyName (string) required
PolicyType (string) required
mpa/list_policiesReturns a list of policies. Policies define the permissions for team resources.MaxResults (integer)
NextToken (string)
mpa/list_policy_versionsReturns a list of the versions for policies. Policies define the permissions for team resources.MaxResults (integer)
NextToken (string)
PolicyArn (string) required
mpa/list_resource_policiesReturns a list of policies for a resource.ResourceArn (string) required
MaxResults (integer)
NextToken (string)
mpa/list_tags_for_resourceReturns a list of the tags for a resource.ResourceArn (string) required
mpa/tag_resourceCreates or updates a resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.ResourceArn (string) required
Tags (object) required
mpa/untag_resourceRemoves a resource tag. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.ResourceArn (string) required
TagKeys (array) required
mpa/start_active_approval_team_deletionStarts the deletion process for an active approval team. Deletions require team approval Requests to delete an active team must be approved by the team.PendingWindowDays (integer)
Arn (string) required
mpa/create_approval_teamCreates a new approval team. For more information, see Approval team in the Multi-party approval User Guide.ClientToken (string)
ApprovalStrategy (undefined) required
Approvers (array) required
Description (string) required
Policies (array) required
Name (string) required
Tags (object)
mpa/get_approval_teamReturns details for an approval team.Arn (string) required
mpa/update_approval_teamUpdates an approval team. You can request to update the team description, approval threshold, and approvers in the team. Updates require team approval Updates to an active team must be approved by the team.ApprovalStrategy (undefined)
Approvers (array)
Description (string)
Arn (string) required
UpdateActions (array)
mpa/delete_inactive_approval_team_versionDeletes an inactive approval team. For more information, see Team health in the Multi-party approval User Guide. You can also use this operation to delete a team draft. For more information, see Interacting with drafts in the Multi-party approval User Guide.Arn (string) required
VersionId (string) required
mpa/list_approval_teamsReturns a list of approval teams.MaxResults (integer)
NextToken (string)
mpa/create_identity_sourceCreates a new identity source. For more information, see Identity Source in the Multi-party approval User Guide.IdentitySourceParameters: {
. IamIdentityCenter (object)
} (object) required
ClientToken (string)
Tags (object)
mpa/get_identity_sourceReturns details for an identity source. For more information, see Identity Source in the Multi-party approval User Guide.IdentitySourceArn (string) required
mpa/delete_identity_sourceDeletes an identity source. For more information, see Identity Source in the Multi-party approval User Guide.IdentitySourceArn (string) required
mpa/list_identity_sourcesReturns a list of identity sources. For more information, see Identity Source in the Multi-party approval User Guide.MaxResults (integer)
NextToken (string)
mpa/get_sessionReturns details for an approval session. For more information, see Session in the Multi-party approval User Guide.SessionArn (string) required
mpa/cancel_sessionCancels an approval session. For more information, see Session in the Multi-party approval User Guide.SessionArn (string) required
mpa/list_sessionsReturns a list of approval sessions. For more information, see Session in the Multi-party approval User Guide.ApprovalTeamArn (string) required
MaxResults (integer)
NextToken (string)
Filters (array)
mq/create_brokerCreates 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:DeleteNetworkInterfacePermissionAuthenticationStrategy (string)
AutoMinorVersionUpgrade (boolean)
BrokerName (string) required
Configuration: {
. Id (string)
. Revision (integer)
} (object)
CreatorRequestId (string)
DeploymentMode (string) required
EncryptionOptions: {
. KmsKeyId (string)
. UseAwsOwnedKey (boolean)
} (object)
EngineType (string) required
EngineVersion (string)
HostInstanceType (string) required
LdapServerMetadata: {
. Hosts (array)
. RoleBase (string)
. RoleName (string)
. RoleSearchMatching (string)
. RoleSearchSubtree (boolean)
. ServiceAccountPassword (string)
. ServiceAccountUsername (string)
. UserBase (string)
. UserRoleName (string)
. UserSearchMatching (string)
. UserSearchSubtree (boolean)
} (object)
Logs: {
. Audit (boolean)
. General (boolean)
} (object)
MaintenanceWindowStartTime: {
. DayOfWeek (string)
. TimeOfDay (string)
. TimeZone (string)
} (object)
PubliclyAccessible (boolean) required
SecurityGroups (array)
StorageType (string)
SubnetIds (array)
Tags (object)
Users (array)
DataReplicationMode (string)
DataReplicationPrimaryBrokerArn (string)
mq/create_configurationCreates a new configuration for the specified configuration name. Amazon MQ uses the default configuration the engine type and version.AuthenticationStrategy (string)
EngineType (string) required
EngineVersion (string)
Name (string) required
Tags (object)
mq/create_tagsAdd a tag to a resource.ResourceArn (string) required
Tags (object)
mq/create_userCreates an ActiveMQ user. Do not add personally identifiable information PII or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.BrokerId (string) required
ConsoleAccess (boolean)
Groups (array)
Password (string) required
Username (string) required
ReplicationUser (boolean)
mq/delete_brokerDeletes a broker. Note: This API is asynchronous.BrokerId (string) required
mq/delete_configurationDeletes the specified configuration.ConfigurationId (string) required
mq/delete_tagsRemoves a tag from a resource.ResourceArn (string) required
TagKeys (array) required
mq/delete_userDeletes an ActiveMQ user.BrokerId (string) required
Username (string) required
mq/describe_brokerReturns information about the specified broker.BrokerId (string) required
mq/describe_broker_engine_typesDescribe available engine types and versions.EngineType (string)
MaxResults (integer)
NextToken (string)
mq/describe_broker_instance_optionsDescribe available broker instance options.EngineType (string)
HostInstanceType (string)
MaxResults (integer)
NextToken (string)
StorageType (string)
mq/describe_configurationReturns information about the specified configuration.ConfigurationId (string) required
mq/describe_configuration_revisionReturns the specified configuration revision for the specified configuration.ConfigurationId (string) required
ConfigurationRevision (string) required
mq/describe_userReturns information about an ActiveMQ user.BrokerId (string) required
Username (string) required
mq/list_brokersReturns a list of all brokers.MaxResults (integer)
NextToken (string)
mq/list_configuration_revisionsReturns a list of all revisions for the specified configuration.ConfigurationId (string) required
MaxResults (integer)
NextToken (string)
mq/list_configurationsReturns a list of all configurations.MaxResults (integer)
NextToken (string)
mq/list_tagsLists tags for a resource.ResourceArn (string) required
mq/list_usersReturns a list of all ActiveMQ users.BrokerId (string) required
MaxResults (integer)
NextToken (string)
mq/promotePromotes a data replication replica broker to the primary broker role.BrokerId (string) required
Mode (string) required
mq/reboot_brokerReboots a broker. Note: This API is asynchronous.BrokerId (string) required
mq/update_brokerAdds a pending configuration change to a broker.AuthenticationStrategy (string)
AutoMinorVersionUpgrade (boolean)
BrokerId (string) required
Configuration: {
. Id (string)
. Revision (integer)
} (object)
EngineVersion (string)
HostInstanceType (string)
LdapServerMetadata: {
. Hosts (array)
. RoleBase (string)
. RoleName (string)
. RoleSearchMatching (string)
. RoleSearchSubtree (boolean)
. ServiceAccountPassword (string)
. ServiceAccountUsername (string)
. UserBase (string)
. UserRoleName (string)
. UserSearchMatching (string)
. UserSearchSubtree (boolean)
} (object)
Logs: {
. Audit (boolean)
. General (boolean)
} (object)
MaintenanceWindowStartTime: {
. DayOfWeek (string)
. TimeOfDay (string)
. TimeZone (string)
} (object)
SecurityGroups (array)
DataReplicationMode (string)
mq/update_configurationUpdates the specified configuration.ConfigurationId (string) required
Data (string) required
Description (string)
mq/update_userUpdates the information for an ActiveMQ user.BrokerId (string) required
ConsoleAccess (boolean)
Groups (array)
Password (string)
Username (string) required
ReplicationUser (boolean)
mturk/accept_qualification_requestThe 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.QualificationRequestId (string) required
IntegerValue (integer)
mturk/approve_assignmentThe 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 tAssignmentId (string) required
RequesterFeedback (string)
OverrideRejection (boolean)
mturk/associate_qualification_with_workerThe 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 QualifiQualificationTypeId (string) required
WorkerId (string) required
IntegerValue (integer)
SendNotification (boolean)
mturk/create_additional_assignments_for_hitThe 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.InvalidMaximumAHITId (string) required
NumberOfAdditionalAssignments (integer) required
UniqueRequestToken (string)
mturk/create_hitThe 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 needingMaxAssignments (integer)
AutoApprovalDelayInSeconds (integer)
LifetimeInSeconds (integer) required
AssignmentDurationInSeconds (integer) required
Reward (string) required
Title (string) required
Keywords (string)
Description (string) required
Question (string)
RequesterAnnotation (string)
QualificationRequirements (array)
UniqueRequestToken (string)
AssignmentReviewPolicy: {
. PolicyName (string)
. Parameters (array)
} (object)
HITReviewPolicy: {
. PolicyName (string)
. Parameters (array)
} (object)
HITLayoutId (string)
HITLayoutParameters (array)
mturk/create_hittypeThe 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.AutoApprovalDelayInSeconds (integer)
AssignmentDurationInSeconds (integer) required
Reward (string) required
Title (string) required
Keywords (string)
Description (string) required
QualificationRequirements (array)
mturk/create_hitwith_hittypeThe 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 HiHITTypeId (string) required
MaxAssignments (integer)
LifetimeInSeconds (integer) required
Question (string)
RequesterAnnotation (string)
UniqueRequestToken (string)
AssignmentReviewPolicy: {
. PolicyName (string)
. Parameters (array)
} (object)
HITReviewPolicy: {
. PolicyName (string)
. Parameters (array)
} (object)
HITLayoutId (string)
HITLayoutParameters (array)
mturk/create_qualification_typeThe CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.Name (string) required
Keywords (string)
Description (string) required
QualificationTypeStatus (string) required
RetryDelayInSeconds (integer)
Test (string)
AnswerKey (string)
TestDurationInSeconds (integer)
AutoGranted (boolean)
AutoGrantedValue (integer)
mturk/create_worker_blockThe 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.WorkerId (string) required
Reason (string) required
mturk/delete_hitThe 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 aHITId (string) required
mturk/delete_qualification_typeThe 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 waiQualificationTypeId (string) required
mturk/delete_worker_blockThe 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.WorkerId (string) required
Reason (string)
mturk/disassociate_qualification_from_workerThe 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.WorkerId (string) required
QualificationTypeId (string) required
Reason (string)
mturk/get_account_balanceThe 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.No parameters
mturk/get_assignmentThe GetAssignment operation retrieves the details of the specified Assignment.AssignmentId (string) required
mturk/get_file_upload_urlThe 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,AssignmentId (string) required
QuestionIdentifier (string) required
mturk/get_hitThe GetHIT operation retrieves the details of the specified HIT.HITId (string) required
mturk/get_qualification_scoreThe 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.QualificationTypeId (string) required
WorkerId (string) required
mturk/get_qualification_typeThe GetQualificationTypeoperation retrieves information about a Qualification type using its ID.QualificationTypeId (string) required
mturk/list_assignments_for_hitThe 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 ListHITId (string) required
NextToken (string)
MaxResults (integer)
AssignmentStatuses (array)
mturk/list_bonus_paymentsThe ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.HITId (string)
AssignmentId (string)
NextToken (string)
MaxResults (integer)
mturk/list_hitsThe 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.NextToken (string)
MaxResults (integer)
mturk/list_hits_for_qualification_typeThe 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.QualificationTypeId (string) required
NextToken (string)
MaxResults (integer)
mturk/list_qualification_requestsThe 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.QualificationTypeId (string)
NextToken (string)
MaxResults (integer)
mturk/list_qualification_typesThe ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term.Query (string)
MustBeRequestable (boolean) required
MustBeOwnedByCaller (boolean)
NextToken (string)
MaxResults (integer)
mturk/list_reviewable_hitsThe ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.HITTypeId (string)
Status (string)
NextToken (string)
MaxResults (integer)
mturk/list_review_policy_results_for_hitThe 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.HITId (string) required
PolicyLevels (array)
RetrieveActions (boolean)
RetrieveResults (boolean)
NextToken (string)
MaxResults (integer)
mturk/list_worker_blocksThe ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.NextToken (string)
MaxResults (integer)
mturk/list_workers_with_qualification_typeThe ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type.QualificationTypeId (string) required
Status (string)
NextToken (string)
MaxResults (integer)
mturk/notify_workersThe 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.Subject (string) required
MessageText (string) required
WorkerIds (array) required
mturk/reject_assignmentThe 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.AssignmentId (string) required
RequesterFeedback (string) required
mturk/reject_qualification_requestThe 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.QualificationRequestId (string) required
Reason (string)
mturk/send_bonusThe 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, similarWorkerId (string) required
BonusAmount (string) required
AssignmentId (string) required
Reason (string) required
UniqueRequestToken (string)
mturk/send_test_event_notificationThe 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.Notification: {
. Destination (string)
. Transport (string)
. Version (string)
. EventTypes (array)
} (object) required
TestEventType (string) required
mturk/update_expiration_for_hitThe 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.HITId (string) required
ExpireAt (string) required
mturk/update_hitreview_statusThe 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.HITId (string) required
Revert (boolean)
mturk/update_hittype_of_hitThe 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.HITId (string) required
HITTypeId (string) required
mturk/update_notification_settingsThe 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 statusHITTypeId (string) required
Notification: {
. Destination (string)
. Transport (string)
. Version (string)
. EventTypes (array)
} (object)
Active (boolean)
mturk/update_qualification_typeThe 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 cannotQualificationTypeId (string) required
Description (string)
QualificationTypeStatus (string)
Test (string)
AnswerKey (string)
TestDurationInSeconds (integer)
RetryDelayInSeconds (integer)
AutoGranted (boolean)
AutoGrantedValue (integer)
mwaa_serverless/list_tags_for_resourceLists all tags that are associated with a specified Amazon Managed Workflows for Apache Airflow Serverless resource.ResourceArn (string) required
mwaa_serverless/tag_resourceAdds tags to an Amazon Managed Workflows for Apache Airflow Serverless resource. Tags are key-value pairs that help you organize and categorize your resources.ResourceArn (string) required
Tags (object) required
mwaa_serverless/untag_resourceRemoves tags from an Amazon Managed Workflows for Apache Airflow Serverless resource. This operation removes the specified tags from the resource.ResourceArn (string) required
TagKeys (array) required
mwaa_serverless/get_task_instanceRetrieves detailed information about a specific task instance within a workflow run. Task instances represent individual tasks that are executed as part of a workflow in the Amazon Managed Workflows for Apache Airflow Serverless environment. Each task instance runs in an isolated ECS container with dedicated resources and security boundaries. The service tracks task execution state, retry attempts, and provides detailed timing and error information for troubleshooting and monitoring purposes.WorkflowArn (string) required
TaskInstanceId (string) required
RunId (string) required
mwaa_serverless/list_task_instancesLists all task instances for a specific workflow run, with optional pagination support.WorkflowArn (string) required
RunId (string) required
MaxResults (integer)
NextToken (string)
mwaa_serverless/create_workflowCreates a new workflow in Amazon Managed Workflows for Apache Airflow Serverless. This operation initializes a workflow with the specified configuration including the workflow definition, execution role, and optional settings for encryption, logging, and networking. You must provide the workflow definition as a YAML file stored in Amazon S3 that defines the DAG structure using supported Amazon Web Services operators. Amazon Managed Workflows for Apache Airflow Serverless automatically creates thName (string) required
ClientToken (string)
DefinitionS3Location: {
. Bucket (string)
. ObjectKey (string)
. VersionId (string)
} (object) required
RoleArn (string) required
Description (string)
EncryptionConfiguration: {
. Type (string)
. KmsKeyId (string)
} (object)
LoggingConfiguration: {
. LogGroupName (string)
} (object)
EngineVersion (integer)
NetworkConfiguration: {
. SecurityGroupIds (array)
. SubnetIds (array)
} (object)
Tags (object)
TriggerMode (string)
mwaa_serverless/get_workflowRetrieves detailed information about a workflow, including its configuration, status, and metadata.WorkflowArn (string) required
WorkflowVersion (string)
mwaa_serverless/update_workflowUpdates an existing workflow with new configuration settings. This operation allows you to modify the workflow definition, role, and other settings. When you update a workflow, Amazon Managed Workflows for Apache Airflow Serverless automatically creates a new version with the updated configuration and disables scheduling on all previous versions to ensure only one version is actively scheduled at a time. The update operation maintains workflow history while providing a clean transition to the neWorkflowArn (string) required
DefinitionS3Location: {
. Bucket (string)
. ObjectKey (string)
. VersionId (string)
} (object) required
RoleArn (string) required
Description (string)
LoggingConfiguration: {
. LogGroupName (string)
} (object)
EngineVersion (integer)
NetworkConfiguration: {
. SecurityGroupIds (array)
. SubnetIds (array)
} (object)
TriggerMode (string)
mwaa_serverless/delete_workflowDeletes a workflow and all its versions. This operation permanently removes the workflow and cannot be undone. Amazon Managed Workflows for Apache Airflow Serverless ensures that all associated resources are properly cleaned up, including stopping any running executions, removing scheduled triggers, and cleaning up execution history. The deletion process respects the multi-tenant isolation boundaries and ensures that no residual data or configurations remain that could affect other customers orWorkflowArn (string) required
WorkflowVersion (string)
mwaa_serverless/list_workflowsLists all workflows in your account, with optional pagination support. This operation returns summary information for workflows, showing only the most recently created version of each workflow. Amazon Managed Workflows for Apache Airflow Serverless maintains workflow metadata in a highly available, distributed storage system that enables efficient querying and filtering. The service implements proper access controls to ensure you can only view workflows that you have permissions to access, suppoMaxResults (integer)
NextToken (string)
mwaa_serverless/start_workflow_runStarts a new execution of a workflow. This operation creates a workflow run that executes the tasks that are defined in the workflow. Amazon Managed Workflows for Apache Airflow Serverless schedules the workflow execution across its managed Airflow environment, automatically scaling ECS worker tasks based on the workload. The service handles task isolation, dependency resolution, and provides comprehensive monitoring and logging throughout the execution lifecycle.WorkflowArn (string) required
ClientToken (string)
OverrideParameters (object)
WorkflowVersion (string)
mwaa_serverless/get_workflow_runRetrieves detailed information about a specific workflow run, including its status, execution details, and task instances.WorkflowArn (string) required
RunId (string) required
mwaa_serverless/stop_workflow_runStops a running workflow execution. This operation terminates all running tasks and prevents new tasks from starting. Amazon Managed Workflows for Apache Airflow Serverless gracefully shuts down the workflow execution by stopping task scheduling and terminating active ECS worker containers. The operation transitions the workflow run to a STOPPING state and then to STOPPED once all cleanup is complete. In-flight tasks may complete or be terminated depending on their current execution state.WorkflowArn (string) required
RunId (string) required
mwaa_serverless/list_workflow_runsLists all runs for a specified workflow, with optional pagination and filtering support.MaxResults (integer)
NextToken (string)
WorkflowArn (string) required
WorkflowVersion (string)
mwaa_serverless/list_workflow_versionsLists all versions of a specified workflow, with optional pagination support.MaxResults (integer)
NextToken (string)
WorkflowArn (string) required
mwaa/create_cli_tokenCreates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.Name (string) required
mwaa/create_environmentCreates an Amazon Managed Workflows for Apache Airflow Amazon MWAA environment.Name (string) required
ExecutionRoleArn (string) required
SourceBucketArn (string) required
DagS3Path (string) required
NetworkConfiguration: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object) required
PluginsS3Path (string)
PluginsS3ObjectVersion (string)
RequirementsS3Path (string)
RequirementsS3ObjectVersion (string)
StartupScriptS3Path (string)
StartupScriptS3ObjectVersion (string)
AirflowConfigurationOptions (object)
EnvironmentClass (string)
MaxWorkers (integer)
KmsKey (string)
AirflowVersion (string)
LoggingConfiguration: {
. DagProcessingLogs (object)
. SchedulerLogs (object)
. WebserverLogs (object)
. WorkerLogs (object)
. TaskLogs (object)
} (object)
WeeklyMaintenanceWindowStart (string)
Tags (object)
WebserverAccessMode (string)
MinWorkers (integer)
Schedulers (integer)
EndpointManagement (string)
MinWebservers (integer)
MaxWebservers (integer)
mwaa/create_web_login_tokenCreates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.Name (string) required
mwaa/delete_environmentDeletes an Amazon Managed Workflows for Apache Airflow Amazon MWAA environment.Name (string) required
mwaa/get_environmentDescribes an Amazon Managed Workflows for Apache Airflow MWAA environment.Name (string) required
mwaa/invoke_rest_apiInvokes the Apache Airflow REST API on the webserver with the specified inputs. To learn more, see Using the Apache Airflow REST APIName (string) required
Path (string) required
Method (string) required
QueryParameters (undefined)
Body (undefined)
mwaa/list_environmentsLists the Amazon Managed Workflows for Apache Airflow MWAA environments.NextToken (string)
MaxResults (integer)
mwaa/list_tags_for_resourceLists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow MWAA environment. For example, 'Environment': 'Staging'.ResourceArn (string) required
mwaa/publish_metricsInternal only. Publishes environment health metrics to Amazon CloudWatch.EnvironmentName (string) required
MetricData (array) required
mwaa/tag_resourceAssociates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow MWAA environment.ResourceArn (string) required
Tags (object) required
mwaa/untag_resourceRemoves key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow MWAA environment. For example, 'Environment': 'Staging'.ResourceArn (string) required
tagKeys (array) required
mwaa/update_environmentUpdates an Amazon Managed Workflows for Apache Airflow MWAA environment.Name (string) required
ExecutionRoleArn (string)
AirflowConfigurationOptions (object)
AirflowVersion (string)
DagS3Path (string)
EnvironmentClass (string)
LoggingConfiguration: {
. DagProcessingLogs (object)
. SchedulerLogs (object)
. WebserverLogs (object)
. WorkerLogs (object)
. TaskLogs (object)
} (object)
MaxWorkers (integer)
MinWorkers (integer)
MaxWebservers (integer)
MinWebservers (integer)
WorkerReplacementStrategy (string)
NetworkConfiguration: {
. SecurityGroupIds (array)
} (object)
PluginsS3Path (string)
PluginsS3ObjectVersion (string)
RequirementsS3Path (string)
RequirementsS3ObjectVersion (string)
Schedulers (integer)
SourceBucketArn (string)
StartupScriptS3Path (string)
StartupScriptS3ObjectVersion (string)
WebserverAccessMode (string)
WeeklyMaintenanceWindowStart (string)
neptune_graph/cancel_queryCancels a specified query.graphIdentifier (string) required
queryId (string) required
neptune_graph/execute_queryExecute an openCypher query. When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query: neptune-graph:ReadDataViaQuery neptune-graph:WriteDataViaQuery neptune-graph:DeleteDataViaQuerygraphIdentifier (string) required
queryString (string) required
language (string) required
parameters (object)
planCache (string)
explainMode (string)
queryTimeoutMilliseconds (integer)
neptune_graph/get_graph_summaryGets a graph summary for a property graph.graphIdentifier (string) required
mode (string)
neptune_graph/get_queryRetrieves the status of a specified query. When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the neptune-graph:GetQueryStatus IAM action attached.graphIdentifier (string) required
queryId (string) required
neptune_graph/list_queriesLists active openCypher queries.graphIdentifier (string) required
maxResults (integer) required
state (string)
neptune_graph/list_tags_for_resourceLists tags associated with a specified resource.resourceArn (string) required
neptune_graph/tag_resourceAdds tags to the specified resource.resourceArn (string) required
tags (object) required
neptune_graph/untag_resourceRemoves the specified tags from the specified resource.resourceArn (string) required
tagKeys (array) required
neptune_graph/create_graphCreates a new Neptune Analytics graph.graphName (string) required
tags (object)
publicConnectivity (boolean)
kmsKeyIdentifier (string)
vectorSearchConfiguration: {
. dimension (integer)
} (object)
replicaCount (integer)
deletionProtection (boolean)
provisionedMemory (integer) required
neptune_graph/delete_graphDeletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.graphIdentifier (string) required
skipSnapshot (boolean) required
neptune_graph/get_graphGets information about a specified graph.graphIdentifier (string) required
neptune_graph/list_graphsLists available Neptune Analytics graphs.nextToken (string)
maxResults (integer)
neptune_graph/reset_graphEmpties the data from a specified Neptune Analytics graph.graphIdentifier (string) required
skipSnapshot (boolean) required
neptune_graph/restore_graph_from_snapshotRestores a graph from a snapshot.snapshotIdentifier (string) required
graphName (string) required
provisionedMemory (integer)
deletionProtection (boolean)
tags (object)
replicaCount (integer)
publicConnectivity (boolean)
neptune_graph/start_graphStarts the specific graph.graphIdentifier (string) required
neptune_graph/stop_graphStops the specific graph.graphIdentifier (string) required
neptune_graph/update_graphUpdates the configuration of a specified Neptune Analytics graphgraphIdentifier (string) required
publicConnectivity (boolean)
provisionedMemory (integer)
deletionProtection (boolean)
neptune_graph/create_private_graph_endpointCreate a private graph endpoint to allow private access to the graph from within a VPC. You can attach security groups to the private graph endpoint. VPC endpoint charges apply.graphIdentifier (string) required
vpcId (string)
subnetIds (array)
vpcSecurityGroupIds (array)
neptune_graph/delete_private_graph_endpointDeletes a private graph endpoint.graphIdentifier (string) required
vpcId (string) required
neptune_graph/get_private_graph_endpointRetrieves information about a specified private endpoint.graphIdentifier (string) required
vpcId (string) required
neptune_graph/list_private_graph_endpointsLists private endpoints for a specified Neptune Analytics graph.graphIdentifier (string) required
nextToken (string)
maxResults (integer)
neptune_graph/create_graph_snapshotCreates a snapshot of the specific graph.graphIdentifier (string) required
snapshotName (string) required
tags (object)
neptune_graph/delete_graph_snapshotDeletes the specified graph snapshot.snapshotIdentifier (string) required
neptune_graph/get_graph_snapshotRetrieves a specified graph snapshot.snapshotIdentifier (string) required
neptune_graph/list_graph_snapshotsLists available snapshots of a specified Neptune Analytics graph.graphIdentifier (string)
nextToken (string)
maxResults (integer)
neptune_graph/cancel_export_taskCancel the specified export task.taskIdentifier (string) required
neptune_graph/cancel_import_taskDeletes the specified import task.taskIdentifier (string) required
neptune_graph/create_graph_using_import_taskCreates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service S3 or from a Neptune database or a Neptune database snapshot. The data can be loaded from files in S3 that in either the Gremlin CSV format or the openCypher load format.graphName (string) required
tags (object)
publicConnectivity (boolean)
kmsKeyIdentifier (string)
vectorSearchConfiguration: {
. dimension (integer)
} (object)
replicaCount (integer)
deletionProtection (boolean)
importOptions (undefined)
maxProvisionedMemory (integer)
minProvisionedMemory (integer)
failOnError (boolean)
source (string) required
format (string)
parquetType (string)
blankNodeHandling (string)
roleArn (string) required
neptune_graph/get_export_taskRetrieves a specified export task.taskIdentifier (string) required
neptune_graph/get_import_taskRetrieves a specified import task.taskIdentifier (string) required
neptune_graph/list_export_tasksRetrieves a list of export tasks.graphIdentifier (string)
nextToken (string)
maxResults (integer)
neptune_graph/list_import_tasksLists import tasks.nextToken (string)
maxResults (integer)
neptune_graph/start_export_taskExport data from an existing Neptune Analytics graph to Amazon S3. The graph state should be AVAILABLE.graphIdentifier (string) required
roleArn (string) required
format (string) required
destination (string) required
kmsKeyIdentifier (string) required
parquetType (string)
exportFilter: {
. vertexFilter (object)
. edgeFilter (object)
} (object)
tags (object)
neptune_graph/start_import_taskImport data into existing Neptune Analytics graph from Amazon Simple Storage Service S3. The graph needs to be empty and in the AVAILABLE state.importOptions (undefined)
failOnError (boolean)
source (string) required
format (string)
parquetType (string)
blankNodeHandling (string)
graphIdentifier (string) required
roleArn (string) required
neptune/add_role_to_dbclusterAssociates an Identity and Access Management IAM role with an Neptune DB cluster.DBClusterIdentifier (string) required
RoleArn (string) required
FeatureName (string)
neptune/add_source_identifier_to_subscriptionAdds a source identifier to an existing event notification subscription.SubscriptionName (string) required
SourceIdentifier (string) required
neptune/add_tags_to_resourceAdds 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.ResourceName (string) required
Tags (array) required
neptune/apply_pending_maintenance_actionApplies a pending maintenance action to a resource for example, to a DB instance.ResourceIdentifier (string) required
ApplyAction (string) required
OptInType (string) required
neptune/copy_dbcluster_parameter_groupCopies the specified DB cluster parameter group.SourceDBClusterParameterGroupIdentifier (string) required
TargetDBClusterParameterGroupIdentifier (string) required
TargetDBClusterParameterGroupDescription (string) required
Tags (array)
neptune/copy_dbcluster_snapshotCopies 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.SourceDBClusterSnapshotIdentifier (string) required
TargetDBClusterSnapshotIdentifier (string) required
KmsKeyId (string)
PreSignedUrl (string)
CopyTags (boolean)
Tags (array)
neptune/copy_dbparameter_groupCopies the specified DB parameter group.SourceDBParameterGroupIdentifier (string) required
TargetDBParameterGroupIdentifier (string) required
TargetDBParameterGroupDescription (string) required
Tags (array)
neptune/create_dbclusterCreates 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.AvailabilityZones (array)
BackupRetentionPeriod (integer)
CharacterSetName (string)
CopyTagsToSnapshot (boolean)
DatabaseName (string)
DBClusterIdentifier (string) required
DBClusterParameterGroupName (string)
VpcSecurityGroupIds (array)
DBSubnetGroupName (string)
Engine (string) required
EngineVersion (string)
Port (integer)
MasterUsername (string)
MasterUserPassword (string)
OptionGroupName (string)
PreferredBackupWindow (string)
PreferredMaintenanceWindow (string)
ReplicationSourceIdentifier (string)
Tags (array)
StorageEncrypted (boolean)
KmsKeyId (string)
PreSignedUrl (string)
EnableIAMDatabaseAuthentication (boolean)
EnableCloudwatchLogsExports (array)
DeletionProtection (boolean)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
} (object)
GlobalClusterIdentifier (string)
StorageType (string)
neptune/create_dbcluster_endpointCreates a new custom endpoint and associates it with an Amazon Neptune DB cluster.DBClusterIdentifier (string) required
DBClusterEndpointIdentifier (string) required
EndpointType (string) required
StaticMembers (array)
ExcludedMembers (array)
Tags (array)
neptune/create_dbcluster_parameter_groupCreates 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 clusterDBClusterParameterGroupName (string) required
DBParameterGroupFamily (string) required
Description (string) required
Tags (array)
neptune/create_dbcluster_snapshotCreates a snapshot of a DB cluster.DBClusterSnapshotIdentifier (string) required
DBClusterIdentifier (string) required
Tags (array)
neptune/create_dbinstanceCreates a new DB instance.DBName (string)
DBInstanceIdentifier (string) required
AllocatedStorage (integer)
DBInstanceClass (string) required
Engine (string) required
MasterUsername (string)
MasterUserPassword (string)
DBSecurityGroups (array)
VpcSecurityGroupIds (array)
AvailabilityZone (string)
DBSubnetGroupName (string)
PreferredMaintenanceWindow (string)
DBParameterGroupName (string)
BackupRetentionPeriod (integer)
PreferredBackupWindow (string)
Port (integer)
MultiAZ (boolean)
EngineVersion (string)
AutoMinorVersionUpgrade (boolean)
LicenseModel (string)
Iops (integer)
OptionGroupName (string)
CharacterSetName (string)
PubliclyAccessible (boolean)
Tags (array)
DBClusterIdentifier (string) required
StorageType (string)
TdeCredentialArn (string)
TdeCredentialPassword (string)
StorageEncrypted (boolean)
KmsKeyId (string)
Domain (string)
CopyTagsToSnapshot (boolean)
MonitoringInterval (integer)
MonitoringRoleArn (string)
DomainIAMRoleName (string)
PromotionTier (integer)
Timezone (string)
EnableIAMDatabaseAuthentication (boolean)
EnablePerformanceInsights (boolean)
PerformanceInsightsKMSKeyId (string)
EnableCloudwatchLogsExports (array)
DeletionProtection (boolean)
neptune/create_dbparameter_groupCreates 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 wDBParameterGroupName (string) required
DBParameterGroupFamily (string) required
Description (string) required
Tags (array)
neptune/create_dbsubnet_groupCreates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.DBSubnetGroupName (string) required
DBSubnetGroupDescription (string) required
SubnetIds (array) required
Tags (array)
neptune/create_event_subscriptionCreates 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 EventCategoriSubscriptionName (string) required
SnsTopicArn (string) required
SourceType (string)
EventCategories (array)
SourceIds (array)
Enabled (boolean)
Tags (array)
neptune/create_global_clusterCreates 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 operationGlobalClusterIdentifier (string) required
SourceDBClusterIdentifier (string)
Engine (string)
EngineVersion (string)
DeletionProtection (boolean)
StorageEncrypted (boolean)
neptune/delete_dbclusterThe 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.DBClusterIdentifier (string) required
SkipFinalSnapshot (boolean)
FinalDBSnapshotIdentifier (string)
neptune/delete_dbcluster_endpointDeletes a custom endpoint and removes it from an Amazon Neptune DB cluster.DBClusterEndpointIdentifier (string) required
neptune/delete_dbcluster_parameter_groupDeletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.DBClusterParameterGroupName (string) required
neptune/delete_dbcluster_snapshotDeletes 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.DBClusterSnapshotIdentifier (string) required
neptune/delete_dbinstanceThe 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 beDBInstanceIdentifier (string) required
SkipFinalSnapshot (boolean)
FinalDBSnapshotIdentifier (string)
neptune/delete_dbparameter_groupDeletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.DBParameterGroupName (string) required
neptune/delete_dbsubnet_groupDeletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.DBSubnetGroupName (string) required
neptune/delete_event_subscriptionDeletes an event notification subscription.SubscriptionName (string) required
neptune/delete_global_clusterDeletes a global database. The primary and all secondary clusters must already be detached or deleted first.GlobalClusterIdentifier (string) required
neptune/describe_dbcluster_endpointsReturns information about endpoints for an Amazon Neptune DB cluster. This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.DBClusterIdentifier (string)
DBClusterEndpointIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_dbcluster_parameter_groupsReturns 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.DBClusterParameterGroupName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_dbcluster_parametersReturns the detailed parameter list for a particular DB cluster parameter group.DBClusterParameterGroupName (string) required
Source (string)
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_dbclustersReturns information about provisioned DB clusters, and supports pagination. This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.DBClusterIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_dbcluster_snapshot_attributesReturns 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. ToDBClusterSnapshotIdentifier (string) required
neptune/describe_dbcluster_snapshotsReturns information about DB cluster snapshots. This API action supports pagination.DBClusterIdentifier (string)
DBClusterSnapshotIdentifier (string)
SnapshotType (string)
Filters (array)
MaxRecords (integer)
Marker (string)
IncludeShared (boolean)
IncludePublic (boolean)
neptune/describe_dbengine_versionsReturns a list of the available DB engines.Engine (string)
EngineVersion (string)
DBParameterGroupFamily (string)
Filters (array)
MaxRecords (integer)
Marker (string)
DefaultOnly (boolean)
ListSupportedCharacterSets (boolean)
ListSupportedTimezones (boolean)
neptune/describe_dbinstancesReturns information about provisioned instances, and supports pagination. This operation can also return information for Amazon RDS instances and Amazon DocDB instances.DBInstanceIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_dbparameter_groupsReturns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.DBParameterGroupName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_dbparametersReturns the detailed parameter list for a particular DB parameter group.DBParameterGroupName (string) required
Source (string)
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_dbsubnet_groupsReturns 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.DBSubnetGroupName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_engine_default_cluster_parametersReturns the default engine and system parameter information for the cluster database engine.DBParameterGroupFamily (string) required
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_engine_default_parametersReturns the default engine and system parameter information for the specified database engine.DBParameterGroupFamily (string) required
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_event_categoriesDisplays a list of categories for all event source types, or, if specified, for a specified source type.SourceType (string)
Filters (array)
neptune/describe_eventsReturns 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.SourceIdentifier (string)
SourceType (string)
StartTime (string)
EndTime (string)
Duration (integer)
EventCategories (array)
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_event_subscriptionsLists 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.SubscriptionName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_global_clustersReturns information about Neptune global database clusters. This API supports pagination.GlobalClusterIdentifier (string)
MaxRecords (integer)
Marker (string)
neptune/describe_orderable_dbinstance_optionsReturns a list of orderable DB instance options for the specified engine.Engine (string) required
EngineVersion (string)
DBInstanceClass (string)
LicenseModel (string)
Vpc (boolean)
Filters (array)
MaxRecords (integer)
Marker (string)
neptune/describe_pending_maintenance_actionsReturns a list of resources for example, DB instances that have at least one pending maintenance action.ResourceIdentifier (string)
Filters (array)
Marker (string)
MaxRecords (integer)
neptune/describe_valid_dbinstance_modificationsYou can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.DBInstanceIdentifier (string) required
neptune/failover_dbclusterForces 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-establishDBClusterIdentifier (string)
TargetDBInstanceIdentifier (string)
neptune/failover_global_clusterInitiates 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 appliesGlobalClusterIdentifier (string) required
TargetDbClusterIdentifier (string) required
AllowDataLoss (boolean)
Switchover (boolean)
neptune/list_tags_for_resourceLists all tags on an Amazon Neptune resource.ResourceName (string) required
Filters (array)
neptune/modify_dbclusterModify 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.DBClusterIdentifier (string) required
NewDBClusterIdentifier (string)
ApplyImmediately (boolean)
BackupRetentionPeriod (integer)
DBClusterParameterGroupName (string)
VpcSecurityGroupIds (array)
Port (integer)
MasterUserPassword (string)
OptionGroupName (string)
PreferredBackupWindow (string)
PreferredMaintenanceWindow (string)
EnableIAMDatabaseAuthentication (boolean)
CloudwatchLogsExportConfiguration: {
. EnableLogTypes (array)
. DisableLogTypes (array)
} (object)
EngineVersion (string)
AllowMajorVersionUpgrade (boolean)
DBInstanceParameterGroupName (string)
DeletionProtection (boolean)
CopyTagsToSnapshot (boolean)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
} (object)
StorageType (string)
neptune/modify_dbcluster_endpointModifies the properties of an endpoint in an Amazon Neptune DB cluster.DBClusterEndpointIdentifier (string) required
EndpointType (string)
StaticMembers (array)
ExcludedMembers (array)
neptune/modify_dbcluster_parameter_groupModifies 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 shouldDBClusterParameterGroupName (string) required
Parameters (array) required
neptune/modify_dbcluster_snapshot_attributeAdds 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 alDBClusterSnapshotIdentifier (string) required
AttributeName (string) required
ValuesToAdd (array)
ValuesToRemove (array)
neptune/modify_dbinstanceModifies 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.DBInstanceIdentifier (string) required
AllocatedStorage (integer)
DBInstanceClass (string)
DBSubnetGroupName (string)
DBSecurityGroups (array)
VpcSecurityGroupIds (array)
ApplyImmediately (boolean)
MasterUserPassword (string)
DBParameterGroupName (string)
BackupRetentionPeriod (integer)
PreferredBackupWindow (string)
PreferredMaintenanceWindow (string)
MultiAZ (boolean)
EngineVersion (string)
AllowMajorVersionUpgrade (boolean)
AutoMinorVersionUpgrade (boolean)
LicenseModel (string)
Iops (integer)
OptionGroupName (string)
NewDBInstanceIdentifier (string)
StorageType (string)
TdeCredentialArn (string)
TdeCredentialPassword (string)
CACertificateIdentifier (string)
Domain (string)
CopyTagsToSnapshot (boolean)
MonitoringInterval (integer)
DBPortNumber (integer)
PubliclyAccessible (boolean)
MonitoringRoleArn (string)
DomainIAMRoleName (string)
PromotionTier (integer)
EnableIAMDatabaseAuthentication (boolean)
EnablePerformanceInsights (boolean)
PerformanceInsightsKMSKeyId (string)
CloudwatchLogsExportConfiguration: {
. EnableLogTypes (array)
. DisableLogTypes (array)
} (object)
DeletionProtection (boolean)
neptune/modify_dbparameter_groupModifies 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 leastDBParameterGroupName (string) required
Parameters (array) required
neptune/modify_dbsubnet_groupModifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.DBSubnetGroupName (string) required
DBSubnetGroupDescription (string)
SubnetIds (array) required
neptune/modify_event_subscriptionModifies 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.SubscriptionName (string) required
SnsTopicArn (string)
SourceType (string)
EventCategories (array)
Enabled (boolean)
neptune/modify_global_clusterModify 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.GlobalClusterIdentifier (string) required
NewGlobalClusterIdentifier (string)
DeletionProtection (boolean)
EngineVersion (string)
AllowMajorVersionUpgrade (boolean)
neptune/promote_read_replica_dbclusterNot supported.DBClusterIdentifier (string) required
neptune/reboot_dbinstanceYou 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.DBInstanceIdentifier (string) required
ForceFailover (boolean)
neptune/remove_from_global_clusterDetaches 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.GlobalClusterIdentifier (string) required
DbClusterIdentifier (string) required
neptune/remove_role_from_dbclusterDisassociates an Identity and Access Management IAM role from a DB cluster.DBClusterIdentifier (string) required
RoleArn (string) required
FeatureName (string)
neptune/remove_source_identifier_from_subscriptionRemoves a source identifier from an existing event notification subscription.SubscriptionName (string) required
SourceIdentifier (string) required
neptune/remove_tags_from_resourceRemoves metadata tags from an Amazon Neptune resource.ResourceName (string) required
TagKeys (array) required
neptune/reset_dbcluster_parameter_groupModifies 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 musDBClusterParameterGroupName (string) required
ResetAllParameters (boolean)
Parameters (array)
neptune/reset_dbparameter_groupModifies 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.DBParameterGroupName (string) required
ResetAllParameters (boolean)
Parameters (array)
neptune/restore_dbcluster_from_snapshotCreates 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.AvailabilityZones (array)
DBClusterIdentifier (string) required
SnapshotIdentifier (string) required
Engine (string) required
EngineVersion (string)
Port (integer)
DBSubnetGroupName (string)
DatabaseName (string)
OptionGroupName (string)
VpcSecurityGroupIds (array)
Tags (array)
KmsKeyId (string)
EnableIAMDatabaseAuthentication (boolean)
EnableCloudwatchLogsExports (array)
DBClusterParameterGroupName (string)
DeletionProtection (boolean)
CopyTagsToSnapshot (boolean)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
} (object)
StorageType (string)
neptune/restore_dbcluster_to_point_in_timeRestores 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 instancDBClusterIdentifier (string) required
RestoreType (string)
SourceDBClusterIdentifier (string) required
RestoreToTime (string)
UseLatestRestorableTime (boolean)
Port (integer)
DBSubnetGroupName (string)
OptionGroupName (string)
VpcSecurityGroupIds (array)
Tags (array)
KmsKeyId (string)
EnableIAMDatabaseAuthentication (boolean)
EnableCloudwatchLogsExports (array)
DBClusterParameterGroupName (string)
DeletionProtection (boolean)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
} (object)
StorageType (string)
neptune/start_dbclusterStarts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.DBClusterIdentifier (string) required
neptune/stop_dbclusterStops 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.DBClusterIdentifier (string) required
neptune/switchover_global_clusterSwitches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called 'managed planned failovers.' Promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary read-only cluster, maintaining the original replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary conGlobalClusterIdentifier (string) required
TargetDbClusterIdentifier (string) required
neptunedata/cancel_gremlin_queryCancels a Gremlin query. See Gremlin query cancellation for more information. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelQuery IAM action in that cluster.queryId (string) required
neptunedata/cancel_loader_jobCancels a specified load job. This is an HTTP DELETE request. See Neptune Loader Get-Status API for more information. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelLoaderJob IAM action in that cluster..loadId (string) required
neptunedata/cancel_mldata_processing_jobCancels a Neptune ML data processing job. See The dataprocessing command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelMLDataProcessingJob IAM action in that cluster.id (string) required
neptuneIamRoleArn (string)
clean (boolean)
neptunedata/cancel_mlmodel_training_jobCancels a Neptune ML model training job. See Model training using the modeltraining command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelMLModelTrainingJob IAM action in that cluster.id (string) required
neptuneIamRoleArn (string)
clean (boolean)
neptunedata/cancel_mlmodel_transform_jobCancels a specified model transform job. See Use a trained model to generate new model artifacts. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelMLModelTransformJob IAM action in that cluster.id (string) required
neptuneIamRoleArn (string)
clean (boolean)
neptunedata/cancel_open_cypher_queryCancels a specified openCypher query. See Neptune openCypher status endpoint for more information. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CancelQuery IAM action in that cluster.queryId (string) required
silent (boolean)
neptunedata/create_mlendpointCreates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed. See Managing inference endpoints using the endpoints command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:CreateMLEndpoint IAM action in that cluster.id (string)
mlModelTrainingJobId (string)
mlModelTransformJobId (string)
update (boolean)
neptuneIamRoleArn (string)
modelName (string)
instanceType (string)
instanceCount (integer)
volumeEncryptionKMSKey (string)
neptunedata/delete_mlendpointCancels the creation of a Neptune ML inference endpoint. See Managing inference endpoints using the endpoints command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteMLEndpoint IAM action in that cluster.id (string) required
neptuneIamRoleArn (string)
clean (boolean)
neptunedata/delete_propertygraph_statisticsDeletes statistics for Gremlin and openCypher property graph data. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteStatistics IAM action in that cluster.No parameters
neptunedata/delete_sparql_statisticsDeletes SPARQL statistics When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:DeleteStatistics IAM action in that cluster.No parameters
neptunedata/execute_fast_resetThe fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data. Neptune fast reset is a two-step process. First you call ExecuteFastReset with action set to initiateDatabaseReset. This returns a UUID token which you then include when calling ExecuteFastReset again with action set to performDatabaseReset. See Empty an Amazon Neptune DB cluster using the fast reset API. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAaction (string) required
token (string)
neptunedata/execute_gremlin_explain_queryExecutes a Gremlin Explain query. Amazon Neptune has added a Gremlin feature named explain that provides is a self-service tool for understanding the execution approach being taken by the Neptune engine for the query. You invoke it by adding an explain parameter to an HTTP call that submits a Gremlin query. The explain feature provides information about the logical structure of query execution plans. You can use this information to identify potential evaluation and execution bottlenecks and to tgremlinQuery (string) required
neptunedata/execute_gremlin_profile_queryExecutes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output. See Gremlin profile API in Neptune for details. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ReadDataViaQuery IAM action in that cluster. Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be usedgremlinQuery (string) required
results (boolean)
chop (integer)
serializer (string)
indexOps (boolean)
neptunedata/execute_gremlin_queryThis commands executes a Gremlin query. Amazon Neptune is compatible with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to query the graph, as described under The Graph in the Apache TinkerPop3 documentation. More details can also be found in Accessing a Neptune graph with Gremlin. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that enables one of the followigremlinQuery (string) required
serializer (string)
neptunedata/execute_open_cypher_explain_queryExecutes an openCypher explain request. See The openCypher explain feature for more information. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ReadDataViaQuery IAM action in that cluster. Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries see Condition keys available inopenCypherQuery (string) required
parameters (string)
explainMode (string) required
neptunedata/execute_open_cypher_queryExecutes an openCypher query. See Accessing the Neptune Graph with openCypher for more information. Neptune supports building graph applications using openCypher, which is currently one of the most popular query languages among developers working with graph databases. Developers, business analysts, and data scientists like openCypher's declarative, SQL-inspired syntax because it provides a familiar structure in which to querying property graphs. The openCypher language was originally developed bopenCypherQuery (string) required
parameters (string)
neptunedata/get_engine_statusRetrieves the status of the graph database on the host. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetEngineStatus IAM action in that cluster.No parameters
neptunedata/get_gremlin_query_statusGets the status of a specified Gremlin query. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster. Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries see Condition keys available in Neptune IAM data-access policy statements.queryId (string) required
neptunedata/get_loader_job_statusGets status information about a specified load job. Neptune keeps track of the most recent 1,024 bulk load jobs, and stores the last 10,000 error details per job. See Neptune Loader Get-Status API for more information. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetLoaderJobStatus IAM action in that cluster..loadId (string) required
details (boolean)
errors (boolean)
page (integer)
errorsPerPage (integer)
neptunedata/get_mldata_processing_jobRetrieves information about a specified data processing job. See The dataprocessing command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:neptune-db:GetMLDataProcessingJobStatus IAM action in that cluster.id (string) required
neptuneIamRoleArn (string)
neptunedata/get_mlendpointRetrieves details about an inference endpoint. See Managing inference endpoints using the endpoints command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetMLEndpointStatus IAM action in that cluster.id (string) required
neptuneIamRoleArn (string)
neptunedata/get_mlmodel_training_jobRetrieves information about a Neptune ML model training job. See Model training using the modeltraining command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetMLModelTrainingJobStatus IAM action in that cluster.id (string) required
neptuneIamRoleArn (string)
neptunedata/get_mlmodel_transform_jobGets information about a specified model transform job. See Use a trained model to generate new model artifacts. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetMLModelTransformJobStatus IAM action in that cluster.id (string) required
neptuneIamRoleArn (string)
neptunedata/get_open_cypher_query_statusRetrieves the status of a specified openCypher query. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster. Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries see Condition keys available in Neptune IAM data-access policy statements.queryId (string) required
neptunedata/get_propertygraph_statisticsGets property graph statistics Gremlin and openCypher. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStatisticsStatus IAM action in that cluster.No parameters
neptunedata/get_propertygraph_streamGets a stream for a property graph. With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. GetPropertygraphStream lets you collect these change-log entries for a property graph. The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1. See Capturing graph changes in real time using Neptune streams. When invokilimit (integer)
iteratorType (string)
commitNum (integer)
opNum (integer)
encoding (string)
neptunedata/get_propertygraph_summaryGets a graph summary for a property graph. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetGraphSummary IAM action in that cluster.mode (string)
neptunedata/get_rdfgraph_summaryGets a graph summary for an RDF graph. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetGraphSummary IAM action in that cluster.mode (string)
neptunedata/get_sparql_statisticsGets RDF statistics SPARQL.No parameters
neptunedata/get_sparql_streamGets a stream for an RDF graph. With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. GetSparqlStream lets you collect these change-log entries for an RDF graph. The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1. See Capturing graph changes in real time using Neptune streams. When invoking this operatilimit (integer)
iteratorType (string)
commitNum (integer)
opNum (integer)
encoding (string)
neptunedata/list_gremlin_queriesLists active Gremlin queries. See Gremlin query status API for details about the output. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster. Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries see Condition keys available in Neptune IAM datincludeWaiting (boolean)
neptunedata/list_loader_jobsRetrieves a list of the loadIds for all active loader jobs. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListLoaderJobs IAM action in that cluster..limit (integer)
includeQueuedLoads (boolean)
neptunedata/list_mldata_processing_jobsReturns a list of Neptune ML data processing jobs. See Listing active data-processing jobs using the Neptune ML dataprocessing command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListMLDataProcessingJobs IAM action in that cluster.maxItems (integer)
neptuneIamRoleArn (string)
neptunedata/list_mlendpointsLists existing inference endpoints. See Managing inference endpoints using the endpoints command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListMLEndpoints IAM action in that cluster.maxItems (integer)
neptuneIamRoleArn (string)
neptunedata/list_mlmodel_training_jobsLists Neptune ML model-training jobs. See Model training using the modeltraining command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:neptune-db:ListMLModelTrainingJobs IAM action in that cluster.maxItems (integer)
neptuneIamRoleArn (string)
neptunedata/list_mlmodel_transform_jobsReturns a list of model transform job IDs. See Use a trained model to generate new model artifacts. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ListMLModelTransformJobs IAM action in that cluster.maxItems (integer)
neptuneIamRoleArn (string)
neptunedata/list_open_cypher_queriesLists active openCypher queries. See Neptune openCypher status endpoint for more information. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetQueryStatus IAM action in that cluster. Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries see Condition keys available in NeptincludeWaiting (boolean)
neptunedata/manage_propertygraph_statisticsManages the generation and use of property graph statistics. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ManageStatistics IAM action in that cluster.mode (string)
neptunedata/manage_sparql_statisticsManages the generation and use of RDF graph statistics. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ManageStatistics IAM action in that cluster.mode (string)
neptunedata/start_loader_jobStarts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance. See Using the Amazon Neptune Bulk Loader to Ingest Data. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartLoaderJob IAM action in that cluster.source (string) required
format (string) required
s3BucketRegion (string) required
iamRoleArn (string) required
mode (string)
failOnError (boolean)
parallelism (string)
parserConfiguration (object)
updateSingleCardinalityProperties (boolean)
queueRequest (boolean)
dependencies (array)
userProvidedEdgeIds (boolean)
edgeOnlyLoad (boolean)
neptunedata/start_mldata_processing_jobCreates a new Neptune ML data processing job for processing the graph data exported from Neptune for training. See The dataprocessing command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelDataProcessingJob IAM action in that cluster.id (string)
previousDataProcessingJobId (string)
inputDataS3Location (string) required
processedDataS3Location (string) required
sagemakerIamRoleArn (string)
neptuneIamRoleArn (string)
processingInstanceType (string)
processingInstanceVolumeSizeInGB (integer)
processingTimeOutInSeconds (integer)
modelType (string)
configFileName (string)
subnets (array)
securityGroupIds (array)
volumeEncryptionKMSKey (string)
s3OutputEncryptionKMSKey (string)
neptunedata/start_mlmodel_training_jobCreates a new Neptune ML model training job. See Model training using the modeltraining command. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelTrainingJob IAM action in that cluster.id (string)
previousModelTrainingJobId (string)
dataProcessingJobId (string) required
trainModelS3Location (string) required
sagemakerIamRoleArn (string)
neptuneIamRoleArn (string)
baseProcessingInstanceType (string)
trainingInstanceType (string)
trainingInstanceVolumeSizeInGB (integer)
trainingTimeOutInSeconds (integer)
maxHPONumberOfTrainingJobs (integer)
maxHPOParallelTrainingJobs (integer)
subnets (array)
securityGroupIds (array)
volumeEncryptionKMSKey (string)
s3OutputEncryptionKMSKey (string)
enableManagedSpotTraining (boolean)
customModelTrainingParameters: {
. sourceS3DirectoryPath (string)
. trainingEntryPointScript (string)
. transformEntryPointScript (string)
} (object)
neptunedata/start_mlmodel_transform_jobCreates a new model transform job. See Use a trained model to generate new model artifacts. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:StartMLModelTransformJob IAM action in that cluster.id (string)
dataProcessingJobId (string)
mlModelTrainingJobId (string)
trainingJobName (string)
modelTransformOutputS3Location (string) required
sagemakerIamRoleArn (string)
neptuneIamRoleArn (string)
customModelTransformParameters: {
. sourceS3DirectoryPath (string)
. transformEntryPointScript (string)
} (object)
baseProcessingInstanceType (string)
baseProcessingInstanceVolumeSizeInGB (integer)
subnets (array)
securityGroupIds (array)
volumeEncryptionKMSKey (string)
s3OutputEncryptionKMSKey (string)
network_firewall/accept_network_firewall_transit_gateway_attachmentAccepts a transit gateway attachment request for Network Firewall. When you accept the attachment request, Network Firewall creates the necessary routing components to enable traffic flow between the transit gateway and firewall endpoints. You must accept a transit gateway attachment to complete the creation of a transit gateway-attached firewall, unless auto-accept is enabled on the transit gateway. After acceptance, use DescribeFirewall to verify the firewall status. To reject an attachment inTransitGatewayAttachmentId (string) required
network_firewall/associate_availability_zonesAssociates the specified Availability Zones with a transit gateway-attached firewall. For each Availability Zone, Network Firewall creates a firewall endpoint to process traffic. You can specify one or more Availability Zones where you want to deploy the firewall. After adding Availability Zones, you must update your transit gateway route tables to direct traffic through the new firewall endpoints. Use DescribeFirewall to monitor the status of the new endpoints.UpdateToken (string)
FirewallArn (string)
FirewallName (string)
AvailabilityZoneMappings (array) required
network_firewall/associate_firewall_policyAssociates 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.UpdateToken (string)
FirewallArn (string)
FirewallName (string)
FirewallPolicyArn (string) required
network_firewall/associate_subnetsAssociates 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.UpdateToken (string)
FirewallArn (string)
FirewallName (string)
SubnetMappings (array) required
network_firewall/attach_rule_groups_to_proxy_configurationAttaches ProxyRuleGroup resources to a ProxyConfiguration A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.ProxyConfigurationName (string)
ProxyConfigurationArn (string)
RuleGroups (array) required
UpdateToken (string) required
network_firewall/create_firewallCreates 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 fFirewallName (string) required
FirewallPolicyArn (string) required
VpcId (string)
SubnetMappings (array)
DeleteProtection (boolean)
SubnetChangeProtection (boolean)
FirewallPolicyChangeProtection (boolean)
Description (string)
Tags (array)
EncryptionConfiguration: {
. KeyId (string)
. Type (string)
} (object)
EnabledAnalysisTypes (array)
TransitGatewayId (string)
AvailabilityZoneMappings (array)
AvailabilityZoneChangeProtection (boolean)
network_firewall/create_firewall_policyCreates 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.FirewallPolicyName (string) required
FirewallPolicy: {
. StatelessRuleGroupReferences (array)
. StatelessDefaultActions (array)
. StatelessFragmentDefaultActions (array)
. StatelessCustomActions (array)
. StatefulRuleGroupReferences (array)
. StatefulDefaultActions (array)
. StatefulEngineOptions (object)
. TLSInspectionConfigurationArn (string)
. PolicyVariables (object)
. EnableTLSSessionHolding (boolean)
} (object) required
Description (string)
Tags (array)
DryRun (boolean)
EncryptionConfiguration: {
. KeyId (string)
. Type (string)
} (object)
network_firewall/create_proxyCreates an Network Firewall Proxy Attaches a Proxy configuration to a NAT Gateway. To manage a proxy's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about proxies, use ListProxies and DescribeProxy.ProxyName (string) required
NatGatewayId (string) required
ProxyConfigurationName (string)
ProxyConfigurationArn (string)
ListenerProperties (array)
TlsInterceptProperties: {
. PcaArn (string)
. TlsInterceptMode (string)
} (object) required
Tags (array)
network_firewall/create_proxy_configurationCreates an Network Firewall ProxyConfiguration A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration. To manage a proxy configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about proxies, use ListProxyConfigurations and DescribeProxyConfiguration.ProxyConfigurationName (string) required
Description (string)
RuleGroupNames (array)
RuleGroupArns (array)
DefaultRulePhaseActions: {
. PreDNS (string)
. PreREQUEST (string)
. PostRESPONSE (string)
} (object) required
Tags (array)
network_firewall/create_proxy_rule_groupCreates an Network Firewall ProxyRuleGroup Collections of related proxy filtering rules. Rule groups help you manage and reuse sets of rules across multiple proxy configurations. To manage a proxy rule group's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource. To retrieve information about proxy rule groups, use ListProxyRuleGroups and DescribeProxyRuleGroup. To retrieve information about individual proxy rules, use DescriProxyRuleGroupName (string) required
Description (string)
Rules: {
. PreDNS (array)
. PreREQUEST (array)
. PostRESPONSE (array)
} (object)
Tags (array)
network_firewall/create_proxy_rulesCreates Network Firewall ProxyRule resources. Attaches new proxy rules to an existing proxy rule group. To retrieve information about individual proxy rules, use DescribeProxyRuleGroup and DescribeProxyRule.ProxyRuleGroupArn (string)
ProxyRuleGroupName (string)
Rules: {
. PreDNS (array)
. PreREQUEST (array)
. PostRESPONSE (array)
} (object) required
network_firewall/create_rule_groupCreates 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.RuleGroupName (string) required
RuleGroup: {
. RuleVariables (object)
. ReferenceSets (object)
. RulesSource (object)
. StatefulRuleOptions (object)
} (object)
Rules (string)
Type (string) required
Description (string)
Capacity (integer) required
Tags (array)
DryRun (boolean)
EncryptionConfiguration: {
. KeyId (string)
. Type (string)
} (object)
SourceMetadata: {
. SourceArn (string)
. SourceUpdateToken (string)
} (object)
AnalyzeRuleGroup (boolean)
SummaryConfiguration: {
. RuleOptions (array)
} (object)
network_firewall/create_tlsinspection_configurationCreates an Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import orTLSInspectionConfigurationName (string) required
TLSInspectionConfiguration: {
. ServerCertificateConfigurations (array)
} (object) required
Description (string)
Tags (array)
EncryptionConfiguration: {
. KeyId (string)
. Type (string)
} (object)
network_firewall/create_vpc_endpoint_associationCreates a firewall endpoint for an Network Firewall firewall. This type of firewall endpoint is independent of the firewall endpoints that you specify in the Firewall itself, and you define it in addition to those endpoints after the firewall has been created. You can define a VPC endpoint association using a different VPC than the one you used in the firewall specifications.FirewallArn (string) required
VpcId (string) required
SubnetMapping: {
. SubnetId (string)
. IPAddressType (string)
} (object) required
Description (string)
Tags (array)
network_firewall/delete_firewallDeletes 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 endpointFirewallName (string)
FirewallArn (string)
network_firewall/delete_firewall_policyDeletes the specified FirewallPolicy.FirewallPolicyName (string)
FirewallPolicyArn (string)
network_firewall/delete_network_firewall_transit_gateway_attachmentDeletes a transit gateway attachment from a Network Firewall. Either the firewall owner or the transit gateway owner can delete the attachment. After you delete a transit gateway attachment, traffic will no longer flow through the firewall endpoints. After you initiate the delete operation, use DescribeFirewall to monitor the deletion status.TransitGatewayAttachmentId (string) required
network_firewall/delete_proxyDeletes the specified Proxy. Detaches a Proxy configuration from a NAT Gateway.NatGatewayId (string) required
ProxyName (string)
ProxyArn (string)
network_firewall/delete_proxy_configurationDeletes the specified ProxyConfiguration.ProxyConfigurationName (string)
ProxyConfigurationArn (string)
network_firewall/delete_proxy_rule_groupDeletes the specified ProxyRuleGroup.ProxyRuleGroupName (string)
ProxyRuleGroupArn (string)
network_firewall/delete_proxy_rulesDeletes the specified ProxyRules. currently attached to a ProxyRuleGroupProxyRuleGroupArn (string)
ProxyRuleGroupName (string)
Rules (array) required
network_firewall/delete_resource_policyDeletes a resource policy that you created in a PutResourcePolicy request.ResourceArn (string) required
network_firewall/delete_rule_groupDeletes the specified RuleGroup.RuleGroupName (string)
RuleGroupArn (string)
Type (string)
network_firewall/delete_tlsinspection_configurationDeletes the specified TLSInspectionConfiguration.TLSInspectionConfigurationArn (string)
TLSInspectionConfigurationName (string)
network_firewall/delete_vpc_endpoint_associationDeletes the specified VpcEndpointAssociation. You can check whether an endpoint association is in use by reviewing the route tables for the Availability Zones where you have the endpoint subnet mapping. You can retrieve the subnet mapping by calling DescribeVpcEndpointAssociation. You define and update the route tables through Amazon VPC. As needed, update the route tables for the Availability Zone to remove the firewall endpoint for the association. When the route tables no longer use the firewVpcEndpointAssociationArn (string) required
network_firewall/describe_firewallReturns the data objects for the specified firewall.FirewallName (string)
FirewallArn (string)
network_firewall/describe_firewall_metadataReturns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.FirewallArn (string)
network_firewall/describe_firewall_policyReturns the data objects for the specified firewall policy.FirewallPolicyName (string)
FirewallPolicyArn (string)
network_firewall/describe_flow_operationReturns key information about a specific flow operation.FirewallArn (string) required
AvailabilityZone (string)
VpcEndpointAssociationArn (string)
VpcEndpointId (string)
FlowOperationId (string) required
network_firewall/describe_logging_configurationReturns the logging configuration for the specified firewall.FirewallArn (string)
FirewallName (string)
network_firewall/describe_proxyReturns the data objects for the specified proxy.ProxyName (string)
ProxyArn (string)
network_firewall/describe_proxy_configurationReturns the data objects for the specified proxy configuration.ProxyConfigurationName (string)
ProxyConfigurationArn (string)
network_firewall/describe_proxy_ruleReturns the data objects for the specified proxy configuration for the specified proxy rule group.ProxyRuleName (string) required
ProxyRuleGroupName (string)
ProxyRuleGroupArn (string)
network_firewall/describe_proxy_rule_groupReturns the data objects for the specified proxy rule group.ProxyRuleGroupName (string)
ProxyRuleGroupArn (string)
network_firewall/describe_resource_policyRetrieves a resource policy that you created in a PutResourcePolicy request.ResourceArn (string) required
network_firewall/describe_rule_groupReturns the data objects for the specified rule group.RuleGroupName (string)
RuleGroupArn (string)
Type (string)
AnalyzeRuleGroup (boolean)
network_firewall/describe_rule_group_metadataHigh-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.RuleGroupName (string)
RuleGroupArn (string)
Type (string)
network_firewall/describe_rule_group_summaryReturns detailed information for a stateful rule group. For active threat defense Amazon Web Services managed rule groups, this operation provides insight into the protections enabled by the rule group, based on Suricata rule metadata fields. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups. To modify how threat information appears in summaries, use the SummaryConfiguration parameter in UpdateRuleGroup.RuleGroupName (string)
RuleGroupArn (string)
Type (string)
network_firewall/describe_tlsinspection_configurationReturns the data objects for the specified TLS inspection configuration.TLSInspectionConfigurationArn (string)
TLSInspectionConfigurationName (string)
network_firewall/describe_vpc_endpoint_associationReturns the data object for the specified VPC endpoint association.VpcEndpointAssociationArn (string) required
network_firewall/detach_rule_groups_from_proxy_configurationDetaches ProxyRuleGroup resources from a ProxyConfiguration A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.ProxyConfigurationName (string)
ProxyConfigurationArn (string)
RuleGroupNames (array)
RuleGroupArns (array)
UpdateToken (string) required
network_firewall/disassociate_availability_zonesRemoves the specified Availability Zone associations from a transit gateway-attached firewall. This removes the firewall endpoints from these Availability Zones and stops traffic filtering in those zones. Before removing an Availability Zone, ensure you've updated your transit gateway route tables to redirect traffic appropriately. If AvailabilityZoneChangeProtection is enabled, you must first disable it using UpdateAvailabilityZoneChangeProtection. To verify the status of your Availability ZoneUpdateToken (string)
FirewallArn (string)
FirewallName (string)
AvailabilityZoneMappings (array) required
network_firewall/disassociate_subnetsRemoves 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.UpdateToken (string)
FirewallArn (string)
FirewallName (string)
SubnetIds (array) required
network_firewall/get_analysis_report_resultsThe results of a COMPLETED analysis report generated with StartAnalysisReport. For more information, see AnalysisTypeReportResult.FirewallName (string)
AnalysisReportId (string) required
FirewallArn (string)
NextToken (string)
MaxResults (integer)
network_firewall/list_analysis_reportsReturns a list of all traffic analysis reports generated within the last 30 days.FirewallName (string)
FirewallArn (string)
NextToken (string)
MaxResults (integer)
network_firewall/list_firewall_policiesRetrieves 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.NextToken (string)
MaxResults (integer)
network_firewall/list_firewallsRetrieves 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.NextToken (string)
VpcIds (array)
MaxResults (integer)
network_firewall/list_flow_operation_resultsReturns the results of a specific flow operation. Flow operations let you manage the flows tracked in the flow table, also known as the firewall table. A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort.FirewallArn (string) required
FlowOperationId (string) required
NextToken (string)
MaxResults (integer)
AvailabilityZone (string)
VpcEndpointId (string)
VpcEndpointAssociationArn (string)
network_firewall/list_flow_operationsReturns a list of all flow operations ran in a specific firewall. You can optionally narrow the request scope by specifying the operation type or Availability Zone associated with a firewall's flow operations. Flow operations let you manage the flows tracked in the flow table, also known as the firewall table. A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, DFirewallArn (string) required
AvailabilityZone (string)
VpcEndpointAssociationArn (string)
VpcEndpointId (string)
FlowOperationType (string)
NextToken (string)
MaxResults (integer)
network_firewall/list_proxiesRetrieves the metadata for the proxies that you have defined. Depending on your setting for max results and the number of proxies, a single call might not return the full list.NextToken (string)
MaxResults (integer)
network_firewall/list_proxy_configurationsRetrieves the metadata for the proxy configuration that you have defined. Depending on your setting for max results and the number of proxy configurations, a single call might not return the full list.NextToken (string)
MaxResults (integer)
network_firewall/list_proxy_rule_groupsRetrieves the metadata for the proxy rule groups that you have defined. Depending on your setting for max results and the number of proxy rule groups, a single call might not return the full list.NextToken (string)
MaxResults (integer)
network_firewall/list_rule_groupsRetrieves 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.NextToken (string)
MaxResults (integer)
Scope (string)
ManagedType (string)
SubscriptionStatus (string)
Type (string)
network_firewall/list_tags_for_resourceRetrieves 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 gNextToken (string)
MaxResults (integer)
ResourceArn (string) required
network_firewall/list_tlsinspection_configurationsRetrieves the metadata for the TLS inspection configurations that you have defined. Depending on your setting for max results and the number of TLS inspection configurations, a single call might not return the full list.NextToken (string)
MaxResults (integer)
network_firewall/list_vpc_endpoint_associationsRetrieves the metadata for the VPC endpoint associations that you have defined. If you specify a fireawll, this returns only the endpoint associations for that firewall. Depending on your setting for max results and the number of associations, a single call might not return the full list.NextToken (string)
MaxResults (integer)
FirewallArn (string)
network_firewall/put_resource_policyCreates or updates an IAM policy for your rule group, firewall policy, or firewall. Use this to share these resources between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager RAM service to manage resource sharing for Network Firewall. For information about using sharing with Network Firewall resources, see Sharing Network Firewall resources in the Network Firewall Developer Guide. Use this operation to create or update a resource policy for yourResourceArn (string) required
Policy (string) required
network_firewall/reject_network_firewall_transit_gateway_attachmentRejects a transit gateway attachment request for Network Firewall. When you reject the attachment request, Network Firewall cancels the creation of routing components between the transit gateway and firewall endpoints. Only the transit gateway owner can reject the attachment. After rejection, no traffic will flow through the firewall endpoints for this attachment. Use DescribeFirewall to monitor the rejection status. To accept the attachment instead of rejecting it, use AcceptNetworkFirewallTranTransitGatewayAttachmentId (string) required
network_firewall/start_analysis_reportGenerates a traffic analysis report for the timeframe and traffic type you specify. For information on the contents of a traffic analysis report, see AnalysisReport.FirewallName (string)
FirewallArn (string)
AnalysisType (string) required
network_firewall/start_flow_captureBegins capturing the flows in a firewall, according to the filters you define. Captures are similar, but not identical to snapshots. Capture operations provide visibility into flows that are not closed and are tracked by a firewall's flow table. Unlike snapshots, captures are a time-boxed view. A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules. For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, ProtocFirewallArn (string) required
AvailabilityZone (string)
VpcEndpointAssociationArn (string)
VpcEndpointId (string)
MinimumFlowAgeInSeconds (integer)
FlowFilters (array) required
network_firewall/start_flow_flushBegins the flushing of traffic from the firewall, according to the filters you define. When the operation starts, impacted flows are temporarily marked as timed out before the Suricata engine prunes, or flushes, the flows from the firewall table. While the flush completes, impacted flows are processed as midstream traffic. This may result in a temporary increase in midstream traffic metrics. We recommend that you double check your stream exception policy before you perform a flush operation.FirewallArn (string) required
AvailabilityZone (string)
VpcEndpointAssociationArn (string)
VpcEndpointId (string)
MinimumFlowAgeInSeconds (integer)
FlowFilters (array) required
network_firewall/tag_resourceAdds 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.ResourceArn (string) required
Tags (array) required
network_firewall/untag_resourceRemoves 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, firewaResourceArn (string) required
TagKeys (array) required
network_firewall/update_availability_zone_change_protectionModifies the AvailabilityZoneChangeProtection setting for a transit gateway-attached firewall. When enabled, this setting prevents accidental changes to the firewall's Availability Zone configuration. This helps protect against disrupting traffic flow in production environments. When enabled, you must disable this protection before using AssociateAvailabilityZones or DisassociateAvailabilityZones to modify the firewall's Availability Zone configuration.UpdateToken (string)
FirewallArn (string)
FirewallName (string)
AvailabilityZoneChangeProtection (boolean) required
network_firewall/update_firewall_analysis_settingsEnables specific types of firewall analysis on a specific firewall you define.EnabledAnalysisTypes (array)
FirewallArn (string)
FirewallName (string)
UpdateToken (string)
network_firewall/update_firewall_delete_protectionModifies 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.UpdateToken (string)
FirewallArn (string)
FirewallName (string)
DeleteProtection (boolean) required
network_firewall/update_firewall_descriptionModifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.UpdateToken (string)
FirewallArn (string)
FirewallName (string)
Description (string)
network_firewall/update_firewall_encryption_configurationA complex type that contains settings for encryption of your firewall resources.UpdateToken (string)
FirewallArn (string)
FirewallName (string)
EncryptionConfiguration: {
. KeyId (string)
. Type (string)
} (object)
network_firewall/update_firewall_policyUpdates the properties of the specified firewall policy.UpdateToken (string) required
FirewallPolicyArn (string)
FirewallPolicyName (string)
FirewallPolicy: {
. StatelessRuleGroupReferences (array)
. StatelessDefaultActions (array)
. StatelessFragmentDefaultActions (array)
. StatelessCustomActions (array)
. StatefulRuleGroupReferences (array)
. StatefulDefaultActions (array)
. StatefulEngineOptions (object)
. TLSInspectionConfigurationArn (string)
. PolicyVariables (object)
. EnableTLSSessionHolding (boolean)
} (object) required
Description (string)
DryRun (boolean)
EncryptionConfiguration: {
. KeyId (string)
. Type (string)
} (object)
network_firewall/update_firewall_policy_change_protectionModifies 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.UpdateToken (string)
FirewallArn (string)
FirewallName (string)
FirewallPolicyChangeProtection (boolean) required
network_firewall/update_logging_configurationSets 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 adFirewallArn (string)
FirewallName (string)
LoggingConfiguration: {
. LogDestinationConfigs (array)
} (object)
EnableMonitoringDashboard (boolean)
network_firewall/update_proxyUpdates the properties of the specified proxy.NatGatewayId (string) required
ProxyName (string)
ProxyArn (string)
ListenerPropertiesToAdd (array)
ListenerPropertiesToRemove (array)
TlsInterceptProperties: {
. PcaArn (string)
. TlsInterceptMode (string)
} (object)
UpdateToken (string) required
network_firewall/update_proxy_configurationUpdates the properties of the specified proxy configuration.ProxyConfigurationName (string)
ProxyConfigurationArn (string)
DefaultRulePhaseActions: {
. PreDNS (string)
. PreREQUEST (string)
. PostRESPONSE (string)
} (object) required
UpdateToken (string) required
network_firewall/update_proxy_ruleUpdates the properties of the specified proxy rule.ProxyRuleGroupName (string)
ProxyRuleGroupArn (string)
ProxyRuleName (string) required
Description (string)
Action (string)
AddConditions (array)
RemoveConditions (array)
UpdateToken (string) required
network_firewall/update_proxy_rule_group_prioritiesUpdates proxy rule group priorities within a proxy configuration.ProxyConfigurationName (string)
ProxyConfigurationArn (string)
RuleGroups (array) required
UpdateToken (string) required
network_firewall/update_proxy_rule_prioritiesUpdates proxy rule priorities within a proxy rule group.ProxyRuleGroupName (string)
ProxyRuleGroupArn (string)
RuleGroupRequestPhase (string) required
Rules (array) required
UpdateToken (string) required
network_firewall/update_rule_groupUpdates 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.UpdateToken (string) required
RuleGroupArn (string)
RuleGroupName (string)
RuleGroup: {
. RuleVariables (object)
. ReferenceSets (object)
. RulesSource (object)
. StatefulRuleOptions (object)
} (object)
Rules (string)
Type (string)
Description (string)
DryRun (boolean)
EncryptionConfiguration: {
. KeyId (string)
. Type (string)
} (object)
SourceMetadata: {
. SourceArn (string)
. SourceUpdateToken (string)
} (object)
AnalyzeRuleGroup (boolean)
SummaryConfiguration: {
. RuleOptions (array)
} (object)
network_firewall/update_subnet_change_protectionNo description availableUpdateToken (string)
FirewallArn (string)
FirewallName (string)
SubnetChangeProtection (boolean) required
network_firewall/update_tlsinspection_configurationUpdates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it in one or more firewall policies. When you modify a TLS inspection configuration, you modify all firewall policies that use the TLS inspection configuration. To update a TLS inspection configuration, first call DescribeTLSInspectionConfiguration to retrieve the current TLSInspectionConfiguration object, update the object as needed, and then prTLSInspectionConfigurationArn (string)
TLSInspectionConfigurationName (string)
TLSInspectionConfiguration: {
. ServerCertificateConfigurations (array)
} (object) required
Description (string)
EncryptionConfiguration: {
. KeyId (string)
. Type (string)
} (object)
UpdateToken (string) required
networkflowmonitor/list_tags_for_resourceReturns all the tags for a resource.resourceArn (string) required
networkflowmonitor/tag_resourceAdds a tag to a resource.resourceArn (string) required
tags (object) required
networkflowmonitor/untag_resourceRemoves a tag from a resource.resourceArn (string) required
tagKeys (array) required
networkflowmonitor/get_query_results_monitor_top_contributorsReturn the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for a specific monitor. Create a query ID for this call by calling the corresponding API call to start the query, StartQueryMonitorTopContributors. Use the scope ID that was returned for your account by CreateScope. Top contributors in Network Flow Monitor are network flows with themonitorName (string) required
queryId (string) required
nextToken (string)
maxResults (integer)
networkflowmonitor/get_query_status_monitor_top_contributorsReturns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors for a monitor. When you create a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start create the query, StartQueryMonitorTopContributors. When you run a query, use this camonitorName (string) required
queryId (string) required
networkflowmonitor/start_query_monitor_top_contributorsCreate a query that you can use with the Network Flow Monitor query interface to return the top contributors for a monitor. Specify the monitor that you want to create the query for. The call returns a query ID that you can use with GetQueryResultsMonitorTopContributors to run the query and return the top contributors for a specific monitor. Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload imonitorName (string) required
startTime (string) required
endTime (string) required
metricName (string) required
destinationCategory (string) required
limit (integer)
networkflowmonitor/stop_query_monitor_top_contributorsStop a top contributors query for a monitor. Specify the query that you want to stop by providing a query ID and a monitor name. Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.monitorName (string) required
queryId (string) required
networkflowmonitor/get_monitorGets information about a monitor in Network Flow Monitor based on a monitor name. The information returned includes the Amazon Resource Name ARN, create time, modified time, resources included in the monitor, and status information.monitorName (string) required
networkflowmonitor/update_monitorUpdate a monitor to add or remove local or remote resources.monitorName (string) required
localResourcesToAdd (array)
localResourcesToRemove (array)
remoteResourcesToAdd (array)
remoteResourcesToRemove (array)
clientToken (string)
networkflowmonitor/delete_monitorDeletes a monitor in Network Flow Monitor.monitorName (string) required
networkflowmonitor/list_monitorsList all monitors in an account. Optionally, you can list only monitors that have a specific status, by using the STATUS parameter.nextToken (string)
maxResults (integer)
monitorStatus (string)
networkflowmonitor/create_monitorCreate a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicator NHI that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose.monitorName (string) required
localResources (array) required
remoteResources (array)
scopeArn (string) required
clientToken (string)
tags (object)
networkflowmonitor/get_query_results_workload_insights_top_contributorsReturn the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for a scope for workload insights. Workload insights provide a high level view of network flow performance data collected by agents. To return the data for the top contributors, see GetQueryResultsWorkloadInsightsTopContributorsData. Create a query ID for this call by calling the coscopeId (string) required
queryId (string) required
nextToken (string)
maxResults (integer)
networkflowmonitor/get_query_results_workload_insights_top_contributors_dataReturn the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a scope ID. This query returns the data for top contributors for workload insights for a specific scope. Workload insights provide a high level view of network flow performance data collected by agents for a scope. To return just the top contributors, see GetQueryResultsWorkloadInsightsTopContributors. Create a query ID for this call by callscopeId (string) required
queryId (string) required
nextToken (string)
maxResults (integer)
networkflowmonitor/get_query_status_workload_insights_top_contributorsReturn the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for workload insights. When you start a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start the query, StartQueryWorkloadInsightsTopContribscopeId (string) required
queryId (string) required
networkflowmonitor/get_query_status_workload_insights_top_contributors_dataReturns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors data for workload insights. When you start a query, use this call to check the status of the query to make sure that it has has SUCCEEDED before you review the results. Use the same query ID that you used for the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributorsData. Top contributorscopeId (string) required
queryId (string) required
networkflowmonitor/start_query_workload_insights_top_contributorsCreate a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors. Specify the scope that you want to create a query for. The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributors to run the query and return the top contributors for the workload insights for a scope. Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be ascopeId (string) required
startTime (string) required
endTime (string) required
metricName (string) required
destinationCategory (string) required
limit (integer)
networkflowmonitor/start_query_workload_insights_top_contributors_dataCreate a query with the Network Flow Monitor query interface that you can run to return data for workload insights top contributors. Specify the scope that you want to create a query for. The call returns a query ID that you can use with GetQueryResultsWorkloadInsightsTopContributorsData to run the query and return the data for the top contributors for the workload insights for a scope. Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type.scopeId (string) required
startTime (string) required
endTime (string) required
metricName (string) required
destinationCategory (string) required
networkflowmonitor/stop_query_workload_insights_top_contributorsStop a top contributors query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID. Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.scopeId (string) required
queryId (string) required
networkflowmonitor/stop_query_workload_insights_top_contributors_dataStop a top contributors data query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID. Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.scopeId (string) required
queryId (string) required
networkflowmonitor/create_scopeIn Network Flow Monitor, you specify a scope for the service to generate metrics for. By using the scope, Network Flow Monitor can generate a topology of all the resources to measure performance metrics for. When you create a scope, you enable permissions for Network Flow Monitor. A scope is a Region-account pair or multiple Region-account pairs. Network Flow Monitor uses your scope to determine all the resources the topology where Network Flow Monitor will gather network flow performance metrictargets (array) required
clientToken (string)
tags (object)
networkflowmonitor/get_scopeGets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account.scopeId (string) required
networkflowmonitor/update_scopeUpdate a scope to add or remove resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend.scopeId (string) required
resourcesToAdd (array)
resourcesToDelete (array)
networkflowmonitor/delete_scopeDeletes a scope that has been defined.scopeId (string) required
networkflowmonitor/list_scopesList all the scopes for an account.nextToken (string)
maxResults (integer)
networkmanager/accept_attachmentAccepts 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.AttachmentId (string) required
networkmanager/associate_connect_peerAssociates 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.GlobalNetworkId (string) required
ConnectPeerId (string) required
DeviceId (string) required
LinkId (string)
networkmanager/associate_customer_gatewayAssociates 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 conneCustomerGatewayArn (string) required
GlobalNetworkId (string) required
DeviceId (string) required
LinkId (string)
networkmanager/associate_linkAssociates 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.GlobalNetworkId (string) required
DeviceId (string) required
LinkId (string) required
networkmanager/associate_transit_gateway_connect_peerAssociates 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.GlobalNetworkId (string) required
TransitGatewayConnectPeerArn (string) required
DeviceId (string) required
LinkId (string)
networkmanager/create_connect_attachmentCreates 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.CoreNetworkId (string) required
EdgeLocation (string) required
TransportAttachmentId (string) required
RoutingPolicyLabel (string)
Options: {
. Protocol (string)
} (object) required
Tags (array)
ClientToken (string)
networkmanager/create_connectionCreates 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.GlobalNetworkId (string) required
DeviceId (string) required
ConnectedDeviceId (string) required
LinkId (string)
ConnectedLinkId (string)
Description (string)
Tags (array)
networkmanager/create_connect_peerCreates 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.ConnectAttachmentId (string) required
CoreNetworkAddress (string)
PeerAddress (string) required
BgpOptions: {
. PeerAsn (integer)
} (object)
InsideCidrBlocks (array)
Tags (array)
ClientToken (string)
SubnetArn (string)
networkmanager/create_core_networkCreates a core network as part of your global network, and optionally, with a core network policy.GlobalNetworkId (string) required
Description (string)
Tags (array)
PolicyDocument (string)
ClientToken (string)
networkmanager/create_core_network_prefix_list_associationCreates an association between a core network and a prefix list for routing control.CoreNetworkId (string) required
PrefixListArn (string) required
PrefixListAlias (string) required
ClientToken (string)
networkmanager/create_deviceCreates 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.GlobalNetworkId (string) required
AWSLocation: {
. Zone (string)
. SubnetArn (string)
} (object)
Description (string)
Type (string)
Vendor (string)
Model (string)
SerialNumber (string)
Location: {
. Address (string)
. Latitude (string)
. Longitude (string)
} (object)
SiteId (string)
Tags (array)
networkmanager/create_direct_connect_gateway_attachmentCreates an Amazon Web Services Direct Connect gateway attachmentCoreNetworkId (string) required
DirectConnectGatewayArn (string) required
RoutingPolicyLabel (string)
EdgeLocations (array) required
Tags (array)
ClientToken (string)
networkmanager/create_global_networkCreates a new, empty global network.Description (string)
Tags (array)
networkmanager/create_linkCreates a new link for a specified site.GlobalNetworkId (string) required
Description (string)
Type (string)
Bandwidth: {
. UploadSpeed (integer)
. DownloadSpeed (integer)
} (object) required
Provider (string)
SiteId (string) required
Tags (array)
networkmanager/create_siteCreates a new site in a global network.GlobalNetworkId (string) required
Description (string)
Location: {
. Address (string)
. Latitude (string)
. Longitude (string)
} (object)
Tags (array)
networkmanager/create_site_to_site_vpn_attachmentCreates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.CoreNetworkId (string) required
VpnConnectionArn (string) required
RoutingPolicyLabel (string)
Tags (array)
ClientToken (string)
networkmanager/create_transit_gateway_peeringCreates a transit gateway peering connection.CoreNetworkId (string) required
TransitGatewayArn (string) required
Tags (array)
ClientToken (string)
networkmanager/create_transit_gateway_route_table_attachmentCreates a transit gateway route table attachment.PeeringId (string) required
TransitGatewayRouteTableArn (string) required
RoutingPolicyLabel (string)
Tags (array)
ClientToken (string)
networkmanager/create_vpc_attachmentCreates a VPC attachment on an edge location of a core network.CoreNetworkId (string) required
VpcArn (string) required
SubnetArns (array) required
Options: {
. Ipv6Support (boolean)
. ApplianceModeSupport (boolean)
. DnsSupport (boolean)
. SecurityGroupReferencingSupport (boolean)
} (object)
RoutingPolicyLabel (string)
Tags (array)
ClientToken (string)
networkmanager/delete_attachmentDeletes an attachment. Supports all attachment types.AttachmentId (string) required
networkmanager/delete_connectionDeletes the specified connection in your global network.GlobalNetworkId (string) required
ConnectionId (string) required
networkmanager/delete_connect_peerDeletes a Connect peer.ConnectPeerId (string) required
networkmanager/delete_core_networkDeletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.CoreNetworkId (string) required
networkmanager/delete_core_network_policy_versionDeletes a policy version from a core network. You can't delete the current LIVE policy.CoreNetworkId (string) required
PolicyVersionId (integer) required
networkmanager/delete_core_network_prefix_list_associationDeletes an association between a core network and a prefix list.CoreNetworkId (string) required
PrefixListArn (string) required
networkmanager/delete_deviceDeletes an existing device. You must first disassociate the device from any links and customer gateways.GlobalNetworkId (string) required
DeviceId (string) required
networkmanager/delete_global_networkDeletes 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.GlobalNetworkId (string) required
networkmanager/delete_linkDeletes an existing link. You must first disassociate the link from any devices and customer gateways.GlobalNetworkId (string) required
LinkId (string) required
networkmanager/delete_peeringDeletes an existing peering connection.PeeringId (string) required
networkmanager/delete_resource_policyDeletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.ResourceArn (string) required
networkmanager/delete_siteDeletes an existing site. The site cannot be associated with any device or link.GlobalNetworkId (string) required
SiteId (string) required
networkmanager/deregister_transit_gatewayDeregisters 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.GlobalNetworkId (string) required
TransitGatewayArn (string) required
networkmanager/describe_global_networksDescribes 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.GlobalNetworkIds (array)
MaxResults (integer)
NextToken (string)
networkmanager/disassociate_connect_peerDisassociates a core network Connect peer from a device and a link.GlobalNetworkId (string) required
ConnectPeerId (string) required
networkmanager/disassociate_customer_gatewayDisassociates a customer gateway from a device and a link.GlobalNetworkId (string) required
CustomerGatewayArn (string) required
networkmanager/disassociate_linkDisassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.GlobalNetworkId (string) required
DeviceId (string) required
LinkId (string) required
networkmanager/disassociate_transit_gateway_connect_peerDisassociates a transit gateway Connect peer from a device and link.GlobalNetworkId (string) required
TransitGatewayConnectPeerArn (string) required
networkmanager/execute_core_network_change_setExecutes a change set on your core network. Deploys changes globally based on the policy submitted..CoreNetworkId (string) required
PolicyVersionId (integer) required
networkmanager/get_connect_attachmentReturns information about a core network Connect attachment.AttachmentId (string) required
networkmanager/get_connectionsGets information about one or more of your connections in a global network.GlobalNetworkId (string) required
ConnectionIds (array)
DeviceId (string)
MaxResults (integer)
NextToken (string)
networkmanager/get_connect_peerReturns information about a core network Connect peer.ConnectPeerId (string) required
networkmanager/get_connect_peer_associationsReturns information about a core network Connect peer associations.GlobalNetworkId (string) required
ConnectPeerIds (array)
MaxResults (integer)
NextToken (string)
networkmanager/get_core_networkReturns information about the LIVE policy for a core network.CoreNetworkId (string) required
networkmanager/get_core_network_change_eventsReturns information about a core network change event.CoreNetworkId (string) required
PolicyVersionId (integer) required
MaxResults (integer)
NextToken (string)
networkmanager/get_core_network_change_setReturns a change set between the LIVE core network policy and a submitted policy.CoreNetworkId (string) required
PolicyVersionId (integer) required
MaxResults (integer)
NextToken (string)
networkmanager/get_core_network_policyReturns details about a core network policy. You can get details about your current live policy or any previous policy version.CoreNetworkId (string) required
PolicyVersionId (integer)
Alias (string)
networkmanager/get_customer_gateway_associationsGets the association information for customer gateways that are associated with devices and links in your global network.GlobalNetworkId (string) required
CustomerGatewayArns (array)
MaxResults (integer)
NextToken (string)
networkmanager/get_devicesGets information about one or more of your devices in a global network.GlobalNetworkId (string) required
DeviceIds (array)
SiteId (string)
MaxResults (integer)
NextToken (string)
networkmanager/get_direct_connect_gateway_attachmentReturns information about a specific Amazon Web Services Direct Connect gateway attachment.AttachmentId (string) required
networkmanager/get_link_associationsGets the link associations for a device or a link. Either the device ID or the link ID must be specified.GlobalNetworkId (string) required
DeviceId (string)
LinkId (string)
MaxResults (integer)
NextToken (string)
networkmanager/get_linksGets 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.GlobalNetworkId (string) required
LinkIds (array)
SiteId (string)
Type (string)
Provider (string)
MaxResults (integer)
NextToken (string)
networkmanager/get_network_resource_countsGets the count of network resources, by resource type, for the specified global network.GlobalNetworkId (string) required
ResourceType (string)
MaxResults (integer)
NextToken (string)
networkmanager/get_network_resource_relationshipsGets the network resource relationships for the specified global network.GlobalNetworkId (string) required
CoreNetworkId (string)
RegisteredGatewayArn (string)
AwsRegion (string)
AccountId (string)
ResourceType (string)
ResourceArn (string)
MaxResults (integer)
NextToken (string)
networkmanager/get_network_resourcesDescribes 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.GlobalNetworkId (string) required
CoreNetworkId (string)
RegisteredGatewayArn (string)
AwsRegion (string)
AccountId (string)
ResourceType (string)
ResourceArn (string)
MaxResults (integer)
NextToken (string)
networkmanager/get_network_routesGets the network routes of the specified global network.GlobalNetworkId (string) required
RouteTableIdentifier: {
. TransitGatewayRouteTableArn (string)
. CoreNetworkSegmentEdge (object)
. CoreNetworkNetworkFunctionGroup (object)
} (object) required
ExactCidrMatches (array)
LongestPrefixMatches (array)
SubnetOfMatches (array)
SupernetOfMatches (array)
PrefixListIds (array)
States (array)
Types (array)
DestinationFilters (object)
networkmanager/get_network_telemetryGets the network telemetry of the specified global network.GlobalNetworkId (string) required
CoreNetworkId (string)
RegisteredGatewayArn (string)
AwsRegion (string)
AccountId (string)
ResourceType (string)
ResourceArn (string)
MaxResults (integer)
NextToken (string)
networkmanager/get_resource_policyReturns information about a resource policy.ResourceArn (string) required
networkmanager/get_route_analysisGets information about the specified route analysis.GlobalNetworkId (string) required
RouteAnalysisId (string) required
networkmanager/get_sitesGets information about one or more of your sites in a global network.GlobalNetworkId (string) required
SiteIds (array)
MaxResults (integer)
NextToken (string)
networkmanager/get_site_to_site_vpn_attachmentReturns information about a site-to-site VPN attachment.AttachmentId (string) required
networkmanager/get_transit_gateway_connect_peer_associationsGets information about one or more of your transit gateway Connect peer associations in a global network.GlobalNetworkId (string) required
TransitGatewayConnectPeerArns (array)
MaxResults (integer)
NextToken (string)
networkmanager/get_transit_gateway_peeringReturns information about a transit gateway peer.PeeringId (string) required
networkmanager/get_transit_gateway_registrationsGets information about the transit gateway registrations in a specified global network.GlobalNetworkId (string) required
TransitGatewayArns (array)
MaxResults (integer)
NextToken (string)
networkmanager/get_transit_gateway_route_table_attachmentReturns information about a transit gateway route table attachment.AttachmentId (string) required
networkmanager/get_vpc_attachmentReturns information about a VPC attachment.AttachmentId (string) required
networkmanager/list_attachment_routing_policy_associationsLists the routing policy associations for attachments in a core network.CoreNetworkId (string) required
AttachmentId (string)
MaxResults (integer)
NextToken (string)
networkmanager/list_attachmentsReturns a list of core network attachments.CoreNetworkId (string)
AttachmentType (string)
EdgeLocation (string)
State (string)
MaxResults (integer)
NextToken (string)
networkmanager/list_connect_peersReturns a list of core network Connect peers.CoreNetworkId (string)
ConnectAttachmentId (string)
MaxResults (integer)
NextToken (string)
networkmanager/list_core_network_policy_versionsReturns a list of core network policy versions.CoreNetworkId (string) required
MaxResults (integer)
NextToken (string)
networkmanager/list_core_network_prefix_list_associationsLists the prefix list associations for a core network.CoreNetworkId (string) required
PrefixListArn (string)
MaxResults (integer)
NextToken (string)
networkmanager/list_core_network_routing_informationLists routing information for a core network, including routes and their attributes.CoreNetworkId (string) required
SegmentName (string) required
EdgeLocation (string) required
NextHopFilters (object)
LocalPreferenceMatches (array)
ExactAsPathMatches (array)
MedMatches (array)
CommunityMatches (array)
MaxResults (integer)
NextToken (string)
networkmanager/list_core_networksReturns a list of owned and shared core networks.MaxResults (integer)
NextToken (string)
networkmanager/list_organization_service_access_statusGets the status of the Service Linked Role SLR deployment for the accounts in a given Amazon Web Services Organization.MaxResults (integer)
NextToken (string)
networkmanager/list_peeringsLists the peerings for a core network.CoreNetworkId (string)
PeeringType (string)
EdgeLocation (string)
State (string)
MaxResults (integer)
NextToken (string)
networkmanager/list_tags_for_resourceLists the tags for a specified resource.ResourceArn (string) required
networkmanager/put_attachment_routing_policy_labelApplies a routing policy label to an attachment for traffic routing decisions.CoreNetworkId (string) required
AttachmentId (string) required
RoutingPolicyLabel (string) required
ClientToken (string)
networkmanager/put_core_network_policyCreates 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.CoreNetworkId (string) required
PolicyDocument (string) required
Description (string)
LatestVersionId (integer)
ClientToken (string)
networkmanager/put_resource_policyCreates or updates a resource policy.PolicyDocument (string) required
ResourceArn (string) required
networkmanager/register_transit_gatewayRegisters a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see Region Availability in the Amazon Web Services Transit Gateways for Global Networks User Guide. The transit gateway can be in any of the supported Amazon Web Services Regions, 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.GlobalNetworkId (string) required
TransitGatewayArn (string) required
networkmanager/reject_attachmentRejects a core network attachment request.AttachmentId (string) required
networkmanager/remove_attachment_routing_policy_labelRemoves a routing policy label from an attachment.CoreNetworkId (string) required
AttachmentId (string) required
networkmanager/restore_core_network_policy_versionRestores 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.CoreNetworkId (string) required
PolicyVersionId (integer) required
networkmanager/start_organization_service_access_updateEnables the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.Action (string) required
networkmanager/start_route_analysisStarts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.GlobalNetworkId (string) required
Source: {
. TransitGatewayAttachmentArn (string)
. IpAddress (string)
} (object) required
Destination: {
. TransitGatewayAttachmentArn (string)
. IpAddress (string)
} (object) required
IncludeReturnPath (boolean)
UseMiddleboxes (boolean)
networkmanager/tag_resourceTags a specified resource.ResourceArn (string) required
Tags (array) required
networkmanager/untag_resourceRemoves tags from a specified resource.ResourceArn (string) required
TagKeys (array) required
networkmanager/update_connectionUpdates the information for an existing connection. To remove information for any of the parameters, specify an empty string.GlobalNetworkId (string) required
ConnectionId (string) required
LinkId (string)
ConnectedLinkId (string)
Description (string)
networkmanager/update_core_networkUpdates the description of a core network.CoreNetworkId (string) required
Description (string)
networkmanager/update_deviceUpdates the details for an existing device. To remove information for any of the parameters, specify an empty string.GlobalNetworkId (string) required
DeviceId (string) required
AWSLocation: {
. Zone (string)
. SubnetArn (string)
} (object)
Description (string)
Type (string)
Vendor (string)
Model (string)
SerialNumber (string)
Location: {
. Address (string)
. Latitude (string)
. Longitude (string)
} (object)
SiteId (string)
networkmanager/update_direct_connect_gateway_attachmentUpdates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment.AttachmentId (string) required
EdgeLocations (array)
networkmanager/update_global_networkUpdates an existing global network. To remove information for any of the parameters, specify an empty string.GlobalNetworkId (string) required
Description (string)
networkmanager/update_linkUpdates the details for an existing link. To remove information for any of the parameters, specify an empty string.GlobalNetworkId (string) required
LinkId (string) required
Description (string)
Type (string)
Bandwidth: {
. UploadSpeed (integer)
. DownloadSpeed (integer)
} (object)
Provider (string)
networkmanager/update_network_resource_metadataUpdates the resource metadata for the specified global network.GlobalNetworkId (string) required
ResourceArn (string) required
Metadata (object) required
networkmanager/update_siteUpdates the information for an existing site. To remove information for any of the parameters, specify an empty string.GlobalNetworkId (string) required
SiteId (string) required
Description (string)
Location: {
. Address (string)
. Latitude (string)
. Longitude (string)
} (object)
networkmanager/update_vpc_attachmentUpdates a VPC attachment.AttachmentId (string) required
AddSubnetArns (array)
RemoveSubnetArns (array)
Options: {
. Ipv6Support (boolean)
. ApplianceModeSupport (boolean)
. DnsSupport (boolean)
. SecurityGroupReferencingSupport (boolean)
} (object)
networkmonitor/list_tags_for_resourceLists the tags assigned to this resource.resourceArn (string) required
networkmonitor/tag_resourceAdds key-value pairs to a monitor or probe.resourceArn (string) required
tags (object) required
networkmonitor/untag_resourceRemoves a key-value pair from a monitor or probe.resourceArn (string) required
tagKeys (array) required
networkmonitor/get_monitorReturns details about a specific monitor. This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.monitorName (string) required
networkmonitor/update_monitorUpdates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of either 30 or 60 seconds. This action requires the monitorName and probeId parameter. Run ListMonitors to get a list of monitor names.monitorName (string) required
aggregationPeriod (integer) required
networkmonitor/delete_monitorDeletes a specified monitor. This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.monitorName (string) required
networkmonitor/list_monitorsReturns a list of all of your monitors.nextToken (string)
maxResults (integer)
state (string)
networkmonitor/create_monitorCreates a monitor between a source subnet and destination IP address. Within a monitor you'll create one or more probes that monitor network traffic between your source Amazon Web Services VPC subnets and your destination IP addresses. Each probe then aggregates and sends metrics to Amazon CloudWatch. You can also create a monitor with probes using this command. For each probe, you define the following: source—The subnet IDs where the probes will be created. destination— The target destination ImonitorName (string) required
probes (array)
aggregationPeriod (integer)
clientToken (string)
tags (object)
networkmonitor/create_probeCreate a probe within a monitor. Once you create a probe, and it begins monitoring your network traffic, you'll incur billing charges for that probe. This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names. Note the name of the monitorName you want to create the probe for.monitorName (string) required
probe: {
. sourceArn (string)
. destination (string)
. destinationPort (integer)
. protocol (string)
. packetSize (integer)
. tags (object)
} (object) required
clientToken (string)
tags (object)
networkmonitor/get_probeReturns the details about a probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.monitorName (string) required
probeId (string) required
networkmonitor/update_probeUpdates a monitor probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs. You can update the following para create a monitor with probes using this command. For each probe, you define the following: state—The state of the probe. destination— The target destination IP address for the probe. destinationPort—Required only if the protocol is TCP. protocol—The communication protocolmonitorName (string) required
probeId (string) required
state (string)
destination (string)
destinationPort (integer)
protocol (string)
packetSize (integer)
networkmonitor/delete_probeDeletes the specified probe. Once a probe is deleted you'll no longer incur any billing fees for that probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs. You can only delete a single probe at a time using this action.monitorName (string) required
probeId (string) required
notifications/list_managed_notification_channel_associationsReturns a list of Account contacts and Channels associated with a ManagedNotificationConfiguration, in paginated format.managedNotificationConfigurationArn (string) required
maxResults (integer)
nextToken (string)
notifications/list_member_accountsReturns a list of member accounts associated with a notification configuration.notificationConfigurationArn (string) required
maxResults (integer)
nextToken (string)
memberAccount (string)
status (string)
organizationalUnitId (string)
notifications/list_tags_for_resourceReturns a list of tags for a specified Amazon Resource Name ARN. For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide. This is only supported for NotificationConfigurations.arn (string) required
notifications/tag_resourceTags the resource with a tag key and value. For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide. This is only supported for NotificationConfigurations.arn (string) required
tags (object) required
notifications/untag_resourceUntags a resource with a specified Amazon Resource Name ARN. For more information, see Tagging your Amazon Web Services resources in the Tagging Amazon Web Services Resources User Guide.arn (string) required
tagKeys (array) required
notifications/disassociate_channelDisassociates a Channel from a specified NotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails notifications-contacts.arn (string) required
notificationConfigurationArn (string) required
notifications/list_channelsReturns a list of Channels for a NotificationConfiguration.notificationConfigurationArn (string) required
maxResults (integer)
nextToken (string)
notifications/associate_channelAssociates a delivery Channel with a particular NotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails notifications-contacts.arn (string) required
notificationConfigurationArn (string) required
notifications/create_event_ruleCreates an EventRule that is associated with a specified NotificationConfiguration.notificationConfigurationArn (string) required
source (string) required
eventType (string) required
eventPattern (string)
regions (array) required
notifications/get_event_ruleReturns a specified EventRule.arn (string) required
notifications/delete_event_ruleDeletes an EventRule.arn (string) required
notifications/list_event_rulesReturns a list of EventRules according to specified filters, in reverse chronological order newest first.notificationConfigurationArn (string) required
maxResults (integer)
nextToken (string)
notifications/update_event_ruleUpdates an existing EventRule.arn (string) required
eventPattern (string)
regions (array)
notifications/disassociate_managed_notification_account_contactDisassociates an Account Contact with a particular ManagedNotificationConfiguration.contactIdentifier (string) required
managedNotificationConfigurationArn (string) required
notifications/associate_managed_notification_account_contactAssociates an Account Contact with a particular ManagedNotificationConfiguration.contactIdentifier (string) required
managedNotificationConfigurationArn (string) required
notifications/disassociate_managed_notification_additional_channelDisassociates an additional Channel from a particular ManagedNotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails notifications-contacts.channelArn (string) required
managedNotificationConfigurationArn (string) required
notifications/associate_managed_notification_additional_channelAssociates an additional Channel with a particular ManagedNotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails notifications-contacts.channelArn (string) required
managedNotificationConfigurationArn (string) required
notifications/get_managed_notification_child_eventReturns the child event of a specific given ManagedNotificationEvent.arn (string) required
locale (string)
notifications/list_managed_notification_child_eventsReturns a list of ManagedNotificationChildEvents for a specified aggregate ManagedNotificationEvent, ordered by creation time in reverse chronological order newest first.aggregateManagedNotificationEventArn (string) required
startTime (string)
endTime (string)
locale (string)
maxResults (integer)
relatedAccount (string)
organizationalUnitId (string)
nextToken (string)
notifications/get_managed_notification_configurationReturns a specified ManagedNotificationConfiguration.arn (string) required
notifications/list_managed_notification_configurationsReturns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order newest first.channelIdentifier (string)
maxResults (integer)
nextToken (string)
notifications/get_managed_notification_eventReturns a specified ManagedNotificationEvent.arn (string) required
locale (string)
notifications/list_managed_notification_eventsReturns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order newest first.startTime (string)
endTime (string)
locale (string)
source (string)
maxResults (integer)
nextToken (string)
organizationalUnitId (string)
relatedAccount (string)
notifications/create_notification_configurationCreates a new NotificationConfiguration.name (string) required
description (string) required
aggregationDuration (string)
tags (object)
notifications/get_notification_configurationReturns a specified NotificationConfiguration.arn (string) required
notifications/delete_notification_configurationDeletes a NotificationConfiguration.arn (string) required
notifications/list_notification_configurationsReturns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order newest first.eventRuleSource (string)
channelArn (string)
status (string)
subtype (string)
maxResults (integer)
nextToken (string)
notifications/update_notification_configurationUpdates a NotificationConfiguration.arn (string) required
name (string)
description (string)
aggregationDuration (string)
notifications/get_notification_eventReturns a specified NotificationEvent. User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, seearn (string) required
locale (string)
notifications/list_notification_eventsReturns a list of NotificationEvents according to specified filters, in reverse chronological order newest first. User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you makstartTime (string)
endTime (string)
locale (string)
source (string)
includeChildEvents (boolean)
aggregateNotificationEventArn (string)
maxResults (integer)
nextToken (string)
organizationalUnitId (string)
notifications/deregister_notification_hubDeregisters a NotificationConfiguration in the specified Region. You can't deregister the last NotificationHub in the account. NotificationEvents stored in the deregistered NotificationConfiguration are no longer be visible. Recreating a new NotificationConfiguration in the same Region restores access to those NotificationEvents.notificationHubRegion (string) required
notifications/list_notification_hubsReturns a list of NotificationHubs.maxResults (integer)
nextToken (string)
notifications/register_notification_hubRegisters a NotificationConfiguration in the specified Region. There is a maximum of one NotificationConfiguration per Region. You can have a maximum of 3 NotificationHub resources at a time.notificationHubRegion (string) required
notifications/get_notifications_access_for_organizationReturns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.No parameters
notifications/disable_notifications_access_for_organizationDisables service trust between User Notifications and Amazon Web Services Organizations.No parameters
notifications/enable_notifications_access_for_organizationEnables service trust between User Notifications and Amazon Web Services Organizations.No parameters
notifications/disassociate_organizational_unitRemoves the association between an organizational unit and a notification configuration.organizationalUnitId (string) required
notificationConfigurationArn (string) required
notifications/list_organizational_unitsReturns a list of organizational units associated with a notification configuration.notificationConfigurationArn (string) required
maxResults (integer)
nextToken (string)
notifications/associate_organizational_unitAssociates an organizational unit with a notification configuration.organizationalUnitId (string) required
notificationConfigurationArn (string) required
notificationscontacts/list_tags_for_resourceLists all of the tags associated with the Amazon Resource Name ARN that you specify. The resource can be a user, server, or role.arn (string) required
notificationscontacts/tag_resourceAttaches a key-value pair to a resource, as identified by its Amazon Resource Name ARN. Taggable resources in AWS User Notifications Contacts include email contacts.arn (string) required
tags (object) required
notificationscontacts/untag_resourceDetaches a key-value pair from a resource, as identified by its Amazon Resource Name ARN. Taggable resources in AWS User Notifications Contacts include email contacts..arn (string) required
tagKeys (array) required
notificationscontacts/activate_email_contactActivates an email contact using an activation code. This code is in the activation email sent to the email address associated with this email contact.arn (string) required
code (string) required
notificationscontacts/send_activation_codeSends an activation email to the email address associated with the specified email contact. It might take a few minutes for the activation email to arrive. If it doesn't arrive, check in your spam folder or try sending another activation email.arn (string) required
notificationscontacts/create_email_contactCreates an email contact for the provided email address.name (string) required
emailAddress (string) required
tags (object)
notificationscontacts/get_email_contactReturns an email contact.arn (string) required
notificationscontacts/delete_email_contactDeletes an email contact. Deleting an email contact removes it from all associated notification configurations.arn (string) required
notificationscontacts/list_email_contactsLists all email contacts created under the Account.maxResults (integer)
nextToken (string)
nova_act/invoke_act_stepExecutes the next step of an act, processing tool call results and returning new tool calls if needed.workflowDefinitionName (string) required
workflowRunId (string) required
sessionId (string) required
actId (string) required
callResults (array) required
previousStepId (string)
nova_act/update_actUpdates an existing act's configuration, status, or error information.workflowDefinitionName (string) required
workflowRunId (string) required
sessionId (string) required
actId (string) required
status (string) required
error: {
. message (string)
. type (string)
} (object)
nova_act/create_actCreates a new AI task act within a session that can interact with tools and perform specific actions.workflowDefinitionName (string) required
workflowRunId (string) required
sessionId (string) required
task (string) required
toolSpecs (array)
clientToken (string)
nova_act/list_actsLists all acts within a specific session with their current status and execution details.workflowDefinitionName (string) required
workflowRunId (string)
sessionId (string)
maxResults (integer)
nextToken (string)
sortOrder (string)
nova_act/list_modelsLists all available AI models that can be used for workflow execution, including their status and compatibility information.clientCompatibilityVersion (integer) required
nova_act/create_sessionCreates a new session context within a workflow run to manage conversation state and acts.workflowDefinitionName (string) required
workflowRunId (string) required
clientToken (string)
nova_act/list_sessionsLists all sessions within a specific workflow run.workflowDefinitionName (string) required
workflowRunId (string) required
maxResults (integer)
nextToken (string)
sortOrder (string)
nova_act/create_workflow_definitionCreates a new workflow definition template that can be used to execute multiple workflow runs.name (string) required
description (string)
exportConfig: {
. s3BucketName (string)
. s3KeyPrefix (string)
} (object)
clientToken (string)
nova_act/get_workflow_definitionRetrieves the details and configuration of a specific workflow definition.workflowDefinitionName (string) required
nova_act/delete_workflow_definitionDeletes a workflow definition and all associated resources. This operation cannot be undone.workflowDefinitionName (string) required
nova_act/list_workflow_definitionsLists all workflow definitions in your account with optional filtering and pagination.maxResults (integer)
nextToken (string)
sortOrder (string)
nova_act/create_workflow_runCreates a new execution instance of a workflow definition with specified parameters.workflowDefinitionName (string) required
modelId (string) required
clientToken (string)
logGroupName (string)
clientInfo: {
. compatibilityVersion (integer)
. sdkVersion (string)
} (object) required
nova_act/get_workflow_runRetrieves the current state, configuration, and execution details of a workflow run.workflowDefinitionName (string) required
workflowRunId (string) required
nova_act/update_workflow_runUpdates the configuration or state of an active workflow run.workflowDefinitionName (string) required
workflowRunId (string) required
status (string) required
nova_act/delete_workflow_runTerminates and cleans up a workflow run, stopping all associated acts and sessions.workflowDefinitionName (string) required
workflowRunId (string) required
nova_act/list_workflow_runsLists all workflow runs for a specific workflow definition with optional filtering and pagination.workflowDefinitionName (string) required
maxResults (integer)
nextToken (string)
sortOrder (string)
oam/create_linkCreates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account. Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policyLabelTemplate (string) required
ResourceTypes (array) required
SinkIdentifier (string) required
Tags (object)
LinkConfiguration: {
. LogGroupConfiguration (object)
. MetricConfiguration (object)
} (object)
oam/create_sinkUse this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data. After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy. Each account can contain one sink per Region. If you delete a sink, youName (string) required
Tags (object)
oam/delete_linkDeletes a link between a monitoring account sink and a source account. You must run this operation in the source account.Identifier (string) required
oam/delete_sinkDeletes a sink. You must delete all links to a sink before you can delete that sink.Identifier (string) required
oam/get_linkReturns complete information about one link. To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.Identifier (string) required
IncludeTags (boolean)
oam/get_sinkReturns complete information about one monitoring account sink. To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.Identifier (string) required
IncludeTags (boolean)
oam/get_sink_policyReturns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.SinkIdentifier (string) required
oam/list_attached_linksReturns a list of source account links that are linked to this monitoring account sink. To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks. To find a list of links for one source account, use ListLinks.MaxResults (integer)
NextToken (string)
SinkIdentifier (string) required
oam/list_linksUse this operation in a source account to return a list of links to monitoring account sinks that this source account has. To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.MaxResults (integer)
NextToken (string)
oam/list_sinksUse this operation in a monitoring account to return the list of sinks created in that account.MaxResults (integer)
NextToken (string)
oam/list_tags_for_resourceDisplays the tags associated with a resource. Both sinks and links support tagging.ResourceArn (string) required
oam/put_sink_policyCreates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts. You can also use a sink policy to limit the types of data that is shared. The six types of services with their respective resource types that you can allow or deny are: Metrics - Specify with AWS::CloudWatch::Metric Log groups - Specify with AWS::Logs::LogGroSinkIdentifier (string) required
Policy (string) required
oam/tag_resourceAssigns one or more tags key-value pairs to the specified resource. Both sinks and links 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 specResourceArn (string) required
Tags (object) required
oam/untag_resourceRemoves one or more tags from the specified resource. Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:TagResource permission does not allow you to tag and untag links and sinks.ResourceArn (string) required
TagKeys (array) required
oam/update_linkUse this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation. When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account. To update the list of tags associated with the sink, use TagResource.Identifier (string) required
ResourceTypes (array) required
LinkConfiguration: {
. LogGroupConfiguration (object)
. MetricConfiguration (object)
} (object)
IncludeTags (boolean)
observabilityadmin/create_centralization_rule_for_organizationCreates a centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.RuleName (string) required
Rule: {
. Source (object)
. Destination (object)
} (object) required
Tags (object)
observabilityadmin/create_s3table_integrationCreates an integration between CloudWatch and S3 Tables for analytics. This integration enables querying CloudWatch telemetry data using analytics engines like Amazon Athena, Amazon Redshift, and Apache Spark.Encryption: {
. SseAlgorithm (string)
. KmsKeyArn (string)
} (object) required
RoleArn (string) required
Tags (object)
observabilityadmin/create_telemetry_ruleCreates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.RuleName (string) required
Rule: {
. ResourceType (string)
. TelemetryType (string)
. TelemetrySourceTypes (array)
. DestinationConfiguration (object)
. Scope (string)
. SelectionCriteria (string)
} (object) required
Tags (object)
observabilityadmin/create_telemetry_rule_for_organizationCreates a telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.RuleName (string) required
Rule: {
. ResourceType (string)
. TelemetryType (string)
. TelemetrySourceTypes (array)
. DestinationConfiguration (object)
. Scope (string)
. SelectionCriteria (string)
} (object) required
Tags (object)
observabilityadmin/delete_centralization_rule_for_organizationDeletes an organization-wide centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.RuleIdentifier (string) required
observabilityadmin/delete_s3table_integrationDeletes an S3 Table integration and its associated data. This operation removes the connection between CloudWatch Observability Admin and S3 Tables.Arn (string) required
observabilityadmin/delete_telemetry_ruleDeletes a telemetry rule from your account. Any telemetry configurations previously created by the rule will remain but no new resources will be configured by this rule.RuleIdentifier (string) required
observabilityadmin/delete_telemetry_rule_for_organizationDeletes an organization-wide telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.RuleIdentifier (string) required
observabilityadmin/get_centralization_rule_for_organizationRetrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.RuleIdentifier (string) required
observabilityadmin/get_s3table_integrationRetrieves information about a specific S3 Table integration, including its configuration, status, and metadata.Arn (string) required
observabilityadmin/get_telemetry_enrichment_statusReturns the current status of the resource tags for telemetry feature, which enhances telemetry data with additional resource metadata from Resource Explorer.No parameters
observabilityadmin/get_telemetry_evaluation_statusReturns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.No parameters
observabilityadmin/get_telemetry_evaluation_status_for_organizationThis returns the onboarding status of the telemetry configuration feature for the organization. It can only be called by a Management Account of an Amazon Web Services Organization or an assigned Delegated Admin Account of Amazon CloudWatch telemetry config.No parameters
observabilityadmin/get_telemetry_ruleRetrieves the details of a specific telemetry rule in your account.RuleIdentifier (string) required
observabilityadmin/get_telemetry_rule_for_organizationRetrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.RuleIdentifier (string) required
observabilityadmin/list_centralization_rules_for_organizationLists all centralization rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.RuleNamePrefix (string)
AllRegions (boolean)
MaxResults (integer)
NextToken (string)
observabilityadmin/list_resource_telemetryReturns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config. For more information, see Auditing CloudWatch telemetry configurations.ResourceIdentifierPrefix (string)
ResourceTypes (array)
TelemetryConfigurationState (object)
ResourceTags (object)
MaxResults (integer)
NextToken (string)
observabilityadmin/list_resource_telemetry_for_organizationReturns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization.AccountIdentifiers (array)
ResourceIdentifierPrefix (string)
ResourceTypes (array)
TelemetryConfigurationState (object)
ResourceTags (object)
MaxResults (integer)
NextToken (string)
observabilityadmin/list_s3table_integrationsLists all S3 Table integrations in your account. We recommend using pagination to ensure that the operation returns quickly and successfully.MaxResults (integer)
NextToken (string)
observabilityadmin/list_tags_for_resourceLists all tags attached to the specified resource. Supports telemetry rule resources and telemetry pipeline resources.ResourceARN (string) required
observabilityadmin/list_telemetry_rulesLists all telemetry rules in your account. You can filter the results by specifying a rule name prefix.RuleNamePrefix (string)
MaxResults (integer)
NextToken (string)
observabilityadmin/list_telemetry_rules_for_organizationLists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.RuleNamePrefix (string)
SourceAccountIds (array)
SourceOrganizationUnitIds (array)
MaxResults (integer)
NextToken (string)
observabilityadmin/start_telemetry_enrichmentEnables the resource tags for telemetry feature for your account, which enhances telemetry data with additional resource metadata from Resource Explorer to provide richer context for monitoring and observability.No parameters
observabilityadmin/start_telemetry_evaluationThis action begins onboarding the caller Amazon Web Services account to the telemetry config feature.No parameters
observabilityadmin/start_telemetry_evaluation_for_organizationThis actions begins onboarding the organization and all member accounts to the telemetry config feature.No parameters
observabilityadmin/stop_telemetry_enrichmentDisables the resource tags for telemetry feature for your account, stopping the enhancement of telemetry data with additional resource metadata.No parameters
observabilityadmin/stop_telemetry_evaluationThis action begins offboarding the caller Amazon Web Services account from the telemetry config feature.No parameters
observabilityadmin/stop_telemetry_evaluation_for_organizationThis action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature.No parameters
observabilityadmin/tag_resourceAdds or updates tags for a resource. Supports telemetry rule resources and telemetry pipeline resources.ResourceARN (string) required
Tags (object) required
observabilityadmin/test_telemetry_pipelineTests a pipeline configuration with sample records to validate data processing before deployment. This operation helps ensure your pipeline configuration works as expected.Records (array) required
Configuration: {
. Body (string)
} (object) required
observabilityadmin/untag_resourceRemoves tags from a resource. Supports telemetry rule resources and telemetry pipeline resources.ResourceARN (string) required
TagKeys (array) required
observabilityadmin/update_centralization_rule_for_organizationUpdates an existing centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.RuleIdentifier (string) required
Rule: {
. Source (object)
. Destination (object)
} (object) required
observabilityadmin/update_telemetry_ruleUpdates an existing telemetry rule in your account. If multiple users attempt to modify the same telemetry rule simultaneously, a ConflictException is returned to provide specific error information for concurrent modification scenarios.RuleIdentifier (string) required
Rule: {
. ResourceType (string)
. TelemetryType (string)
. TelemetrySourceTypes (array)
. DestinationConfiguration (object)
. Scope (string)
. SelectionCriteria (string)
} (object) required
observabilityadmin/update_telemetry_rule_for_organizationUpdates an existing telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.RuleIdentifier (string) required
Rule: {
. ResourceType (string)
. TelemetryType (string)
. TelemetrySourceTypes (array)
. DestinationConfiguration (object)
. Scope (string)
. SelectionCriteria (string)
} (object) required
observabilityadmin/validate_telemetry_pipeline_configurationValidates a pipeline configuration without creating the pipeline. This operation checks the configuration for syntax errors and compatibility issues.Configuration: {
. Body (string)
} (object) required
observabilityadmin/create_telemetry_pipelineCreates a telemetry pipeline for processing and transforming telemetry data. The pipeline defines how data flows from sources through processors to destinations, enabling data transformation and delivering capabilities.Name (string) required
Configuration: {
. Body (string)
} (object) required
Tags (object)
observabilityadmin/get_telemetry_pipelineRetrieves information about a specific telemetry pipeline, including its configuration, status, and metadata.PipelineIdentifier (string) required
observabilityadmin/update_telemetry_pipelineUpdates the configuration of an existing telemetry pipeline. The following attributes cannot be updated after pipeline creation: Pipeline name - The pipeline name is immutable Pipeline ARN - The ARN is automatically generated and cannot be changed Source type - Once a pipeline is created with a specific source type such as S3, CloudWatch Logs, GitHub, or third-party sources, it cannot be changed to a different source type Processors can be added, removed, or modified. However, some processors arPipelineIdentifier (string) required
Configuration: {
. Body (string)
} (object) required
observabilityadmin/delete_telemetry_pipelineDeletes a telemetry pipeline and its associated resources. This operation stops data processing and removes the pipeline configuration.PipelineIdentifier (string) required
observabilityadmin/list_telemetry_pipelinesReturns a list of telemetry pipelines in your account. Returns up to 100 results. If more than 100 telemetry pipelines exist, include the NextToken value from the response to retrieve the next set of results.MaxResults (integer)
NextToken (string)
odb/accept_marketplace_registrationRegisters the Amazon Web Services Marketplace token for your Amazon Web Services account to activate your Oracle Database@Amazon Web Services subscription.marketplaceRegistrationToken (string) required
odb/associate_iam_role_to_resourceAssociates an Amazon Web Services Identity and Access Management IAM service role with a specified resource to enable Amazon Web Services service integration.iamRoleArn (string) required
awsIntegration (string) required
resourceArn (string) required
odb/disassociate_iam_role_from_resourceDisassociates an Amazon Web Services Identity and Access Management IAM service role from a specified resource to disable Amazon Web Services service integration.iamRoleArn (string) required
awsIntegration (string) required
resourceArn (string) required
odb/get_oci_onboarding_statusReturns the tenancy activation link and onboarding status for your Amazon Web Services account.No parameters
odb/initialize_serviceInitializes the ODB service for the first time in an account.ociIdentityDomain (boolean)
odb/list_db_system_shapesReturns information about the shapes that are available for an Exadata infrastructure.maxResults (integer)
nextToken (string)
availabilityZone (string)
availabilityZoneId (string)
odb/list_gi_versionsReturns information about Oracle Grid Infrastructure GI software versions that are available for a VM cluster for the specified shape.maxResults (integer)
nextToken (string)
shape (string)
odb/list_system_versionsReturns information about the system versions that are available for a VM cluster for the specified giVersion and shape.maxResults (integer)
nextToken (string)
giVersion (string) required
shape (string) required
odb/list_tags_for_resourceReturns information about the tags applied to this resource.resourceArn (string) required
odb/tag_resourceApplies tags to the specified resource.resourceArn (string) required
tags (object) required
odb/untag_resourceRemoves tags from the specified resource.resourceArn (string) required
tagKeys (array) required
odb/list_autonomous_virtual_machinesLists all Autonomous VMs in an Autonomous VM cluster.maxResults (integer)
nextToken (string)
cloudAutonomousVmClusterId (string) required
odb/create_cloud_autonomous_vm_clusterCreates a new Autonomous VM cluster in the specified Exadata infrastructure.cloudExadataInfrastructureId (string) required
odbNetworkId (string) required
displayName (string) required
clientToken (string)
autonomousDataStorageSizeInTBs (number) required
cpuCoreCountPerNode (integer) required
dbServers (array)
description (string)
isMtlsEnabledVmCluster (boolean)
licenseModel (string)
maintenanceWindow: {
. customActionTimeoutInMins (integer)
. daysOfWeek (array)
. hoursOfDay (array)
. isCustomActionTimeoutEnabled (boolean)
. leadTimeInWeeks (integer)
. months (array)
. patchingMode (string)
. preference (string)
. skipRu (boolean)
. weeksOfMonth (array)
} (object)
memoryPerOracleComputeUnitInGBs (integer) required
scanListenerPortNonTls (integer)
scanListenerPortTls (integer)
tags (object)
timeZone (string)
totalContainerDatabases (integer) required
odb/get_cloud_autonomous_vm_clusterGets information about a specific Autonomous VM cluster.cloudAutonomousVmClusterId (string) required
odb/delete_cloud_autonomous_vm_clusterDeletes an Autonomous VM cluster.cloudAutonomousVmClusterId (string) required
odb/list_cloud_autonomous_vm_clustersLists all Autonomous VM clusters in a specified Cloud Exadata infrastructure.maxResults (integer)
nextToken (string)
cloudExadataInfrastructureId (string)
odb/get_cloud_exadata_infrastructure_unallocated_resourcesRetrieves information about unallocated resources in a specified Cloud Exadata Infrastructure.cloudExadataInfrastructureId (string) required
dbServers (array)
odb/get_db_serverReturns information about the specified database server.cloudExadataInfrastructureId (string) required
dbServerId (string) required
odb/list_db_serversReturns information about the database servers that belong to the specified Exadata infrastructure.cloudExadataInfrastructureId (string) required
maxResults (integer)
nextToken (string)
odb/create_cloud_exadata_infrastructureCreates an Exadata infrastructure.displayName (string) required
shape (string) required
availabilityZone (string)
availabilityZoneId (string)
tags (object)
computeCount (integer) required
customerContactsToSendToOCI (array)
maintenanceWindow: {
. customActionTimeoutInMins (integer)
. daysOfWeek (array)
. hoursOfDay (array)
. isCustomActionTimeoutEnabled (boolean)
. leadTimeInWeeks (integer)
. months (array)
. patchingMode (string)
. preference (string)
. skipRu (boolean)
. weeksOfMonth (array)
} (object)
storageCount (integer) required
clientToken (string)
databaseServerType (string)
storageServerType (string)
odb/get_cloud_exadata_infrastructureReturns information about the specified Exadata infrastructure.cloudExadataInfrastructureId (string) required
odb/update_cloud_exadata_infrastructureUpdates the properties of an Exadata infrastructure resource.cloudExadataInfrastructureId (string) required
maintenanceWindow: {
. customActionTimeoutInMins (integer)
. daysOfWeek (array)
. hoursOfDay (array)
. isCustomActionTimeoutEnabled (boolean)
. leadTimeInWeeks (integer)
. months (array)
. patchingMode (string)
. preference (string)
. skipRu (boolean)
. weeksOfMonth (array)
} (object)
odb/delete_cloud_exadata_infrastructureDeletes the specified Exadata infrastructure. Before you use this operation, make sure to delete all of the VM clusters that are hosted on this Exadata infrastructure.cloudExadataInfrastructureId (string) required
odb/list_cloud_exadata_infrastructuresReturns information about the Exadata infrastructures owned by your Amazon Web Services account.maxResults (integer)
nextToken (string)
odb/create_cloud_vm_clusterCreates a VM cluster on the specified Exadata infrastructure.cloudExadataInfrastructureId (string) required
cpuCoreCount (integer) required
displayName (string) required
giVersion (string) required
hostname (string) required
sshPublicKeys (array) required
odbNetworkId (string) required
clusterName (string)
dataCollectionOptions: {
. isDiagnosticsEventsEnabled (boolean)
. isHealthMonitoringEnabled (boolean)
. isIncidentLogsEnabled (boolean)
} (object)
dataStorageSizeInTBs (number)
dbNodeStorageSizeInGBs (integer)
dbServers (array)
tags (object)
isLocalBackupEnabled (boolean)
isSparseDiskgroupEnabled (boolean)
licenseModel (string)
memorySizeInGBs (integer)
systemVersion (string)
timeZone (string)
clientToken (string)
scanListenerPortTcp (integer)
odb/get_cloud_vm_clusterReturns information about the specified VM cluster.cloudVmClusterId (string) required
odb/delete_cloud_vm_clusterDeletes the specified VM cluster.cloudVmClusterId (string) required
odb/list_cloud_vm_clustersReturns information about the VM clusters owned by your Amazon Web Services account or only the ones on the specified Exadata infrastructure.maxResults (integer)
nextToken (string)
cloudExadataInfrastructureId (string)
odb/reboot_db_nodeReboots the specified DB node in a VM cluster.cloudVmClusterId (string) required
dbNodeId (string) required
odb/start_db_nodeStarts the specified DB node in a VM cluster.cloudVmClusterId (string) required
dbNodeId (string) required
odb/stop_db_nodeStops the specified DB node in a VM cluster.cloudVmClusterId (string) required
dbNodeId (string) required
odb/get_db_nodeReturns information about the specified DB node.cloudVmClusterId (string) required
dbNodeId (string) required
odb/list_db_nodesReturns information about the DB nodes for the specified VM cluster.maxResults (integer)
nextToken (string)
cloudVmClusterId (string) required
odb/create_odb_networkCreates an ODB network.displayName (string) required
availabilityZone (string)
availabilityZoneId (string)
clientSubnetCidr (string) required
backupSubnetCidr (string)
customDomainName (string)
defaultDnsPrefix (string)
clientToken (string)
s3Access (string)
zeroEtlAccess (string)
stsAccess (string)
kmsAccess (string)
s3PolicyDocument (string)
stsPolicyDocument (string)
kmsPolicyDocument (string)
crossRegionS3RestoreSourcesToEnable (array)
tags (object)
odb/get_odb_networkReturns information about the specified ODB network.odbNetworkId (string) required
odb/update_odb_networkUpdates properties of a specified ODB network.odbNetworkId (string) required
displayName (string)
peeredCidrsToBeAdded (array)
peeredCidrsToBeRemoved (array)
s3Access (string)
zeroEtlAccess (string)
stsAccess (string)
kmsAccess (string)
s3PolicyDocument (string)
stsPolicyDocument (string)
kmsPolicyDocument (string)
crossRegionS3RestoreSourcesToEnable (array)
crossRegionS3RestoreSourcesToDisable (array)
odb/delete_odb_networkDeletes the specified ODB network.odbNetworkId (string) required
deleteAssociatedResources (boolean) required
odb/list_odb_networksReturns information about the ODB networks owned by your Amazon Web Services account.maxResults (integer)
nextToken (string)
odb/create_odb_peering_connectionCreates a peering connection between an ODB network and a VPC. A peering connection enables private connectivity between the networks for application-tier communication.odbNetworkId (string) required
peerNetworkId (string) required
displayName (string)
peerNetworkCidrsToBeAdded (array)
clientToken (string)
tags (object)
odb/get_odb_peering_connectionRetrieves information about an ODB peering connection.odbPeeringConnectionId (string) required
odb/update_odb_peering_connectionModifies the settings of an Oracle Database@Amazon Web Services peering connection. You can update the display name and add or remove CIDR blocks from the peering connection.odbPeeringConnectionId (string) required
displayName (string)
peerNetworkCidrsToBeAdded (array)
peerNetworkCidrsToBeRemoved (array)
odb/delete_odb_peering_connectionDeletes an ODB peering connection. When you delete an ODB peering connection, the underlying VPC peering connection is also deleted.odbPeeringConnectionId (string) required
odb/list_odb_peering_connectionsLists all ODB peering connections or those associated with a specific ODB network.maxResults (integer)
nextToken (string)
odbNetworkId (string)
omics/delete_s3access_policyDeletes an access policy for the specified store.s3AccessPointArn (string) required
omics/get_s3access_policyRetrieves details about an access policy on a given store.s3AccessPointArn (string) required
omics/put_s3access_policyAdds an access policy to the specified store.s3AccessPointArn (string) required
s3AccessPolicy (string) required
omics/start_annotation_import_jobAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Starts an annotation import job.destinationName (string) required
roleArn (string) required
items (array) required
versionName (string)
formatOptions (undefined)
runLeftNormalization (boolean)
annotationFields (object)
omics/get_annotation_import_jobAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about an annotation import job.jobId (string) required
omics/cancel_annotation_import_jobAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Cancels an annotation import job.jobId (string) required
omics/list_annotation_import_jobsAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of annotation import jobs.maxResults (integer)
ids (array)
nextToken (string)
filter: {
. status (string)
. storeName (string)
} (object)
omics/create_annotation_storeAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Creates an annotation store.reference (undefined)
name (string)
description (string)
tags (object)
versionName (string)
sseConfig: {
. type (string)
. keyArn (string)
} (object)
storeFormat (string) required
storeOptions (undefined)
omics/get_annotation_storeAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about an annotation store.name (string) required
omics/update_annotation_storeAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Updates an annotation store.name (string) required
description (string)
omics/delete_annotation_storeAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Deletes an annotation store.name (string) required
force (boolean)
omics/list_annotation_storesAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of annotation stores.ids (array)
maxResults (integer)
nextToken (string)
filter: {
. status (string)
} (object)
omics/delete_annotation_store_versionsDeletes one or multiple versions of an annotation store.name (string) required
versions (array) required
force (boolean)
omics/create_annotation_store_versionCreates a new version of an annotation store.name (string) required
versionName (string) required
description (string)
versionOptions (undefined)
tags (object)
omics/get_annotation_store_versionRetrieves the metadata for an annotation store version.name (string) required
versionName (string) required
omics/update_annotation_store_versionUpdates the description of an annotation store version.name (string) required
versionName (string) required
description (string)
omics/list_annotation_store_versionsLists the versions of an annotation store.name (string) required
maxResults (integer)
nextToken (string)
filter: {
. status (string)
} (object)
omics/get_reference_import_jobMonitors the status of a reference import job. This operation can be called after calling the StartReferenceImportJob operation.id (string) required
referenceStoreId (string) required
omics/list_reference_import_jobsRetrieves the metadata of one or more reference import jobs for a reference store.maxResults (integer)
nextToken (string)
referenceStoreId (string) required
filter: {
. status (string)
. createdAfter (string)
. createdBefore (string)
} (object)
omics/start_reference_import_jobImports a reference genome from Amazon S3 into a specified reference store. You can have multiple reference genomes in a reference store. You can only import reference genomes one at a time into each reference store. Monitor the status of your reference import job by using the GetReferenceImportJob API operation.referenceStoreId (string) required
roleArn (string) required
clientToken (string)
sources (array) required
omics/create_reference_storeCreates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the StartReferenceImportJob API operation. For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.name (string) required
description (string)
sseConfig: {
. type (string)
. keyArn (string)
} (object)
tags (object)
clientToken (string)
omics/get_reference_storeGets information about a reference store.id (string) required
omics/delete_reference_storeDeletes a reference store and returns a response with no body if the operation is successful. You can only delete a reference store when it does not contain any reference genomes. To empty a reference store, use DeleteReference. For more information about your workflow status, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.id (string) required
omics/list_reference_storesRetrieves a list of reference stores linked to your account and returns their metadata in JSON format. For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.maxResults (integer)
nextToken (string)
filter: {
. name (string)
. createdAfter (string)
. createdBefore (string)
} (object)
omics/get_referenceDownloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded. For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.id (string) required
referenceStoreId (string) required
range (string)
partNumber (integer) required
file (string)
omics/get_reference_metadataRetrieves metadata for a reference genome. This operation returns the number of parts, part size, and MD5 of an entire file. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.id (string) required
referenceStoreId (string) required
omics/delete_referenceDeletes a reference genome and returns a response with no body if the operation is successful. The read set associated with the reference genome must first be deleted before deleting the reference genome. After the reference genome is deleted, you can delete the reference store using the DeleteReferenceStore API operation. For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.id (string) required
referenceStoreId (string) required
omics/list_referencesRetrieves the metadata of one or more reference genomes in a reference store. For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.referenceStoreId (string) required
maxResults (integer)
nextToken (string)
filter: {
. name (string)
. md5 (string)
. createdAfter (string)
. createdBefore (string)
} (object)
omics/create_run_cacheCreates a run cache to store and reference task outputs from completed private runs. Specify an Amazon S3 location where Amazon Web Services HealthOmics saves the cached data. This data must be immediately accessible and not in an archived state. You can save intermediate task files to a run cache if they are declared as task outputs in the workflow definition file. For more information, see Call caching and Creating a run cache in the Amazon Web Services HealthOmics User Guide.cacheBehavior (string)
cacheS3Location (string) required
description (string)
name (string)
requestId (string) required
tags (object)
cacheBucketOwnerId (string)
omics/get_run_cacheRetrieves detailed information about the specified run cache using its ID. For more information, see Call caching for Amazon Web Services HealthOmics runs in the Amazon Web Services HealthOmics User Guide.id (string) required
omics/update_run_cacheUpdates a run cache using its ID and returns a response with no body if the operation is successful. You can update the run cache description, name, or the default run cache behavior with CACHE_ON_FAILURE or CACHE_ALWAYS. To confirm that your run cache settings have been properly updated, use the GetRunCache API operation. For more information, see How call caching works in the Amazon Web Services HealthOmics User Guide.cacheBehavior (string)
description (string)
id (string) required
name (string)
omics/delete_run_cacheDeletes a run cache and returns a response with no body if the operation is successful. This action removes the cache metadata stored in the service account, but does not delete the data in Amazon S3. You can access the cache data in Amazon S3, for inspection or to troubleshoot issues. You can remove old cache data using standard S3 Delete operations. For more information, see Deleting a run cache in the Amazon Web Services HealthOmics User Guide.id (string) required
omics/list_run_cachesRetrieves a list of your run caches and the metadata for each cache.maxResults (integer)
startingToken (string)
omics/create_run_groupCreates a run group to limit the compute resources for the runs that are added to the group. Returns an ARN, ID, and tags for the run group.name (string)
maxCpus (integer)
maxRuns (integer)
maxDuration (integer)
tags (object)
requestId (string) required
maxGpus (integer)
omics/get_run_groupGets information about a run group and returns its metadata.id (string) required
omics/update_run_groupUpdates the settings of a run group and returns a response with no body if the operation is successful. You can update the following settings with UpdateRunGroup: Maximum number of CPUs Run time measured in minutes Number of GPUs Number of concurrent runs Group name To confirm that the settings have been successfully updated, use the ListRunGroups or GetRunGroup API operations to verify that the desired changes have been made.id (string) required
name (string)
maxCpus (integer)
maxRuns (integer)
maxDuration (integer)
maxGpus (integer)
omics/delete_run_groupDeletes a run group and returns a response with no body if the operation is successful. To verify that the run group is deleted: Use ListRunGroups to confirm the workflow no longer appears in the list. Use GetRunGroup to verify the workflow cannot be found.id (string) required
omics/list_run_groupsRetrieves a list of all run groups and returns the metadata for each run group.name (string)
startingToken (string)
maxResults (integer)
omics/cancel_runCancels a run using its ID and returns a response with no body if the operation is successful. To confirm that the run has been cancelled, use the ListRuns API operation to check that it is no longer listed.id (string) required
omics/start_runStarts a new run and returns details about the run, or duplicates an existing run. A run is a single invocation of a workflow. If you provide request IDs, Amazon Web Services HealthOmics identifies duplicate requests and starts the run only once. Monitor the progress of the run by calling the GetRun API operation. To start a new run, the following inputs are required: A service role ARN roleArn. The run's workflow ID workflowId, not the uuid or runId. An Amazon S3 location outputUri where the ruworkflowId (string)
workflowType (string)
runId (string)
roleArn (string) required
name (string)
cacheId (string)
cacheBehavior (string)
runGroupId (string)
priority (integer)
parameters (undefined)
storageCapacity (integer)
outputUri (string) required
logLevel (string)
tags (object)
requestId (string) required
retentionMode (string)
storageType (string)
workflowOwnerId (string)
workflowVersionName (string)
omics/get_runGets detailed information about a specific run using its ID. Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If GetRun does not return the requested run, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.id (string) required
export (array)
omics/delete_runDeletes a run and returns a response with no body if the operation is successful. You can only delete a run that has reached a COMPLETED, FAILED, or CANCELLED stage. A completed run has delivered an output, or was cancelled and resulted in no output. When you delete a run, only the metadata associated with the run is deleted. The run outputs remain in Amazon S3 and logs remain in CloudWatch. To verify that the workflow is deleted: Use ListRuns to confirm the workflow no longer appears in the lisid (string) required
omics/list_runsRetrieves a list of runs and returns each run's metadata and status. Amazon Web Services HealthOmics stores a configurable number of runs, as determined by service limits, that are available to the console and API. If the ListRuns response doesn't include specific runs that you expected, you can find all run logs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the Amazon Web Services HealthOmics User Guide.name (string)
runGroupId (string)
startingToken (string)
maxResults (integer)
status (string)
omics/get_run_taskGets detailed information about a run task using its ID.id (string) required
taskId (string) required
omics/list_run_tasksReturns a list of tasks and status information within their specified run. Use this operation to monitor runs and to identify which specific tasks have failed.id (string) required
status (string)
startingToken (string)
maxResults (integer)
omics/abort_multipart_read_set_uploadStops a multipart read set upload into a sequence store and returns a response with no body if the operation is successful. To confirm that a multipart read set upload has been stopped, use the ListMultipartReadSetUploads API operation to view all active multipart read set uploads.sequenceStoreId (string) required
uploadId (string) required
omics/complete_multipart_read_set_uploadCompletes a multipart read set upload into a sequence store after you have initiated the upload process with CreateMultipartReadSetUpload and uploaded all read set parts using UploadReadSetPart. You must specify the parts you uploaded using the parts parameter. If the operation is successful, it returns the read set IDs of the uploaded read sets. For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.sequenceStoreId (string) required
uploadId (string) required
parts (array) required
omics/create_multipart_read_set_uploadInitiates a multipart read set upload for uploading partitioned source files into a sequence store. You can directly import source files from an EC2 instance and other local compute, or from an S3 bucket. To separate these source files into parts, use the split operation. Each part cannot be larger than 100 MB. If the operation is successful, it provides an uploadId which is required by the UploadReadSetPart API operation to upload parts into a sequence store. To continue uploading a multipart rsequenceStoreId (string) required
clientToken (string)
sourceFileType (string) required
subjectId (string) required
sampleId (string) required
generatedFrom (string)
referenceArn (string)
name (string) required
description (string)
tags (object)
omics/get_read_set_activation_jobReturns detailed information about the status of a read set activation job in JSON format.id (string) required
sequenceStoreId (string) required
omics/get_read_set_export_jobRetrieves status information about a read set export job and returns the data in JSON format. Use this operation to actively monitor the progress of an export job.sequenceStoreId (string) required
id (string) required
omics/get_read_set_import_jobGets detailed and status information about a read set import job and returns the data in JSON format.id (string) required
sequenceStoreId (string) required
omics/list_multipart_read_set_uploadsLists in-progress multipart read set uploads for a sequence store and returns it in a JSON formatted output. Multipart read set uploads are initiated by the CreateMultipartReadSetUploads API operation. This operation returns a response with no body when the upload is complete.sequenceStoreId (string) required
maxResults (integer)
nextToken (string)
omics/list_read_set_activation_jobsRetrieves a list of read set activation jobs and returns the metadata in a JSON formatted output. To extract metadata from a read set activation job, use the GetReadSetActivationJob API operation.sequenceStoreId (string) required
maxResults (integer)
nextToken (string)
filter: {
. status (string)
. createdAfter (string)
. createdBefore (string)
} (object)
omics/list_read_set_export_jobsRetrieves a list of read set export jobs in a JSON formatted response. This API operation is used to check the status of a read set export job initiated by the StartReadSetExportJob API operation.sequenceStoreId (string) required
maxResults (integer)
nextToken (string)
filter: {
. status (string)
. createdAfter (string)
. createdBefore (string)
} (object)
omics/list_read_set_import_jobsRetrieves a list of read set import jobs and returns the data in JSON format.maxResults (integer)
nextToken (string)
sequenceStoreId (string) required
filter: {
. status (string)
. createdAfter (string)
. createdBefore (string)
} (object)
omics/list_read_set_upload_partsLists all parts in a multipart read set upload for a sequence store and returns the metadata in a JSON formatted output.sequenceStoreId (string) required
uploadId (string) required
partSource (string) required
maxResults (integer)
nextToken (string)
filter: {
. createdAfter (string)
. createdBefore (string)
} (object)
omics/start_read_set_activation_jobActivates an archived read set and returns its metadata in a JSON formatted output. AWS HealthOmics automatically archives unused read sets after 30 days. To monitor the status of your read set activation job, use the GetReadSetActivationJob operation. To learn more, see Activating read sets in the Amazon Web Services HealthOmics User Guide.sequenceStoreId (string) required
clientToken (string)
sources (array) required
omics/start_read_set_export_jobStarts a read set export job. When the export job is finished, the read set is exported to an Amazon S3 bucket which can be retrieved using the GetReadSetExportJob API operation. To monitor the status of the export job, use the ListReadSetExportJobs API operation.sequenceStoreId (string) required
destination (string) required
roleArn (string) required
clientToken (string)
sources (array) required
omics/start_read_set_import_jobImports a read set from the sequence store. Read set import jobs support a maximum of 100 read sets of different types. Monitor the progress of your read set import job by calling the GetReadSetImportJob API operation.sequenceStoreId (string) required
roleArn (string) required
clientToken (string)
sources (array) required
omics/upload_read_set_partUploads a specific part of a read set into a sequence store. When you a upload a read set part with a part number that already exists, the new part replaces the existing one. This operation returns a JSON formatted response containing a string identifier that is used to confirm that parts are being added to the intended upload. For more information, see Direct upload to a sequence store in the Amazon Web Services HealthOmics User Guide.sequenceStoreId (string) required
uploadId (string) required
partSource (string) required
partNumber (integer) required
payload (string) required
omics/create_sequence_storeCreates a sequence store and returns its metadata. Sequence stores are used to store sequence data files called read sets that are saved in FASTQ, BAM, uBAM, or CRAM formats. For aligned formats BAM and CRAM, a sequence store can only use one reference genome. For unaligned formats FASTQ and uBAM, a reference genome is not required. You can create multiple sequence stores per region per account. The following are optional parameters you can specify for your sequence store: Use s3AccessConfig toname (string) required
description (string)
sseConfig: {
. type (string)
. keyArn (string)
} (object)
tags (object)
clientToken (string)
fallbackLocation (string)
eTagAlgorithmFamily (string)
propagatedSetLevelTags (array)
s3AccessConfig: {
. accessLogLocation (string)
} (object)
omics/get_sequence_storeRetrieves metadata for a sequence store using its ID and returns it in JSON format.id (string) required
omics/update_sequence_storeUpdate one or more parameters for the sequence store.id (string) required
name (string)
description (string)
clientToken (string)
fallbackLocation (string)
propagatedSetLevelTags (array)
s3AccessConfig: {
. accessLogLocation (string)
} (object)
omics/delete_sequence_storeDeletes a sequence store and returns a response with no body if the operation is successful. You can only delete a sequence store when it does not contain any read sets. Use the BatchDeleteReadSet API operation to ensure that all read sets in the sequence store are deleted. When a sequence store is deleted, all tags associated with the store are also deleted. For more information, see Deleting HealthOmics reference and sequence stores in the Amazon Web Services HealthOmics User Guide.id (string) required
omics/list_sequence_storesRetrieves a list of sequence stores and returns each sequence store's metadata. For more information, see Creating a HealthOmics sequence store in the Amazon Web Services HealthOmics User Guide.maxResults (integer)
nextToken (string)
filter: {
. name (string)
. createdAfter (string)
. createdBefore (string)
. status (string)
. updatedAfter (string)
. updatedBefore (string)
} (object)
omics/get_read_setRetrieves detailed information from parts of a read set and returns the read set in the same format that it was uploaded. You must have read sets uploaded to your sequence store in order to run this operation.id (string) required
sequenceStoreId (string) required
file (string)
partNumber (integer) required
omics/batch_delete_read_setDeletes one or more read sets. If the operation is successful, it returns a response with no body. If there is an error with deleting one of the read sets, the operation returns an error list. If the operation successfully deletes only a subset of files, it will return an error list for the remaining files that fail to be deleted. There is a limit of 100 read sets that can be deleted in each BatchDeleteReadSet API call.ids (array) required
sequenceStoreId (string) required
omics/get_read_set_metadataRetrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.id (string) required
sequenceStoreId (string) required
omics/list_read_setsRetrieves a list of read sets from a sequence store ID and returns the metadata in JSON format.sequenceStoreId (string) required
maxResults (integer)
nextToken (string)
filter: {
. name (string)
. status (string)
. referenceArn (string)
. createdAfter (string)
. createdBefore (string)
. sampleId (string)
. subjectId (string)
. generatedFrom (string)
. creationType (string)
} (object)
omics/create_shareCreates a cross-account shared resource. The resource owner makes an offer to share the resource with the principal subscriber an AWS user with a different account than the resource owner. The following resources support cross-account sharing: HealthOmics variant stores HealthOmics annotation stores Private workflowsresourceArn (string) required
principalSubscriber (string) required
shareName (string)
omics/get_shareRetrieves the metadata for the specified resource share.shareId (string) required
omics/accept_shareAccept a resource share request.shareId (string) required
omics/delete_shareDeletes a resource share. If you are the resource owner, the subscriber will no longer have access to the shared resource. If you are the subscriber, this operation deletes your access to the share.shareId (string) required
omics/list_sharesRetrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.resourceOwner (string) required
filter: {
. resourceArns (array)
. status (array)
. type (array)
} (object)
nextToken (string)
maxResults (integer)
omics/tag_resourceTags a resource.resourceArn (string) required
tags (object) required
omics/untag_resourceRemoves tags from a resource.resourceArn (string) required
tagKeys (array) required
omics/list_tags_for_resourceRetrieves a list of tags for a resource.resourceArn (string) required
omics/start_variant_import_jobAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Starts a variant import job.destinationName (string) required
roleArn (string) required
items (array) required
runLeftNormalization (boolean)
annotationFields (object)
omics/get_variant_import_jobAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about a variant import job.jobId (string) required
omics/cancel_variant_import_jobAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Cancels a variant import job.jobId (string) required
omics/list_variant_import_jobsAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of variant import jobs.maxResults (integer)
ids (array)
nextToken (string)
filter: {
. status (string)
. storeName (string)
} (object)
omics/create_variant_storeAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Creates a variant store.reference (undefined) required
name (string)
description (string)
tags (object)
sseConfig: {
. type (string)
. keyArn (string)
} (object)
omics/get_variant_storeAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Gets information about a variant store.name (string) required
omics/update_variant_storeAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Updates a variant store.name (string) required
description (string)
omics/delete_variant_storeAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Deletes a variant store.name (string) required
force (boolean)
omics/list_variant_storesAmazon Web Services HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services HealthOmics variant store and annotation store availability change. Retrieves a list of variant stores.maxResults (integer)
ids (array)
nextToken (string)
filter: {
. status (string)
} (object)
omics/create_workflowCreates a private workflow. Before you create a private workflow, you must create and configure these required resources: Workflow definition file: A workflow definition file written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in .zip format. For more information, see Woname (string)
description (string)
engine (string)
definitionZip (string)
definitionUri (string)
main (string)
parameterTemplate (object)
storageCapacity (integer)
tags (object)
requestId (string) required
accelerators (string)
storageType (string)
containerRegistryMap: {
. registryMappings (array)
. imageMappings (array)
} (object)
containerRegistryMapUri (string)
readmeMarkdown (string)
parameterTemplatePath (string)
readmePath (string)
definitionRepository: {
. connectionArn (string)
. fullRepositoryId (string)
. sourceReference (object)
. excludeFilePatterns (array)
} (object)
workflowBucketOwnerId (string)
readmeUri (string)
omics/get_workflowGets all information about a workflow using its ID. If a workflow is shared with you, you cannot export the workflow. For more information about your workflow status, see Verify the workflow status in the Amazon Web Services HealthOmics User Guide.id (string) required
type (string)
export (array)
workflowOwnerId (string)
omics/update_workflowUpdates information about a workflow. You can update the following workflow information: Name Description Default storage type Default storage capacity with workflow ID This operation returns a response with no body if the operation is successful. You can check the workflow updates by calling the GetWorkflow API operation. For more information, see Update a private workflow in the Amazon Web Services HealthOmics User Guide.id (string) required
name (string)
description (string)
storageType (string)
storageCapacity (integer)
readmeMarkdown (string)
omics/delete_workflowDeletes a workflow by specifying its ID. This operation returns a response with no body if the deletion is successful. To verify that the workflow is deleted: Use ListWorkflows to confirm the workflow no longer appears in the list. Use GetWorkflow to verify the workflow cannot be found.id (string) required
omics/list_workflowsRetrieves a list of existing workflows. You can filter for specific workflows by their name and type. Using the type parameter, specify PRIVATE to retrieve a list of private workflows or specify READY2RUN for a list of all Ready2Run workflows. If you do not specify the type of workflow, this operation returns a list of existing workflows.type (string)
name (string)
startingToken (string)
maxResults (integer)
omics/get_workflow_versionGets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.workflowId (string) required
versionName (string) required
type (string)
export (array)
workflowOwnerId (string)
omics/update_workflow_versionUpdates information about the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.workflowId (string) required
versionName (string) required
description (string)
storageType (string)
storageCapacity (integer)
readmeMarkdown (string)
omics/delete_workflow_versionDeletes a workflow version. Deleting a workflow version doesn't affect any ongoing runs that are using the workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.workflowId (string) required
versionName (string) required
omics/list_workflow_versionsLists the workflow versions for the specified workflow. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.workflowId (string) required
type (string)
workflowOwnerId (string)
startingToken (string)
maxResults (integer)
omics/create_workflow_versionCreates a new workflow version for the workflow that you specify with the workflowId parameter. When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow. Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version. Don't include any personally identifiable information PII in the version name. Version names appear in the workfloworkflowId (string) required
versionName (string) required
definitionZip (string)
definitionUri (string)
accelerators (string)
description (string)
engine (string)
main (string)
parameterTemplate (object)
requestId (string) required
storageType (string)
storageCapacity (integer)
tags (object)
workflowBucketOwnerId (string)
containerRegistryMap: {
. registryMappings (array)
. imageMappings (array)
} (object)
containerRegistryMapUri (string)
readmeMarkdown (string)
parameterTemplatePath (string)
readmePath (string)
definitionRepository: {
. connectionArn (string)
. fullRepositoryId (string)
. sourceReference (object)
. excludeFilePatterns (array)
} (object)
readmeUri (string)
opensearch/accept_inbound_connectionAllows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.ConnectionId (string) required
opensearch/add_data_sourceCreates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.DomainName (string) required
Name (string) required
DataSourceType (undefined) required
Description (string)
opensearch/add_direct_query_data_sourceAdds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.DataSourceName (string) required
DataSourceType (undefined) required
Description (string)
OpenSearchArns (array) required
TagList (array)
opensearch/add_tagsAttaches tags to an existing Amazon OpenSearch Service domain, data source, or application. Tags are a set of case-sensitive key-value pairs. A domain, data source, or application can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service resources.ARN (string) required
TagList (array) required
opensearch/associate_packageAssociates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.PackageID (string) required
DomainName (string) required
PrerequisitePackageIDList (array)
AssociationConfiguration: {
. KeyStoreAccessOption (object)
} (object)
opensearch/associate_packagesOperation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.PackageList (array) required
DomainName (string) required
opensearch/authorize_vpc_endpoint_accessProvides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.DomainName (string) required
Account (string)
Service (string)
opensearch/cancel_domain_config_changeCancels a pending configuration change on an Amazon OpenSearch Service domain.DomainName (string) required
DryRun (boolean)
opensearch/cancel_service_software_updateCancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.DomainName (string) required
opensearch/create_applicationCreates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service.clientToken (string)
name (string) required
dataSources (array)
iamIdentityCenterOptions: {
. enabled (boolean)
. iamIdentityCenterInstanceArn (string)
. iamRoleForIdentityCenterApplicationArn (string)
} (object)
appConfigs (array)
tagList (array)
kmsKeyArn (string)
opensearch/create_domainCreates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.DomainName (string) required
EngineVersion (string)
ClusterConfig: {
. InstanceType (string)
. InstanceCount (integer)
. DedicatedMasterEnabled (boolean)
. ZoneAwarenessEnabled (boolean)
. ZoneAwarenessConfig (object)
. DedicatedMasterType (string)
. DedicatedMasterCount (integer)
. WarmEnabled (boolean)
. WarmType (string)
. WarmCount (integer)
. ColdStorageOptions (object)
. MultiAZWithStandbyEnabled (boolean)
. NodeOptions (array)
} (object)
EBSOptions: {
. EBSEnabled (boolean)
. VolumeType (string)
. VolumeSize (integer)
. Iops (integer)
. Throughput (integer)
} (object)
AccessPolicies (string)
IPAddressType (string)
SnapshotOptions: {
. AutomatedSnapshotStartHour (integer)
} (object)
VPCOptions: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object)
CognitoOptions: {
. Enabled (boolean)
. UserPoolId (string)
. IdentityPoolId (string)
. RoleArn (string)
} (object)
EncryptionAtRestOptions: {
. Enabled (boolean)
. KmsKeyId (string)
} (object)
NodeToNodeEncryptionOptions: {
. Enabled (boolean)
} (object)
AdvancedOptions (object)
LogPublishingOptions (object)
DomainEndpointOptions: {
. EnforceHTTPS (boolean)
. TLSSecurityPolicy (string)
. CustomEndpointEnabled (boolean)
. CustomEndpoint (string)
. CustomEndpointCertificateArn (string)
} (object)
AdvancedSecurityOptions: {
. Enabled (boolean)
. InternalUserDatabaseEnabled (boolean)
. MasterUserOptions (object)
. SAMLOptions (object)
. JWTOptions (object)
. IAMFederationOptions (object)
. AnonymousAuthEnabled (boolean)
} (object)
IdentityCenterOptions: {
. EnabledAPIAccess (boolean)
. IdentityCenterInstanceARN (string)
. SubjectKey (string)
. RolesKey (string)
} (object)
TagList (array)
AutoTuneOptions: {
. DesiredState (string)
. MaintenanceSchedules (array)
. UseOffPeakWindow (boolean)
} (object)
OffPeakWindowOptions: {
. Enabled (boolean)
. OffPeakWindow (object)
} (object)
SoftwareUpdateOptions: {
. AutoSoftwareUpdateEnabled (boolean)
} (object)
AIMLOptions: {
. NaturalLanguageQueryGenerationOptions (object)
. S3VectorsEngine (object)
. ServerlessVectorAcceleration (object)
} (object)
opensearch/create_indexCreates an OpenSearch index with optional automatic semantic enrichment for specified text fields. Automatic semantic enrichment enables semantic search capabilities without requiring machine learning expertise, improving search relevance by up to 20% by understanding search intent and contextual meaning beyond keyword matching. The semantic enrichment process has zero impact on search latency as sparse encodings are stored directly within the index during indexing. For more information, see AutDomainName (string) required
IndexName (string) required
IndexSchema (undefined) required
opensearch/create_outbound_connectionCreates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.LocalDomainInfo: {
. AWSDomainInformation (object)
} (object) required
RemoteDomainInfo: {
. AWSDomainInformation (object)
} (object) required
ConnectionAlias (string) required
ConnectionMode (string)
ConnectionProperties: {
. Endpoint (string)
. CrossClusterSearch (object)
} (object)
opensearch/create_packageCreates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.PackageName (string) required
PackageType (string) required
PackageDescription (string)
PackageSource: {
. S3BucketName (string)
. S3Key (string)
} (object) required
PackageConfiguration: {
. LicenseRequirement (string)
. LicenseFilepath (string)
. ConfigurationRequirement (string)
. RequiresRestartForConfigurationUpdate (boolean)
} (object)
EngineVersion (string)
PackageVendingOptions: {
. VendingEnabled (boolean)
} (object)
PackageEncryptionOptions: {
. KmsKeyIdentifier (string)
. EncryptionEnabled (boolean)
} (object)
opensearch/create_vpc_endpointCreates an Amazon OpenSearch Service-managed VPC endpoint.DomainArn (string) required
VpcOptions: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object) required
ClientToken (string)
opensearch/delete_applicationDeletes a specified OpenSearch application.id (string) required
opensearch/delete_data_sourceDeletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.DomainName (string) required
Name (string) required
opensearch/delete_direct_query_data_sourceDeletes a previously configured direct query data source from Amazon OpenSearch Service.DataSourceName (string) required
opensearch/delete_domainDeletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.DomainName (string) required
opensearch/delete_inbound_connectionAllows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.ConnectionId (string) required
opensearch/delete_indexDeletes an OpenSearch index. This operation permanently removes the index and cannot be undone.DomainName (string) required
IndexName (string) required
opensearch/delete_outbound_connectionAllows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.ConnectionId (string) required
opensearch/delete_packageDeletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.PackageID (string) required
opensearch/delete_vpc_endpointDeletes an Amazon OpenSearch Service-managed interface VPC endpoint.VpcEndpointId (string) required
opensearch/describe_domainDescribes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.DomainName (string) required
opensearch/describe_domain_auto_tunesReturns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.DomainName (string) required
MaxResults (integer)
NextToken (string)
opensearch/describe_domain_change_progressReturns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.DomainName (string) required
ChangeId (string)
opensearch/describe_domain_configReturns the configuration of an Amazon OpenSearch Service domain.DomainName (string) required
opensearch/describe_domain_healthReturns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.DomainName (string) required
opensearch/describe_domain_nodesReturns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zones, standby nodes, node configurations, and node states.DomainName (string) required
opensearch/describe_domainsReturns domain configuration information about the specified Amazon OpenSearch Service domains.DomainNames (array) required
opensearch/describe_dry_run_progressDescribes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.DomainName (string) required
DryRunId (string)
LoadDryRunConfig (boolean)
opensearch/describe_inbound_connectionsLists all the inbound cross-cluster search connections for a destination remote Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.Filters (array)
MaxResults (integer)
NextToken (string)
opensearch/describe_instance_type_limitsDescribes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.DomainName (string)
InstanceType (string) required
EngineVersion (string) required
opensearch/describe_outbound_connectionsLists all the outbound cross-cluster connections for a local source Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.Filters (array)
MaxResults (integer)
NextToken (string)
opensearch/describe_packagesDescribes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.Filters (array)
MaxResults (integer)
NextToken (string)
opensearch/describe_reserved_instance_offeringsDescribes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.ReservedInstanceOfferingId (string)
MaxResults (integer)
NextToken (string)
opensearch/describe_reserved_instancesDescribes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.ReservedInstanceId (string)
MaxResults (integer)
NextToken (string)
opensearch/describe_vpc_endpointsDescribes one or more Amazon OpenSearch Service-managed VPC endpoints.VpcEndpointIds (array) required
opensearch/dissociate_packageRemoves a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.PackageID (string) required
DomainName (string) required
opensearch/dissociate_packagesDissociates multiple packages from a domain simultaneously.PackageList (array) required
DomainName (string) required
opensearch/get_applicationRetrieves the configuration and status of an existing OpenSearch application.id (string) required
opensearch/get_compatible_versionsReturns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.DomainName (string)
opensearch/get_data_sourceRetrieves information about a direct query data source.DomainName (string) required
Name (string) required
opensearch/get_default_application_settingGets the ARN of the current default application. If the default application isn't set, the operation returns a resource not found error.No parameters
opensearch/get_direct_query_data_sourceReturns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.DataSourceName (string) required
opensearch/get_domain_maintenance_statusThe status of the maintenance action.DomainName (string) required
MaintenanceId (string) required
opensearch/get_indexRetrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.DomainName (string) required
IndexName (string) required
opensearch/get_package_version_historyReturns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties if the package is a zip plugin package. For more information, see Custom packages for Amazon OpenSearch Service.PackageID (string) required
MaxResults (integer)
NextToken (string)
opensearch/get_upgrade_historyRetrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.DomainName (string) required
MaxResults (integer)
NextToken (string)
opensearch/get_upgrade_statusReturns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.DomainName (string) required
opensearch/list_applicationsLists all OpenSearch applications under your account.nextToken (string)
statuses (array)
maxResults (integer)
opensearch/list_data_sourcesLists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.DomainName (string) required
opensearch/list_direct_query_data_sourcesLists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.NextToken (string)
opensearch/list_domain_maintenancesA list of maintenance actions for the domain.DomainName (string) required
Action (string)
Status (string)
MaxResults (integer)
NextToken (string)
opensearch/list_domain_namesReturns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.EngineType (string)
opensearch/list_domains_for_packageLists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.PackageID (string) required
MaxResults (integer)
NextToken (string)
opensearch/list_instance_type_detailsLists all instance types and available features for a given OpenSearch or Elasticsearch version.EngineVersion (string) required
DomainName (string)
MaxResults (integer)
NextToken (string)
RetrieveAZs (boolean)
InstanceType (string)
opensearch/list_packages_for_domainLists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.DomainName (string) required
MaxResults (integer)
NextToken (string)
opensearch/list_scheduled_actionsRetrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.DomainName (string) required
MaxResults (integer)
NextToken (string)
opensearch/list_tagsReturns all resource tags for an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch Service resources.ARN (string) required
opensearch/list_versionsLists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.MaxResults (integer)
NextToken (string)
opensearch/list_vpc_endpoint_accessRetrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.DomainName (string) required
NextToken (string)
opensearch/list_vpc_endpointsRetrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.NextToken (string)
opensearch/list_vpc_endpoints_for_domainRetrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.DomainName (string) required
NextToken (string)
opensearch/purchase_reserved_instance_offeringAllows you to purchase Amazon OpenSearch Service Reserved Instances.ReservedInstanceOfferingId (string) required
ReservationName (string) required
InstanceCount (integer)
opensearch/put_default_application_settingSets the default application to the application with the specified ARN. To remove the default application, use the GetDefaultApplicationSetting operation to get the current default and then call the PutDefaultApplicationSetting with the current applications ARN and the setAsDefault parameter set to false.applicationArn (string) required
setAsDefault (boolean) required
opensearch/reject_inbound_connectionAllows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.ConnectionId (string) required
opensearch/remove_tagsRemoves the specified set of tags from an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch Service resources.ARN (string) required
TagKeys (array) required
opensearch/revoke_vpc_endpoint_accessRevokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.DomainName (string) required
Account (string)
Service (string)
opensearch/start_domain_maintenanceStarts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.DomainName (string) required
Action (string) required
NodeId (string)
opensearch/start_service_software_updateSchedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.DomainName (string) required
ScheduleAt (string)
DesiredStartTime (integer)
opensearch/update_applicationUpdates the configuration and settings of an existing OpenSearch application.id (string) required
dataSources (array)
appConfigs (array)
opensearch/update_data_sourceUpdates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.DomainName (string) required
Name (string) required
DataSourceType (undefined) required
Description (string)
Status (string)
opensearch/update_direct_query_data_sourceUpdates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service.DataSourceName (string) required
DataSourceType (undefined) required
Description (string)
OpenSearchArns (array) required
opensearch/update_domain_configModifies the cluster configuration of the specified Amazon OpenSearch Service domain.DomainName (string) required
ClusterConfig: {
. InstanceType (string)
. InstanceCount (integer)
. DedicatedMasterEnabled (boolean)
. ZoneAwarenessEnabled (boolean)
. ZoneAwarenessConfig (object)
. DedicatedMasterType (string)
. DedicatedMasterCount (integer)
. WarmEnabled (boolean)
. WarmType (string)
. WarmCount (integer)
. ColdStorageOptions (object)
. MultiAZWithStandbyEnabled (boolean)
. NodeOptions (array)
} (object)
EBSOptions: {
. EBSEnabled (boolean)
. VolumeType (string)
. VolumeSize (integer)
. Iops (integer)
. Throughput (integer)
} (object)
SnapshotOptions: {
. AutomatedSnapshotStartHour (integer)
} (object)
VPCOptions: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object)
CognitoOptions: {
. Enabled (boolean)
. UserPoolId (string)
. IdentityPoolId (string)
. RoleArn (string)
} (object)
AdvancedOptions (object)
AccessPolicies (string)
IPAddressType (string)
LogPublishingOptions (object)
EncryptionAtRestOptions: {
. Enabled (boolean)
. KmsKeyId (string)
} (object)
DomainEndpointOptions: {
. EnforceHTTPS (boolean)
. TLSSecurityPolicy (string)
. CustomEndpointEnabled (boolean)
. CustomEndpoint (string)
. CustomEndpointCertificateArn (string)
} (object)
NodeToNodeEncryptionOptions: {
. Enabled (boolean)
} (object)
AdvancedSecurityOptions: {
. Enabled (boolean)
. InternalUserDatabaseEnabled (boolean)
. MasterUserOptions (object)
. SAMLOptions (object)
. JWTOptions (object)
. IAMFederationOptions (object)
. AnonymousAuthEnabled (boolean)
} (object)
IdentityCenterOptions: {
. EnabledAPIAccess (boolean)
. IdentityCenterInstanceARN (string)
. SubjectKey (string)
. RolesKey (string)
} (object)
AutoTuneOptions: {
. DesiredState (string)
. RollbackOnDisable (string)
. MaintenanceSchedules (array)
. UseOffPeakWindow (boolean)
} (object)
DryRun (boolean)
DryRunMode (string)
OffPeakWindowOptions: {
. Enabled (boolean)
. OffPeakWindow (object)
} (object)
SoftwareUpdateOptions: {
. AutoSoftwareUpdateEnabled (boolean)
} (object)
AIMLOptions: {
. NaturalLanguageQueryGenerationOptions (object)
. S3VectorsEngine (object)
. ServerlessVectorAcceleration (object)
} (object)
opensearch/update_indexUpdates an existing OpenSearch index schema and semantic enrichment configuration. This operation allows modification of field mappings and semantic search settings for text fields. Changes to semantic enrichment configuration will apply to newly ingested documents.DomainName (string) required
IndexName (string) required
IndexSchema (undefined) required
opensearch/update_packageUpdates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.PackageID (string) required
PackageSource: {
. S3BucketName (string)
. S3Key (string)
} (object) required
PackageDescription (string)
CommitMessage (string)
PackageConfiguration: {
. LicenseRequirement (string)
. LicenseFilepath (string)
. ConfigurationRequirement (string)
. RequiresRestartForConfigurationUpdate (boolean)
} (object)
PackageEncryptionOptions: {
. KmsKeyIdentifier (string)
. EncryptionEnabled (boolean)
} (object)
opensearch/update_package_scopeUpdates the scope of a package. Scope of the package defines users who can view and associate a package.PackageID (string) required
Operation (string) required
PackageUserList (array) required
opensearch/update_scheduled_actionReschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.DomainName (string) required
ActionID (string) required
ActionType (string) required
ScheduleAt (string) required
DesiredStartTime (integer)
opensearch/update_vpc_endpointModifies an Amazon OpenSearch Service-managed interface VPC endpoint.VpcEndpointId (string) required
VpcOptions: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object) required
opensearch/upgrade_domainAllows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.DomainName (string) required
TargetVersion (string) required
PerformCheckOnly (boolean)
AdvancedOptions (object)
opensearchserverless/batch_get_collectionReturns attributes for one or more collections, including the collection endpoint, the OpenSearch Dashboards endpoint, and FIPS-compliant endpoints. For more information, see Creating and managing Amazon OpenSearch Serverless collections.ids (array)
names (array)
opensearchserverless/batch_get_collection_groupReturns attributes for one or more collection groups, including capacity limits and the number of collections in each group. For more information, see Creating and managing Amazon OpenSearch Serverless collections.ids (array)
names (array)
opensearchserverless/batch_get_effective_lifecycle_policyReturns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.resourceIdentifiers (array) required
opensearchserverless/batch_get_lifecycle_policyReturns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.identifiers (array) required
opensearchserverless/batch_get_vpc_endpointReturns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.ids (array) required
opensearchserverless/create_lifecycle_policyCreates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.type (string) required
name (string) required
description (string)
policy (string) required
clientToken (string)
opensearchserverless/create_security_policyCreates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.type (string) required
name (string) required
description (string)
policy (string) required
clientToken (string)
opensearchserverless/get_account_settingsReturns account-level settings related to OpenSearch Serverless.No parameters
opensearchserverless/get_policies_statsReturns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.No parameters
opensearchserverless/list_tags_for_resourceReturns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.resourceArn (string) required
opensearchserverless/tag_resourceAssociates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.resourceArn (string) required
tags (array) required
opensearchserverless/untag_resourceRemoves a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.resourceArn (string) required
tagKeys (array) required
opensearchserverless/update_account_settingsUpdate the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.capacityLimits: {
. maxIndexingCapacityInOCU (integer)
. maxSearchCapacityInOCU (integer)
} (object)
opensearchserverless/update_vpc_endpointUpdates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.id (string) required
addSubnetIds (array)
removeSubnetIds (array)
addSecurityGroupIds (array)
removeSecurityGroupIds (array)
clientToken (string)
opensearchserverless/get_access_policyReturns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.type (string) required
name (string) required
opensearchserverless/update_access_policyUpdates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.type (string) required
name (string) required
policyVersion (string) required
description (string)
policy (string)
clientToken (string)
opensearchserverless/delete_access_policyDeletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.type (string) required
name (string) required
clientToken (string)
opensearchserverless/list_access_policiesReturns information about a list of OpenSearch Serverless access policies.type (string) required
resource (array)
nextToken (string)
maxResults (integer)
opensearchserverless/create_access_policyCreates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.type (string) required
name (string) required
description (string)
policy (string) required
clientToken (string)
opensearchserverless/create_collectionCreates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.name (string) required
type (string)
description (string)
tags (array)
standbyReplicas (string)
vectorOptions: {
. ServerlessVectorAcceleration (string)
} (object)
collectionGroupName (string)
encryptionConfig: {
. aWSOwnedKey (boolean)
. kmsKeyArn (string)
} (object)
clientToken (string)
opensearchserverless/update_collectionUpdates an OpenSearch Serverless collection.id (string) required
description (string)
clientToken (string)
opensearchserverless/delete_collectionDeletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.id (string) required
clientToken (string)
opensearchserverless/list_collectionsLists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections. Make sure to include an empty request body if you don't include any collection filters in the request.collectionFilters: {
. name (string)
. status (string)
. collectionGroupName (string)
} (object)
nextToken (string)
maxResults (integer)
opensearchserverless/create_collection_groupCreates a collection group within OpenSearch Serverless. Collection groups let you manage OpenSearch Compute Units OCUs at a group level, with multiple collections sharing the group's capacity limits. For more information, see Managing collection groups.name (string) required
standbyReplicas (string) required
description (string)
tags (array)
capacityLimits: {
. maxIndexingCapacityInOCU (number)
. maxSearchCapacityInOCU (number)
. minIndexingCapacityInOCU (number)
. minSearchCapacityInOCU (number)
} (object)
clientToken (string)
opensearchserverless/update_collection_groupUpdates the description and capacity limits of a collection group.id (string) required
description (string)
capacityLimits: {
. maxIndexingCapacityInOCU (number)
. maxSearchCapacityInOCU (number)
. minIndexingCapacityInOCU (number)
. minSearchCapacityInOCU (number)
} (object)
clientToken (string)
opensearchserverless/delete_collection_groupDeletes a collection group. You can only delete empty collection groups that contain no collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.id (string) required
clientToken (string)
opensearchserverless/list_collection_groupsReturns a list of collection groups. For more information, see Creating and managing Amazon OpenSearch Serverless collections.nextToken (string)
maxResults (integer)
opensearchserverless/get_indexRetrieves information about an index in an OpenSearch Serverless collection, including its schema definition. The index might be configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.id (string) required
indexName (string) required
opensearchserverless/update_indexUpdates an existing index in an OpenSearch Serverless collection. This operation allows you to modify the index schema, including adding new fields or changing field mappings. You can also enable automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.id (string) required
indexName (string) required
indexSchema (undefined)
opensearchserverless/delete_indexDeletes an index from an OpenSearch Serverless collection. Be aware that the index might be configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment.id (string) required
indexName (string) required
opensearchserverless/create_indexCreates an index within an OpenSearch Serverless collection. Unlike other OpenSearch indexes, indexes created by this API are automatically configured to conduct automatic semantic enrichment ingestion and search. For more information, see About automatic semantic enrichment in the OpenSearch User Guide.id (string) required
indexName (string) required
indexSchema (undefined)
opensearchserverless/update_lifecycle_policyUpdates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.type (string) required
name (string) required
policyVersion (string) required
description (string)
policy (string)
clientToken (string)
opensearchserverless/delete_lifecycle_policyDeletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.type (string) required
name (string) required
clientToken (string)
opensearchserverless/list_lifecycle_policiesReturns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.type (string) required
resources (array)
nextToken (string)
maxResults (integer)
opensearchserverless/create_security_configSpecifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.type (string) required
name (string) required
description (string)
samlOptions: {
. metadata (string)
. userAttribute (string)
. groupAttribute (string)
. openSearchServerlessEntityId (string)
. sessionTimeout (integer)
} (object)
iamIdentityCenterOptions: {
. instanceArn (string)
. userAttribute (string)
. groupAttribute (string)
} (object)
iamFederationOptions: {
. groupAttribute (string)
. userAttribute (string)
} (object)
clientToken (string)
opensearchserverless/get_security_configReturns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.id (string) required
opensearchserverless/update_security_configUpdates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.id (string) required
configVersion (string) required
description (string)
samlOptions: {
. metadata (string)
. userAttribute (string)
. groupAttribute (string)
. openSearchServerlessEntityId (string)
. sessionTimeout (integer)
} (object)
iamIdentityCenterOptionsUpdates: {
. userAttribute (string)
. groupAttribute (string)
} (object)
iamFederationOptions: {
. groupAttribute (string)
. userAttribute (string)
} (object)
clientToken (string)
opensearchserverless/delete_security_configDeletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.id (string) required
clientToken (string)
opensearchserverless/list_security_configsReturns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.type (string) required
nextToken (string)
maxResults (integer)
opensearchserverless/get_security_policyReturns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.type (string) required
name (string) required
opensearchserverless/update_security_policyUpdates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.type (string) required
name (string) required
policyVersion (string) required
description (string)
policy (string)
clientToken (string)
opensearchserverless/delete_security_policyDeletes an OpenSearch Serverless security policy.type (string) required
name (string) required
clientToken (string)
opensearchserverless/list_security_policiesReturns information about configured OpenSearch Serverless security policies.type (string) required
resource (array)
nextToken (string)
maxResults (integer)
opensearchserverless/create_vpc_endpointCreates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.name (string) required
vpcId (string) required
subnetIds (array) required
securityGroupIds (array)
clientToken (string)
opensearchserverless/delete_vpc_endpointDeletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.id (string) required
clientToken (string)
opensearchserverless/list_vpc_endpointsReturns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.vpcEndpointFilters: {
. status (string)
} (object)
nextToken (string)
maxResults (integer)
organizations/accept_handshakeAccepts a handshake by sending an ACCEPTED response to the sender. You can view accepted handshakes in API responses for 30 days before they are deleted. Only the management account can accept the following handshakes: Enable all features final confirmation APPROVE_ALL_FEATURES Billing transfer TRANSFER_RESPONSIBILITY For more information, see Enabling all features and Responding to a billing transfer invitation in the Organizations User Guide. Only a member account can accept the following handHandshakeId (string) required
organizations/attach_policyAttaches 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: SERVICE_CONTROL_POLICY RESOURCE_CONTROL_POLICY DECLARATIVE_POLICY_EC2 BACKUP_POLICY TAG_POLICY CHATBOT_POLICY AISERVICES_OPT_OUT_POLICY SECURITYHUB_POLICY UPGRADE_ROLLOUT_POLICY INSPECTOR_POLICY BEDROCK_POLICY S3_POLICY NETWORK_SECURITY_DIRECTOR_POLICY You can only call this oPolicyId (string) required
TargetId (string) required
organizations/cancel_handshakeCancels a Handshake. Only the account that sent a handshake can call this operation. The recipient of the handshake can't cancel it, but can use DeclineHandshake to decline. After a handshake is canceled, the recipient can no longer respond to the handshake. You can view canceled handshakes in API responses for 30 days before they are deleted.HandshakeId (string) required
organizations/close_accountCloses an Amazon Web Services member account within an organization. You can close an account when all features are enabled . 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 statusAccountId (string) required
organizations/create_accountCreates 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 thEmail (string) required
AccountName (string) required
RoleName (string)
IamUserAccessToBilling (string)
Tags (array)
organizations/create_gov_cloud_accountThis 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 comEmail (string) required
AccountName (string) required
RoleName (string)
IamUserAccessToBilling (string)
Tags (array)
organizations/create_organizationCreates 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 contrFeatureSet (string)
organizations/create_organizational_unitCreates 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 OUs in the Organizations User Guide. If the request includes tags, then the requeParentId (string) required
Name (string) required
Tags (array)
organizations/create_policyCreates 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 Organizations policies. If the request includes tags, then the requester must have the organizations:TagResource permission. You can only call this operation from the management account or a member account that is a delegated administrator.Content (string) required
Description (string) required
Name (string) required
Type (string) required
Tags (array)
organizations/decline_handshakeDeclines a Handshake. Only the account that receives a handshake can call this operation. The sender of the handshake can use CancelHandshake to cancel if the handshake hasn't yet been responded to. You can view canceled handshakes in API responses for 30 days before they are deleted.HandshakeId (string) required
organizations/delete_organizationDeletes the organization. You can delete an organization only by using credentials from the management account. The organization must be empty of member accounts.No parameters
organizations/delete_organizational_unitDeletes 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. You can only call this operation from the management account.OrganizationalUnitId (string) required
organizations/delete_policyDeletes 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. You can only call this operation from the management account or a member account that is a delegated administrator.PolicyId (string) required
organizations/delete_resource_policyDeletes the resource policy from your organization. You can only call this operation from the management account.No parameters
organizations/deregister_delegated_administratorRemoves 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 aAccountId (string) required
ServicePrincipal (string) required
organizations/describe_accountRetrieves Organizations-related information about the specified account. You can only call this operation from the management account or a member account that is a delegated administrator.AccountId (string) required
organizations/describe_create_account_statusRetrieves the current status of an asynchronous request to create an account. You can only call this operation from the management account or a member account that is a delegated administrator.CreateAccountRequestId (string) required
organizations/describe_effective_policyReturns 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 management policies. It does not apply to authorization policies: service control policies SCPs and resource control policies RCPs. For more information about policy inheritance, see Understanding management pPolicyType (string) required
TargetId (string)
organizations/describe_handshakeReturns details for a handshake. A handshake is the secure exchange of information between two Amazon Web Services accounts: a sender and a recipient. You can view ACCEPTED, DECLINED, or CANCELED handshakes in API Responses for 30 days before they are deleted. You can call this operation from any account in a organization.HandshakeId (string) required
organizations/describe_organizationRetrieves information about the organization that the user's account belongs to. You can call this operation from any account in a organization. Even if a policy type is shown as available in the organization, you can disable it separately at the root level with DisablePolicyType. Use ListRoots to see the status of policy types for a specified root.No parameters
organizations/describe_organizational_unitRetrieves information about an organizational unit OU. You can only call this operation from the management account or a member account that is a delegated administrator.OrganizationalUnitId (string) required
organizations/describe_policyRetrieves information about a policy. You can only call this operation from the management account or a member account that is a delegated administrator.PolicyId (string) required
organizations/describe_resource_policyRetrieves information about a resource policy. You can only call this operation from the management account or a member account that is a delegated administrator.No parameters
organizations/describe_responsibility_transferReturns details for a transfer. A transfer is an arrangement between two management accounts where one account designates the other with specified responsibilities for their organization.Id (string) required
organizations/detach_policyDetaches 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 thePolicyId (string) required
TargetId (string) required
organizations/disable_awsservice_accessDisables 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 rServicePrincipal (string) required
organizations/disable_policy_typeDisables 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 rooRootId (string) required
PolicyType (string) required
organizations/enable_all_featuresEnables 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 wNo parameters
organizations/enable_awsservice_accessProvides an Amazon Web Services service the service that is specified by ServicePrincipal with permissions to view the structure of an organization, create a service-linked role in all the accounts in the organization, and allow the service to perform operations on behalf of the organization and its accounts. Establishing these permissions can be a first step in enabling the integration of an Amazon Web Services service with Organizations. We recommend that you enable integration between OrganizServicePrincipal (string) required
organizations/enable_policy_typeEnables 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. You can only call this operationRootId (string) required
PolicyType (string) required
organizations/invite_account_to_organizationSends 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. 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 theTarget: {
. Id (string)
. Type (string)
} (object) required
Notes (string)
Tags (array)
organizations/invite_organization_to_transfer_responsibilitySends an invitation to another organization's management account to designate your account with the specified responsibilities for their organization. The invitation is implemented as a Handshake whose details are in the response. You can only call this operation from the management account.Type (string) required
Target: {
. Id (string)
. Type (string)
} (object) required
Notes (string)
StartTimestamp (string) required
SourceName (string) required
Tags (array)
organizations/leave_organizationRemoves a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the management account, use RemoveAccountFromOrganization instead. You can only call from operation from a member account. The management account in an organization with all features enabled can set service control policies SCPs that can restrict what administrators of member accounts can do. This includes preventing them frNo parameters
organizations/list_accountsLists all the accounts in the organization. To request only the accounts in a specified root or organizational unit OU, use the ListAccountsForParent operation instead. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have reNextToken (string)
MaxResults (integer)
organizations/list_accounts_for_parentLists 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. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result setParentId (string) required
NextToken (string)
MaxResults (integer)
organizations/list_accounts_with_invalid_effective_policyLists all the accounts in an organization that have invalid effective policies. An invalid effective policy is an effective policy that fails validation checks, resulting in the effective policy not being fully enforced on all the intended accounts within an organization. You can only call this operation from the management account or a member account that is a delegated administrator.PolicyType (string) required
NextToken (string)
MaxResults (integer)
organizations/list_awsservice_access_for_organizationReturns 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 Using Organizations with other Amazon Web Services services in the Organizations User Guide.NextToken (string)
MaxResults (integer)
organizations/list_childrenLists 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. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. AParentId (string) required
ChildType (string) required
NextToken (string)
MaxResults (integer)
organizations/list_create_account_statusLists the account creation requests that match the specified status that is currently being tracked for the organization. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results. You can only calStates (array)
NextToken (string)
MaxResults (integer)
organizations/list_delegated_administratorsLists the Amazon Web Services accounts that are designated as delegated administrators in this organization. You can only call this operation from the management account or a member account that is a delegated administrator.ServicePrincipal (string)
NextToken (string)
MaxResults (integer)
organizations/list_delegated_services_for_accountList the Amazon Web Services services for which the specified account is a delegated administrator. You can only call this operation from the management account or a member account that is a delegated administrator.AccountId (string) required
NextToken (string)
MaxResults (integer)
organizations/list_effective_policy_validation_errorsLists all the validation errors on an effective policy for a specified account and policy type. You can only call this operation from the management account or a member account that is a delegated administrator.AccountId (string) required
PolicyType (string) required
NextToken (string)
MaxResults (integer)
organizations/list_handshakes_for_accountLists the recent handshakes that you have received. You can view CANCELED, ACCEPTED, DECLINED, or EXPIRED handshakes in API responses for 30 days before they are deleted. You can call this operation from any account in a organization. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextTokFilter: {
. ActionType (string)
. ParentHandshakeId (string)
} (object)
NextToken (string)
MaxResults (integer)
organizations/list_handshakes_for_organizationLists the recent handshakes that you have sent. You can view CANCELED, ACCEPTED, DECLINED, or EXPIRED handshakes in API responses for 30 days before they are deleted. You can only call this operation from the management account or a member account that is a delegated administrator. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are aFilter: {
. ActionType (string)
. ParentHandshakeId (string)
} (object)
NextToken (string)
MaxResults (integer)
organizations/list_inbound_responsibility_transfersLists transfers that allow you to manage the specified responsibilities for another organization. This operation returns both transfer invitations and transfers. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrievedType (string) required
Id (string)
NextToken (string)
MaxResults (integer)
organizations/list_organizational_units_for_parentLists the organizational units OUs in a parent organizational unit or root. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results. You can only call this operation from the management account oParentId (string) required
NextToken (string)
MaxResults (integer)
organizations/list_outbound_responsibility_transfersLists transfers that allow an account outside your organization to manage the specified responsibilities for your organization. This operation returns both transfer invitations and transfers. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indType (string) required
NextToken (string)
MaxResults (integer)
organizations/list_parentsLists 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. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returnsChildId (string) required
NextToken (string)
MaxResults (integer)
organizations/list_policiesRetrieves the list of all policies in an organization of a specified type. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results. You can only call this operation from the management account orFilter (string) required
NextToken (string)
MaxResults (integer)
organizations/list_policies_for_targetLists 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. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicTargetId (string) required
Filter (string) required
NextToken (string)
MaxResults (integer)
organizations/list_rootsLists the roots that are defined in the current organization. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results. You can only call this operation from the management account or a member accNextToken (string)
MaxResults (integer)
organizations/list_tags_for_resourceLists 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 You can only call this operation from the management account or a member account that is a delegated administrator.ResourceId (string) required
NextToken (string)
organizations/list_targets_for_policyLists all the roots, organizational units OUs, and accounts that the specified policy is attached to. When calling List operations, always check the NextToken response parameter value, even if you receive an empty result set. These operations can occasionally return an empty set of results even when more results are available. Continue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results. You can only call this operation froPolicyId (string) required
NextToken (string)
MaxResults (integer)
organizations/move_accountMoves an account from its current source parent root or organizational unit OU to the specified destination parent root or OU. You can only call this operation from the management account.AccountId (string) required
SourceParentId (string) required
DestinationParentId (string) required
organizations/put_resource_policyCreates or updates a resource policy. You can only call this operation from the management account..Content (string) required
Tags (array)
organizations/register_delegated_administratorEnables 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 ServiAccountId (string) required
ServicePrincipal (string) required
organizations/remove_account_from_organizationRemoves 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. You can only call this operation from the management account. Member accounts can remove themselves with LeaveOrganization iAccountId (string) required
organizations/tag_resourceAdds 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 You can only call this operation from the management account or a member account that is a delegated administrator.ResourceId (string) required
Tags (array) required
organizations/terminate_responsibility_transferEnds a transfer. A transfer is an arrangement between two management accounts where one account designates the other with specified responsibilities for their organization.Id (string) required
EndTimestamp (string)
organizations/untag_resourceRemoves 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 You can only call this operation from the management account or a member account that is a delegated administrator.ResourceId (string) required
TagKeys (array) required
organizations/update_organizational_unitRenames 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. You can only call this operation from the management account.OrganizationalUnitId (string) required
Name (string)
organizations/update_policyUpdates 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. You can only call this operation from the management account or a member account that is a delegated administrator.PolicyId (string) required
Name (string)
Description (string)
Content (string)
organizations/update_responsibility_transferUpdates a transfer. A transfer is the arrangement between two management accounts where one account designates the other with specified responsibilities for their organization. You can update the name assigned to a transfer.Id (string) required
Name (string) required
osis/create_pipelineCreates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.PipelineName (string) required
MinUnits (integer) required
MaxUnits (integer) required
PipelineConfigurationBody (string) required
LogPublishingOptions: {
. IsLoggingEnabled (boolean)
. CloudWatchLogDestination (object)
} (object)
VpcOptions: {
. SubnetIds (array)
. SecurityGroupIds (array)
. VpcAttachmentOptions (object)
. VpcEndpointManagement (string)
} (object)
BufferOptions: {
. PersistentBufferEnabled (boolean)
} (object)
EncryptionAtRestOptions: {
. KmsKeyArn (string)
} (object)
Tags (array)
PipelineRoleArn (string)
osis/create_pipeline_endpointCreates a VPC endpoint for an OpenSearch Ingestion pipeline. Pipeline endpoints allow you to ingest data from your VPC into pipelines that you have access to.PipelineArn (string) required
VpcOptions: {
. SubnetIds (array)
. SecurityGroupIds (array)
} (object) required
osis/delete_pipelineDeletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.PipelineName (string) required
osis/delete_pipeline_endpointDeletes a VPC endpoint for an OpenSearch Ingestion pipeline.EndpointId (string) required
osis/delete_resource_policyDeletes a resource-based policy from an OpenSearch Ingestion resource.ResourceArn (string) required
osis/get_pipelineRetrieves information about an OpenSearch Ingestion pipeline.PipelineName (string) required
osis/get_pipeline_blueprintRetrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.BlueprintName (string) required
Format (string)
osis/get_pipeline_change_progressReturns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created. For more information, see Tracking the status of pipeline creation.PipelineName (string) required
osis/get_resource_policyRetrieves the resource-based policy attached to an OpenSearch Ingestion resource.ResourceArn (string) required
osis/list_pipeline_blueprintsRetrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.No parameters
osis/list_pipeline_endpoint_connectionsLists the pipeline endpoints connected to pipelines in your account.MaxResults (integer)
NextToken (string)
osis/list_pipeline_endpointsLists all pipeline endpoints in your account.MaxResults (integer)
NextToken (string)
osis/list_pipelinesLists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.MaxResults (integer)
NextToken (string)
osis/list_tags_for_resourceLists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.Arn (string) required
osis/put_resource_policyAttaches a resource-based policy to an OpenSearch Ingestion resource. Resource-based policies grant permissions to principals to perform actions on the resource.ResourceArn (string) required
Policy (string) required
osis/revoke_pipeline_endpoint_connectionsRevokes pipeline endpoints from specified endpoint IDs.PipelineArn (string) required
EndpointIds (array) required
osis/start_pipelineStarts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.PipelineName (string) required
osis/stop_pipelineStops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.PipelineName (string) required
osis/tag_resourceTags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.Arn (string) required
Tags (array) required
osis/untag_resourceRemoves one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.Arn (string) required
TagKeys (array) required
osis/update_pipelineUpdates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.PipelineName (string) required
MinUnits (integer)
MaxUnits (integer)
PipelineConfigurationBody (string)
LogPublishingOptions: {
. IsLoggingEnabled (boolean)
. CloudWatchLogDestination (object)
} (object)
BufferOptions: {
. PersistentBufferEnabled (boolean)
} (object)
EncryptionAtRestOptions: {
. KmsKeyArn (string)
} (object)
PipelineRoleArn (string)
osis/validate_pipelineChecks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.PipelineConfigurationBody (string) required
outposts/cancel_capacity_taskCancels the capacity task.CapacityTaskId (string) required
OutpostIdentifier (string) required
outposts/cancel_orderCancels the specified order for an Outpost.OrderId (string) required
outposts/create_orderCreates an order for an Outpost.OutpostIdentifier (string) required
LineItems (array)
PaymentOption (string) required
PaymentTerm (string)
outposts/create_outpostCreates an Outpost. You can specify either an Availability one or an AZ ID.Name (string) required
Description (string)
SiteId (string) required
AvailabilityZone (string)
AvailabilityZoneId (string)
Tags (object)
SupportedHardwareType (string)
outposts/create_siteCreates a site for an Outpost.Name (string) required
Description (string)
Notes (string)
Tags (object)
OperatingAddress: {
. ContactName (string)
. ContactPhoneNumber (string)
. AddressLine1 (string)
. AddressLine2 (string)
. AddressLine3 (string)
. City (string)
. StateOrRegion (string)
. DistrictOrCounty (string)
. PostalCode (string)
. CountryCode (string)
. Municipality (string)
} (object)
ShippingAddress: {
. ContactName (string)
. ContactPhoneNumber (string)
. AddressLine1 (string)
. AddressLine2 (string)
. AddressLine3 (string)
. City (string)
. StateOrRegion (string)
. DistrictOrCounty (string)
. PostalCode (string)
. CountryCode (string)
. Municipality (string)
} (object)
RackPhysicalProperties: {
. PowerDrawKva (string)
. PowerPhase (string)
. PowerConnector (string)
. PowerFeedDrop (string)
. UplinkGbps (string)
. UplinkCount (string)
. FiberOpticCableType (string)
. OpticalStandard (string)
. MaximumSupportedWeightLbs (string)
} (object)
outposts/delete_outpostDeletes the specified Outpost.OutpostId (string) required
outposts/delete_siteDeletes the specified site.SiteId (string) required
outposts/get_capacity_taskGets details of the specified capacity task.CapacityTaskId (string) required
OutpostIdentifier (string) required
outposts/get_catalog_itemGets information about the specified catalog item.CatalogItemId (string) required
outposts/get_connectionAmazon 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.ConnectionId (string) required
outposts/get_orderGets information about the specified order.OrderId (string) required
outposts/get_outpostGets information about the specified Outpost.OutpostId (string) required
outposts/get_outpost_billing_informationGets current and historical billing information about the specified Outpost.NextToken (string)
MaxResults (integer)
OutpostIdentifier (string) required
outposts/get_outpost_instance_typesGets the instance types for the specified Outpost.OutpostId (string) required
NextToken (string)
MaxResults (integer)
outposts/get_outpost_supported_instance_typesGets the instance types that an Outpost can support in InstanceTypeCapacity. This will generally include instance types that are not currently configured and therefore cannot be launched with the current Outpost capacity configuration.OutpostIdentifier (string) required
OrderId (string)
AssetId (string)
MaxResults (integer)
NextToken (string)
outposts/get_siteGets information about the specified Outpost site.SiteId (string) required
outposts/get_site_addressGets the site address of the specified site.SiteId (string) required
AddressType (string) required
outposts/list_asset_instancesA list of Amazon EC2 instances, belonging to all accounts, running on the specified Outpost. Does not include Amazon EBS or Amazon S3 instances.OutpostIdentifier (string) required
AssetIdFilter (array)
InstanceTypeFilter (array)
AccountIdFilter (array)
AwsServiceFilter (array)
MaxResults (integer)
NextToken (string)
outposts/list_assetsLists 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.OutpostIdentifier (string) required
HostIdFilter (array)
MaxResults (integer)
NextToken (string)
StatusFilter (array)
outposts/list_blocking_instances_for_capacity_taskA list of Amazon EC2 instances running on the Outpost and belonging to the account that initiated the capacity task. Use this list to specify the instances you cannot stop to free up capacity to run the capacity task.OutpostIdentifier (string) required
CapacityTaskId (string) required
MaxResults (integer)
NextToken (string)
outposts/list_capacity_tasksLists the capacity tasks 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.OutpostIdentifierFilter (string)
MaxResults (integer)
NextToken (string)
CapacityTaskStatusFilter (array)
outposts/list_catalog_itemsLists 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.NextToken (string)
MaxResults (integer)
ItemClassFilter (array)
SupportedStorageFilter (array)
EC2FamilyFilter (array)
outposts/list_ordersLists the Outpost orders for your Amazon Web Services account.OutpostIdentifierFilter (string)
NextToken (string)
MaxResults (integer)
outposts/list_outpostsLists 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.NextToken (string)
MaxResults (integer)
LifeCycleStatusFilter (array)
AvailabilityZoneFilter (array)
AvailabilityZoneIdFilter (array)
outposts/list_sitesLists 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.NextToken (string)
MaxResults (integer)
OperatingAddressCountryCodeFilter (array)
OperatingAddressStateOrRegionFilter (array)
OperatingAddressCityFilter (array)
outposts/list_tags_for_resourceLists the tags for the specified resource.ResourceArn (string) required
outposts/start_capacity_taskStarts the specified capacity task. You can have one active capacity task for each order and each Outpost.OutpostIdentifier (string) required
OrderId (string)
AssetId (string)
InstancePools (array) required
InstancesToExclude: {
. Instances (array)
. AccountIds (array)
. Services (array)
} (object)
DryRun (boolean)
TaskActionOnBlockingInstances (string)
outposts/start_connectionAmazon 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.DeviceSerialNumber (string)
AssetId (string) required
ClientPublicKey (string) required
NetworkInterfaceDeviceIndex (integer) required
outposts/start_outpost_decommissionStarts the decommission process to return the Outposts racks or servers.OutpostIdentifier (string) required
ValidateOnly (boolean)
outposts/tag_resourceAdds tags to the specified resource.ResourceArn (string) required
Tags (object) required
outposts/untag_resourceRemoves tags from the specified resource.ResourceArn (string) required
TagKeys (array) required
outposts/update_outpostUpdates an Outpost.OutpostId (string) required
Name (string)
Description (string)
SupportedHardwareType (string)
outposts/update_siteUpdates the specified site.SiteId (string) required
Name (string)
Description (string)
Notes (string)
outposts/update_site_addressUpdates 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.SiteId (string) required
AddressType (string) required
Address: {
. ContactName (string)
. ContactPhoneNumber (string)
. AddressLine1 (string)
. AddressLine2 (string)
. AddressLine3 (string)
. City (string)
. StateOrRegion (string)
. DistrictOrCounty (string)
. PostalCode (string)
. CountryCode (string)
. Municipality (string)
} (object) required
outposts/update_site_rack_physical_propertiesUpdate 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.SiteId (string) required
PowerDrawKva (string)
PowerPhase (string)
PowerConnector (string)
PowerFeedDrop (string)
UplinkGbps (string)
UplinkCount (string)
FiberOpticCableType (string)
OpticalStandard (string)
MaximumSupportedWeightLbs (string)
panorama/create_application_instanceCreates an application instance and deploys it to a device.Name (string)
Description (string)
ManifestPayload (undefined) required
ManifestOverridesPayload (undefined)
ApplicationInstanceIdToReplace (string)
RuntimeRoleArn (string)
DefaultRuntimeContextDevice (string) required
Tags (object)
panorama/create_job_for_devicesCreates a job to run on a device. A job can update a device's software or reboot it.DeviceIds (array) required
DeviceJobConfig: {
. OTAJobConfig (object)
} (object)
JobType (string) required
panorama/create_node_from_template_jobCreates a camera stream node.TemplateType (string) required
OutputPackageName (string) required
OutputPackageVersion (string) required
NodeName (string) required
NodeDescription (string)
TemplateParameters (object) required
JobTags (array)
panorama/create_packageCreates a package and storage location in an Amazon S3 access point.PackageName (string) required
Tags (object)
panorama/create_package_import_jobImports a node package.JobType (string) required
InputConfig: {
. PackageVersionInputConfig (object)
} (object) required
OutputConfig: {
. PackageVersionOutputConfig (object)
} (object) required
ClientToken (string) required
JobTags (array)
panorama/delete_deviceDeletes a device.DeviceId (string) required
panorama/delete_packageDeletes a package. To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API.PackageId (string) required
ForceDelete (boolean)
panorama/deregister_package_versionDeregisters a package version.OwnerAccount (string)
PackageId (string) required
PackageVersion (string) required
PatchVersion (string) required
UpdatedLatestPatchVersion (string)
panorama/describe_application_instanceReturns information about an application instance on a device.ApplicationInstanceId (string) required
panorama/describe_application_instance_detailsReturns information about an application instance's configuration manifest.ApplicationInstanceId (string) required
panorama/describe_deviceReturns information about a device.DeviceId (string) required
panorama/describe_device_jobReturns information about a device job.JobId (string) required
panorama/describe_nodeReturns information about a node.NodeId (string) required
OwnerAccount (string)
panorama/describe_node_from_template_jobReturns information about a job to create a camera stream node.JobId (string) required
panorama/describe_packageReturns information about a package.PackageId (string) required
panorama/describe_package_import_jobReturns information about a package import job.JobId (string) required
panorama/describe_package_versionReturns information about a package version.OwnerAccount (string)
PackageId (string) required
PackageVersion (string) required
PatchVersion (string)
panorama/list_application_instance_dependenciesReturns a list of application instance dependencies.ApplicationInstanceId (string) required
MaxResults (integer)
NextToken (string)
panorama/list_application_instance_node_instancesReturns a list of application node instances.ApplicationInstanceId (string) required
MaxResults (integer)
NextToken (string)
panorama/list_application_instancesReturns a list of application instances.DeviceId (string)
StatusFilter (string)
MaxResults (integer)
NextToken (string)
panorama/list_devicesReturns a list of devices.NextToken (string)
MaxResults (integer)
SortBy (string)
SortOrder (string)
NameFilter (string)
DeviceAggregatedStatusFilter (string)
panorama/list_devices_jobsReturns a list of jobs.DeviceId (string)
NextToken (string)
MaxResults (integer)
panorama/list_node_from_template_jobsReturns a list of camera stream node jobs.NextToken (string)
MaxResults (integer)
panorama/list_nodesReturns a list of nodes.Category (string)
OwnerAccount (string)
PackageName (string)
PackageVersion (string)
PatchVersion (string)
NextToken (string)
MaxResults (integer)
panorama/list_package_import_jobsReturns a list of package import jobs.NextToken (string)
MaxResults (integer)
panorama/list_packagesReturns a list of packages.MaxResults (integer)
NextToken (string)
panorama/list_tags_for_resourceReturns a list of tags for a resource.ResourceArn (string) required
panorama/provision_deviceCreates 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.Name (string) required
Description (string)
Tags (object)
NetworkingConfiguration: {
. Ethernet0 (object)
. Ethernet1 (object)
. Ntp (object)
} (object)
panorama/register_package_versionRegisters a package version.OwnerAccount (string)
PackageId (string) required
PackageVersion (string) required
PatchVersion (string) required
MarkLatest (boolean)
panorama/remove_application_instanceRemoves an application instance.ApplicationInstanceId (string) required
panorama/signal_application_instance_node_instancesSignal camera nodes to stop or resume.ApplicationInstanceId (string) required
NodeSignals (array) required
panorama/tag_resourceTags a resource.ResourceArn (string) required
Tags (object) required
panorama/untag_resourceRemoves tags from a resource.ResourceArn (string) required
TagKeys (array) required
panorama/update_device_metadataUpdates a device's metadata.DeviceId (string) required
Description (string)
partnercentral_account/get_verificationRetrieves the current status and details of a verification process for a partner account. This operation allows partners to check the progress and results of business or registrant verification processes.VerificationType (string) required
partnercentral_account/list_tags_for_resourceLists all tags associated with a specific AWS Partner Central Account resource.ResourceArn (string) required
partnercentral_account/send_email_verification_codeSends an email verification code to the specified email address for account verification purposes.Catalog (string) required
Email (string) required
partnercentral_account/start_verificationInitiates a new verification process for a partner account. This operation begins the verification workflow for either business registration or individual registrant identity verification as required by AWS Partner Central.ClientToken (string)
VerificationDetails (undefined)
partnercentral_account/tag_resourceAdds or updates tags for a specified AWS Partner Central Account resource.ResourceArn (string) required
Tags (array) required
partnercentral_account/untag_resourceRemoves specified tags from an AWS Partner Central Account resource.ResourceArn (string) required
TagKeys (array) required
partnercentral_account/accept_connection_invitationAccepts a connection invitation from another partner, establishing a formal partnership connection between the two parties.Catalog (string) required
Identifier (string) required
ClientToken (string) required
partnercentral_account/cancel_connection_invitationCancels a pending connection invitation before it has been accepted or rejected.Catalog (string) required
Identifier (string) required
ClientToken (string) required
partnercentral_account/reject_connection_invitationRejects a connection invitation from another partner, declining the partnership request.Catalog (string) required
Identifier (string) required
ClientToken (string) required
Reason (string)
partnercentral_account/create_connection_invitationCreates a new connection invitation to establish a partnership with another organization.Catalog (string) required
ClientToken (string) required
ConnectionType (string) required
Email (string) required
Message (string) required
Name (string) required
ReceiverIdentifier (string) required
partnercentral_account/get_connection_invitationRetrieves detailed information about a specific connection invitation.Catalog (string) required
Identifier (string) required
partnercentral_account/list_connection_invitationsLists connection invitations for the partner account, with optional filtering by status, type, and other criteria.Catalog (string) required
NextToken (string)
ConnectionType (string)
MaxResults (integer)
OtherParticipantIdentifiers (array)
ParticipantType (string)
Status (string)
partnercentral_account/update_connection_preferencesUpdates the connection preferences for a partner account, modifying access settings and exclusions.Catalog (string) required
Revision (integer) required
AccessType (string) required
ExcludedParticipantIdentifiers (array)
partnercentral_account/get_connection_preferencesRetrieves the connection preferences for a partner account, including access settings and exclusions.Catalog (string) required
partnercentral_account/cancel_connectionCancels an existing connection between partners, terminating the partnership relationship.Catalog (string) required
Identifier (string) required
ConnectionType (string) required
Reason (string) required
ClientToken (string) required
partnercentral_account/get_connectionRetrieves detailed information about a specific connection between partners.Catalog (string) required
Identifier (string) required
partnercentral_account/list_connectionsLists active connections for the partner account, with optional filtering by connection type and participant.Catalog (string) required
NextToken (string)
ConnectionType (string)
MaxResults (integer)
OtherParticipantIdentifiers (array)
partnercentral_account/associate_aws_training_certification_email_domainAssociates an email domain with AWS training and certification for the partner account, enabling automatic verification of employee certifications.Catalog (string) required
Identifier (string) required
ClientToken (string)
Email (string) required
EmailVerificationCode (string) required
partnercentral_account/cancel_profile_update_taskCancels an in-progress profile update task, stopping any pending changes to the partner profile.Catalog (string) required
Identifier (string) required
ClientToken (string)
TaskId (string) required
partnercentral_account/disassociate_aws_training_certification_email_domainRemoves the association between an email domain and AWS training and certification for the partner account.Catalog (string) required
Identifier (string) required
ClientToken (string)
DomainName (string) required
partnercentral_account/get_alliance_lead_contactRetrieves the alliance lead contact information for a partner account.Catalog (string) required
Identifier (string) required
partnercentral_account/get_profile_update_taskRetrieves information about a specific profile update task.Catalog (string) required
Identifier (string) required
partnercentral_account/get_profile_visibilityRetrieves the visibility settings for a partner profile, determining who can see the profile information.Catalog (string) required
Identifier (string) required
partnercentral_account/put_alliance_lead_contactCreates or updates the alliance lead contact information for a partner account.Catalog (string) required
Identifier (string) required
AllianceLeadContact: {
. FirstName (string)
. LastName (string)
. Email (string)
. BusinessTitle (string)
} (object) required
EmailVerificationCode (string)
partnercentral_account/put_profile_visibilitySets the visibility level for a partner profile, controlling who can view the profile information.Catalog (string) required
Identifier (string) required
Visibility (string) required
partnercentral_account/start_profile_update_taskInitiates a profile update task to modify partner profile information asynchronously.Catalog (string) required
Identifier (string) required
ClientToken (string)
TaskDetails: {
. DisplayName (string)
. Description (string)
. WebsiteUrl (string)
. LogoUrl (string)
. PrimarySolutionType (string)
. IndustrySegments (array)
. TranslationSourceLocale (string)
. LocalizedContents (array)
} (object) required
partnercentral_account/create_partnerCreates a new partner account in the AWS Partner Network with the specified details and configuration.Catalog (string) required
ClientToken (string)
LegalName (string) required
PrimarySolutionType (string) required
AllianceLeadContact: {
. FirstName (string)
. LastName (string)
. Email (string)
. BusinessTitle (string)
} (object) required
EmailVerificationCode (string) required
Tags (array)
partnercentral_account/get_partnerRetrieves detailed information about a specific partner account.Catalog (string) required
Identifier (string) required
partnercentral_account/list_partnersLists partner accounts in the catalog, providing a summary view of all partners.Catalog (string) required
NextToken (string)
partnercentral_benefits/amend_benefit_applicationModifies an existing benefit application by applying amendments to specific fields while maintaining revision control.Catalog (string) required
ClientToken (string) required
Revision (string) required
Identifier (string) required
AmendmentReason (string) required
Amendments (array) required
partnercentral_benefits/associate_benefit_application_resourceLinks an AWS resource to an existing benefit application for tracking and management purposes.Catalog (string) required
BenefitApplicationIdentifier (string) required
ResourceArn (string) required
partnercentral_benefits/cancel_benefit_applicationCancels a benefit application that is currently in progress, preventing further processing.Catalog (string) required
ClientToken (string) required
Identifier (string) required
Reason (string)
partnercentral_benefits/create_benefit_applicationCreates a new benefit application for a partner to request access to AWS benefits and programs.Catalog (string) required
ClientToken (string) required
Name (string)
Description (string)
BenefitIdentifier (string) required
FulfillmentTypes (array)
BenefitApplicationDetails (undefined)
Tags (array)
AssociatedResources (array)
PartnerContacts (array)
FileDetails (array)
partnercentral_benefits/disassociate_benefit_application_resourceRemoves the association between an AWS resource and a benefit application.Catalog (string) required
BenefitApplicationIdentifier (string) required
ResourceArn (string) required
partnercentral_benefits/get_benefitRetrieves detailed information about a specific benefit available in the partner catalog.Catalog (string) required
Identifier (string) required
partnercentral_benefits/get_benefit_allocationRetrieves detailed information about a specific benefit allocation that has been granted to a partner.Catalog (string) required
Identifier (string) required
partnercentral_benefits/get_benefit_applicationRetrieves detailed information about a specific benefit application.Catalog (string) required
Identifier (string) required
partnercentral_benefits/list_benefit_allocationsRetrieves a paginated list of benefit allocations based on specified filter criteria.Catalog (string) required
FulfillmentTypes (array)
BenefitIdentifiers (array)
BenefitApplicationIdentifiers (array)
Status (array)
MaxResults (integer)
NextToken (string)
partnercentral_benefits/list_benefit_applicationsRetrieves a paginated list of benefit applications based on specified filter criteria.Catalog (string) required
Programs (array)
FulfillmentTypes (array)
BenefitIdentifiers (array)
Status (array)
Stages (array)
AssociatedResources (array)
AssociatedResourceArns (array)
MaxResults (integer)
NextToken (string)
partnercentral_benefits/list_benefitsRetrieves a paginated list of available benefits based on specified filter criteria.Catalog (string) required
Programs (array)
FulfillmentTypes (array)
Status (array)
MaxResults (integer)
NextToken (string)
partnercentral_benefits/list_tags_for_resourceRetrieves all tags associated with a specific resource.resourceArn (string) required
partnercentral_benefits/recall_benefit_applicationRecalls a submitted benefit application, returning it to draft status for further modifications.Catalog (string) required
ClientToken (string)
Identifier (string) required
Reason (string) required
partnercentral_benefits/submit_benefit_applicationSubmits a benefit application for review and processing by AWS.Catalog (string) required
Identifier (string) required
partnercentral_benefits/tag_resourceAdds or updates tags for a specified resource.resourceArn (string) required
tags (array) required
partnercentral_benefits/untag_resourceRemoves specified tags from a resource.resourceArn (string) required
tagKeys (array) required
partnercentral_benefits/update_benefit_applicationUpdates an existing benefit application with new information while maintaining revision control.Catalog (string) required
ClientToken (string) required
Name (string)
Description (string)
Identifier (string) required
Revision (string) required
BenefitApplicationDetails (undefined)
PartnerContacts (array)
FileDetails (array)
partnercentral_channel/list_tags_for_resourceLists tags associated with a specific resource.resourceArn (string) required
partnercentral_channel/tag_resourceAdds or updates tags for a specified resource.resourceArn (string) required
tags (array) required
partnercentral_channel/untag_resourceRemoves tags from a specified resource.resourceArn (string) required
tagKeys (array) required
partnercentral_channel/accept_channel_handshakeAccepts a pending channel handshake request from another AWS account.catalog (string) required
identifier (string) required
partnercentral_channel/cancel_channel_handshakeCancels a pending channel handshake request.catalog (string) required
identifier (string) required
partnercentral_channel/reject_channel_handshakeRejects a pending channel handshake request.catalog (string) required
identifier (string) required
partnercentral_channel/create_channel_handshakeCreates a new channel handshake request to establish a partnership with another AWS account.handshakeType (string) required
catalog (string) required
associatedResourceIdentifier (string) required
payload (undefined)
clientToken (string)
tags (array)
partnercentral_channel/list_channel_handshakesLists channel handshakes based on specified criteria.handshakeType (string) required
catalog (string) required
participantType (string) required
maxResults (integer)
statuses (array)
associatedResourceIdentifiers (array)
handshakeTypeFilters (undefined)
handshakeTypeSort (undefined)
nextToken (string)
partnercentral_channel/create_program_management_accountCreates a new program management account for managing partner relationships.catalog (string) required
program (string) required
displayName (string) required
accountId (string) required
clientToken (string)
tags (array)
partnercentral_channel/update_program_management_accountUpdates the properties of a program management account.catalog (string) required
identifier (string) required
revision (string)
displayName (string)
partnercentral_channel/delete_program_management_accountDeletes a program management account.catalog (string) required
identifier (string) required
clientToken (string)
partnercentral_channel/list_program_management_accountsLists program management accounts based on specified criteria.catalog (string) required
maxResults (integer)
displayNames (array)
programs (array)
accountIds (array)
statuses (array)
sort: {
. sortOrder (string)
. sortBy (string)
} (object)
nextToken (string)
partnercentral_channel/create_relationshipCreates a new partner relationship between accounts.catalog (string) required
associationType (string) required
programManagementAccountIdentifier (string) required
associatedAccountId (string) required
displayName (string) required
resaleAccountModel (string)
sector (string) required
clientToken (string)
tags (array)
requestedSupportPlan (undefined)
partnercentral_channel/get_relationshipRetrieves details of a specific partner relationship.catalog (string) required
programManagementAccountIdentifier (string) required
identifier (string) required
partnercentral_channel/update_relationshipUpdates the properties of a partner relationship.catalog (string) required
identifier (string) required
programManagementAccountIdentifier (string) required
revision (string)
displayName (string)
requestedSupportPlan (undefined)
partnercentral_channel/delete_relationshipDeletes a partner relationship.catalog (string) required
identifier (string) required
programManagementAccountIdentifier (string) required
clientToken (string)
partnercentral_channel/list_relationshipsLists partner relationships based on specified criteria.catalog (string) required
maxResults (integer)
associatedAccountIds (array)
associationTypes (array)
displayNames (array)
programManagementAccountIdentifiers (array)
sort: {
. sortOrder (string)
. sortBy (string)
} (object)
nextToken (string)
partnercentral_selling/create_engagement_contextCreates a new context within an existing engagement. This action allows you to add contextual information such as customer projects or documents to an engagement, providing additional details that help facilitate collaboration between engagement members.Catalog (string) required
EngagementIdentifier (string) required
ClientToken (string) required
Type (string) required
Payload (undefined) required
partnercentral_selling/get_selling_system_settingsRetrieves the currently set system settings, which include the IAM Role used for resource snapshot jobs.Catalog (string) required
partnercentral_selling/list_tags_for_resourceReturns a list of tags for a resource.ResourceArn (string) required
partnercentral_selling/put_selling_system_settingsUpdates the currently set system settings, which include the IAM Role used for resource snapshot jobs.Catalog (string) required
ResourceSnapshotJobRoleIdentifier (string)
partnercentral_selling/tag_resourceAssigns one or more tags key-value pairs to the specified resource.ResourceArn (string) required
Tags (array) required
partnercentral_selling/untag_resourceRemoves a tag or tags from a resource.ResourceArn (string) required
TagKeys (array) required
partnercentral_selling/update_engagement_contextUpdates the context information for an existing engagement with new or modified data.Catalog (string) required
EngagementIdentifier (string) required
ContextIdentifier (string) required
EngagementLastModifiedAt (string) required
Type (string) required
Payload (undefined) required
partnercentral_selling/list_engagement_membersRetrieves the details of member partners in an Engagement. This operation can only be invoked by members of the Engagement. The ListEngagementMembers operation allows you to fetch information about the members of a specific Engagement. This action is restricted to members of the Engagement being queried.Catalog (string) required
Identifier (string) required
MaxResults (integer)
NextToken (string)
partnercentral_selling/create_engagementThe CreateEngagement action allows you to create an Engagement, which serves as a collaborative space between different parties such as AWS Partners and AWS Sellers. This action automatically adds the caller's AWS account as an active member of the newly created Engagement.Catalog (string) required
ClientToken (string) required
Title (string) required
Description (string) required
Contexts (array)
partnercentral_selling/get_engagementUse this action to retrieve the engagement record for a given EngagementIdentifier.Catalog (string) required
Identifier (string) required
partnercentral_selling/list_engagementsThis action allows users to retrieve a list of Engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process.Catalog (string) required
CreatedBy (array)
ExcludeCreatedBy (array)
ContextTypes (array)
ExcludeContextTypes (array)
Sort: {
. SortOrder (string)
. SortBy (string)
} (object)
MaxResults (integer)
NextToken (string)
EngagementIdentifier (array)
partnercentral_selling/start_engagement_by_accepting_invitation_taskThis action starts the engagement by accepting an EngagementInvitation. The task is asynchronous and involves the following steps: accepting the invitation, creating an opportunity in the partner’s account from the AWS opportunity, and copying details for tracking. When completed, an Opportunity Created event is generated, indicating that the opportunity has been successfully created in the partner's account.Catalog (string) required
ClientToken (string) required
Identifier (string) required
Tags (array)
partnercentral_selling/list_engagement_by_accepting_invitation_tasksLists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account.MaxResults (integer)
NextToken (string)
Sort: {
. SortOrder (string)
. SortBy (string)
} (object)
Catalog (string) required
TaskStatus (array)
OpportunityIdentifier (array)
EngagementInvitationIdentifier (array)
TaskIdentifier (array)
partnercentral_selling/start_engagement_from_opportunity_taskSimilar to StartEngagementByAcceptingInvitationTask, this action is asynchronous and performs multiple steps before completion. This action orchestrates a comprehensive workflow that combines multiple API operations into a single task to create and initiate an engagement from an existing opportunity. It automatically executes a sequence of operations including GetOpportunity, CreateEngagement if it doesn't exist, CreateResourceSnapshot, CreateResourceSnapshotJob, CreateEngagementInvitation if noCatalog (string) required
ClientToken (string) required
Identifier (string) required
AwsSubmission: {
. InvolvementType (string)
. Visibility (string)
} (object) required
Tags (array)
partnercentral_selling/list_engagement_from_opportunity_tasksLists all in-progress, completed, or failed EngagementFromOpportunity tasks that were initiated by the caller's account.MaxResults (integer)
NextToken (string)
Sort: {
. SortOrder (string)
. SortBy (string)
} (object)
Catalog (string) required
TaskStatus (array)
TaskIdentifier (array)
OpportunityIdentifier (array)
EngagementIdentifier (array)
partnercentral_selling/accept_engagement_invitationUse the AcceptEngagementInvitation action to accept an engagement invitation shared by AWS. Accepting the invitation indicates your willingness to participate in the engagement, granting you access to all engagement-related data.Catalog (string) required
Identifier (string) required
partnercentral_selling/reject_engagement_invitationThis action rejects an EngagementInvitation that AWS shared. Rejecting an invitation indicates that the partner doesn't want to pursue the opportunity, and all related data will become inaccessible thereafter.Catalog (string) required
Identifier (string) required
RejectionReason (string)
partnercentral_selling/create_engagement_invitationThis action creates an invitation from a sender to a single receiver to join an engagement.Catalog (string) required
ClientToken (string) required
EngagementIdentifier (string) required
Invitation: {
. Message (string)
. Receiver
. Payload
} (object) required
partnercentral_selling/get_engagement_invitationRetrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s Payload.Project.Title with opportunity Project.Title.Catalog (string) required
Identifier (string) required
partnercentral_selling/list_engagement_invitationsRetrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track opportunities shared by AWS.Catalog (string) required
MaxResults (integer)
NextToken (string)
Sort: {
. SortOrder (string)
. SortBy (string)
} (object)
PayloadType (array)
ParticipantType (string) required
Status (array)
EngagementIdentifier (array)
SenderAwsAccountId (array)
partnercentral_selling/assign_opportunityEnables you to reassign an existing Opportunity to another user within your Partner Central account. The specified user receives the opportunity, and it appears on their Partner Central dashboard, allowing them to take necessary actions or proceed with the opportunity. This is useful for distributing opportunities to the appropriate team members or departments within your organization, ensuring that each opportunity is handled by the right person. By default, the opportunity owner is the one whoCatalog (string) required
Identifier (string) required
Assignee: {
. Email (string)
. FirstName (string)
. LastName (string)
. Phone (string)
. BusinessTitle (string)
} (object) required
partnercentral_selling/associate_opportunityEnables you to create a formal association between an Opportunity and various related entities, enriching the context and details of the opportunity for better collaboration and decision making. You can associate an opportunity with the following entity types: Partner Solution: A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address business challenges using Amazon Web Services services. Amazon Web Services Products: Amazon Web ServicCatalog (string) required
OpportunityIdentifier (string) required
RelatedEntityType (string) required
RelatedEntityIdentifier (string) required
partnercentral_selling/disassociate_opportunityAllows you to remove an existing association between an Opportunity and related entities, such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer. This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage associations as business needs change. Use this operation to update the associations of an Opportunity due to changes in the related entities, or if an association was made in error. Ensuring accurate associatioCatalog (string) required
OpportunityIdentifier (string) required
RelatedEntityType (string) required
RelatedEntityIdentifier (string) required
partnercentral_selling/get_aws_opportunity_summaryRetrieves a summary of an AWS Opportunity. This summary includes high-level details about the opportunity sourced from AWS, such as lifecycle information, customer details, and involvement type. It is useful for tracking updates on the AWS opportunity corresponding to an opportunity in the partner's account.Catalog (string) required
RelatedOpportunityIdentifier (string) required
partnercentral_selling/submit_opportunityUse this action to submit an Opportunity that was previously created by partner for AWS review. After you perform this action, the Opportunity becomes non-editable until it is reviewed by AWS and has LifeCycle.ReviewStatus as either Approved or Action Required.Catalog (string) required
Identifier (string) required
InvolvementType (string) required
Visibility (string)
partnercentral_selling/create_opportunityCreates an Opportunity record in Partner Central. Use this operation to create a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets Lifecycle.ReviewStatus to Pending Submission. To submit an opportunity, follow these steps: To create the opportunity, use CreateOpportunity. To associate a solution with the opportunity, use AssociateOpportunity. To start the engagement with AWS, use StartEngagementFromOpportunity. After submission, you can't edit theCatalog (string) required
PrimaryNeedsFromAws (array)
NationalSecurity (string)
PartnerOpportunityIdentifier (string)
Customer: {
. Account (object)
. Contacts (array)
} (object)
Project: {
. DeliveryModels (array)
. ExpectedCustomerSpend (array)
. Title (string)
. ApnPrograms (array)
. CustomerBusinessProblem (string)
. CustomerUseCase (string)
. RelatedOpportunityIdentifier (string)
. SalesActivities (array)
. CompetitorName (string)
. OtherCompetitorNames (string)
. OtherSolutionDescription (string)
. AdditionalComments (string)
. AwsPartition (string)
} (object)
OpportunityType (string)
Marketing: {
. CampaignName (string)
. Source (string)
. UseCases (array)
. Channels (array)
. AwsFundingUsed (string)
} (object)
SoftwareRevenue: {
. DeliveryModel (string)
. Value (object)
. EffectiveDate (string)
. ExpirationDate (string)
} (object)
ClientToken (string) required
LifeCycle: {
. Stage (string)
. ClosedLostReason (string)
. NextSteps (string)
. TargetCloseDate (string)
. ReviewStatus (string)
. ReviewComments (string)
. ReviewStatusReason (string)
. NextStepsHistory (array)
} (object)
Origin (string)
OpportunityTeam (array)
Tags (array)
partnercentral_selling/get_opportunityFetches the Opportunity record from Partner Central by a given Identifier. Use the ListOpportunities action or the event notification from Amazon EventBridge to obtain this identifier.Catalog (string) required
Identifier (string) required
partnercentral_selling/update_opportunityUpdates the Opportunity record identified by a given Identifier. This operation allows you to modify the details of an existing opportunity to reflect the latest information and progress. Use this action to keep the opportunity record up-to-date and accurate. When you perform updates, include the entire payload with each request. If any field is omitted, the API assumes that the field is set to null. The best practice is to always perform a GetOpportunity to retrieve the latest values, then sendCatalog (string) required
PrimaryNeedsFromAws (array)
NationalSecurity (string)
PartnerOpportunityIdentifier (string)
Customer: {
. Account (object)
. Contacts (array)
} (object)
Project: {
. DeliveryModels (array)
. ExpectedCustomerSpend (array)
. Title (string)
. ApnPrograms (array)
. CustomerBusinessProblem (string)
. CustomerUseCase (string)
. RelatedOpportunityIdentifier (string)
. SalesActivities (array)
. CompetitorName (string)
. OtherCompetitorNames (string)
. OtherSolutionDescription (string)
. AdditionalComments (string)
. AwsPartition (string)
} (object)
OpportunityType (string)
Marketing: {
. CampaignName (string)
. Source (string)
. UseCases (array)
. Channels (array)
. AwsFundingUsed (string)
} (object)
SoftwareRevenue: {
. DeliveryModel (string)
. Value (object)
. EffectiveDate (string)
. ExpirationDate (string)
} (object)
LastModifiedDate (string) required
Identifier (string) required
LifeCycle: {
. Stage (string)
. ClosedLostReason (string)
. NextSteps (string)
. TargetCloseDate (string)
. ReviewStatus (string)
. ReviewComments (string)
. ReviewStatusReason (string)
. NextStepsHistory (array)
} (object)
partnercentral_selling/list_opportunitiesThis request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from Partner Central using the ListOpportunities API action. To synchronize your system with Amazon Web Services, list only the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus. You can also use the ListOpportunities action. We recCatalog (string) required
MaxResults (integer)
NextToken (string)
Sort: {
. SortOrder (string)
. SortBy (string)
} (object)
LastModifiedDate: {
. AfterLastModifiedDate (string)
. BeforeLastModifiedDate (string)
} (object)
Identifier (array)
LifeCycleStage (array)
LifeCycleReviewStatus (array)
CustomerCompanyName (array)
CreatedDate: {
. AfterCreatedDate (string)
. BeforeCreatedDate (string)
} (object)
partnercentral_selling/start_opportunity_from_engagement_taskThis action creates an opportunity from an existing engagement context. The task is asynchronous and orchestrates the process of converting engagement contextual information into a structured opportunity record within the partner's account.Catalog (string) required
ClientToken (string) required
Identifier (string) required
ContextIdentifier (string) required
Tags (array)
partnercentral_selling/list_opportunity_from_engagement_tasksLists all in-progress, completed, or failed opportunity creation tasks from engagements that were initiated by the caller's account.MaxResults (integer)
NextToken (string)
Sort: {
. SortOrder (string)
. SortBy (string)
} (object)
Catalog (string) required
TaskStatus (array)
TaskIdentifier (array)
OpportunityIdentifier (array)
EngagementIdentifier (array)
ContextIdentifier (array)
partnercentral_selling/create_resource_snapshotThis action allows you to create an immutable snapshot of a specific resource, such as an opportunity, within the context of an engagement. The snapshot captures a subset of the resource's data based on the schema defined by the provided template.Catalog (string) required
EngagementIdentifier (string) required
ResourceType (string) required
ResourceIdentifier (string) required
ResourceSnapshotTemplateIdentifier (string) required
ClientToken (string) required
partnercentral_selling/get_resource_snapshotUse this action to retrieve a specific snapshot record.Catalog (string) required
EngagementIdentifier (string) required
ResourceType (string) required
ResourceIdentifier (string) required
ResourceSnapshotTemplateIdentifier (string) required
Revision (integer)
partnercentral_selling/list_engagement_resource_associationsLists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement.Catalog (string) required
MaxResults (integer)
NextToken (string)
EngagementIdentifier (string)
ResourceType (string)
ResourceIdentifier (string)
CreatedBy (string)
partnercentral_selling/list_resource_snapshotsRetrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including: Fetching all snapshots associated with an engagement. Retrieving snapshots of a specific resource type within an engagement. Obtaining snapshots for a particular resource using a specified template. Accessing the latest snapshot of a resource within an engagement. Filtering snapshots by resource owner.Catalog (string) required
MaxResults (integer)
NextToken (string)
EngagementIdentifier (string) required
ResourceType (string)
ResourceIdentifier (string)
ResourceSnapshotTemplateIdentifier (string)
CreatedBy (string)
partnercentral_selling/start_resource_snapshot_jobStarts a resource snapshot job that has been previously created.Catalog (string) required
ResourceSnapshotJobIdentifier (string) required
partnercentral_selling/stop_resource_snapshot_jobStops a resource snapshot job. The job must be started prior to being stopped.Catalog (string) required
ResourceSnapshotJobIdentifier (string) required
partnercentral_selling/create_resource_snapshot_jobUse this action to create a job to generate a snapshot of the specified resource within an engagement. It initiates an asynchronous process to create a resource snapshot. The job creates a new snapshot only if the resource state has changed, adhering to the same access control and immutability rules as direct snapshot creation.Catalog (string) required
ClientToken (string) required
EngagementIdentifier (string) required
ResourceType (string) required
ResourceIdentifier (string) required
ResourceSnapshotTemplateIdentifier (string) required
Tags (array)
partnercentral_selling/get_resource_snapshot_jobUse this action to retrieves information about a specific resource snapshot job.Catalog (string) required
ResourceSnapshotJobIdentifier (string) required
partnercentral_selling/delete_resource_snapshot_jobUse this action to deletes a previously created resource snapshot job. The job must be in a stopped state before it can be deleted.Catalog (string) required
ResourceSnapshotJobIdentifier (string) required
partnercentral_selling/list_resource_snapshot_jobsLists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs for a specific engagement, jobs with a specific status, or any combination of these filters.Catalog (string) required
MaxResults (integer)
NextToken (string)
EngagementIdentifier (string)
Status (string)
Sort: {
. SortBy (string)
. SortOrder (string)
} (object)
partnercentral_selling/list_solutionsRetrieves a list of Partner Solutions that the partner registered on Partner Central. This API is used to generate a list of solutions that an end user selects from for association with an opportunity.Catalog (string) required
MaxResults (integer)
NextToken (string)
Sort: {
. SortOrder (string)
. SortBy (string)
} (object)
Status (array)
Identifier (array)
Category (array)
payment_cryptography_data/decrypt_dataDecrypts ciphertext data to plaintext using a symmetric TDES, AES, asymmetric RSA, or derived DUKPT or EMV encryption key scheme. For more information, see Decrypt data in the Amazon Web Services Payment Cryptography User Guide. You can use an decryption key generated within Amazon Web Services Payment Cryptography, or you can import your own decryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Decrypt. In asymmetric decryption, Amazon Web Services PaymKeyIdentifier (string) required
CipherText (string) required
DecryptionAttributes (undefined) required
WrappedKey: {
. WrappedKeyMaterial
. KeyCheckValueAlgorithm (string)
} (object)
payment_cryptography_data/encrypt_dataEncrypts plaintext data to ciphertext using a symmetric TDES, AES, asymmetric RSA, or derived DUKPT or EMV encryption key scheme. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide. You can generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey. You can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Encrypt. In asymmetric encryption, plaintext iKeyIdentifier (string) required
PlainText (string) required
EncryptionAttributes (undefined) required
WrappedKey: {
. WrappedKeyMaterial
. KeyCheckValueAlgorithm (string)
} (object)
payment_cryptography_data/generate_as2805kek_validationEstablishes node-to-node initialization between payment processing nodes such as an acquirer, issuer or payment network using Australian Standard 2805 AS2805. During node-to-node initialization, both communicating nodes must validate that they possess the correct Key Encrypting Keys KEKs before proceeding with session key exchange. In AS2805, the sending KEK KEKs of one node corresponds to the receiving KEK KEKr of its partner node. Each node uses its KEK to encrypt and decrypt session keys exchKeyIdentifier (string) required
KekValidationType (undefined) required
RandomKeySendVariantMask (string) required
payment_cryptography_data/generate_card_validation_dataGenerates card-related validation data using algorithms such as Card Verification Values CVV/CVV2, Dynamic Card Verification Values dCVV/dCVV2, or Card Security Codes CSC. For more information, see Generate card data in the Amazon Web Services Payment Cryptography User Guide. This operation generates a CVV or CSC value that is printed on a payment credit or debit card during card production. The CVV or CSC, PAN Primary Account Number and expiration date of the card are required to check its valiKeyIdentifier (string) required
PrimaryAccountNumber (string) required
GenerationAttributes (undefined) required
ValidationDataLength (integer)
payment_cryptography_data/generate_macGenerates a Message Authentication Code MAC cryptogram within Amazon Web Services Payment Cryptography. You can use this operation to authenticate card-related data by using known data values to generate MAC for data validation between the sending and receiving parties. This operation uses message data, a secret encryption key and MAC algorithm to generate a unique MAC value for transmission. The receiving party of the MAC must use the same message data, secret encryption key and MAC algorithm tKeyIdentifier (string) required
MessageData (string) required
GenerationAttributes (undefined) required
MacLength (integer)
payment_cryptography_data/generate_mac_emv_pin_changeGenerates an issuer script mac for EMV payment cards that use offline PINs as the cardholder verification method CVM. This operation generates an authenticated issuer script response by appending the incoming message data APDU command with the target encrypted PIN block in ISO2 format. The command structure and method to send the issuer script update to the card is not defined by this operation and is typically determined by the applicable payment card scheme. The primary inputs to this operatioNewPinPekIdentifier (string) required
NewEncryptedPinBlock (string) required
PinBlockFormat (string) required
SecureMessagingIntegrityKeyIdentifier (string) required
SecureMessagingConfidentialityKeyIdentifier (string) required
MessageData (string) required
DerivationMethodAttributes (undefined) required
payment_cryptography_data/generate_pin_dataGenerates pin-related data such as PIN, PIN Verification Value PVV, PIN Block, and PIN Offset during new card issuance or reissuance. For more information, see Generate PIN data in the Amazon Web Services Payment Cryptography User Guide. PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation generates PIN, PVV, or PIN Offset and then encrypts it using Pin Encryption Key PEK to create an EncryptedPinBlock for transmission from Amazon Web ServiceGenerationKeyIdentifier (string) required
EncryptionKeyIdentifier (string) required
GenerationAttributes (undefined) required
PinDataLength (integer)
PrimaryAccountNumber (string)
PinBlockFormat (string) required
EncryptionWrappedKey: {
. WrappedKeyMaterial
. KeyCheckValueAlgorithm (string)
} (object)
payment_cryptography_data/re_encrypt_dataRe-encrypt ciphertext using DUKPT or Symmetric data encryption keys. You can either generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey or import your own encryption key by calling ImportKey. The KeyArn for use with this operation must be in a compatible key state with KeyModesOfUse set to Encrypt. This operation also supports dynamic keys, allowing you to pass a dynamic encryption key as a TR-31 WrappedKeyBlock. This can be used when key material is fIncomingKeyIdentifier (string) required
OutgoingKeyIdentifier (string) required
CipherText (string) required
IncomingEncryptionAttributes (undefined) required
OutgoingEncryptionAttributes (undefined) required
IncomingWrappedKey: {
. WrappedKeyMaterial
. KeyCheckValueAlgorithm (string)
} (object)
OutgoingWrappedKey: {
. WrappedKeyMaterial
. KeyCheckValueAlgorithm (string)
} (object)
payment_cryptography_data/translate_key_materialTranslates an cryptographic key between different wrapping keys without importing the key into Amazon Web Services Payment Cryptography. This operation can be used when key material is frequently rotated, such as during every card transaction, and there is a need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. It translates short-lived transaction keys such as PEK generated for each transaction and wrapped with an ECDH derived wrapping key to another KEK wrappiIncomingKeyMaterial (undefined) required
OutgoingKeyMaterial (undefined) required
KeyCheckValueAlgorithm (string)
payment_cryptography_data/translate_pin_dataTranslates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide. PIN block translation involves changing a PIN block from one encryption key to another and optionally change its format. PIN block translation occurs entirely within the HSM boundary and PIN data never enters or leaves Amazon Web Services Payment Cryptography in clear text. The encryption key transformation can be from PEK PIncomingKeyIdentifier (string) required
OutgoingKeyIdentifier (string) required
IncomingTranslationAttributes (undefined) required
OutgoingTranslationAttributes (undefined) required
EncryptedPinBlock (string) required
IncomingDukptAttributes: {
. KeySerialNumber (string)
. DukptKeyDerivationType (string)
. DukptKeyVariant (string)
} (object)
OutgoingDukptAttributes: {
. KeySerialNumber (string)
. DukptKeyDerivationType (string)
. DukptKeyVariant (string)
} (object)
IncomingWrappedKey: {
. WrappedKeyMaterial
. KeyCheckValueAlgorithm (string)
} (object)
OutgoingWrappedKey: {
. WrappedKeyMaterial
. KeyCheckValueAlgorithm (string)
} (object)
IncomingAs2805Attributes: {
. SystemTraceAuditNumber (string)
. TransactionAmount (string)
} (object)
payment_cryptography_data/verify_auth_request_cryptogramVerifies Authorization Request Cryptogram ARQC for a EMV chip payment card authorization. For more information, see Verify auth request cryptogram in the Amazon Web Services Payment Cryptography User Guide. ARQC generation is done outside of Amazon Web Services Payment Cryptography and is typically generated on a point of sale terminal for an EMV chip card to obtain payment authorization during transaction time. For ARQC verification, you must first import the ARQC generated outside of Amazon WeKeyIdentifier (string) required
TransactionData (string) required
AuthRequestCryptogram (string) required
MajorKeyDerivationMode (string) required
SessionKeyDerivationAttributes (undefined) required
AuthResponseAttributes (undefined)
payment_cryptography_data/verify_card_validation_dataVerifies card-related validation data using algorithms such as Card Verification Values CVV/CVV2, Dynamic Card Verification Values dCVV/dCVV2 and Card Security Codes CSC. For more information, see Verify card data in the Amazon Web Services Payment Cryptography User Guide. This operation validates the CVV or CSC codes that is printed on a payment credit or debit card during card payment transaction. The input values are typically provided as part of an inbound transaction to an issuer or supportKeyIdentifier (string) required
PrimaryAccountNumber (string) required
VerificationAttributes (undefined) required
ValidationData (string) required
payment_cryptography_data/verify_macVerifies a Message Authentication Code MAC. You can use this operation to verify MAC for message data authentication such as . In this operation, you must use the same message data, secret encryption key and MAC algorithm that was used to generate MAC. You can use this operation to verify a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. For information about valid keys for this operation, see Understanding key attributes and Key types for spKeyIdentifier (string) required
MessageData (string) required
Mac (string) required
VerificationAttributes (undefined) required
MacLength (integer)
payment_cryptography_data/verify_pin_dataVerifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624. For more information, see Verify PIN data in the Amazon Web Services Payment Cryptography User Guide. This operation verifies PIN data for user payment card. A card holder PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation uses PIN Verification Key PVK for PIN or PIN Offset generation and then encrypts it using PIN Encryption Key PEK to creVerificationKeyIdentifier (string) required
EncryptionKeyIdentifier (string) required
VerificationAttributes (undefined) required
EncryptedPinBlock (string) required
PrimaryAccountNumber (string)
PinBlockFormat (string) required
PinDataLength (integer)
DukptAttributes: {
. KeySerialNumber (string)
. DukptDerivationType (string)
} (object)
EncryptionWrappedKey: {
. WrappedKeyMaterial
. KeyCheckValueAlgorithm (string)
} (object)
payment_cryptography/disable_default_key_replication_regionsDisables Multi-Region key replication settings for the specified Amazon Web Services Regions in your Amazon Web Services account, preventing new keys from being automatically replicated to those regions. After disabling Multi-Region key replication for specific regions, new keys created in your account will not be automatically replicated to those regions. You can still manually add replication to those regions for individual keys using the AddKeyReplicationRegions operation. This operation doesReplicationRegions (array) required
payment_cryptography/enable_default_key_replication_regionsEnables Multi-Region key replication settings for your Amazon Web Services account, causing new keys to be automatically replicated to the specified Amazon Web Services Regions when created. When Multi-Region key replication are enabled, any new keys created in your account will automatically be replicated to these regions unless you explicitly override this behavior during key creation. This simplifies key management for applications that operate across multiple regions. Existing keys are not aReplicationRegions (array) required
payment_cryptography/export_keyExports a key from Amazon Web Services Payment Cryptography. Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ExportKey you can export symmetric keys using either symmetric and asymmetric key exchange mechanisms. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web SKeyMaterial (undefined) required
ExportKeyIdentifier (string) required
ExportAttributes: {
. ExportDukptInitialKey (object)
. KeyCheckValueAlgorithm (string)
} (object)
payment_cryptography/get_certificate_signing_requestCreates a certificate signing request CSR from a key pair.KeyIdentifier (string) required
SigningAlgorithm (string) required
CertificateSubject: {
. CommonName (string)
. OrganizationUnit (string)
. Organization (string)
. City (string)
. Country (string)
. StateOrProvince (string)
. EmailAddress (string)
} (object) required
payment_cryptography/get_default_key_replication_regionsRetrieves the list of Amazon Web Services Regions where Multi-Region key replication is currently enabled for your Amazon Web Services account. This operation returns the current Multi-Region key replication configuration. New keys created in your account will be automatically replicated to these regions unless explicitly overridden during key creation. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: EnableDefaultKeyReplicationReNo parameters
payment_cryptography/get_parameters_for_exportGets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography. The signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 30 days. You can use the same export token to export multiple keys from your service account. Cross-account use: This operation can't be used aKeyMaterialType (string) required
SigningKeyAlgorithm (string) required
payment_cryptography/get_parameters_for_importGets the import token and the wrapping key certificate in PEM format base64 encoded to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography. The wrapping key certificate wraps the key under import. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 30 days. You can use the same import token to import multiple keys into your service account. Cross-accounKeyMaterialType (string) required
WrappingKeyAlgorithm (string) required
payment_cryptography/get_public_key_certificateGets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography. Unlike the private key of an asymmetric key, which never leaves Amazon Web Services Payment Cryptography unencrypted, callers with GetPublicKeyCertificate permission can download the public key certificate of the asymmetric key. You can share the public key certificate to allow others to encrypt messages and verify signatures outside of Amazon Web Services Payment CryptographyKeyIdentifier (string) required
payment_cryptography/import_keyImports symmetric keys and public key certificates in PEM format base64 encoded into Amazon Web Services Payment Cryptography. Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ImportKey you can import symmetric keys using either symmetric and asymmetric key exchange mechanisms. For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCKeyMaterial (undefined) required
KeyCheckValueAlgorithm (string)
Enabled (boolean)
Tags (array)
ReplicationRegions (array)
payment_cryptography/list_tags_for_resourceLists the tags for an Amazon Web Services resource. 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 ListTagsForResource 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. Cross-account use: This operation can't be used across different AmaResourceArn (string) required
NextToken (string)
MaxResults (integer)
payment_cryptography/tag_resourceAdds or edits tags on an Amazon Web Services Payment Cryptography key. Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key. 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 also add tags to an Amazon Web Services Payment CryptographyResourceArn (string) required
Tags (array) required
payment_cryptography/untag_resourceDeletes a tag from an Amazon Web Services Payment Cryptography key. Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: ListTagsForResource TagResourceResourceArn (string) required
TagKeys (array) required
payment_cryptography/get_aliasGets the Amazon Web Services Payment Cryptography key associated with the alias. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: CreateAlias DeleteAlias ListAliases UpdateAliasAliasName (string) required
payment_cryptography/update_aliasAssociates an existing Amazon Web Services Payment Cryptography alias with a different key. Each alias is associated with only one Amazon Web Services Payment Cryptography key at a time, although a key can have multiple aliases. The alias and the Amazon Web Services Payment Cryptography key must be in the same Amazon Web Services account and Amazon Web Services Region Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: CreateAlias DeAliasName (string) required
KeyArn (string)
payment_cryptography/delete_aliasDeletes the alias, but doesn't affect the underlying key. Each key can have multiple aliases. To get the aliases of all keys, use the UpdateAlias operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: CreateAlias GetAlias ListAliaAliasName (string) required
payment_cryptography/list_aliasesLists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the aliases by keyARN. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide. This is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value. Use this value in a subsequent ListAliases request to get morKeyArn (string)
NextToken (string)
MaxResults (integer)
payment_cryptography/create_aliasCreates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData. You can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and Amazon Web ServicesAliasName (string) required
KeyArn (string)
payment_cryptography/add_key_replication_regionsAdds replication Amazon Web Services Regions to an existing Amazon Web Services Payment Cryptography key, enabling the key to be used for cryptographic operations in additional Amazon Web Services Regions. Multi-Region key replication allow you to use the same key material across multiple Amazon Web Services Regions, providing lower latency for applications distributed across regions. When you add Replication Regions, Amazon Web Services Payment Cryptography securely replicates the key materialKeyIdentifier (string) required
ReplicationRegions (array) required
payment_cryptography/remove_key_replication_regionsRemoves Replication Regions from an existing Amazon Web Services Payment Cryptography key, disabling the key's availability for cryptographic operations in the specified Amazon Web Services Regions. When you remove Replication Regions, the key material is securely deleted from those regions and can no longer be used for cryptographic operations there. This operation is irreversible for the specified Amazon Web Services Regions. For more information, see Multi-Region key replication. Ensure thatKeyIdentifier (string) required
ReplicationRegions (array) required
payment_cryptography/restore_keyCancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion. During the waiting period, the KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted. After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations:KeyIdentifier (string) required
payment_cryptography/start_key_usageEnables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: StopKeyUsageKeyIdentifier (string) required
payment_cryptography/stop_key_usageDisables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography. You can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: DeleteKey StartKeyUsageKeyIdentifier (string) required
payment_cryptography/create_keyCreates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption. In addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state. When you create a key, you specify bKeyAttributes: {
. KeyUsage (string)
. KeyClass (string)
. KeyAlgorithm (string)
. KeyModesOfUse (object)
} (object) required
KeyCheckValueAlgorithm (string)
Exportable (boolean) required
Enabled (boolean)
Tags (array)
DeriveKeyUsage (string)
ReplicationRegions (array)
payment_cryptography/get_keyGets the key metadata for an Amazon Web Services Payment Cryptography key, including the immutable and mutable attributes specified when the key was created. Returns key metadata including attributes, state, and timestamps, but does not return the actual cryptographic key material. Cross-account use: This operation can't be used across different Amazon Web Services accounts. Related operations: CreateKey DeleteKey ListKeysKeyIdentifier (string) required
payment_cryptography/delete_keyDeletes the key material and metadata associated with Amazon Web Services Payment Cryptography key. Key deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion ofKeyIdentifier (string) required
DeleteKeyInDays (integer)
payment_cryptography/list_keysLists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys. This is a paginated operation, which means that each response might contain only a subset of all the keys. When the response contains only a subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys request to get more keys. When you receive a response with no NextToken or an empty or null value, that means there are no more keys to get. Cross-aKeyState (string)
NextToken (string)
MaxResults (integer)
pca_connector_ad/list_tags_for_resourceLists the tags, if any, that are associated with your resource.ResourceArn (string) required
pca_connector_ad/tag_resourceAdds one or more tags to your resource.ResourceArn (string) required
Tags (object) required
pca_connector_ad/untag_resourceRemoves one or more tags from your resource.ResourceArn (string) required
TagKeys (array) required
pca_connector_ad/create_connectorCreates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA, directory ID, and security groups.DirectoryId (string) required
CertificateAuthorityArn (string) required
VpcInformation: {
. IpAddressType (string)
. SecurityGroupIds (array)
} (object) required
ClientToken (string)
Tags (object)
pca_connector_ad/get_connectorLists information about your connector. You specify the connector on input by its ARN Amazon Resource Name.ConnectorArn (string) required
pca_connector_ad/delete_connectorDeletes a connector for Active Directory. You must provide the Amazon Resource Name ARN of the connector that you want to delete. You can find the ARN by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister your directory by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration actConnectorArn (string) required
pca_connector_ad/list_connectorsLists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.MaxResults (integer)
NextToken (string)
pca_connector_ad/create_directory_registrationCreates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active DirectoryDirectoryId (string) required
ClientToken (string)
Tags (object)
pca_connector_ad/get_directory_registrationA structure that contains information about your directory registration.DirectoryRegistrationArn (string) required
pca_connector_ad/delete_directory_registrationDeletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.DirectoryRegistrationArn (string) required
pca_connector_ad/list_directory_registrationsLists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.MaxResults (integer)
NextToken (string)
pca_connector_ad/get_service_principal_nameLists the service principal name that the connector uses to authenticate with Active Directory.DirectoryRegistrationArn (string) required
ConnectorArn (string) required
pca_connector_ad/delete_service_principal_nameDeletes the service principal name SPN used by a connector to authenticate with your Active Directory.DirectoryRegistrationArn (string) required
ConnectorArn (string) required
pca_connector_ad/list_service_principal_namesLists the service principal names that the connector uses to authenticate with Active Directory.MaxResults (integer)
NextToken (string)
DirectoryRegistrationArn (string) required
pca_connector_ad/create_service_principal_nameCreates a service principal name SPN for the service account in Active Directory. Kerberos authentication uses SPNs to associate a service instance with a service sign-in account.DirectoryRegistrationArn (string) required
ConnectorArn (string) required
ClientToken (string)
pca_connector_ad/get_template_group_access_control_entryRetrieves the group access control entries for a template.TemplateArn (string) required
GroupSecurityIdentifier (string) required
pca_connector_ad/update_template_group_access_control_entryUpdate a group access control entry you created using CreateTemplateGroupAccessControlEntry.TemplateArn (string) required
GroupSecurityIdentifier (string) required
GroupDisplayName (string)
AccessRights: {
. Enroll (string)
. AutoEnroll (string)
} (object)
pca_connector_ad/delete_template_group_access_control_entryDeletes a group access control entry.TemplateArn (string) required
GroupSecurityIdentifier (string) required
pca_connector_ad/list_template_group_access_control_entriesLists group access control entries you created.MaxResults (integer)
NextToken (string)
TemplateArn (string) required
pca_connector_ad/create_template_group_access_control_entryCreate a group access control entry. Allow or deny Active Directory groups from enrolling and/or autoenrolling with the template based on the group security identifiers SIDs.TemplateArn (string) required
GroupSecurityIdentifier (string) required
GroupDisplayName (string) required
AccessRights: {
. Enroll (string)
. AutoEnroll (string)
} (object) required
ClientToken (string)
pca_connector_ad/create_templateCreates an Active Directory compatible certificate template. The connectors issues certificates using these templates based on the requester’s Active Directory group membership.ConnectorArn (string) required
Name (string) required
Definition (undefined) required
ClientToken (string)
Tags (object)
pca_connector_ad/get_templateRetrieves a certificate template that the connector uses to issue certificates from a private CA.TemplateArn (string) required
pca_connector_ad/update_templateUpdate template configuration to define the information included in certificates.TemplateArn (string) required
Definition (undefined)
ReenrollAllCertificateHolders (boolean)
pca_connector_ad/delete_templateDeletes a template. Certificates issued using the template are still valid until they are revoked or expired.TemplateArn (string) required
pca_connector_ad/list_templatesLists the templates, if any, that are associated with a connector.MaxResults (integer)
NextToken (string)
ConnectorArn (string) required
pca_connector_scep/list_tags_for_resourceRetrieves 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.ResourceArn (string) required
pca_connector_scep/tag_resourceAdds one or more tags to your resource.ResourceArn (string) required
Tags (object) required
pca_connector_scep/untag_resourceRemoves one or more tags from your resource.ResourceArn (string) required
TagKeys (array) required
pca_connector_scep/get_challenge_passwordRetrieves the challenge password for the specified Challenge.ChallengeArn (string) required
pca_connector_scep/create_challengeFor general-purpose connectors. Creates a challenge password for the specified connector. The SCEP protocol uses a challenge password to authenticate a request before issuing a certificate from a certificate authority CA. Your SCEP clients include the challenge password as part of their certificate request to Connector for SCEP. To retrieve the connector Amazon Resource Names ARNs for the connectors in your account, call ListConnectors. To create additional challenge passwords for the connector,ConnectorArn (string) required
ClientToken (string)
Tags (object)
pca_connector_scep/get_challenge_metadataRetrieves the metadata for the specified Challenge.ChallengeArn (string) required
pca_connector_scep/delete_challengeDeletes the specified Challenge.ChallengeArn (string) required
pca_connector_scep/list_challenge_metadataRetrieves the challenge metadata for the specified ARN.MaxResults (integer)
NextToken (string)
ConnectorArn (string) required
pca_connector_scep/create_connectorCreates a SCEP connector. A SCEP connector links Amazon Web Services Private Certificate Authority to your SCEP-compatible devices and mobile device management MDM systems. Before you create a connector, you must complete a set of prerequisites, including creation of a private certificate authority CA to use with this connector. For more information, see Connector for SCEP prerequisites.CertificateAuthorityArn (string) required
MobileDeviceManagement (undefined)
ClientToken (string)
Tags (object)
pca_connector_scep/get_connectorRetrieves details about the specified Connector. Calling this action returns important details about the connector, such as the public SCEP URL where your clients can request certificates.ConnectorArn (string) required
pca_connector_scep/delete_connectorDeletes the specified Connector. This operation also deletes any challenges associated with the connector.ConnectorArn (string) required
pca_connector_scep/list_connectorsLists the connectors belonging to your Amazon Web Services account.MaxResults (integer)
NextToken (string)
pcs/list_tags_for_resourceReturns a list of all tags on an PCS resource.resourceArn (string) required
pcs/tag_resourceAdds or edits tags on an PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value 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.resourceArn (string) required
tags (object) required
pcs/untag_resourceDeletes tags from an PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name ARN of the PCS resource.resourceArn (string) required
tagKeys (array) required
pcs/delete_clusterDeletes a cluster and all its linked resources. You must delete all queues and compute node groups associated with the cluster before you can delete the cluster.clusterIdentifier (string) required
clientToken (string)
pcs/get_clusterReturns detailed information about a running cluster in your account. This API action provides networking information, endpoint information for communication with the scheduler, and provisioning status.clusterIdentifier (string) required
pcs/register_compute_node_group_instanceThis API action isn't intended for you to use. PCS uses this API action to register the compute nodes it launches in your account.clusterIdentifier (string) required
bootstrapId (string) required
pcs/list_clustersReturns a list of running clusters in your account.nextToken (string)
maxResults (integer)
pcs/create_clusterCreates a cluster in your account. PCS creates the cluster controller in a service-owned account. The cluster controller communicates with the cluster resources in your account. The subnets and security groups for the cluster must already exist before you use this API action. It takes time for PCS to create the cluster. The cluster is in a Creating state until it is ready to use. There can only be 1 cluster in a Creating state per Amazon Web Services Region per Amazon Web Services account. CreatclusterName (string) required
scheduler: {
. type (string)
. version (string)
} (object) required
size (string) required
networking: {
. subnetIds (array)
. securityGroupIds (array)
. networkType (string)
} (object) required
slurmConfiguration: {
. scaleDownIdleTimeInSeconds (integer)
. slurmCustomSettings (array)
. accounting (object)
. slurmRest (object)
} (object)
clientToken (string)
tags (object)
pcs/update_clusterUpdates a cluster configuration. You can modify Slurm scheduler settings, accounting configuration, and security groups for an existing cluster. You can only update clusters that are in ACTIVE, UPDATE_FAILED, or SUSPENDED state. All associated resources queues and compute node groups must be in ACTIVE state before you can update the cluster.clusterIdentifier (string) required
clientToken (string)
slurmConfiguration: {
. scaleDownIdleTimeInSeconds (integer)
. slurmCustomSettings (array)
. accounting (object)
. slurmRest (object)
} (object)
pcs/delete_compute_node_groupDeletes a compute node group. You must delete all queues associated with the compute node group first.clusterIdentifier (string) required
computeNodeGroupIdentifier (string) required
clientToken (string)
pcs/get_compute_node_groupReturns detailed information about a compute node group. This API action provides networking information, EC2 instance type, compute node group status, and scheduler such as Slurm configuration.clusterIdentifier (string) required
computeNodeGroupIdentifier (string) required
pcs/list_compute_node_groupsReturns a list of all compute node groups associated with a cluster.clusterIdentifier (string) required
nextToken (string)
maxResults (integer)
pcs/create_compute_node_groupCreates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. PCS uses the information you provide to this API action to launch compute nodes in your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive billing charges for the compute nodes that PCS launches in your account. YoclusterIdentifier (string) required
computeNodeGroupName (string) required
amiId (string)
subnetIds (array) required
purchaseOption (string)
customLaunchTemplate: {
. id (string)
. version (string)
} (object) required
iamInstanceProfileArn (string) required
scalingConfiguration: {
. minInstanceCount (integer)
. maxInstanceCount (integer)
} (object) required
instanceConfigs (array) required
spotOptions: {
. allocationStrategy (string)
} (object)
slurmConfiguration: {
. slurmCustomSettings (array)
} (object)
clientToken (string)
tags (object)
pcs/update_compute_node_groupUpdates a compute node group. You can update many of the fields related to your compute node group including the configurations for networking, compute nodes, and settings specific to your scheduler such as Slurm.clusterIdentifier (string) required
computeNodeGroupIdentifier (string) required
amiId (string)
subnetIds (array)
customLaunchTemplate: {
. id (string)
. version (string)
} (object)
purchaseOption (string)
spotOptions: {
. allocationStrategy (string)
} (object)
scalingConfiguration: {
. minInstanceCount (integer)
. maxInstanceCount (integer)
} (object)
iamInstanceProfileArn (string)
slurmConfiguration: {
. slurmCustomSettings (array)
} (object)
clientToken (string)
pcs/delete_queueDeletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, PCS terminates all the compute nodes for this queue.clusterIdentifier (string) required
queueIdentifier (string) required
clientToken (string)
pcs/get_queueReturns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.clusterIdentifier (string) required
queueIdentifier (string) required
pcs/list_queuesReturns a list of all queues associated with a cluster.clusterIdentifier (string) required
nextToken (string)
maxResults (integer)
pcs/create_queueCreates a job queue. You must associate 1 or more compute node groups with the queue. You can associate 1 compute node group with multiple queues.clusterIdentifier (string) required
queueName (string) required
computeNodeGroupConfigurations (array)
slurmConfiguration: {
. slurmCustomSettings (array)
} (object)
clientToken (string)
tags (object)
pcs/update_queueUpdates the compute node group configuration of a queue. Use this API to change the compute node groups that the queue can send jobs to.clusterIdentifier (string) required
queueIdentifier (string) required
computeNodeGroupConfigurations (array)
slurmConfiguration: {
. slurmCustomSettings (array)
} (object)
clientToken (string)
personalize_events/put_action_interactionsRecords action interaction event data. An action interaction event is an interaction between a user and an action. For example, a user taking an action, such a enrolling in a membership program or downloading your app. For more information about recording action interactions, see Recording action interaction events. For more information about actions in an Actions dataset, see Actions dataset.trackingId (string) required
actionInteractions (array) required
personalize_events/put_actionsAdds one or more actions to an Actions dataset. For more information see Importing actions individually.datasetArn (string) required
actions (array) required
personalize_events/put_eventsRecords item interaction event data. For more information see Recording item interaction events.trackingId (string) required
userId (string)
sessionId (string) required
eventList (array) required
personalize_events/put_itemsAdds one or more items to an Items dataset. For more information see Importing items individually.datasetArn (string) required
items (array) required
personalize_events/put_usersAdds one or more users to a Users dataset. For more information see Importing users individually.datasetArn (string) required
users (array) required
personalize_runtime/get_action_recommendationsReturns a list of recommended actions in sorted in descending order by prediction score. Use the GetActionRecommendations API if you have a custom campaign that deploys a solution version trained with a PERSONALIZED_ACTIONS recipe. For more information about PERSONALIZED_ACTIONS recipes, see PERSONALIZED_ACTIONS recipes. For more information about getting action recommendations, see Getting action recommendations.campaignArn (string)
userId (string)
numResults (integer)
filterArn (string)
filterValues (object)
personalize_runtime/get_personalized_rankingRe-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.campaignArn (string) required
inputList (array) required
userId (string) required
context (object)
filterArn (string)
filterValues (object)
metadataColumns (object)
personalize_runtime/get_recommendationsReturns 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 rcampaignArn (string)
itemId (string)
userId (string)
numResults (integer)
context (object)
filterArn (string)
filterValues (object)
recommenderArn (string)
promotions (array)
metadataColumns (object)
personalize/create_batch_inference_jobGenerates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket. To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of rjobName (string) required
solutionVersionArn (string) required
filterArn (string)
numResults (integer)
jobInput: {
. s3DataSource (object)
} (object) required
jobOutput: {
. s3DataDestination (object)
} (object) required
roleArn (string) required
batchInferenceJobConfig: {
. itemExplorationConfig (object)
. rankingInfluence (object)
} (object)
tags (array)
batchInferenceJobMode (string)
themeGenerationConfig: {
. fieldsForThemeGeneration (object)
} (object)
personalize/create_batch_segment_jobCreates 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.jobName (string) required
solutionVersionArn (string) required
filterArn (string)
numResults (integer)
jobInput: {
. s3DataSource (object)
} (object) required
jobOutput: {
. s3DataDestination (object)
} (object) required
roleArn (string) required
tags (array)
personalize/create_campaignYou incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign costs, see Amazon Personalize pricing. 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 high minProvisionedTPS will increase your cost. We recommend starting with 1 for minProvisname (string) required
solutionVersionArn (string) required
minProvisionedTPS (integer)
campaignConfig: {
. itemExplorationConfig (object)
. enableMetadataWithRecommendations (boolean)
. syncWithLatestSolutionVersion (boolean)
. rankingInfluence (object)
} (object)
tags (array)
personalize/create_data_deletion_jobCreates a batch job that deletes all references to specific users from an Amazon Personalize dataset group in batches. You specify the users to delete in a CSV file of userIds in an Amazon S3 bucket. After a job completes, Amazon Personalize no longer trains on the users’ data and no longer considers the users when generating user segments. For more information about creating a data deletion job, see Deleting users. Your input file must be a CSV file with a single USER_ID column that lists the ujobName (string) required
datasetGroupArn (string) required
dataSource: {
. dataLocation (string)
} (object) required
roleArn (string) required
tags (array)
personalize/create_datasetCreates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset. There are 5 types of datasets: Item interactions Items Users Action interactions Actions Each dataset type has an associated schema with required field types. Only the Item 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 ACTname (string) required
schemaArn (string) required
datasetGroupArn (string) required
datasetType (string) required
tags (array)
personalize/create_dataset_export_jobCreates 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 jjobName (string) required
datasetArn (string) required
ingestionMode (string)
roleArn (string) required
jobOutput: {
. s3DataDestination (object)
} (object) required
tags (array)
personalize/create_dataset_groupCreates 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: Item interactions Items Users Actions Action interactions 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. Iname (string) required
roleArn (string)
kmsKeyArn (string)
domain (string)
tags (array)
personalize/create_dataset_import_jobCreates 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. If you already created a recommender orjobName (string) required
datasetArn (string) required
dataSource: {
. dataLocation (string)
} (object) required
roleArn (string)
tags (array)
importMode (string)
publishAttributionMetricsToS3 (boolean)
personalize/create_event_trackerCreates 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 Item interactionsname (string) required
datasetGroupArn (string) required
tags (array)
personalize/create_filterCreates a recommendation filter. For more information, see Filtering recommendations and user segments.name (string) required
datasetGroupArn (string) required
filterExpression (string) required
tags (array)
personalize/create_metric_attributionCreates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.name (string) required
datasetGroupArn (string) required
metrics (array) required
metricsOutputConfig: {
. s3DataDestination (object)
. roleArn (string)
} (object) required
personalize/create_recommenderCreates 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 A high minRecommendationRequestsPerSecond will increase your bill. We recommend starting with 1 for minRecommendationRequestsPerSecond the default. Track your usage using Amazon CloudWatch metrics, and increase the minRecommname (string) required
datasetGroupArn (string) required
recipeArn (string) required
recommenderConfig: {
. itemExplorationConfig (object)
. minRecommendationRequestsPerSecond (integer)
. trainingDataConfig (object)
. enableMetadataWithRecommendations (boolean)
} (object)
tags (array)
personalize/create_schemaCreates 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 DeleteSchemaname (string) required
schema (string) required
domain (string)
personalize/create_solutionBy default, all new solutions use automatic training. With automatic training, you incur training costs while your solution is active. To avoid unnecessary costs, when you are finished you can update the solution to turn off automatic training. For information about training costs, see Amazon Personalize pricing. Creates the configuration for training a model creating a solution version. This configuration includes the recipe to use for model training and optional training configuration, such asname (string) required
performHPO (boolean)
performAutoML (boolean)
performAutoTraining (boolean)
performIncrementalUpdate (boolean)
recipeArn (string)
datasetGroupArn (string) required
eventType (string)
solutionConfig: {
. eventValueThreshold (string)
. hpoConfig (object)
. algorithmHyperParameters (object)
. featureTransformationParameters (object)
. autoMLConfig (object)
. eventsConfig (object)
. optimizationObjective (object)
. trainingDataConfig (object)
. autoTrainingConfig (object)
} (object)
tags (array)
personalize/create_solution_versionTrains 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 sname (string)
solutionArn (string) required
trainingMode (string)
tags (array)
personalize/delete_campaignRemoves 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.campaignArn (string) required
personalize/delete_datasetDeletes 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 about deleting datasets, see Deleting a dataset.datasetArn (string) required
personalize/delete_dataset_groupDeletes 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.datasetGroupArn (string) required
personalize/delete_event_trackerDeletes the event tracker. Does not delete the dataset from the dataset group. For more information on event trackers, see CreateEventTracker.eventTrackerArn (string) required
personalize/delete_filterDeletes a filter.filterArn (string) required
personalize/delete_metric_attributionDeletes a metric attribution.metricAttributionArn (string) required
personalize/delete_recommenderDeactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.recommenderArn (string) required
personalize/delete_schemaDeletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.schemaArn (string) required
personalize/delete_solutionDeletes 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.solutionArn (string) required
personalize/describe_algorithmDescribes the given algorithm.algorithmArn (string) required
personalize/describe_batch_inference_jobGets 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.batchInferenceJobArn (string) required
personalize/describe_batch_segment_jobGets 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.batchSegmentJobArn (string) required
personalize/describe_campaignDescribes 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.campaignArn (string) required
personalize/describe_data_deletion_jobDescribes the data deletion job created by CreateDataDeletionJob, including the job status.dataDeletionJobArn (string) required
personalize/describe_datasetDescribes the given dataset. For more information on datasets, see CreateDataset.datasetArn (string) required
personalize/describe_dataset_export_jobDescribes the dataset export job created by CreateDatasetExportJob, including the export job status.datasetExportJobArn (string) required
personalize/describe_dataset_groupDescribes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.datasetGroupArn (string) required
personalize/describe_dataset_import_jobDescribes the dataset import job created by CreateDatasetImportJob, including the import job status.datasetImportJobArn (string) required
personalize/describe_event_trackerDescribes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.eventTrackerArn (string) required
personalize/describe_feature_transformationDescribes the given feature transformation.featureTransformationArn (string) required
personalize/describe_filterDescribes a filter's properties.filterArn (string) required
personalize/describe_metric_attributionDescribes a metric attribution.metricAttributionArn (string) required
personalize/describe_recipeDescribes 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 rerecipeArn (string) required
personalize/describe_recommenderDescribes 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 recommendrecommenderArn (string) required
personalize/describe_schemaDescribes a schema. For more information on schemas, see CreateSchema.schemaArn (string) required
personalize/describe_solutionDescribes a solution. For more information on solutions, see CreateSolution.solutionArn (string) required
personalize/describe_solution_versionDescribes a specific version of a solution. For more information on solutions, see CreateSolutionsolutionVersionArn (string) required
personalize/get_solution_metricsGets the metrics for the specified solution version.solutionVersionArn (string) required
personalize/list_batch_inference_jobsGets a list of the batch inference jobs that have been performed off of a solution version.solutionVersionArn (string)
nextToken (string)
maxResults (integer)
personalize/list_batch_segment_jobsGets a list of the batch segment jobs that have been performed off of a solution version that you specify.solutionVersionArn (string)
nextToken (string)
maxResults (integer)
personalize/list_campaignsReturns 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.solutionArn (string)
nextToken (string)
maxResults (integer)
personalize/list_data_deletion_jobsReturns a list of data deletion jobs for a dataset group ordered by creation time, with the most recent first. When a dataset group is not specified, all the data deletion jobs associated with the account are listed. The response provides the properties for each job, including the Amazon Resource Name ARN. For more information on data deletion jobs, see Deleting users.datasetGroupArn (string)
nextToken (string)
maxResults (integer)
personalize/list_dataset_export_jobsReturns 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.datasetArn (string)
nextToken (string)
maxResults (integer)
personalize/list_dataset_groupsReturns 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.nextToken (string)
maxResults (integer)
personalize/list_dataset_import_jobsReturns 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.datasetArn (string)
nextToken (string)
maxResults (integer)
personalize/list_datasetsReturns 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.datasetGroupArn (string)
nextToken (string)
maxResults (integer)
personalize/list_event_trackersReturns 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.datasetGroupArn (string)
nextToken (string)
maxResults (integer)
personalize/list_filtersLists all filters that belong to a given dataset group.datasetGroupArn (string)
nextToken (string)
maxResults (integer)
personalize/list_metric_attribution_metricsLists the metrics for the metric attribution.metricAttributionArn (string)
nextToken (string)
maxResults (integer)
personalize/list_metric_attributionsLists metric attributions.datasetGroupArn (string)
nextToken (string)
maxResults (integer)
personalize/list_recipesReturns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name ARN.recipeProvider (string)
nextToken (string)
maxResults (integer)
domain (string)
personalize/list_recommendersReturns 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.datasetGroupArn (string)
nextToken (string)
maxResults (integer)
personalize/list_schemasReturns 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.nextToken (string)
maxResults (integer)
personalize/list_solutionsReturns a list of solutions in a 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.datasetGroupArn (string)
nextToken (string)
maxResults (integer)
personalize/list_solution_versionsReturns 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.solutionArn (string)
nextToken (string)
maxResults (integer)
personalize/list_tags_for_resourceGet a list of tags attached to a resource.resourceArn (string) required
personalize/start_recommenderStarts a recommender that is INACTIVE. Starting a recommender does not create any new models, but resumes billing and automatic retraining for the recommender.recommenderArn (string) required
personalize/stop_recommenderStops a recommender that is ACTIVE. Stopping a recommender halts billing and automatic retraining for the recommender.recommenderArn (string) required
personalize/stop_solution_version_creationStops 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.solutionVersionArn (string) required
personalize/tag_resourceAdd a list of tags to a resource.resourceArn (string) required
tags (array) required
personalize/untag_resourceRemoves the specified tags that are attached to a resource. For more information, see Removing tags from Amazon Personalize resources.resourceArn (string) required
tagKeys (array) required
personalize/update_campaignUpdates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's minProvisionedTPS, or modify your campaign's configuration. For example, you can set enableMetadataWithRecommendations to true for an existing campaign. To update a campaign to start automatically using the latest solution version, specify the following: For the SolutionVersionArn parameter, specify the Amazon Resource Name ARN of your solution in SolutionArn/$LATEST format. In the campaigcampaignArn (string) required
solutionVersionArn (string)
minProvisionedTPS (integer)
campaignConfig: {
. itemExplorationConfig (object)
. enableMetadataWithRecommendations (boolean)
. syncWithLatestSolutionVersion (boolean)
. rankingInfluence (object)
} (object)
personalize/update_datasetUpdate a dataset to replace its schema with a new or existing one. For more information, see Replacing a dataset's schema.datasetArn (string) required
schemaArn (string) required
personalize/update_metric_attributionUpdates a metric attribution.addMetrics (array)
removeMetrics (array)
metricsOutputConfig: {
. s3DataDestination (object)
. roleArn (string)
} (object)
metricAttributionArn (string)
personalize/update_recommenderUpdates the recommender to modify the recommender configuration. If you update the recommender to modify the columns used in training, Amazon Personalize automatically starts a full retraining of the models backing your recommender. While the update completes, you can still get recommendations from the recommender. The recommender uses the previous configuration until the update completes. To track the status of this update, use the latestRecommenderUpdate returned in the DescribeRecommender operecommenderArn (string) required
recommenderConfig: {
. itemExplorationConfig (object)
. minRecommendationRequestsPerSecond (integer)
. trainingDataConfig (object)
. enableMetadataWithRecommendations (boolean)
} (object) required
personalize/update_solutionUpdates an Amazon Personalize solution to use a different automatic training configuration. When you update a solution, you can change whether the solution uses automatic training, and you can change the training frequency. For more information about updating a solution, see Updating a solution. A solution update can be in one of the following states: CREATE PENDING CREATE IN_PROGRESS ACTIVE -or- CREATE FAILED To get the status of a solution update, call the DescribeSolution API operation andsolutionArn (string) required
performAutoTraining (boolean)
performIncrementalUpdate (boolean)
solutionUpdateConfig: {
. autoTrainingConfig (object)
. eventsConfig (object)
} (object)
pi/create_performance_analysis_reportCreates a new performance analysis report for a specific time period for the DB instance.ServiceType (string) required
Identifier (string) required
StartTime (string) required
EndTime (string) required
Tags (array)
pi/delete_performance_analysis_reportDeletes a performance analysis report.ServiceType (string) required
Identifier (string) required
AnalysisReportId (string) required
pi/describe_dimension_keysFor 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.ServiceType (string) required
Identifier (string) required
StartTime (string) required
EndTime (string) required
Metric (string) required
PeriodInSeconds (integer)
GroupBy: {
. Group (string)
. Dimensions (array)
. Limit (integer)
} (object) required
AdditionalMetrics (array)
PartitionBy: {
. Group (string)
. Dimensions (array)
. Limit (integer)
} (object)
Filter (object)
MaxResults (integer)
NextToken (string)
pi/get_dimension_key_detailsGet 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, lock snapshots, and execution plans.ServiceType (string) required
Identifier (string) required
Group (string) required
GroupIdentifier (string) required
RequestedDimensions (array)
pi/get_performance_analysis_reportRetrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.ServiceType (string) required
Identifier (string) required
AnalysisReportId (string) required
TextFormat (string)
AcceptLanguage (string)
pi/get_resource_metadataRetrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.ServiceType (string) required
Identifier (string) required
pi/get_resource_metricsRetrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric. Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.ServiceType (string) required
Identifier (string) required
MetricQueries (array) required
StartTime (string) required
EndTime (string) required
PeriodInSeconds (integer)
MaxResults (integer)
NextToken (string)
PeriodAlignment (string)
pi/list_available_resource_dimensionsRetrieve the dimensions that can be queried for each specified metric type on a specified DB instance.ServiceType (string) required
Identifier (string) required
Metrics (array) required
MaxResults (integer)
NextToken (string)
AuthorizedActions (array)
pi/list_available_resource_metricsRetrieve metrics of the specified types that can be queried for a specified DB instance.ServiceType (string) required
Identifier (string) required
MetricTypes (array) required
NextToken (string)
MaxResults (integer)
pi/list_performance_analysis_reportsLists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.ServiceType (string) required
Identifier (string) required
NextToken (string)
MaxResults (integer)
ListTags (boolean)
pi/list_tags_for_resourceRetrieves all the metadata tags associated with Amazon RDS Performance Insights resource.ServiceType (string) required
ResourceARN (string) required
pi/tag_resourceAdds metadata tags to the Amazon RDS Performance Insights resource.ServiceType (string) required
ResourceARN (string) required
Tags (array) required
pi/untag_resourceDeletes the metadata tags from the Amazon RDS Performance Insights resource.ServiceType (string) required
ResourceARN (string) required
TagKeys (array) required
pinpoint_email/create_configuration_setCreate 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.ConfigurationSetName (string) required
TrackingOptions: {
. CustomRedirectDomain (string)
} (object)
DeliveryOptions: {
. TlsPolicy (string)
. SendingPoolName (string)
} (object)
ReputationOptions: {
. ReputationMetricsEnabled (boolean)
. LastFreshStart (string)
} (object)
SendingOptions: {
. SendingEnabled (boolean)
} (object)
Tags (array)
pinpoint_email/create_configuration_set_event_destinationCreate 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.ConfigurationSetName (string) required
EventDestinationName (string) required
EventDestination: {
. Enabled (boolean)
. MatchingEventTypes (array)
. KinesisFirehoseDestination (object)
. CloudWatchDestination (object)
. SnsDestination (object)
. PinpointDestination (object)
} (object) required
pinpoint_email/create_dedicated_ip_poolCreate 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.PoolName (string) required
Tags (array)
pinpoint_email/create_deliverability_test_reportCreate 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 tReportName (string)
FromEmailAddress (string) required
Content: {
. Simple (object)
. Raw (object)
. Template (object)
} (object) required
Tags (array)
pinpoint_email/create_email_identityVerifies 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 emailEmailIdentity (string) required
Tags (array)
pinpoint_email/delete_configuration_setDelete 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.ConfigurationSetName (string) required
pinpoint_email/delete_configuration_set_event_destinationDelete 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.ConfigurationSetName (string) required
EventDestinationName (string) required
pinpoint_email/delete_dedicated_ip_poolDelete a dedicated IP pool.PoolName (string) required
pinpoint_email/delete_email_identityDeletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.EmailIdentity (string) required
pinpoint_email/get_accountObtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.No parameters
pinpoint_email/get_blacklist_reportsRetrieve a list of the blacklists that your dedicated IP addresses appear on.BlacklistItemNames (array) required
pinpoint_email/get_configuration_setGet 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 thConfigurationSetName (string) required
pinpoint_email/get_configuration_set_event_destinationsRetrieve 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.ConfigurationSetName (string) required
pinpoint_email/get_dedicated_ipGet 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.Ip (string) required
pinpoint_email/get_dedicated_ipsList the dedicated IP addresses that are associated with your Amazon Pinpoint account.PoolName (string)
NextToken (string)
PageSize (integer)
pinpoint_email/get_deliverability_dashboard_optionsRetrieve 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 PinpNo parameters
pinpoint_email/get_deliverability_test_reportRetrieve the results of a predictive inbox placement test.ReportId (string) required
pinpoint_email/get_domain_deliverability_campaignRetrieve 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.CampaignId (string) required
pinpoint_email/get_domain_statistics_reportRetrieve inbox placement and engagement rates for the domains that you use to send email.Domain (string) required
StartDate (string) required
EndDate (string) required
pinpoint_email/get_email_identityProvides 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.EmailIdentity (string) required
pinpoint_email/list_configuration_setsList 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.NextToken (string)
PageSize (integer)
pinpoint_email/list_dedicated_ip_poolsList all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.NextToken (string)
PageSize (integer)
pinpoint_email/list_deliverability_test_reportsShow 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.NextToken (string)
PageSize (integer)
pinpoint_email/list_domain_deliverability_campaignsRetrieve 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.StartDate (string) required
EndDate (string) required
SubscribedDomain (string) required
NextToken (string)
PageSize (integer)
pinpoint_email/list_email_identitiesReturns 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.NextToken (string)
PageSize (integer)
pinpoint_email/list_tags_for_resourceRetrieve 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.ResourceArn (string) required
pinpoint_email/put_account_dedicated_ip_warmup_attributesEnable or disable the automatic warm-up feature for dedicated IP addresses.AutoWarmupEnabled (boolean)
pinpoint_email/put_account_sending_attributesEnable or disable the ability of your account to send email.SendingEnabled (boolean)
pinpoint_email/put_configuration_set_delivery_optionsAssociate 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.ConfigurationSetName (string) required
TlsPolicy (string)
SendingPoolName (string)
pinpoint_email/put_configuration_set_reputation_optionsEnable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.ConfigurationSetName (string) required
ReputationMetricsEnabled (boolean)
pinpoint_email/put_configuration_set_sending_optionsEnable or disable email sending for messages that use a particular configuration set in a specific AWS Region.ConfigurationSetName (string) required
SendingEnabled (boolean)
pinpoint_email/put_configuration_set_tracking_optionsSpecify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.ConfigurationSetName (string) required
CustomRedirectDomain (string)
pinpoint_email/put_dedicated_ip_in_poolMove 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.Ip (string) required
DestinationPoolName (string) required
pinpoint_email/put_dedicated_ip_warmup_attributesNo description availableIp (string) required
WarmupPercentage (integer) required
pinpoint_email/put_deliverability_dashboard_optionEnable 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 informatDashboardEnabled (boolean) required
SubscribedDomains (array)
pinpoint_email/put_email_identity_dkim_attributesUsed to enable or disable DKIM authentication for an email identity.EmailIdentity (string) required
SigningEnabled (boolean)
pinpoint_email/put_email_identity_feedback_attributesUsed 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 notificaEmailIdentity (string) required
EmailForwardingEnabled (boolean)
pinpoint_email/put_email_identity_mail_from_attributesUsed to enable or disable the custom Mail-From domain configuration for an email identity.EmailIdentity (string) required
MailFromDomain (string)
BehaviorOnMxFailure (string)
pinpoint_email/send_emailSends 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 attaFromEmailAddress (string)
Destination: {
. ToAddresses (array)
. CcAddresses (array)
. BccAddresses (array)
} (object) required
ReplyToAddresses (array)
FeedbackForwardingEmailAddress (string)
Content: {
. Simple (object)
. Raw (object)
. Template (object)
} (object) required
EmailTags (array)
ConfigurationSetName (string)
pinpoint_email/tag_resourceAdd 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 valuesResourceArn (string) required
Tags (array) required
pinpoint_email/untag_resourceRemove one or more tags keys and values from a specified resource.ResourceArn (string) required
TagKeys (array) required
pinpoint_email/update_configuration_set_event_destinationUpdate 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.ConfigurationSetName (string) required
EventDestinationName (string) required
EventDestination: {
. Enabled (boolean)
. MatchingEventTypes (array)
. KinesisFirehoseDestination (object)
. CloudWatchDestination (object)
. SnsDestination (object)
. PinpointDestination (object)
} (object) required
pinpoint_sms_voice_v2/associate_origination_identityAssociates 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.PoolId (string) required
OriginationIdentity (string) required
IsoCountryCode (string) required
ClientToken (string)
pinpoint_sms_voice_v2/associate_protect_configurationAssociate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.ProtectConfigurationId (string) required
ConfigurationSetName (string) required
pinpoint_sms_voice_v2/carrier_lookupReturns information about a destination phone number, including whether the number type and whether it is valid, the carrier, and more.PhoneNumber (string) required
pinpoint_sms_voice_v2/create_configuration_setCreates 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.ConfigurationSetName (string) required
Tags (array)
ClientToken (string)
pinpoint_sms_voice_v2/create_event_destinationCreates 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 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. You can only create one event destination at a time. You must provide a value for a single event deConfigurationSetName (string) required
EventDestinationName (string) required
MatchingEventTypes (array) required
CloudWatchLogsDestination: {
. IamRoleArn (string)
. LogGroupArn (string)
} (object)
KinesisFirehoseDestination: {
. IamRoleArn (string)
. DeliveryStreamArn (string)
} (object)
SnsDestination: {
. TopicArn (string)
} (object)
ClientToken (string)
pinpoint_sms_voice_v2/create_opt_out_listCreates 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 End User Messaging SOptOutListName (string) required
Tags (array)
ClientToken (string)
pinpoint_sms_voice_v2/create_poolCreates 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 originatOriginationIdentity (string) required
IsoCountryCode (string) required
MessageType (string) required
DeletionProtectionEnabled (boolean)
Tags (array)
ClientToken (string)
pinpoint_sms_voice_v2/create_protect_configurationCreate a new protect configuration. By default all country rule sets for each capability are set to ALLOW. Update the country rule sets using UpdateProtectConfigurationCountryRuleSet. A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.ClientToken (string)
DeletionProtectionEnabled (boolean)
Tags (array)
pinpoint_sms_voice_v2/create_registrationCreates a new registration based on the RegistrationType field.RegistrationType (string) required
Tags (array)
ClientToken (string)
pinpoint_sms_voice_v2/create_registration_associationAssociate the registration with an origination identity such as a phone number or sender ID.RegistrationId (string) required
ResourceId (string) required
pinpoint_sms_voice_v2/create_registration_attachmentCreate a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed “letter of authorization” LOA to be submitted. Use either AttachmentUrl or AttachmentBody to upload your attachment. If both are specified then an exception is returned.AttachmentBody (string)
AttachmentUrl (string)
Tags (array)
ClientToken (string)
pinpoint_sms_voice_v2/create_registration_versionCreate a new version of the registration and increase the VersionNumber. The previous version of the registration becomes read-only.RegistrationId (string) required
pinpoint_sms_voice_v2/create_verified_destination_numberYou can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.DestinationPhoneNumber (string) required
Tags (array)
ClientToken (string)
pinpoint_sms_voice_v2/delete_account_default_protect_configurationRemoves the current account default protect configuration.No parameters
pinpoint_sms_voice_v2/delete_configuration_setDeletes 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.ConfigurationSetName (string) required
pinpoint_sms_voice_v2/delete_default_message_typeDeletes 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.ConfigurationSetName (string) required
pinpoint_sms_voice_v2/delete_default_sender_idDeletes 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.ConfigurationSetName (string) required
pinpoint_sms_voice_v2/delete_event_destinationDeletes 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.ConfigurationSetName (string) required
EventDestinationName (string) required
pinpoint_sms_voice_v2/delete_keywordDeletes 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, End User Messaging SMS responds with a customizable message. Keywords 'HELP' and 'STOP' can't be deleted or modified.OriginationIdentity (string) required
Keyword (string) required
pinpoint_sms_voice_v2/delete_media_message_spend_limit_overrideDeletes an account-level monthly spending limit override for sending multimedia messages MMS. 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 Quotas for Server Migration Service in the Server Migration Service User Guide.No parameters
pinpoint_sms_voice_v2/delete_opted_out_numberDeletes 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.OptOutListName (string) required
OptedOutNumber (string) required
pinpoint_sms_voice_v2/delete_opt_out_listDeletes 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.OptOutListName (string) required
pinpoint_sms_voice_v2/delete_poolDeletes 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.PoolId (string) required
pinpoint_sms_voice_v2/delete_protect_configurationPermanently delete the protect configuration. The protect configuration must have deletion protection disabled and must not be associated as the account default protect configuration or associated with a configuration set.ProtectConfigurationId (string) required
pinpoint_sms_voice_v2/delete_protect_configuration_rule_set_number_overridePermanently delete the protect configuration rule set number override.ProtectConfigurationId (string) required
DestinationPhoneNumber (string) required
pinpoint_sms_voice_v2/delete_registrationPermanently delete an existing registration from your account.RegistrationId (string) required
pinpoint_sms_voice_v2/delete_registration_attachmentPermanently delete the specified registration attachment.RegistrationAttachmentId (string) required
pinpoint_sms_voice_v2/delete_registration_field_valueDelete the value in a registration form field.RegistrationId (string) required
FieldPath (string) required
pinpoint_sms_voice_v2/delete_resource_policyDeletes the resource-based policy document attached to the End User Messaging SMS resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.ResourceArn (string) required
pinpoint_sms_voice_v2/delete_text_message_spend_limit_overrideDeletes 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 Quotas in the End User Messaging SMS User Guide.No parameters
pinpoint_sms_voice_v2/delete_verified_destination_numberDelete a verified destination phone number.VerifiedDestinationNumberId (string) required
pinpoint_sms_voice_v2/delete_voice_message_spend_limit_overrideDeletes 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 Quotas in the End User Messaging SMS User Guide.No parameters
pinpoint_sms_voice_v2/describe_account_attributesDescribes 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 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.NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_account_limitsDescribes the current End User Messaging SMS 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 Quotas in the End User Messaging SMS User Guide.NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_configuration_setsDescribes 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.ConfigurationSetNames (array)
Filters (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_keywordsDescribes 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, End User Messaging SMS responds with a customizable message. If you specify a keyword that isn't valid, an errOriginationIdentity (string) required
Keywords (array)
Filters (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_opted_out_numbersDescribes 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 anOptOutListName (string) required
OptedOutNumbers (array)
Filters (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_opt_out_listsDescribes 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.OptOutListNames (array)
NextToken (string)
MaxResults (integer)
Owner (string)
pinpoint_sms_voice_v2/describe_phone_numbersDescribes 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.PhoneNumberIds (array)
Filters (array)
NextToken (string)
MaxResults (integer)
Owner (string)
pinpoint_sms_voice_v2/describe_poolsRetrieves 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 pPoolIds (array)
Filters (array)
NextToken (string)
MaxResults (integer)
Owner (string)
pinpoint_sms_voice_v2/describe_protect_configurationsRetrieves the protect configurations that match any of filters. If a filter isn’t provided then all protect configurations are returned.ProtectConfigurationIds (array)
Filters (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_registration_attachmentsRetrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.RegistrationAttachmentIds (array)
Filters (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_registration_field_definitionsRetrieves the specified registration type field definitions. You can use DescribeRegistrationFieldDefinitions to view the requirements for creating, filling out, and submitting each registration type.RegistrationType (string) required
SectionPath (string)
FieldPaths (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_registration_field_valuesRetrieves the specified registration field values.RegistrationId (string) required
VersionNumber (integer)
SectionPath (string)
FieldPaths (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_registrationsRetrieves the specified registrations.RegistrationIds (array)
Filters (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_registration_section_definitionsRetrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.RegistrationType (string) required
SectionPaths (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_registration_type_definitionsRetrieves the specified registration type definitions. You can use DescribeRegistrationTypeDefinitions to view the requirements for creating, filling out, and submitting each registration type.RegistrationTypes (array)
Filters (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_registration_versionsRetrieves the specified registration version.RegistrationId (string) required
VersionNumbers (array)
Filters (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_sender_idsDescribes 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.SenderIds (array)
Filters (array)
NextToken (string)
MaxResults (integer)
Owner (string)
pinpoint_sms_voice_v2/describe_spend_limitsDescribes the current 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, MMS, or Voice spending quota in the End User Messaging SMS User Guide.NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/describe_verified_destination_numbersRetrieves the specified verified destination numbers.VerifiedDestinationNumberIds (array)
DestinationPhoneNumbers (array)
Filters (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/disassociate_origination_identityRemoves the specified origination identity from an existing pool. If the origination identity isn't associated with the specified pool, an error is returned.PoolId (string) required
OriginationIdentity (string) required
IsoCountryCode (string) required
ClientToken (string)
pinpoint_sms_voice_v2/disassociate_protect_configurationDisassociate a protect configuration from a configuration set.ProtectConfigurationId (string) required
ConfigurationSetName (string) required
pinpoint_sms_voice_v2/discard_registration_versionDiscard the current version of the registration.RegistrationId (string) required
pinpoint_sms_voice_v2/get_protect_configuration_country_rule_setRetrieve the CountryRuleSet for the specified NumberCapability from a protect configuration.ProtectConfigurationId (string) required
NumberCapability (string) required
pinpoint_sms_voice_v2/get_resource_policyRetrieves the JSON text of the resource-based policy document attached to the End User Messaging SMS resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.ResourceArn (string) required
pinpoint_sms_voice_v2/list_pool_origination_identitiesLists 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.PoolId (string) required
Filters (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/list_protect_configuration_rule_set_number_overridesRetrieve all of the protect configuration rule set number overrides that match the filters.ProtectConfigurationId (string) required
Filters (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/list_registration_associationsRetrieve all of the origination identities that are associated with a registration.RegistrationId (string) required
Filters (array)
NextToken (string)
MaxResults (integer)
pinpoint_sms_voice_v2/list_tags_for_resourceList all tags associated with a resource.ResourceArn (string) required
pinpoint_sms_voice_v2/put_keywordCreates 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, End User Messaging SMS responds with a customizable message. If you specify a keyword that isn't valid, an error is reOriginationIdentity (string) required
Keyword (string) required
KeywordMessage (string) required
KeywordAction (string)
pinpoint_sms_voice_v2/put_message_feedbackSet the MessageFeedbackStatus as RECEIVED or FAILED for the passed in MessageId. If you use message feedback then you must update message feedback record. When you receive a signal that a user has received the message you must use PutMessageFeedback to set the message feedback record as RECEIVED; Otherwise, an hour after the message feedback record is set to FAILED.MessageId (string) required
MessageFeedbackStatus (string) required
pinpoint_sms_voice_v2/put_opted_out_numberCreates 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.OptOutListName (string) required
OptedOutNumber (string) required
pinpoint_sms_voice_v2/put_protect_configuration_rule_set_number_overrideCreate or update a phone number rule override and associate it with a protect configuration.ClientToken (string)
ProtectConfigurationId (string) required
DestinationPhoneNumber (string) required
Action (string) required
ExpirationTimestamp (string)
pinpoint_sms_voice_v2/put_registration_field_valueCreates or updates a field value for a registration.RegistrationId (string) required
FieldPath (string) required
SelectChoices (array)
TextValue (string)
RegistrationAttachmentId (string)
pinpoint_sms_voice_v2/put_resource_policyAttaches a resource-based policy to a End User Messaging SMS resourcephone number, sender Id, phone poll, or opt-out list that is used for sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about resource-based policies, see Working with shared resources in the End User Messaging SMS User Guide.ResourceArn (string) required
Policy (string) required
pinpoint_sms_voice_v2/release_phone_numberReleases 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.PhoneNumberId (string) required
pinpoint_sms_voice_v2/release_sender_idReleases an existing sender ID in your account.SenderId (string) required
IsoCountryCode (string) required
pinpoint_sms_voice_v2/request_phone_numberRequest an origination phone number for use in your account. For more information on phone number request see Request a phone number in the End User Messaging SMS User Guide.IsoCountryCode (string) required
MessageType (string) required
NumberCapabilities (array) required
NumberType (string) required
OptOutListName (string)
PoolId (string)
RegistrationId (string)
InternationalSendingEnabled (boolean)
DeletionProtectionEnabled (boolean)
Tags (array)
ClientToken (string)
pinpoint_sms_voice_v2/request_sender_idRequest a new sender ID that doesn't require registration.SenderId (string) required
IsoCountryCode (string) required
MessageTypes (array)
DeletionProtectionEnabled (boolean)
Tags (array)
ClientToken (string)
pinpoint_sms_voice_v2/send_destination_number_verification_codeBefore you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.VerifiedDestinationNumberId (string) required
VerificationChannel (string) required
LanguageCode (string)
OriginationIdentity (string)
ConfigurationSetName (string)
Context (object)
DestinationCountryParameters (object)
pinpoint_sms_voice_v2/send_media_messageCreates a new multimedia message MMS and sends it to a recipient's phone number.DestinationPhoneNumber (string) required
OriginationIdentity (string) required
MessageBody (string)
MediaUrls (array)
ConfigurationSetName (string)
MaxPrice (string)
TimeToLive (integer)
Context (object)
DryRun (boolean)
ProtectConfigurationId (string)
MessageFeedbackEnabled (boolean)
pinpoint_sms_voice_v2/send_text_messageCreates a new text message and sends it to a recipient's phone number. SendTextMessage only sends an SMS message to one recipient each time it is invoked. 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 about MPS, see Message Parts per Second MPS limits in the End User Messaging SMS User Guide.DestinationPhoneNumber (string) required
OriginationIdentity (string)
MessageBody (string)
MessageType (string)
Keyword (string)
ConfigurationSetName (string)
MaxPrice (string)
TimeToLive (integer)
Context (object)
DestinationCountryParameters (object)
DryRun (boolean)
ProtectConfigurationId (string)
MessageFeedbackEnabled (boolean)
pinpoint_sms_voice_v2/send_voice_messageAllows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message.DestinationPhoneNumber (string) required
OriginationIdentity (string) required
MessageBody (string)
MessageBodyTextType (string)
VoiceId (string)
ConfigurationSetName (string)
MaxPricePerMinute (string)
TimeToLive (integer)
Context (object)
DryRun (boolean)
ProtectConfigurationId (string)
MessageFeedbackEnabled (boolean)
pinpoint_sms_voice_v2/set_account_default_protect_configurationSet a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.ProtectConfigurationId (string) required
pinpoint_sms_voice_v2/set_default_message_feedback_enabledSets a configuration set's default for message feedback.ConfigurationSetName (string) required
MessageFeedbackEnabled (boolean) required
pinpoint_sms_voice_v2/set_default_message_typeSets 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.ConfigurationSetName (string) required
MessageType (string) required
pinpoint_sms_voice_v2/set_default_sender_idSets 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.ConfigurationSetName (string) required
SenderId (string) required
pinpoint_sms_voice_v2/set_media_message_spend_limit_overrideSets an account level monthly spend limit override for sending MMS messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.MonthlyLimit (integer) required
pinpoint_sms_voice_v2/set_text_message_spend_limit_overrideSets 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.MonthlyLimit (integer) required
pinpoint_sms_voice_v2/set_voice_message_spend_limit_overrideSets 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.MonthlyLimit (integer) required
pinpoint_sms_voice_v2/submit_registration_versionSubmit the specified registration for review and approval.RegistrationId (string) required
AwsReview (boolean)
pinpoint_sms_voice_v2/tag_resourceAdds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tags in the End User Messaging SMS User Guide.ResourceArn (string) required
Tags (array) required
pinpoint_sms_voice_v2/untag_resourceRemoves the association of the specified tags from a resource. For more information on tags see Tags in the End User Messaging SMS User Guide.ResourceArn (string) required
TagKeys (array) required
pinpoint_sms_voice_v2/update_event_destinationUpdates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and 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, Firehose, and Amazon SNS.ConfigurationSetName (string) required
EventDestinationName (string) required
Enabled (boolean)
MatchingEventTypes (array)
CloudWatchLogsDestination: {
. IamRoleArn (string)
. LogGroupArn (string)
} (object)
KinesisFirehoseDestination: {
. IamRoleArn (string)
. DeliveryStreamArn (string)
} (object)
SnsDestination: {
. TopicArn (string)
} (object)
pinpoint_sms_voice_v2/update_phone_numberUpdates 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.PhoneNumberId (string) required
TwoWayEnabled (boolean)
TwoWayChannelArn (string)
TwoWayChannelRole (string)
SelfManagedOptOutsEnabled (boolean)
OptOutListName (string)
InternationalSendingEnabled (boolean)
DeletionProtectionEnabled (boolean)
pinpoint_sms_voice_v2/update_poolUpdates 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.PoolId (string) required
TwoWayEnabled (boolean)
TwoWayChannelArn (string)
TwoWayChannelRole (string)
SelfManagedOptOutsEnabled (boolean)
OptOutListName (string)
SharedRoutesEnabled (boolean)
DeletionProtectionEnabled (boolean)
pinpoint_sms_voice_v2/update_protect_configurationUpdate the setting for an existing protect configuration.ProtectConfigurationId (string) required
DeletionProtectionEnabled (boolean)
pinpoint_sms_voice_v2/update_protect_configuration_country_rule_setUpdate a country rule set to ALLOW, BLOCK, MONITOR, or FILTER messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.ProtectConfigurationId (string) required
NumberCapability (string) required
CountryRuleSetUpdates (object) required
pinpoint_sms_voice_v2/update_sender_idUpdates the configuration of an existing sender ID.SenderId (string) required
IsoCountryCode (string) required
DeletionProtectionEnabled (boolean)
pinpoint_sms_voice_v2/verify_destination_numberUse the verification code that was received by the verified destination phone number to opt-in the verified destination phone number to receive more messages.VerifiedDestinationNumberId (string) required
VerificationCode (string) required
pinpoint_sms_voice/create_configuration_setCreate a new configuration set. After you create the configuration set, you can add one or more event destinations to it.ConfigurationSetName (string)
pinpoint_sms_voice/create_configuration_set_event_destinationCreate a new event destination in a configuration set.ConfigurationSetName (string) required
EventDestination: {
. CloudWatchLogsDestination (object)
. Enabled (boolean)
. KinesisFirehoseDestination (object)
. MatchingEventTypes (array)
. SnsDestination (object)
} (object)
EventDestinationName (string)
pinpoint_sms_voice/delete_configuration_setDeletes an existing configuration set.ConfigurationSetName (string) required
pinpoint_sms_voice/delete_configuration_set_event_destinationDeletes an event destination in a configuration set.ConfigurationSetName (string) required
EventDestinationName (string) required
pinpoint_sms_voice/get_configuration_set_event_destinationsObtain 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.ConfigurationSetName (string) required
pinpoint_sms_voice/list_configuration_setsList all of the configuration sets associated with your Amazon Pinpoint account in the current region.NextToken (string)
PageSize (string)
pinpoint_sms_voice/send_voice_messageCreate a new voice message and send it to a recipient's phone number.CallerId (string)
ConfigurationSetName (string)
Content: {
. CallInstructionsMessage (object)
. PlainTextMessage (object)
. SSMLMessage (object)
} (object)
DestinationPhoneNumber (string)
OriginationPhoneNumber (string)
pinpoint_sms_voice/update_configuration_set_event_destinationUpdate 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.ConfigurationSetName (string) required
EventDestination: {
. CloudWatchLogsDestination (object)
. Enabled (boolean)
. KinesisFirehoseDestination (object)
. MatchingEventTypes (array)
. SnsDestination (object)
} (object)
EventDestinationName (string) required
pinpoint/create_appCreates an application.CreateApplicationRequest: {
. Name (string)
. tags (object)
} (object) required
pinpoint/create_campaignCreates a new campaign for an application or updates the settings of an existing campaign for an application.ApplicationId (string) required
WriteCampaignRequest: {
. AdditionalTreatments (array)
. CustomDeliveryConfiguration (object)
. Description (string)
. HoldoutPercent (integer)
. Hook (object)
. IsPaused (boolean)
. Limits (object)
. MessageConfiguration (object)
. Name (string)
. Schedule (object)
. SegmentId (string)
. SegmentVersion (integer)
. tags (object)
. TemplateConfiguration (object)
. TreatmentDescription (string)
. TreatmentName (string)
. Priority (integer)
} (object) required
pinpoint/create_email_templateCreates a message template for messages that are sent through the email channel.EmailTemplateRequest: {
. DefaultSubstitutions (string)
. HtmlPart (string)
. RecommenderId (string)
. Subject (string)
. Headers (array)
. tags (object)
. TemplateDescription (string)
. TextPart (string)
} (object) required
TemplateName (string) required
pinpoint/create_export_jobCreates an export job for an application.ApplicationId (string) required
ExportJobRequest: {
. RoleArn (string)
. S3UrlPrefix (string)
. SegmentId (string)
. SegmentVersion (integer)
} (object) required
pinpoint/create_import_jobCreates an import job for an application.ApplicationId (string) required
ImportJobRequest: {
. DefineSegment (boolean)
. ExternalId (string)
. Format (string)
. RegisterEndpoints (boolean)
. RoleArn (string)
. S3Url (string)
. SegmentId (string)
. SegmentName (string)
} (object) required
pinpoint/create_in_app_templateCreates a new message template for messages using the in-app message channel.InAppTemplateRequest: {
. Content (array)
. CustomConfig (object)
. Layout (string)
. tags (object)
. TemplateDescription (string)
} (object) required
TemplateName (string) required
pinpoint/create_journeyCreates a journey for an application.ApplicationId (string) required
WriteJourneyRequest: {
. Activities (object)
. CreationDate (string)
. LastModifiedDate (string)
. Limits (object)
. LocalTime (boolean)
. Name (string)
. QuietTime (object)
. RefreshFrequency (string)
. Schedule (object)
. StartActivity (string)
. StartCondition (object)
. State (string)
. WaitForQuietTime (boolean)
. RefreshOnSegmentUpdate (boolean)
. JourneyChannelSettings (object)
. SendingSchedule (boolean)
. OpenHours (object)
. ClosedDays (object)
. TimezoneEstimationMethods (array)
} (object) required
pinpoint/create_push_templateCreates a message template for messages that are sent through a push notification channel.PushNotificationTemplateRequest: {
. ADM (object)
. APNS (object)
. Baidu (object)
. Default (object)
. DefaultSubstitutions (string)
. GCM (object)
. RecommenderId (string)
. tags (object)
. TemplateDescription (string)
} (object) required
TemplateName (string) required
pinpoint/create_recommender_configurationCreates an Amazon Pinpoint configuration for a recommender model.CreateRecommenderConfiguration: {
. Attributes (object)
. Description (string)
. Name (string)
. RecommendationProviderIdType (string)
. RecommendationProviderRoleArn (string)
. RecommendationProviderUri (string)
. RecommendationTransformerUri (string)
. RecommendationsDisplayName (string)
. RecommendationsPerMessage (integer)
} (object) required
pinpoint/create_segmentCreates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.ApplicationId (string) required
WriteSegmentRequest: {
. Dimensions (object)
. Name (string)
. SegmentGroups (object)
. tags (object)
} (object) required
pinpoint/create_sms_templateCreates a message template for messages that are sent through the SMS channel.SMSTemplateRequest: {
. Body (string)
. DefaultSubstitutions (string)
. RecommenderId (string)
. tags (object)
. TemplateDescription (string)
} (object) required
TemplateName (string) required
pinpoint/create_voice_templateCreates a message template for messages that are sent through the voice channel.TemplateName (string) required
VoiceTemplateRequest: {
. Body (string)
. DefaultSubstitutions (string)
. LanguageCode (string)
. tags (object)
. TemplateDescription (string)
. VoiceId (string)
} (object) required
pinpoint/delete_adm_channelDisables the ADM channel for an application and deletes any existing settings for the channel.ApplicationId (string) required
pinpoint/delete_apns_channelDisables the APNs channel for an application and deletes any existing settings for the channel.ApplicationId (string) required
pinpoint/delete_apns_sandbox_channelDisables the APNs sandbox channel for an application and deletes any existing settings for the channel.ApplicationId (string) required
pinpoint/delete_apns_voip_channelDisables the APNs VoIP channel for an application and deletes any existing settings for the channel.ApplicationId (string) required
pinpoint/delete_apns_voip_sandbox_channelDisables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.ApplicationId (string) required
pinpoint/delete_appDeletes an application.ApplicationId (string) required
pinpoint/delete_baidu_channelDisables the Baidu channel for an application and deletes any existing settings for the channel.ApplicationId (string) required
pinpoint/delete_campaignDeletes a campaign from an application.ApplicationId (string) required
CampaignId (string) required
pinpoint/delete_email_channelDisables the email channel for an application and deletes any existing settings for the channel.ApplicationId (string) required
pinpoint/delete_email_templateDeletes a message template for messages that were sent through the email channel.TemplateName (string) required
Version (string)
pinpoint/delete_endpointDeletes an endpoint from an application.ApplicationId (string) required
EndpointId (string) required
pinpoint/delete_event_streamDeletes the event stream for an application.ApplicationId (string) required
pinpoint/delete_gcm_channelDisables the GCM channel for an application and deletes any existing settings for the channel.ApplicationId (string) required
pinpoint/delete_in_app_templateDeletes a message template for messages sent using the in-app message channel.TemplateName (string) required
Version (string)
pinpoint/delete_journeyDeletes a journey from an application.ApplicationId (string) required
JourneyId (string) required
pinpoint/delete_push_templateDeletes a message template for messages that were sent through a push notification channel.TemplateName (string) required
Version (string)
pinpoint/delete_recommender_configurationDeletes an Amazon Pinpoint configuration for a recommender model.RecommenderId (string) required
pinpoint/delete_segmentDeletes a segment from an application.ApplicationId (string) required
SegmentId (string) required
pinpoint/delete_sms_channelDisables the SMS channel for an application and deletes any existing settings for the channel.ApplicationId (string) required
pinpoint/delete_sms_templateDeletes a message template for messages that were sent through the SMS channel.TemplateName (string) required
Version (string)
pinpoint/delete_user_endpointsDeletes all the endpoints that are associated with a specific user ID.ApplicationId (string) required
UserId (string) required
pinpoint/delete_voice_channelDisables the voice channel for an application and deletes any existing settings for the channel.ApplicationId (string) required
pinpoint/delete_voice_templateDeletes a message template for messages that were sent through the voice channel.TemplateName (string) required
Version (string)
pinpoint/get_adm_channelRetrieves information about the status and settings of the ADM channel for an application.ApplicationId (string) required
pinpoint/get_apns_channelRetrieves information about the status and settings of the APNs channel for an application.ApplicationId (string) required
pinpoint/get_apns_sandbox_channelRetrieves information about the status and settings of the APNs sandbox channel for an application.ApplicationId (string) required
pinpoint/get_apns_voip_channelRetrieves information about the status and settings of the APNs VoIP channel for an application.ApplicationId (string) required
pinpoint/get_apns_voip_sandbox_channelRetrieves information about the status and settings of the APNs VoIP sandbox channel for an application.ApplicationId (string) required
pinpoint/get_appRetrieves information about an application.ApplicationId (string) required
pinpoint/get_application_date_range_kpiRetrieves queries pre-aggregated data for a standard metric that applies to an application.ApplicationId (string) required
EndTime (string)
KpiName (string) required
NextToken (string)
PageSize (string)
StartTime (string)
pinpoint/get_application_settingsRetrieves information about the settings for an application.ApplicationId (string) required
pinpoint/get_appsRetrieves information about all the applications that are associated with your Amazon Pinpoint account.PageSize (string)
Token (string)
pinpoint/get_baidu_channelRetrieves information about the status and settings of the Baidu channel for an application.ApplicationId (string) required
pinpoint/get_campaignRetrieves information about the status, configuration, and other settings for a campaign.ApplicationId (string) required
CampaignId (string) required
pinpoint/get_campaign_activitiesRetrieves information about all the activities for a campaign.ApplicationId (string) required
CampaignId (string) required
PageSize (string)
Token (string)
pinpoint/get_campaign_date_range_kpiRetrieves queries pre-aggregated data for a standard metric that applies to a campaign.ApplicationId (string) required
CampaignId (string) required
EndTime (string)
KpiName (string) required
NextToken (string)
PageSize (string)
StartTime (string)
pinpoint/get_campaignsRetrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.ApplicationId (string) required
PageSize (string)
Token (string)
pinpoint/get_campaign_versionRetrieves information about the status, configuration, and other settings for a specific version of a campaign.ApplicationId (string) required
CampaignId (string) required
Version (string) required
pinpoint/get_campaign_versionsRetrieves information about the status, configuration, and other settings for all versions of a campaign.ApplicationId (string) required
CampaignId (string) required
PageSize (string)
Token (string)
pinpoint/get_channelsRetrieves information about the history and status of each channel for an application.ApplicationId (string) required
pinpoint/get_email_channelRetrieves information about the status and settings of the email channel for an application.ApplicationId (string) required
pinpoint/get_email_templateRetrieves the content and settings of a message template for messages that are sent through the email channel.TemplateName (string) required
Version (string)
pinpoint/get_endpointRetrieves information about the settings and attributes of a specific endpoint for an application.ApplicationId (string) required
EndpointId (string) required
pinpoint/get_event_streamRetrieves information about the event stream settings for an application.ApplicationId (string) required
pinpoint/get_export_jobRetrieves information about the status and settings of a specific export job for an application.ApplicationId (string) required
JobId (string) required
pinpoint/get_export_jobsRetrieves information about the status and settings of all the export jobs for an application.ApplicationId (string) required
PageSize (string)
Token (string)
pinpoint/get_gcm_channelRetrieves information about the status and settings of the GCM channel for an application.ApplicationId (string) required
pinpoint/get_import_jobRetrieves information about the status and settings of a specific import job for an application.ApplicationId (string) required
JobId (string) required
pinpoint/get_import_jobsRetrieves information about the status and settings of all the import jobs for an application.ApplicationId (string) required
PageSize (string)
Token (string)
pinpoint/get_in_app_messagesRetrieves the in-app messages targeted for the provided endpoint ID.ApplicationId (string) required
EndpointId (string) required
pinpoint/get_in_app_templateRetrieves the content and settings of a message template for messages sent through the in-app channel.TemplateName (string) required
Version (string)
pinpoint/get_journeyRetrieves information about the status, configuration, and other settings for a journey.ApplicationId (string) required
JourneyId (string) required
pinpoint/get_journey_date_range_kpiRetrieves queries pre-aggregated data for a standard engagement metric that applies to a journey.ApplicationId (string) required
EndTime (string)
JourneyId (string) required
KpiName (string) required
NextToken (string)
PageSize (string)
StartTime (string)
pinpoint/get_journey_execution_activity_metricsRetrieves queries pre-aggregated data for a standard execution metric that applies to a journey activity.ApplicationId (string) required
JourneyActivityId (string) required
JourneyId (string) required
NextToken (string)
PageSize (string)
pinpoint/get_journey_execution_metricsRetrieves queries pre-aggregated data for a standard execution metric that applies to a journey.ApplicationId (string) required
JourneyId (string) required
NextToken (string)
PageSize (string)
pinpoint/get_journey_run_execution_activity_metricsRetrieves queries pre-aggregated data for a standard run execution metric that applies to a journey activity.ApplicationId (string) required
JourneyActivityId (string) required
JourneyId (string) required
NextToken (string)
PageSize (string)
RunId (string) required
pinpoint/get_journey_run_execution_metricsRetrieves queries pre-aggregated data for a standard run execution metric that applies to a journey.ApplicationId (string) required
JourneyId (string) required
NextToken (string)
PageSize (string)
RunId (string) required
pinpoint/get_journey_runsProvides information about the runs of a journey.ApplicationId (string) required
JourneyId (string) required
PageSize (string)
Token (string)
pinpoint/get_push_templateRetrieves the content and settings of a message template for messages that are sent through a push notification channel.TemplateName (string) required
Version (string)
pinpoint/get_recommender_configurationRetrieves information about an Amazon Pinpoint configuration for a recommender model.RecommenderId (string) required
pinpoint/get_recommender_configurationsRetrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.PageSize (string)
Token (string)
pinpoint/get_segmentRetrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.ApplicationId (string) required
SegmentId (string) required
pinpoint/get_segment_export_jobsRetrieves information about the status and settings of the export jobs for a segment.ApplicationId (string) required
PageSize (string)
SegmentId (string) required
Token (string)
pinpoint/get_segment_import_jobsRetrieves information about the status and settings of the import jobs for a segment.ApplicationId (string) required
PageSize (string)
SegmentId (string) required
Token (string)
pinpoint/get_segmentsRetrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.ApplicationId (string) required
PageSize (string)
Token (string)
pinpoint/get_segment_versionRetrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.ApplicationId (string) required
SegmentId (string) required
Version (string) required
pinpoint/get_segment_versionsRetrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.ApplicationId (string) required
PageSize (string)
SegmentId (string) required
Token (string)
pinpoint/get_sms_channelRetrieves information about the status and settings of the SMS channel for an application.ApplicationId (string) required
pinpoint/get_sms_templateRetrieves the content and settings of a message template for messages that are sent through the SMS channel.TemplateName (string) required
Version (string)
pinpoint/get_user_endpointsRetrieves information about all the endpoints that are associated with a specific user ID.ApplicationId (string) required
UserId (string) required
pinpoint/get_voice_channelRetrieves information about the status and settings of the voice channel for an application.ApplicationId (string) required
pinpoint/get_voice_templateRetrieves the content and settings of a message template for messages that are sent through the voice channel.TemplateName (string) required
Version (string)
pinpoint/list_journeysRetrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.ApplicationId (string) required
PageSize (string)
Token (string)
pinpoint/list_tags_for_resourceRetrieves all the tags keys and values that are associated with an application, campaign, message template, or segment.ResourceArn (string) required
pinpoint/list_templatesRetrieves information about all the message templates that are associated with your Amazon Pinpoint account.NextToken (string)
PageSize (string)
Prefix (string)
TemplateType (string)
pinpoint/list_template_versionsRetrieves information about all the versions of a specific message template.NextToken (string)
PageSize (string)
TemplateName (string) required
TemplateType (string) required
pinpoint/phone_number_validateRetrieves information about a phone number.NumberValidateRequest: {
. IsoCountryCode (string)
. PhoneNumber (string)
} (object) required
pinpoint/put_eventsCreates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.ApplicationId (string) required
EventsRequest: {
. BatchItem (object)
} (object) required
pinpoint/put_event_streamCreates a new event stream for an application or updates the settings of an existing event stream for an application.ApplicationId (string) required
WriteEventStream: {
. DestinationStreamArn (string)
. RoleArn (string)
} (object) required
pinpoint/remove_attributesRemoves one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.ApplicationId (string) required
AttributeType (string) required
UpdateAttributesRequest: {
. Blacklist (array)
} (object) required
pinpoint/send_messagesCreates and sends a direct message.ApplicationId (string) required
MessageRequest: {
. Addresses (object)
. Context (object)
. Endpoints (object)
. MessageConfiguration (object)
. TemplateConfiguration (object)
. TraceId (string)
} (object) required
pinpoint/send_otpmessageSend an OTP messageApplicationId (string) required
SendOTPMessageRequestParameters: {
. AllowedAttempts (integer)
. BrandName (string)
. Channel (string)
. CodeLength (integer)
. DestinationIdentity (string)
. EntityId (string)
. Language (string)
. OriginationIdentity (string)
. ReferenceId (string)
. TemplateId (string)
. ValidityPeriod (integer)
} (object) required
pinpoint/send_users_messagesCreates and sends a message to a list of users.ApplicationId (string) required
SendUsersMessageRequest: {
. Context (object)
. MessageConfiguration (object)
. TemplateConfiguration (object)
. TraceId (string)
. Users (object)
} (object) required
pinpoint/tag_resourceAdds one or more tags keys and values to an application, campaign, message template, or segment.ResourceArn (string) required
TagsModel: {
. tags (object)
} (object) required
pinpoint/untag_resourceRemoves one or more tags keys and values from an application, campaign, message template, or segment.ResourceArn (string) required
TagKeys (array) required
pinpoint/update_adm_channelEnables the ADM channel for an application or updates the status and settings of the ADM channel for an application.ADMChannelRequest: {
. ClientId (string)
. ClientSecret (string)
. Enabled (boolean)
} (object) required
ApplicationId (string) required
pinpoint/update_apns_channelEnables the APNs channel for an application or updates the status and settings of the APNs channel for an application.APNSChannelRequest: {
. BundleId (string)
. Certificate (string)
. DefaultAuthenticationMethod (string)
. Enabled (boolean)
. PrivateKey (string)
. TeamId (string)
. TokenKey (string)
. TokenKeyId (string)
} (object) required
ApplicationId (string) required
pinpoint/update_apns_sandbox_channelEnables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.APNSSandboxChannelRequest: {
. BundleId (string)
. Certificate (string)
. DefaultAuthenticationMethod (string)
. Enabled (boolean)
. PrivateKey (string)
. TeamId (string)
. TokenKey (string)
. TokenKeyId (string)
} (object) required
ApplicationId (string) required
pinpoint/update_apns_voip_channelEnables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.APNSVoipChannelRequest: {
. BundleId (string)
. Certificate (string)
. DefaultAuthenticationMethod (string)
. Enabled (boolean)
. PrivateKey (string)
. TeamId (string)
. TokenKey (string)
. TokenKeyId (string)
} (object) required
ApplicationId (string) required
pinpoint/update_apns_voip_sandbox_channelEnables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.APNSVoipSandboxChannelRequest: {
. BundleId (string)
. Certificate (string)
. DefaultAuthenticationMethod (string)
. Enabled (boolean)
. PrivateKey (string)
. TeamId (string)
. TokenKey (string)
. TokenKeyId (string)
} (object) required
ApplicationId (string) required
pinpoint/update_application_settingsUpdates the settings for an application.ApplicationId (string) required
WriteApplicationSettingsRequest: {
. CampaignHook (object)
. CloudWatchMetricsEnabled (boolean)
. EventTaggingEnabled (boolean)
. Limits (object)
. QuietTime (object)
. JourneyLimits (object)
} (object) required
pinpoint/update_baidu_channelEnables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.ApplicationId (string) required
BaiduChannelRequest: {
. ApiKey (string)
. Enabled (boolean)
. SecretKey (string)
} (object) required
pinpoint/update_campaignUpdates the configuration and other settings for a campaign.ApplicationId (string) required
CampaignId (string) required
WriteCampaignRequest: {
. AdditionalTreatments (array)
. CustomDeliveryConfiguration (object)
. Description (string)
. HoldoutPercent (integer)
. Hook (object)
. IsPaused (boolean)
. Limits (object)
. MessageConfiguration (object)
. Name (string)
. Schedule (object)
. SegmentId (string)
. SegmentVersion (integer)
. tags (object)
. TemplateConfiguration (object)
. TreatmentDescription (string)
. TreatmentName (string)
. Priority (integer)
} (object) required
pinpoint/update_email_channelEnables the email channel for an application or updates the status and settings of the email channel for an application.ApplicationId (string) required
EmailChannelRequest: {
. ConfigurationSet (string)
. Enabled (boolean)
. FromAddress (string)
. Identity (string)
. RoleArn (string)
. OrchestrationSendingRoleArn (string)
} (object) required
pinpoint/update_email_templateUpdates an existing message template for messages that are sent through the email channel.CreateNewVersion (boolean)
EmailTemplateRequest: {
. DefaultSubstitutions (string)
. HtmlPart (string)
. RecommenderId (string)
. Subject (string)
. Headers (array)
. tags (object)
. TemplateDescription (string)
. TextPart (string)
} (object) required
TemplateName (string) required
Version (string)
pinpoint/update_endpointCreates 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.ApplicationId (string) required
EndpointId (string) required
EndpointRequest: {
. Address (string)
. Attributes (object)
. ChannelType (string)
. Demographic (object)
. EffectiveDate (string)
. EndpointStatus (string)
. Location (object)
. Metrics (object)
. OptOut (string)
. RequestId (string)
. User (object)
} (object) required
pinpoint/update_endpoints_batchCreates 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.ApplicationId (string) required
EndpointBatchRequest: {
. Item (array)
} (object) required
pinpoint/update_gcm_channelEnables the GCM channel for an application or updates the status and settings of the GCM channel for an application.ApplicationId (string) required
GCMChannelRequest: {
. ApiKey (string)
. DefaultAuthenticationMethod (string)
. Enabled (boolean)
. ServiceJson (string)
} (object) required
pinpoint/update_in_app_templateUpdates an existing message template for messages sent through the in-app message channel.CreateNewVersion (boolean)
InAppTemplateRequest: {
. Content (array)
. CustomConfig (object)
. Layout (string)
. tags (object)
. TemplateDescription (string)
} (object) required
TemplateName (string) required
Version (string)
pinpoint/update_journeyUpdates the configuration and other settings for a journey.ApplicationId (string) required
JourneyId (string) required
WriteJourneyRequest: {
. Activities (object)
. CreationDate (string)
. LastModifiedDate (string)
. Limits (object)
. LocalTime (boolean)
. Name (string)
. QuietTime (object)
. RefreshFrequency (string)
. Schedule (object)
. StartActivity (string)
. StartCondition (object)
. State (string)
. WaitForQuietTime (boolean)
. RefreshOnSegmentUpdate (boolean)
. JourneyChannelSettings (object)
. SendingSchedule (boolean)
. OpenHours (object)
. ClosedDays (object)
. TimezoneEstimationMethods (array)
} (object) required
pinpoint/update_journey_stateCancels stops an active journey.ApplicationId (string) required
JourneyId (string) required
JourneyStateRequest: {
. State (string)
} (object) required
pinpoint/update_push_templateUpdates an existing message template for messages that are sent through a push notification channel.CreateNewVersion (boolean)
PushNotificationTemplateRequest: {
. ADM (object)
. APNS (object)
. Baidu (object)
. Default (object)
. DefaultSubstitutions (string)
. GCM (object)
. RecommenderId (string)
. tags (object)
. TemplateDescription (string)
} (object) required
TemplateName (string) required
Version (string)
pinpoint/update_recommender_configurationUpdates an Amazon Pinpoint configuration for a recommender model.RecommenderId (string) required
UpdateRecommenderConfiguration: {
. Attributes (object)
. Description (string)
. Name (string)
. RecommendationProviderIdType (string)
. RecommendationProviderRoleArn (string)
. RecommendationProviderUri (string)
. RecommendationTransformerUri (string)
. RecommendationsDisplayName (string)
. RecommendationsPerMessage (integer)
} (object) required
pinpoint/update_segmentCreates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.ApplicationId (string) required
SegmentId (string) required
WriteSegmentRequest: {
. Dimensions (object)
. Name (string)
. SegmentGroups (object)
. tags (object)
} (object) required
pinpoint/update_sms_channelEnables the SMS channel for an application or updates the status and settings of the SMS channel for an application.ApplicationId (string) required
SMSChannelRequest: {
. Enabled (boolean)
. SenderId (string)
. ShortCode (string)
} (object) required
pinpoint/update_sms_templateUpdates an existing message template for messages that are sent through the SMS channel.CreateNewVersion (boolean)
SMSTemplateRequest: {
. Body (string)
. DefaultSubstitutions (string)
. RecommenderId (string)
. tags (object)
. TemplateDescription (string)
} (object) required
TemplateName (string) required
Version (string)
pinpoint/update_template_active_versionChanges the status of a specific version of a message template to active.TemplateActiveVersionRequest: {
. Version (string)
} (object) required
TemplateName (string) required
TemplateType (string) required
pinpoint/update_voice_channelEnables the voice channel for an application or updates the status and settings of the voice channel for an application.ApplicationId (string) required
VoiceChannelRequest: {
. Enabled (boolean)
} (object) required
pinpoint/update_voice_templateUpdates an existing message template for messages that are sent through the voice channel.CreateNewVersion (boolean)
TemplateName (string) required
Version (string)
VoiceTemplateRequest: {
. Body (string)
. DefaultSubstitutions (string)
. LanguageCode (string)
. tags (object)
. TemplateDescription (string)
. VoiceId (string)
} (object) required
pinpoint/verify_otpmessageVerify an OTPApplicationId (string) required
VerifyOTPMessageRequestParameters: {
. DestinationIdentity (string)
. Otp (string)
. ReferenceId (string)
} (object) required
pipes/list_tags_for_resourceDisplays the tags associated with a pipe.resourceArn (string) required
pipes/tag_resourceAssigns one or more tags key-value pairs to the specified pipe. 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 pipe that already has tags. If you specify a new tag key, this tag is appended to tresourceArn (string) required
tags (object) required
pipes/untag_resourceRemoves one or more tags from the specified pipes.resourceArn (string) required
tagKeys (array) required
pipes/start_pipeStart an existing pipe.Name (string) required
pipes/stop_pipeStop an existing pipe.Name (string) required
pipes/describe_pipeGet the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.Name (string) required
pipes/update_pipeUpdate an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have specified in the request; the rest remain unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. For example, DynamoDBStreamParameters or EventBridgeEventBusParameters. EventBridge updates the fields in these objects atomically as one and overrides existing values. This is by design,Name (string) required
Description (string)
DesiredState (string)
SourceParameters: {
. FilterCriteria (object)
. KinesisStreamParameters (object)
. DynamoDBStreamParameters (object)
. SqsQueueParameters (object)
. ActiveMQBrokerParameters (object)
. RabbitMQBrokerParameters (object)
. ManagedStreamingKafkaParameters (object)
. SelfManagedKafkaParameters (object)
} (object)
Enrichment (string)
EnrichmentParameters: {
. InputTemplate (string)
. HttpParameters (object)
} (object)
Target (string)
TargetParameters: {
. InputTemplate (string)
. LambdaFunctionParameters (object)
. StepFunctionStateMachineParameters (object)
. KinesisStreamParameters (object)
. EcsTaskParameters (object)
. BatchJobParameters (object)
. SqsQueueParameters (object)
. HttpParameters (object)
. RedshiftDataParameters (object)
. SageMakerPipelineParameters (object)
. EventBridgeEventBusParameters (object)
. CloudWatchLogsParameters (object)
. TimestreamParameters (object)
} (object)
RoleArn (string) required
LogConfiguration: {
. S3LogDestination (object)
. FirehoseLogDestination (object)
. CloudwatchLogsLogDestination (object)
. Level (string)
. IncludeExecutionData (array)
} (object)
KmsKeyIdentifier (string)
pipes/delete_pipeDelete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.Name (string) required
pipes/list_pipesGet the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.NamePrefix (string)
DesiredState (string)
CurrentState (string)
SourcePrefix (string)
TargetPrefix (string)
NextToken (string)
Limit (integer)
pipes/create_pipeCreate a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.Name (string) required
Description (string)
DesiredState (string)
Source (string) required
SourceParameters: {
. FilterCriteria (object)
. KinesisStreamParameters (object)
. DynamoDBStreamParameters (object)
. SqsQueueParameters (object)
. ActiveMQBrokerParameters (object)
. RabbitMQBrokerParameters (object)
. ManagedStreamingKafkaParameters (object)
. SelfManagedKafkaParameters (object)
} (object)
Enrichment (string)
EnrichmentParameters: {
. InputTemplate (string)
. HttpParameters (object)
} (object)
Target (string) required
TargetParameters: {
. InputTemplate (string)
. LambdaFunctionParameters (object)
. StepFunctionStateMachineParameters (object)
. KinesisStreamParameters (object)
. EcsTaskParameters (object)
. BatchJobParameters (object)
. SqsQueueParameters (object)
. HttpParameters (object)
. RedshiftDataParameters (object)
. SageMakerPipelineParameters (object)
. EventBridgeEventBusParameters (object)
. CloudWatchLogsParameters (object)
. TimestreamParameters (object)
} (object)
RoleArn (string) required
Tags (object)
LogConfiguration: {
. S3LogDestination (object)
. FirehoseLogDestination (object)
. CloudwatchLogsLogDestination (object)
. Level (string)
. IncludeExecutionData (array)
} (object)
KmsKeyIdentifier (string)
polly/delete_lexiconDeletes 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.Name (string) required
polly/describe_voicesReturns 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 chooseEngine (string)
LanguageCode (string)
IncludeAdditionalLanguageCodes (boolean)
NextToken (string)
polly/get_lexiconReturns the content of the specified pronunciation lexicon stored in an Amazon Web Services Region. For more information, see Managing Lexicons.Name (string) required
polly/get_speech_synthesis_taskRetrieves 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.TaskId (string) required
polly/list_lexiconsReturns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.NextToken (string)
polly/list_speech_synthesis_tasksReturns 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.MaxResults (integer)
NextToken (string)
Status (string)
polly/put_lexiconStores 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.Name (string) required
Content (string) required
polly/start_speech_synthesis_taskAllows 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 statEngine (string)
LanguageCode (string)
LexiconNames (array)
OutputFormat (string) required
OutputS3BucketName (string) required
OutputS3KeyPrefix (string)
SampleRate (string)
SnsTopicArn (string)
SpeechMarkTypes (array)
Text (string) required
TextType (string)
VoiceId (string) required
polly/synthesize_speechSynthesizes 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.Engine (string)
LanguageCode (string)
LexiconNames (array)
OutputFormat (string) required
SampleRate (string)
SpeechMarkTypes (array)
Text (string) required
TextType (string)
VoiceId (string) required
pricing/describe_servicesReturns 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.ServiceCode (string)
FormatVersion (string)
NextToken (string)
MaxResults (integer)
pricing/get_attribute_valuesReturns 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.ServiceCode (string) required
AttributeName (string) required
NextToken (string)
MaxResults (integer)
pricing/get_price_list_file_urlThis feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms Section 1.10. This returns the URL that you can retrieve your Price List file from. This URL is based on the PriceListArn and FileFormat that you retrieve from the ListPriceLists response.PriceListArn (string) required
FileFormat (string) required
pricing/get_productsReturns a list of all products that match the filter criteria.ServiceCode (string) required
Filters (array)
FormatVersion (string)
NextToken (string)
MaxResults (integer)
pricing/list_price_listsThis feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms Section 1.10. This returns a list of Price List references that the requester if authorized to view, given a ServiceCode, CurrencyCode, and an EffectiveDate. Use without a RegionCode filter to list Price List references from all available Amazon Web Services Regions. Use with a RegionCode filter toServiceCode (string) required
EffectiveDate (string) required
RegionCode (string)
CurrencyCode (string) required
NextToken (string)
MaxResults (integer)
proton/cancel_component_deploymentAttempts 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.componentName (string) required
proton/cancel_environment_deploymentAttempts 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, theenvironmentName (string) required
proton/cancel_service_instance_deploymentAttempts 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 atteserviceInstanceName (string) required
serviceName (string) required
proton/cancel_service_pipeline_deploymentAttempts 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 atteserviceName (string) required
proton/get_repository_sync_statusGet 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.repositoryName (string) required
repositoryProvider (string) required
branch (string) required
syncType (string) required
proton/get_resources_summaryGet counts of Proton resources. For infrastructure-provisioning resources environments, services, service instances, pipelines, the action returns staleness counts. A resource is stale when it's behind the recommended version of the Proton template that it uses and it needs an update to become current. The action returns staleness counts counts of resources that are up-to-date, behind a template major version, or behind a template minor version, the total number of resources, and the number of rNo parameters
proton/get_service_instance_sync_statusGet the status of the synced service instance.serviceName (string) required
serviceInstanceName (string) required
proton/get_template_sync_statusGet the status of a template sync.templateName (string) required
templateType (string) required
templateVersion (string) required
proton/list_repository_sync_definitionsList repository sync definitions with detail data.repositoryName (string) required
repositoryProvider (string) required
syncType (string) required
nextToken (string)
proton/list_tags_for_resourceList tags for a resource. For more information, see Proton resources and tagging in the Proton User Guide.resourceArn (string) required
nextToken (string)
maxResults (integer)
proton/notify_resource_deployment_status_changeNotify 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.resourceArn (string) required
status (string)
outputs (array)
deploymentId (string)
statusMessage (string)
proton/tag_resourceTag 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.resourceArn (string) required
tags (array) required
proton/untag_resourceRemove 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.resourceArn (string) required
tagKeys (array) required
proton/get_account_settingsGet detail data for Proton account-wide settings.No parameters
proton/update_account_settingsUpdate Proton settings that are used for multiple services in the Amazon Web Services account.pipelineServiceRoleArn (string)
pipelineProvisioningRepository: {
. provider (string)
. name (string)
. branch (string)
} (object)
deletePipelineProvisioningRepository (boolean)
pipelineCodebuildRoleArn (string)
proton/list_component_outputsGet a list of component Infrastructure as Code IaC outputs. For more information about components, see Proton components in the Proton User Guide.componentName (string) required
nextToken (string)
deploymentId (string)
proton/list_component_provisioned_resourcesList provisioned resources for a component with details. For more information about components, see Proton components in the Proton User Guide.componentName (string) required
nextToken (string)
proton/get_componentGet detailed data for a component. For more information about components, see Proton components in the Proton User Guide.name (string) required
proton/update_componentUpdate 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.name (string) required
deploymentType (string) required
description (string)
serviceName (string)
serviceInstanceName (string)
serviceSpec (string)
templateFile (string)
clientToken (string)
proton/delete_componentDelete an Proton component resource. For more information about components, see Proton components in the Proton User Guide.name (string) required
proton/list_componentsList 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.nextToken (string)
environmentName (string)
serviceName (string)
serviceInstanceName (string)
maxResults (integer)
proton/create_componentCreate 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.name (string) required
description (string)
serviceName (string)
serviceInstanceName (string)
environmentName (string)
templateFile (string) required
manifest (string) required
serviceSpec (string)
tags (array)
clientToken (string)
proton/get_deploymentGet detailed data for a deployment.id (string) required
environmentName (string)
serviceName (string)
serviceInstanceName (string)
componentName (string)
proton/delete_deploymentDelete the deployment.id (string) required
proton/list_deploymentsList deployments. You can filter the result list by environment, service, or a single service instance.nextToken (string)
environmentName (string)
serviceName (string)
serviceInstanceName (string)
componentName (string)
maxResults (integer)
proton/accept_environment_account_connectionIn 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.id (string) required
proton/reject_environment_account_connectionIn 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.id (string) required
proton/create_environment_account_connectionCreate 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.clientToken (string)
managementAccountId (string) required
roleArn (string)
environmentName (string) required
tags (array)
componentRoleArn (string)
codebuildRoleArn (string)
proton/get_environment_account_connectionIn an environment account, get the detailed data for an environment account connection. For more information, see Environment account connections in the Proton User guide.id (string) required
proton/update_environment_account_connectionIn 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.id (string) required
roleArn (string)
componentRoleArn (string)
codebuildRoleArn (string)
proton/delete_environment_account_connectionIn 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 theid (string) required
proton/list_environment_account_connectionsView a list of environment account connections. For more information, see Environment account connections in the Proton User guide.requestedBy (string) required
environmentName (string)
statuses (array)
nextToken (string)
maxResults (integer)
proton/list_environment_outputsList the infrastructure as code outputs for your environment.environmentName (string) required
nextToken (string)
deploymentId (string)
proton/list_environment_provisioned_resourcesList the provisioned resources for your environment.environmentName (string) required
nextToken (string)
proton/get_environmentGet detailed data for an environment.name (string) required
proton/update_environmentUpdate 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 environmname (string) required
description (string)
spec (string)
templateMajorVersion (string)
templateMinorVersion (string)
protonServiceRoleArn (string)
deploymentType (string) required
environmentAccountConnectionId (string)
provisioningRepository: {
. provider (string)
. name (string)
. branch (string)
} (object)
componentRoleArn (string)
codebuildRoleArn (string)
proton/delete_environmentDelete an environment.name (string) required
proton/list_environmentsList environments with detail data summaries.nextToken (string)
maxResults (integer)
environmentTemplates (array)
proton/create_environmentDeploy 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. Fname (string) required
templateName (string) required
templateMajorVersion (string) required
templateMinorVersion (string)
description (string)
spec (string) required
protonServiceRoleArn (string)
environmentAccountConnectionId (string)
tags (array)
provisioningRepository: {
. provider (string)
. name (string)
. branch (string)
} (object)
componentRoleArn (string)
codebuildRoleArn (string)
proton/get_environment_templateGet detailed data for an environment template.name (string) required
proton/update_environment_templateUpdate an environment template.name (string) required
displayName (string)
description (string)
proton/delete_environment_templateIf no other major or minor versions of an environment template exist, delete the environment template.name (string) required
proton/list_environment_templatesList environment templates.nextToken (string)
maxResults (integer)
proton/create_environment_templateCreate 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 provisiname (string) required
displayName (string)
description (string)
encryptionKey (string)
provisioning (string)
tags (array)
proton/create_environment_template_versionCreate 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.clientToken (string)
templateName (string) required
description (string)
majorVersion (string)
source (undefined) required
tags (array)
proton/get_environment_template_versionGet detailed data for a major or minor version of an environment template.templateName (string) required
majorVersion (string) required
minorVersion (string) required
proton/update_environment_template_versionUpdate a major or minor version of an environment template.templateName (string) required
majorVersion (string) required
minorVersion (string) required
description (string)
status (string)
proton/delete_environment_template_versionIf 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 oftemplateName (string) required
majorVersion (string) required
minorVersion (string) required
proton/list_environment_template_versionsList major or minor versions of an environment template with detail data.nextToken (string)
maxResults (integer)
templateName (string) required
majorVersion (string)
proton/get_repositoryGet detail data for a linked repository.provider (string) required
name (string) required
proton/delete_repositoryDe-register and unlink your repository.provider (string) required
name (string) required
proton/list_repositoriesList linked repositories with detail data.nextToken (string)
maxResults (integer)
proton/create_repositoryCreate 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 inprovider (string) required
name (string) required
connectionArn (string) required
encryptionKey (string)
tags (array)
proton/list_service_instance_outputsGet a list service of instance Infrastructure as Code IaC outputs.serviceInstanceName (string) required
serviceName (string) required
nextToken (string)
deploymentId (string)
proton/list_service_instance_provisioned_resourcesList provisioned resources for a service instance with details.serviceName (string) required
serviceInstanceName (string) required
nextToken (string)
proton/get_service_instanceGet detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.name (string) required
serviceName (string) required
proton/update_service_instanceUpdate 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.name (string) required
serviceName (string) required
deploymentType (string) required
spec (string)
templateMajorVersion (string)
templateMinorVersion (string)
clientToken (string)
proton/list_service_instancesList service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.serviceName (string)
nextToken (string)
maxResults (integer)
filters (array)
sortBy (string)
sortOrder (string)
proton/create_service_instanceCreate a service instance.name (string) required
serviceName (string) required
spec (string) required
templateMajorVersion (string)
templateMinorVersion (string)
tags (array)
clientToken (string)
proton/list_service_pipeline_outputsGet a list of service pipeline Infrastructure as Code IaC outputs.serviceName (string) required
nextToken (string)
deploymentId (string)
proton/list_service_pipeline_provisioned_resourcesList provisioned resources for a service and pipeline with details.serviceName (string) required
nextToken (string)
proton/update_service_pipelineUpdate 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 piserviceName (string) required
spec (string) required
deploymentType (string) required
templateMajorVersion (string)
templateMinorVersion (string)
proton/get_serviceGet detailed data for a service.name (string) required
proton/update_serviceEdit 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.name (string) required
description (string)
spec (string)
proton/delete_serviceDelete 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.name (string) required
proton/list_servicesList services with summaries of detail data.nextToken (string)
maxResults (integer)
proton/create_serviceCreate 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.name (string) required
description (string)
templateName (string) required
templateMajorVersion (string) required
templateMinorVersion (string)
spec (string) required
repositoryConnectionArn (string)
repositoryId (string)
branchName (string)
tags (array)
proton/get_service_sync_blocker_summaryGet detailed data for the service sync blocker summary.serviceName (string) required
serviceInstanceName (string)
proton/update_service_sync_blockerUpdate the service sync blocker by resolving it.id (string) required
resolvedReason (string) required
proton/get_service_sync_configGet detailed information for the service sync configuration.serviceName (string) required
proton/update_service_sync_configUpdate the Proton Ops config file.serviceName (string) required
repositoryProvider (string) required
repositoryName (string) required
branch (string) required
filePath (string) required
proton/delete_service_sync_configDelete the Proton Ops file.serviceName (string) required
proton/create_service_sync_configCreate the Proton Ops configuration file.serviceName (string) required
repositoryProvider (string) required
repositoryName (string) required
branch (string) required
filePath (string) required
proton/get_service_templateGet detailed data for a service template.name (string) required
proton/update_service_templateUpdate a service template.name (string) required
displayName (string)
description (string)
proton/delete_service_templateIf no other major or minor versions of the service template exist, delete the service template.name (string) required
proton/list_service_templatesList service templates with detail data.nextToken (string)
maxResults (integer)
proton/create_service_templateCreate 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.name (string) required
displayName (string)
description (string)
encryptionKey (string)
pipelineProvisioning (string)
tags (array)
proton/create_service_template_versionCreate 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.clientToken (string)
templateName (string) required
description (string)
majorVersion (string)
source (undefined) required
compatibleEnvironmentTemplates (array) required
tags (array)
supportedComponentSources (array)
proton/get_service_template_versionGet detailed data for a major or minor version of a service template.templateName (string) required
majorVersion (string) required
minorVersion (string) required
proton/update_service_template_versionUpdate a major or minor version of a service template.templateName (string) required
majorVersion (string) required
minorVersion (string) required
description (string)
status (string)
compatibleEnvironmentTemplates (array)
supportedComponentSources (array)
proton/delete_service_template_versionIf 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 ntemplateName (string) required
majorVersion (string) required
minorVersion (string) required
proton/list_service_template_versionsList major or minor versions of a service template with detail data.nextToken (string)
maxResults (integer)
templateName (string) required
majorVersion (string)
proton/get_template_sync_configGet detail data for a template sync configuration.templateName (string) required
templateType (string) required
proton/update_template_sync_configUpdate 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.templateName (string) required
templateType (string) required
repositoryProvider (string) required
repositoryName (string) required
branch (string) required
subdirectory (string)
proton/delete_template_sync_configDelete a template sync configuration.templateName (string) required
templateType (string) required
proton/create_template_sync_configSet 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 stemplateName (string) required
templateType (string) required
repositoryProvider (string) required
repositoryName (string) required
branch (string) required
subdirectory (string)
qapps/associate_library_item_reviewAssociates a rating or review for a library item with the user submitting the request. This increments the rating count for the specified library item.instanceId (string) required
libraryItemId (string) required
qapps/associate_qapp_with_userThis operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a favorite for the user if the user doesn't own the Amazon Q App so they can still run it and see it in their inventory of Q Apps.instanceId (string) required
appId (string) required
qapps/batch_create_categoryCreates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.instanceId (string) required
categories (array) required
qapps/batch_delete_categoryDeletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.instanceId (string) required
categories (array) required
qapps/batch_update_categoryUpdates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.instanceId (string) required
categories (array) required
qapps/create_library_itemCreates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.instanceId (string) required
appId (string) required
appVersion (integer) required
categories (array) required
qapps/create_presigned_urlCreates a presigned URL for an S3 POST operation to upload a file. You can use this URL to set a default file for a FileUploadCard in a Q App definition or to provide a file for a single Q App run. The scope parameter determines how the file will be used, either at the app definition level or the app session level. The IAM permissions are derived from the qapps:ImportDocument action. For more information on the IAM policy for Amazon Q Apps, see IAM permissions for using Amazon Q Apps.instanceId (string) required
cardId (string) required
appId (string) required
fileContentsSha256 (string) required
fileName (string) required
scope (string) required
sessionId (string)
qapps/create_qappCreates a new Amazon Q App based on the provided definition. The Q App definition specifies the cards and flow of the Q App. This operation also calculates the dependencies between the cards by inspecting the references in the prompts.instanceId (string) required
title (string) required
description (string)
appDefinition: {
. cards (array)
. initialPrompt (string)
} (object) required
tags (object)
qapps/delete_library_itemDeletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users.instanceId (string) required
libraryItemId (string) required
qapps/delete_qappDeletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.instanceId (string) required
appId (string) required
qapps/describe_qapp_permissionsDescribes read permissions for a Amazon Q App in Amazon Q Business application environment instance.instanceId (string) required
appId (string) required
qapps/disassociate_library_item_reviewRemoves a rating or review previously submitted by the user for a library item.instanceId (string) required
libraryItemId (string) required
qapps/disassociate_qapp_from_userDisassociates a Q App from a user removing the user's access to run the Q App.instanceId (string) required
appId (string) required
qapps/export_qapp_session_dataExports the collected data of a Q App data collection session.instanceId (string) required
sessionId (string) required
qapps/get_library_itemRetrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.instanceId (string) required
libraryItemId (string) required
appId (string)
qapps/get_qappRetrieves the full details of an Q App, including its definition specifying the cards and flow.instanceId (string) required
appId (string) required
appVersion (integer)
qapps/get_qapp_sessionRetrieves the current state and results for an active session of an Amazon Q App.instanceId (string) required
sessionId (string) required
qapps/get_qapp_session_metadataRetrieves the current configuration of a Q App session.instanceId (string) required
sessionId (string) required
qapps/import_documentUploads a file that can then be used either as a default in a FileUploadCard from Q App definition or as a file that is used inside a single Q App run. The purpose of the document is determined by a scope parameter that indicates whether it is at the app definition level or at the app session level.instanceId (string) required
cardId (string) required
appId (string) required
fileContentsBase64 (string) required
fileName (string) required
scope (string) required
sessionId (string)
qapps/list_categoriesLists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.instanceId (string) required
qapps/list_library_itemsLists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.instanceId (string) required
limit (integer)
nextToken (string)
categoryId (string)
qapps/list_qappsLists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation..instanceId (string) required
limit (integer)
nextToken (string)
qapps/list_qapp_session_dataLists the collected data of a Q App data collection session.instanceId (string) required
sessionId (string) required
qapps/list_tags_for_resourceLists the tags associated with an Amazon Q Apps resource.resourceARN (string) required
qapps/predict_qappGenerates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call CreateQApp. This API doesn't create Amazon Q Apps directly.instanceId (string) required
options (undefined)
qapps/start_qapp_sessionStarts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run. Each Q App session will be condensed into a single conversation in the web experience.instanceId (string) required
appId (string) required
appVersion (integer) required
initialValues (array)
sessionId (string)
tags (object)
qapps/stop_qapp_sessionStops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation.instanceId (string) required
sessionId (string) required
qapps/tag_resourceAssociates tags with an Amazon Q Apps resource.resourceARN (string) required
tags (object) required
qapps/untag_resourceDisassociates tags from an Amazon Q Apps resource.resourceARN (string) required
tagKeys (array) required
qapps/update_library_itemUpdates the library item for an Amazon Q App.instanceId (string) required
libraryItemId (string) required
status (string)
categories (array)
qapps/update_library_item_metadataUpdates the verification status of a library item for an Amazon Q App.instanceId (string) required
libraryItemId (string) required
isVerified (boolean)
qapps/update_qappUpdates an existing Amazon Q App, allowing modifications to its title, description, and definition.instanceId (string) required
appId (string) required
title (string)
description (string)
appDefinition: {
. cards (array)
. initialPrompt (string)
} (object)
qapps/update_qapp_permissionsUpdates read permissions for a Amazon Q App in Amazon Q Business application environment instance.instanceId (string) required
appId (string) required
grantPermissions (array)
revokePermissions (array)
qapps/update_qapp_sessionUpdates the session for a given Q App sessionId. This is only valid when at least one card of the session is in the WAITING state. Data for each WAITING card can be provided as input. If inputs are not provided, the call will be accepted but session will not move forward. Inputs for cards that are not in the WAITING status will be ignored.instanceId (string) required
sessionId (string) required
values (array)
qapps/update_qapp_session_metadataUpdates the configuration metadata of a session for a given Q App sessionId.instanceId (string) required
sessionId (string) required
sessionName (string)
sharingConfiguration: {
. enabled (boolean)
. acceptResponses (boolean)
. revealCards (boolean)
} (object) required
qbusiness/associate_permissionAdds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.applicationId (string) required
statementId (string) required
actions (array) required
conditions (array)
principal (string) required
qbusiness/batch_delete_documentAsynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index. You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.applicationId (string) required
indexId (string) required
documents (array) required
dataSourceSyncId (string)
qbusiness/batch_put_documentAdds one or more documents to an Amazon Q Business index. You use this API to: ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index. add custom attributes to documents in an Amazon Q Business index. attach an access control list to the documents added to an Amazon Q Business index. You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.applicationId (string) required
indexId (string) required
documents (array) required
roleArn (string)
dataSourceSyncId (string)
qbusiness/cancel_subscriptionUnsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month.applicationId (string) required
subscriptionId (string) required
qbusiness/chatStarts or continues a streaming Amazon Q Business conversation.applicationId (string) required
userId (string)
userGroups (array)
conversationId (string)
parentMessageId (string)
clientToken (string)
inputStream (undefined)
qbusiness/chat_syncStarts or continues a non-streaming Amazon Q Business conversation.applicationId (string) required
userId (string)
userGroups (array)
userMessage (string)
attachments (array)
actionExecution: {
. pluginId (string)
. payload (object)
. payloadFieldNameSeparator (string)
} (object)
authChallengeResponse: {
. responseMap (object)
} (object)
conversationId (string)
parentMessageId (string)
attributeFilter: {
. andAllFilters (array)
. orAllFilters (array)
. notFilter (object)
. equalsTo (object)
. containsAll (object)
. containsAny (object)
. greaterThan (object)
. greaterThanOrEquals (object)
. lessThan (object)
. lessThanOrEquals (object)
} (object)
chatMode (string)
chatModeConfiguration (undefined)
clientToken (string)
qbusiness/check_document_accessVerifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.applicationId (string) required
indexId (string) required
userId (string) required
documentId (string) required
dataSourceId (string)
qbusiness/create_anonymous_web_experience_urlCreates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.applicationId (string) required
webExperienceId (string) required
sessionDurationInMinutes (integer)
qbusiness/create_chat_response_configurationCreates a new chat response configuration for an Amazon Q Business application. This operation establishes a set of parameters that define how the system generates and formats responses to user queries in chat interactions.applicationId (string) required
displayName (string) required
clientToken (string)
responseConfigurations (object) required
tags (array)
qbusiness/create_subscriptionSubscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application. Amazon Q Business offers two subscription tiers: Q_LITE and Q_BUSINESS. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing. For an example IAM role policy for assigning subscriptions, see Set up required permissions in the Amazon Q Business User Guide.applicationId (string) required
principal (undefined) required
type (string) required
clientToken (string)
qbusiness/create_userCreates a universally unique identifier UUID mapped to a list of local user ids within an application.applicationId (string) required
userId (string) required
userAliases (array)
clientToken (string)
qbusiness/delete_attachmentDeletes an attachment associated with a specific Amazon Q Business conversation.applicationId (string) required
conversationId (string) required
attachmentId (string) required
userId (string)
qbusiness/delete_chat_controls_configurationDeletes chat controls configured for an existing Amazon Q Business application.applicationId (string) required
qbusiness/delete_chat_response_configurationDeletes a specified chat response configuration from an Amazon Q Business application.applicationId (string) required
chatResponseConfigurationId (string) required
qbusiness/delete_conversationDeletes an Amazon Q Business web experience conversation.conversationId (string) required
applicationId (string) required
userId (string)
qbusiness/delete_groupDeletes 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 chat results. If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group 'Engineering' leaves the engineering team and another user taapplicationId (string) required
indexId (string) required
groupName (string) required
dataSourceId (string)
qbusiness/delete_userDeletes a user by email id.applicationId (string) required
userId (string) required
qbusiness/disassociate_permissionRemoves a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.applicationId (string) required
statementId (string) required
qbusiness/get_chat_controls_configurationGets information about chat controls configured for an existing Amazon Q Business application.applicationId (string) required
maxResults (integer)
nextToken (string)
qbusiness/get_chat_response_configurationRetrieves detailed information about a specific chat response configuration from an Amazon Q Business application. This operation returns the complete configuration settings and metadata.applicationId (string) required
chatResponseConfigurationId (string) required
qbusiness/get_document_contentRetrieves the content of a document that was ingested into Amazon Q Business. This API validates user authorization against document ACLs before returning a pre-signed URL for secure document access. You can download or view source documents referenced in chat responses through the URL.applicationId (string) required
indexId (string) required
dataSourceId (string)
documentId (string) required
outputFormat (string)
qbusiness/get_groupDescribes a group by group name.applicationId (string) required
indexId (string) required
groupName (string) required
dataSourceId (string)
qbusiness/get_mediaReturns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses. For more information, see Extracting semantic meaning from images and visuals.applicationId (string) required
conversationId (string) required
messageId (string) required
mediaId (string) required
qbusiness/get_policyRetrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.applicationId (string) required
qbusiness/get_userDescribes the universally unique identifier UUID associated with a local user in a data source.applicationId (string) required
userId (string) required
qbusiness/list_attachmentsGets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.applicationId (string) required
conversationId (string)
userId (string)
nextToken (string)
maxResults (integer)
qbusiness/list_chat_response_configurationsRetrieves a list of all chat response configurations available in a specified Amazon Q Business application. This operation returns summary information about each configuration to help administrators manage and select appropriate response settings.applicationId (string) required
maxResults (integer)
nextToken (string)
qbusiness/list_conversationsLists one or more Amazon Q Business conversations.applicationId (string) required
userId (string)
nextToken (string)
maxResults (integer)
qbusiness/list_data_source_sync_jobsGet information about an Amazon Q Business data source connector synchronization.dataSourceId (string) required
applicationId (string) required
indexId (string) required
nextToken (string)
maxResults (integer)
startTime (string)
endTime (string)
statusFilter (string)
qbusiness/list_documentsA list of documents attached to an index.applicationId (string) required
indexId (string) required
dataSourceIds (array)
nextToken (string)
maxResults (integer)
qbusiness/list_groupsProvides a list of groups that are mapped to users.applicationId (string) required
indexId (string) required
updatedEarlierThan (string) required
dataSourceId (string)
nextToken (string)
maxResults (integer)
qbusiness/list_messagesGets a list of messages associated with an Amazon Q Business web experience.conversationId (string) required
applicationId (string) required
userId (string)
nextToken (string)
maxResults (integer)
qbusiness/list_plugin_actionsLists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.applicationId (string) required
pluginId (string) required
nextToken (string)
maxResults (integer)
qbusiness/list_plugin_type_actionsLists configured Amazon Q Business actions for any plugin type—both built-in and custom.pluginType (string) required
nextToken (string)
maxResults (integer)
qbusiness/list_plugin_type_metadataLists metadata for all Amazon Q Business plugin types.nextToken (string)
maxResults (integer)
qbusiness/list_subscriptionsLists all subscriptions created in an Amazon Q Business application.applicationId (string) required
nextToken (string)
maxResults (integer)
qbusiness/list_tags_for_resourceGets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.resourceARN (string) required
qbusiness/put_feedbackEnables your end user to provide feedback on their Amazon Q Business generated chat responses.applicationId (string) required
userId (string)
conversationId (string) required
messageId (string) required
messageCopiedAt (string)
messageUsefulness: {
. usefulness (string)
. reason (string)
. comment (string)
. submittedAt (string)
} (object)
qbusiness/put_groupCreate, or updates, a mapping of users—who have access to a document—to groups. 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 Amazon Q Business chat results. ThapplicationId (string) required
indexId (string) required
groupName (string) required
dataSourceId (string)
type (string) required
groupMembers: {
. memberGroups (array)
. memberUsers (array)
. s3PathForGroupMembers (object)
} (object) required
roleArn (string)
qbusiness/search_relevant_contentSearches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters such as content source and maximum results as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relapplicationId (string) required
queryText (string) required
contentSource (undefined) required
attributeFilter: {
. andAllFilters (array)
. orAllFilters (array)
. notFilter (object)
. equalsTo (object)
. containsAll (object)
. containsAny (object)
. greaterThan (object)
. greaterThanOrEquals (object)
. lessThan (object)
. lessThanOrEquals (object)
} (object)
maxResults (integer)
nextToken (string)
qbusiness/start_data_source_sync_jobStarts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.dataSourceId (string) required
applicationId (string) required
indexId (string) required
qbusiness/stop_data_source_sync_jobStops an Amazon Q Business data source connector synchronization job already in progress.dataSourceId (string) required
applicationId (string) required
indexId (string) required
qbusiness/tag_resourceAdds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.resourceARN (string) required
tags (array) required
qbusiness/untag_resourceRemoves a tag from an Amazon Q Business application or a data source.resourceARN (string) required
tagKeys (array) required
qbusiness/update_chat_controls_configurationUpdates a set of chat controls configured for an existing Amazon Q Business application.applicationId (string) required
clientToken (string)
responseScope (string)
orchestrationConfiguration: {
. control (string)
} (object)
blockedPhrasesConfigurationUpdate: {
. blockedPhrasesToCreateOrUpdate (array)
. blockedPhrasesToDelete (array)
. systemMessageOverride (string)
} (object)
topicConfigurationsToCreateOrUpdate (array)
topicConfigurationsToDelete (array)
creatorModeConfiguration: {
. creatorModeControl (string)
} (object)
hallucinationReductionConfiguration: {
. hallucinationReductionControl (string)
} (object)
qbusiness/update_chat_response_configurationUpdates an existing chat response configuration in an Amazon Q Business application. This operation allows administrators to modify configuration settings, display name, and response parameters to refine how the system generates responses.applicationId (string) required
chatResponseConfigurationId (string) required
displayName (string)
responseConfigurations (object) required
clientToken (string)
qbusiness/update_subscriptionUpdates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see Amazon Q Business pricing.applicationId (string) required
subscriptionId (string) required
type (string) required
qbusiness/update_userUpdates a information associated with a user id.applicationId (string) required
userId (string) required
userAliasesToUpdate (array)
userAliasesToDelete (array)
qbusiness/create_applicationCreates an Amazon Q Business application. There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see Amazon Q Business tiers. You must use the Amazon Q Business console to assign subscription tiers to users. An Amazon Q Apps service linked role will be created if it's absent in the Amazon Web Services account when QdisplayName (string) required
roleArn (string)
identityType (string)
iamIdentityProviderArn (string)
identityCenterInstanceArn (string)
clientIdsForOIDC (array)
description (string)
encryptionConfiguration: {
. kmsKeyId (string)
} (object)
tags (array)
clientToken (string)
attachmentsConfiguration: {
. attachmentsControlMode (string)
} (object)
qAppsConfiguration: {
. qAppsControlMode (string)
} (object)
personalizationConfiguration: {
. personalizationControlMode (string)
} (object)
quickSightConfiguration: {
. clientNamespace (string)
} (object)
qbusiness/get_applicationGets information about an existing Amazon Q Business application.applicationId (string) required
qbusiness/update_applicationUpdates an existing Amazon Q Business application. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business. An Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account when QAppsConfiguration is enabled in the request. For more information, see Using service-linked roles for Q Apps.applicationId (string) required
identityCenterInstanceArn (string)
displayName (string)
description (string)
roleArn (string)
attachmentsConfiguration: {
. attachmentsControlMode (string)
} (object)
qAppsConfiguration: {
. qAppsControlMode (string)
} (object)
personalizationConfiguration: {
. personalizationControlMode (string)
} (object)
autoSubscriptionConfiguration: {
. autoSubscribe (string)
. defaultSubscriptionType (string)
} (object)
qbusiness/delete_applicationDeletes an Amazon Q Business application.applicationId (string) required
qbusiness/list_applicationsLists Amazon Q Business applications. Amazon Q Business applications may securely transmit data for processing across Amazon Web Services Regions within your geography. For more information, see Cross region inference in Amazon Q Business.nextToken (string)
maxResults (integer)
qbusiness/create_data_accessorCreates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's ideapplicationId (string) required
principal (string) required
actionConfigurations (array) required
clientToken (string)
displayName (string) required
authenticationDetail: {
. authenticationType (string)
. authenticationConfiguration
. externalIds (array)
} (object)
tags (array)
qbusiness/get_data_accessorRetrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name ARN, the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.applicationId (string) required
dataAccessorId (string) required
qbusiness/update_data_accessorUpdates an existing data accessor. This operation allows modifying the action configurations the allowed actions and associated filters and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.applicationId (string) required
dataAccessorId (string) required
actionConfigurations (array) required
authenticationDetail: {
. authenticationType (string)
. authenticationConfiguration
. externalIds (array)
} (object)
displayName (string)
qbusiness/delete_data_accessorDeletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.applicationId (string) required
dataAccessorId (string) required
qbusiness/list_data_accessorsLists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.applicationId (string) required
nextToken (string)
maxResults (integer)
qbusiness/create_indexCreates an Amazon Q Business index. 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 the CreateDataSource API.applicationId (string) required
displayName (string) required
description (string)
type (string)
tags (array)
capacityConfiguration: {
. units (integer)
} (object)
clientToken (string)
qbusiness/get_indexGets information about an existing Amazon Q Business index.applicationId (string) required
indexId (string) required
qbusiness/update_indexUpdates an Amazon Q Business index.applicationId (string) required
indexId (string) required
displayName (string)
description (string)
capacityConfiguration: {
. units (integer)
} (object)
documentAttributeConfigurations (array)
qbusiness/delete_indexDeletes an Amazon Q Business index.applicationId (string) required
indexId (string) required
qbusiness/list_indicesLists the Amazon Q Business indices you have created.applicationId (string) required
nextToken (string)
maxResults (integer)
qbusiness/create_data_sourceCreates a data source connector for an Amazon Q Business application. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.applicationId (string) required
indexId (string) required
displayName (string) required
configuration (undefined) required
vpcConfiguration: {
. subnetIds (array)
. securityGroupIds (array)
} (object)
description (string)
tags (array)
syncSchedule (string)
roleArn (string)
clientToken (string)
documentEnrichmentConfiguration: {
. inlineConfigurations (array)
. preExtractionHookConfiguration (object)
. postExtractionHookConfiguration (object)
} (object)
mediaExtractionConfiguration: {
. imageExtractionConfiguration (object)
. audioExtractionConfiguration (object)
. videoExtractionConfiguration (object)
} (object)
qbusiness/get_data_sourceGets information about an existing Amazon Q Business data source connector.applicationId (string) required
indexId (string) required
dataSourceId (string) required
qbusiness/update_data_sourceUpdates an existing Amazon Q Business data source connector.applicationId (string) required
indexId (string) required
dataSourceId (string) required
displayName (string)
configuration (undefined)
vpcConfiguration: {
. subnetIds (array)
. securityGroupIds (array)
} (object)
description (string)
syncSchedule (string)
roleArn (string)
documentEnrichmentConfiguration: {
. inlineConfigurations (array)
. preExtractionHookConfiguration (object)
. postExtractionHookConfiguration (object)
} (object)
mediaExtractionConfiguration: {
. imageExtractionConfiguration (object)
. audioExtractionConfiguration (object)
. videoExtractionConfiguration (object)
} (object)
qbusiness/delete_data_sourceDeletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.applicationId (string) required
indexId (string) required
dataSourceId (string) required
qbusiness/list_data_sourcesLists the Amazon Q Business data source connectors that you have created.applicationId (string) required
indexId (string) required
nextToken (string)
maxResults (integer)
qbusiness/create_pluginCreates an Amazon Q Business plugin.applicationId (string) required
displayName (string) required
type (string) required
authConfiguration (undefined) required
serverUrl (string)
customPluginConfiguration: {
. description (string)
. apiSchemaType (string)
. apiSchema
} (object)
tags (array)
clientToken (string)
qbusiness/get_pluginGets information about an existing Amazon Q Business plugin.applicationId (string) required
pluginId (string) required
qbusiness/update_pluginUpdates an Amazon Q Business plugin.applicationId (string) required
pluginId (string) required
displayName (string)
state (string)
serverUrl (string)
customPluginConfiguration: {
. description (string)
. apiSchemaType (string)
. apiSchema
} (object)
authConfiguration (undefined)
qbusiness/delete_pluginDeletes an Amazon Q Business plugin.applicationId (string) required
pluginId (string) required
qbusiness/list_pluginsLists configured Amazon Q Business plugins.applicationId (string) required
nextToken (string)
maxResults (integer)
qbusiness/create_retrieverAdds a retriever to your Amazon Q Business application.applicationId (string) required
type (string) required
displayName (string) required
configuration (undefined) required
roleArn (string)
clientToken (string)
tags (array)
qbusiness/get_retrieverGets information about an existing retriever used by an Amazon Q Business application.applicationId (string) required
retrieverId (string) required
qbusiness/update_retrieverUpdates the retriever used for your Amazon Q Business application.applicationId (string) required
retrieverId (string) required
configuration (undefined)
displayName (string)
roleArn (string)
qbusiness/delete_retrieverDeletes the retriever used by an Amazon Q Business application.applicationId (string) required
retrieverId (string) required
qbusiness/list_retrieversLists the retriever used by an Amazon Q Business application.applicationId (string) required
nextToken (string)
maxResults (integer)
qbusiness/create_web_experienceCreates an Amazon Q Business web experience.applicationId (string) required
title (string)
subtitle (string)
welcomeMessage (string)
samplePromptsControlMode (string)
origins (array)
roleArn (string)
tags (array)
clientToken (string)
identityProviderConfiguration (undefined)
browserExtensionConfiguration: {
. enabledBrowserExtensions (array)
} (object)
customizationConfiguration: {
. customCSSUrl (string)
. logoUrl (string)
. fontUrl (string)
. faviconUrl (string)
} (object)
qbusiness/get_web_experienceGets information about an existing Amazon Q Business web experience.applicationId (string) required
webExperienceId (string) required
qbusiness/update_web_experienceUpdates an Amazon Q Business web experience.applicationId (string) required
webExperienceId (string) required
roleArn (string)
authenticationConfiguration (undefined)
title (string)
subtitle (string)
welcomeMessage (string)
samplePromptsControlMode (string)
identityProviderConfiguration (undefined)
origins (array)
browserExtensionConfiguration: {
. enabledBrowserExtensions (array)
} (object)
customizationConfiguration: {
. customCSSUrl (string)
. logoUrl (string)
. fontUrl (string)
. faviconUrl (string)
} (object)
qbusiness/delete_web_experienceDeletes an Amazon Q Business web experience.applicationId (string) required
webExperienceId (string) required
qbusiness/list_web_experiencesLists one or more Amazon Q Business Web Experiences.applicationId (string) required
nextToken (string)
maxResults (integer)
qconnect/list_tags_for_resourceLists the tags for the specified resource.resourceArn (string) required
qconnect/tag_resourceAdds the specified tags to the specified resource.resourceArn (string) required
tags (object) required
qconnect/untag_resourceRemoves the specified tags from the specified resource.resourceArn (string) required
tagKeys (array) required
qconnect/get_recommendationsThis API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library amazon-q-connectinto your applications. 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 parameteassistantId (string) required
sessionId (string) required
maxResults (integer)
waitTimeSeconds (integer)
nextChunkToken (string)
recommendationType (string)
qconnect/notify_recommendations_receivedRemoves 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.assistantId (string) required
sessionId (string) required
recommendationIds (array) required
qconnect/put_feedbackProvides feedback against the specified assistant for the specified target. This API only supports generative targets.assistantId (string) required
targetId (string) required
targetType (string) required
contentFeedback (undefined) required
qconnect/query_assistantThis API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library amazon-q-connectinto your applications. Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.assistantId (string) required
queryText (string)
nextToken (string)
maxResults (integer)
sessionId (string)
queryCondition (array)
queryInputData (undefined)
overrideKnowledgeBaseSearchType (string)
qconnect/remove_assistant_aiagentRemoves the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.assistantId (string) required
aiAgentType (string) required
orchestratorUseCase (string)
qconnect/retrieveRetrieves content from knowledge sources based on a query.assistantId (string) required
retrievalConfiguration: {
. knowledgeSource
. filter
. numberOfResults (integer)
. overrideKnowledgeBaseSearchType (string)
} (object) required
retrievalQuery (string) required
qconnect/search_sessionsSearches for sessions.nextToken (string)
maxResults (integer)
assistantId (string) required
searchExpression: {
. filters (array)
} (object) required
qconnect/update_assistant_aiagentUpdates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.assistantId (string) required
aiAgentType (string) required
configuration: {
. aiAgentId (string)
} (object) required
orchestratorUseCase (string)
qconnect/create_assistantCreates an Amazon Q in Connect assistant.clientToken (string)
name (string) required
type (string) required
description (string)
tags (object)
serverSideEncryptionConfiguration: {
. kmsKeyId (string)
} (object)
qconnect/get_assistantRetrieves information about an assistant.assistantId (string) required
qconnect/delete_assistantDeletes an assistant.assistantId (string) required
qconnect/list_assistantsLists information about assistants.nextToken (string)
maxResults (integer)
qconnect/create_aiagent_versionCreates and Amazon Q in Connect AI Agent version.assistantId (string) required
aiAgentId (string) required
modifiedTime (string)
clientToken (string)
qconnect/delete_aiagent_versionDeletes an Amazon Q in Connect AI Agent Version.assistantId (string) required
aiAgentId (string) required
versionNumber (integer) required
qconnect/list_aiagent_versionsList AI Agent versions.assistantId (string) required
aiAgentId (string) required
nextToken (string)
maxResults (integer)
origin (string)
qconnect/create_aiagentCreates an Amazon Q in Connect AI Agent.clientToken (string)
assistantId (string) required
name (string) required
type (string) required
configuration (undefined) required
visibilityStatus (string) required
tags (object)
description (string)
qconnect/get_aiagentGets an Amazon Q in Connect AI Agent.assistantId (string) required
aiAgentId (string) required
qconnect/update_aiagentUpdates an AI Agent.clientToken (string)
assistantId (string) required
aiAgentId (string) required
visibilityStatus (string) required
configuration (undefined)
description (string)
qconnect/delete_aiagentDeletes an Amazon Q in Connect AI Agent.assistantId (string) required
aiAgentId (string) required
qconnect/list_aiagentsLists AI Agents.assistantId (string) required
nextToken (string)
maxResults (integer)
origin (string)
qconnect/create_aiguardrail_versionCreates an Amazon Q in Connect AI Guardrail version.assistantId (string) required
aiGuardrailId (string) required
modifiedTime (string)
clientToken (string)
qconnect/delete_aiguardrail_versionDelete and Amazon Q in Connect AI Guardrail version.assistantId (string) required
aiGuardrailId (string) required
versionNumber (integer) required
qconnect/list_aiguardrail_versionsLists AI Guardrail versions.assistantId (string) required
aiGuardrailId (string) required
nextToken (string)
maxResults (integer)
qconnect/create_aiguardrailCreates an Amazon Q in Connect AI Guardrail.clientToken (string)
assistantId (string) required
name (string) required
blockedInputMessaging (string) required
blockedOutputsMessaging (string) required
visibilityStatus (string) required
description (string)
topicPolicyConfig: {
. topicsConfig (array)
} (object)
contentPolicyConfig: {
. filtersConfig (array)
} (object)
wordPolicyConfig: {
. wordsConfig (array)
. managedWordListsConfig (array)
} (object)
sensitiveInformationPolicyConfig: {
. piiEntitiesConfig (array)
. regexesConfig (array)
} (object)
contextualGroundingPolicyConfig: {
. filtersConfig (array)
} (object)
tags (object)
qconnect/get_aiguardrailGets the Amazon Q in Connect AI Guardrail.assistantId (string) required
aiGuardrailId (string) required
qconnect/update_aiguardrailUpdates an AI Guardrail.clientToken (string)
assistantId (string) required
aiGuardrailId (string) required
visibilityStatus (string) required
blockedInputMessaging (string) required
blockedOutputsMessaging (string) required
description (string)
topicPolicyConfig: {
. topicsConfig (array)
} (object)
contentPolicyConfig: {
. filtersConfig (array)
} (object)
wordPolicyConfig: {
. wordsConfig (array)
. managedWordListsConfig (array)
} (object)
sensitiveInformationPolicyConfig: {
. piiEntitiesConfig (array)
. regexesConfig (array)
} (object)
contextualGroundingPolicyConfig: {
. filtersConfig (array)
} (object)
qconnect/delete_aiguardrailDeletes an Amazon Q in Connect AI Guardrail.assistantId (string) required
aiGuardrailId (string) required
qconnect/list_aiguardrailsLists the AI Guardrails available on the Amazon Q in Connect assistant.assistantId (string) required
nextToken (string)
maxResults (integer)
qconnect/create_aiprompt_versionCreates an Amazon Q in Connect AI Prompt version.assistantId (string) required
aiPromptId (string) required
modifiedTime (string)
clientToken (string)
qconnect/delete_aiprompt_versionDelete and Amazon Q in Connect AI Prompt version.assistantId (string) required
aiPromptId (string) required
versionNumber (integer) required
qconnect/list_aiprompt_versionsLists AI Prompt versions.assistantId (string) required
aiPromptId (string) required
nextToken (string)
maxResults (integer)
origin (string)
qconnect/create_aipromptCreates an Amazon Q in Connect AI Prompt.clientToken (string)
assistantId (string) required
name (string) required
type (string) required
templateConfiguration (undefined) required
visibilityStatus (string) required
templateType (string) required
modelId (string) required
apiFormat (string) required
tags (object)
description (string)
inferenceConfiguration: {
. temperature (number)
. topP (number)
. topK (integer)
. maxTokensToSample (integer)
} (object)
qconnect/get_aipromptGets and Amazon Q in Connect AI Prompt.assistantId (string) required
aiPromptId (string) required
qconnect/update_aipromptUpdates an AI Prompt.clientToken (string)
assistantId (string) required
aiPromptId (string) required
visibilityStatus (string) required
templateConfiguration (undefined)
description (string)
modelId (string)
inferenceConfiguration: {
. temperature (number)
. topP (number)
. topK (integer)
. maxTokensToSample (integer)
} (object)
qconnect/delete_aipromptDeletes an Amazon Q in Connect AI Prompt.assistantId (string) required
aiPromptId (string) required
qconnect/list_aipromptsLists the AI Prompts available on the Amazon Q in Connect assistant.assistantId (string) required
nextToken (string)
maxResults (integer)
origin (string)
qconnect/create_assistant_associationCreates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.assistantId (string) required
associationType (string) required
association (undefined) required
clientToken (string)
tags (object)
qconnect/get_assistant_associationRetrieves information about an assistant association.assistantAssociationId (string) required
assistantId (string) required
qconnect/delete_assistant_associationDeletes an assistant association.assistantAssociationId (string) required
assistantId (string) required
qconnect/list_assistant_associationsLists information about assistant associations.nextToken (string)
maxResults (integer)
assistantId (string) required
qconnect/get_next_messageRetrieves next message on an Amazon Q in Connect session.assistantId (string) required
sessionId (string) required
nextMessageToken (string) required
qconnect/list_messagesLists messages on an Amazon Q in Connect session.assistantId (string) required
sessionId (string) required
nextToken (string)
maxResults (integer)
filter (string)
qconnect/list_spansRetrieves AI agent execution traces for a session, providing granular visibility into agent orchestration flows, LLM interactions, and tool invocations.assistantId (string) required
sessionId (string) required
nextToken (string)
maxResults (integer)
qconnect/send_messageSubmits a message to the Amazon Q in Connect session.assistantId (string) required
sessionId (string) required
type (string) required
message: {
. value
} (object) required
aiAgentId (string)
conversationContext: {
. selfServiceConversationHistory (array)
} (object)
configuration: {
. generateFillerMessage (boolean)
. generateChunkedMessage (boolean)
} (object)
clientToken (string)
orchestratorUseCase (string)
metadata (object)
qconnect/update_session_dataUpdates the data stored on an Amazon Q in Connect Session.assistantId (string) required
sessionId (string) required
namespace (string)
data (array) required
qconnect/create_sessionCreates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.clientToken (string)
assistantId (string) required
name (string) required
description (string)
tags (object)
tagFilter (undefined)
aiAgentConfiguration (object)
contactArn (string)
orchestratorConfigurationList (array)
removeOrchestratorConfigurationList (boolean)
qconnect/get_sessionRetrieves information for a specified session.assistantId (string) required
sessionId (string) required
qconnect/update_sessionUpdates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.assistantId (string) required
sessionId (string) required
description (string)
tagFilter (undefined)
aiAgentConfiguration (object)
orchestratorConfigurationList (array)
removeOrchestratorConfigurationList (boolean)
qconnect/delete_import_jobDeletes the quick response import job.knowledgeBaseId (string) required
importJobId (string) required
qconnect/get_import_jobRetrieves the started import job.importJobId (string) required
knowledgeBaseId (string) required
qconnect/list_import_jobsLists information about import jobs.nextToken (string)
maxResults (integer)
knowledgeBaseId (string) required
qconnect/remove_knowledge_base_template_uriRemoves a URI template from a knowledge base.knowledgeBaseId (string) required
qconnect/search_contentSearches for content in a specified knowledge base. Can be used to get a specific content resource by its name.nextToken (string)
maxResults (integer)
knowledgeBaseId (string) required
searchExpression: {
. filters (array)
} (object) required
qconnect/search_message_templatesSearches for Amazon Q in Connect message templates in the specified knowledge base.knowledgeBaseId (string) required
searchExpression: {
. queries (array)
. filters (array)
. orderOnField (object)
} (object) required
nextToken (string)
maxResults (integer)
qconnect/search_quick_responsesSearches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.knowledgeBaseId (string) required
searchExpression: {
. queries (array)
. filters (array)
. orderOnField (object)
} (object) required
nextToken (string)
maxResults (integer)
attributes (object)
qconnect/start_content_uploadGet 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.knowledgeBaseId (string) required
contentType (string) required
presignedUrlTimeToLive (integer)
qconnect/start_import_jobStart an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data. For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.knowledgeBaseId (string) required
importJobType (string) required
uploadId (string) required
clientToken (string)
metadata (object)
externalSourceConfiguration: {
. source (string)
. configuration
} (object)
qconnect/update_knowledge_base_template_uriUpdates 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 Amazon Q in Connect 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.knowledgeBaseId (string) required
templateUri (string) required
qconnect/create_knowledge_baseCreates 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. 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: Call DeleteKnowledgeBase. Call DeleteDataIntegration. Call CreateDataIntegration to recreateclientToken (string)
name (string) required
knowledgeBaseType (string) required
sourceConfiguration (undefined)
renderingConfiguration: {
. templateUri (string)
} (object)
vectorIngestionConfiguration: {
. chunkingConfiguration (object)
. parsingConfiguration (object)
} (object)
serverSideEncryptionConfiguration: {
. kmsKeyId (string)
} (object)
description (string)
tags (object)
qconnect/get_knowledge_baseRetrieves information about the knowledge base.knowledgeBaseId (string) required
qconnect/delete_knowledge_baseDeletes 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.knowledgeBaseId (string) required
qconnect/list_knowledge_basesLists the knowledge bases.nextToken (string)
maxResults (integer)
qconnect/get_content_summaryRetrieves summary information about the content.contentId (string) required
knowledgeBaseId (string) required
qconnect/create_contentCreates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.knowledgeBaseId (string) required
name (string) required
title (string)
overrideLinkOutUri (string)
metadata (object)
uploadId (string) required
clientToken (string)
tags (object)
qconnect/get_contentRetrieves content, including a pre-signed URL to download the content.contentId (string) required
knowledgeBaseId (string) required
qconnect/update_contentUpdates information about the content.knowledgeBaseId (string) required
contentId (string) required
revisionId (string)
title (string)
overrideLinkOutUri (string)
removeOverrideLinkOutUri (boolean)
metadata (object)
uploadId (string)
qconnect/delete_contentDeletes the content.knowledgeBaseId (string) required
contentId (string) required
qconnect/list_contentsLists the content.nextToken (string)
maxResults (integer)
knowledgeBaseId (string) required
qconnect/create_content_associationCreates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides. After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you haclientToken (string)
knowledgeBaseId (string) required
contentId (string) required
associationType (string) required
association (undefined) required
tags (object)
qconnect/get_content_associationReturns the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.knowledgeBaseId (string) required
contentId (string) required
contentAssociationId (string) required
qconnect/delete_content_associationDeletes the content association. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.knowledgeBaseId (string) required
contentId (string) required
contentAssociationId (string) required
qconnect/list_content_associationsLists the content associations. For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.nextToken (string)
maxResults (integer)
knowledgeBaseId (string) required
contentId (string) required
qconnect/activate_message_templateActivates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the $ACTIVE_VERSION qualifier later to reference the version that is in active status.knowledgeBaseId (string) required
messageTemplateId (string) required
versionNumber (integer) required
qconnect/create_message_template_attachmentUploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.knowledgeBaseId (string) required
messageTemplateId (string) required
contentDisposition (string) required
name (string) required
body (string) required
clientToken (string)
qconnect/create_message_template_versionCreates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in message-template-id:versionNumber as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with $LAknowledgeBaseId (string) required
messageTemplateId (string) required
messageTemplateContentSha256 (string)
qconnect/deactivate_message_templateDeactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION qualifier to reference the version in active status.knowledgeBaseId (string) required
messageTemplateId (string) required
versionNumber (integer) required
qconnect/delete_message_template_attachmentDeletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.knowledgeBaseId (string) required
messageTemplateId (string) required
attachmentId (string) required
qconnect/list_message_template_versionsLists all the available versions for the specified Amazon Q in Connect message template.knowledgeBaseId (string) required
messageTemplateId (string) required
nextToken (string)
maxResults (integer)
qconnect/render_message_templateRenders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.knowledgeBaseId (string) required
messageTemplateId (string) required
attributes: {
. systemAttributes (object)
. agentAttributes (object)
. customerProfileAttributes (object)
. customAttributes (object)
} (object) required
qconnect/update_message_template_metadataUpdates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.knowledgeBaseId (string) required
messageTemplateId (string) required
name (string)
description (string)
groupingConfiguration: {
. criteria (string)
. values (array)
} (object)
qconnect/create_message_templateCreates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.knowledgeBaseId (string) required
name (string)
content (undefined)
description (string)
channelSubtype (string) required
language (string)
sourceConfiguration (undefined)
defaultAttributes: {
. systemAttributes (object)
. agentAttributes (object)
. customerProfileAttributes (object)
. customAttributes (object)
} (object)
groupingConfiguration: {
. criteria (string)
. values (array)
} (object)
clientToken (string)
tags (object)
qconnect/get_message_templateRetrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, message-template-id:qualifier, which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST. If it is not supplied, then $LATEST is assumed implicitly.messageTemplateId (string) required
knowledgeBaseId (string) required
qconnect/update_message_templateUpdates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST qualifier. Any modification will only apply to the message template that is referenced by the $LATEST qualifier. The fields for all available versions will remain unchanged.knowledgeBaseId (string) required
messageTemplateId (string) required
content (undefined)
language (string)
sourceConfiguration (undefined)
defaultAttributes: {
. systemAttributes (object)
. agentAttributes (object)
. customerProfileAttributes (object)
. customAttributes (object)
} (object)
qconnect/delete_message_templateDeletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as message-template-id:versionNumber to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.knowledgeBaseId (string) required
messageTemplateId (string) required
qconnect/list_message_templatesLists all the available Amazon Q in Connect message templates for the specified knowledge base.nextToken (string)
maxResults (integer)
knowledgeBaseId (string) required
qconnect/create_quick_responseCreates an Amazon Q in Connect quick response.knowledgeBaseId (string) required
name (string) required
content (undefined) required
contentType (string)
groupingConfiguration: {
. criteria (string)
. values (array)
} (object)
description (string)
shortcutKey (string)
isActive (boolean)
channels (array)
language (string)
clientToken (string)
tags (object)
qconnect/get_quick_responseRetrieves the quick response.quickResponseId (string) required
knowledgeBaseId (string) required
qconnect/update_quick_responseUpdates an existing Amazon Q in Connect quick response.knowledgeBaseId (string) required
quickResponseId (string) required
name (string)
content (undefined)
contentType (string)
groupingConfiguration: {
. criteria (string)
. values (array)
} (object)
removeGroupingConfiguration (boolean)
description (string)
removeDescription (boolean)
shortcutKey (string)
removeShortcutKey (boolean)
isActive (boolean)
channels (array)
language (string)
qconnect/delete_quick_responseDeletes a quick response.knowledgeBaseId (string) required
quickResponseId (string) required
qconnect/list_quick_responsesLists information about quick response.nextToken (string)
maxResults (integer)
knowledgeBaseId (string) required
quicksight/batch_create_topic_reviewed_answerCreates new reviewed answers for a Q Topic.AwsAccountId (string) required
TopicId (string) required
Answers (array) required
quicksight/batch_delete_topic_reviewed_answerDeletes reviewed answers for Q Topic.AwsAccountId (string) required
TopicId (string) required
AnswerIds (array)
quicksight/cancel_ingestionCancels an ongoing ingestion of data into SPICE.AwsAccountId (string) required
DataSetId (string) required
IngestionId (string) required
quicksight/create_account_customizationCreates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. CustomizaAwsAccountId (string) required
Namespace (string)
AccountCustomization: {
. DefaultTheme (string)
. DefaultEmailCustomizationTemplate (string)
} (object) required
Tags (array)
quicksight/create_account_subscriptionCreates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. 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 Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct Identity and AccesEdition (string)
AuthenticationMethod (string) required
AwsAccountId (string) required
AccountName (string) required
NotificationEmail (string) required
ActiveDirectoryName (string)
Realm (string)
DirectoryId (string)
AdminGroup (array)
AuthorGroup (array)
ReaderGroup (array)
AdminProGroup (array)
AuthorProGroup (array)
ReaderProGroup (array)
FirstName (string)
LastName (string)
EmailAddress (string)
ContactNumber (string)
IAMIdentityCenterInstanceArn (string)
quicksight/create_action_connectorCreates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.AwsAccountId (string) required
ActionConnectorId (string) required
Name (string) required
Type (string) required
AuthenticationConfig: {
. AuthenticationType (string)
. AuthenticationMetadata
} (object) required
Description (string)
Permissions (array)
VpcConnectionArn (string)
Tags (array)
quicksight/create_analysisCreates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition.AwsAccountId (string) required
AnalysisId (string) required
Name (string) required
Parameters: {
. StringParameters (array)
. IntegerParameters (array)
. DecimalParameters (array)
. DateTimeParameters (array)
} (object)
Permissions (array)
SourceEntity: {
. SourceTemplate (object)
} (object)
ThemeArn (string)
Tags (array)
Definition: {
. DataSetIdentifierDeclarations (array)
. Sheets (array)
. CalculatedFields (array)
. ParameterDeclarations (array)
. FilterGroups (array)
. ColumnConfigurations (array)
. AnalysisDefaults (object)
. Options (object)
. QueryExecutionOptions (object)
. StaticFiles (array)
} (object)
ValidationStrategy: {
. Mode (string)
} (object)
FolderArns (array)
quicksight/create_brandCreates an Quick Sight brand.AwsAccountId (string) required
BrandId (string) required
BrandDefinition: {
. BrandName (string)
. Description (string)
. ApplicationTheme (object)
. LogoConfiguration (object)
} (object)
Tags (array)
quicksight/create_custom_permissionsCreates a custom permissions profile.AwsAccountId (string) required
CustomPermissionsName (string) required
Capabilities: {
. ExportToCsv (string)
. ExportToExcel (string)
. ExportToPdf (string)
. PrintReports (string)
. CreateAndUpdateThemes (string)
. AddOrRunAnomalyDetectionForAnalyses (string)
. ShareAnalyses (string)
. CreateAndUpdateDatasets (string)
. ShareDatasets (string)
. SubscribeDashboardEmailReports (string)
. CreateAndUpdateDashboardEmailReports (string)
. ShareDashboards (string)
. CreateAndUpdateThresholdAlerts (string)
. RenameSharedFolders (string)
. CreateSharedFolders (string)
. CreateAndUpdateDataSources (string)
. ShareDataSources (string)
. ViewAccountSPICECapacity (string)
. CreateSPICEDataset (string)
. ExportToPdfInScheduledReports (string)
. ExportToCsvInScheduledReports (string)
. ExportToExcelInScheduledReports (string)
. IncludeContentInScheduledReportsEmail (string)
. Dashboard (string)
. Analysis (string)
. Automate (string)
. Flow (string)
. PublishWithoutApproval (string)
. UseBedrockModels (string)
. PerformFlowUiTask (string)
. UseAgentWebSearch (string)
. KnowledgeBase (string)
. Action (string)
. GenericHTTPAction (string)
. CreateAndUpdateGenericHTTPAction (string)
. ShareGenericHTTPAction (string)
. UseGenericHTTPAction (string)
. AsanaAction (string)
. CreateAndUpdateAsanaAction (string)
. ShareAsanaAction (string)
. UseAsanaAction (string)
. SlackAction (string)
. CreateAndUpdateSlackAction (string)
. ShareSlackAction (string)
. UseSlackAction (string)
. ServiceNowAction (string)
. CreateAndUpdateServiceNowAction (string)
. ShareServiceNowAction (string)
. UseServiceNowAction (string)
. SalesforceAction (string)
. CreateAndUpdateSalesforceAction (string)
. ShareSalesforceAction (string)
. UseSalesforceAction (string)
. MSExchangeAction (string)
. CreateAndUpdateMSExchangeAction (string)
. ShareMSExchangeAction (string)
. UseMSExchangeAction (string)
. PagerDutyAction (string)
. CreateAndUpdatePagerDutyAction (string)
. SharePagerDutyAction (string)
. UsePagerDutyAction (string)
. JiraAction (string)
. CreateAndUpdateJiraAction (string)
. ShareJiraAction (string)
. UseJiraAction (string)
. ConfluenceAction (string)
. CreateAndUpdateConfluenceAction (string)
. ShareConfluenceAction (string)
. UseConfluenceAction (string)
. OneDriveAction (string)
. CreateAndUpdateOneDriveAction (string)
. ShareOneDriveAction (string)
. UseOneDriveAction (string)
. SharePointAction (string)
. CreateAndUpdateSharePointAction (string)
. ShareSharePointAction (string)
. UseSharePointAction (string)
. MSTeamsAction (string)
. CreateAndUpdateMSTeamsAction (string)
. ShareMSTeamsAction (string)
. UseMSTeamsAction (string)
. GoogleCalendarAction (string)
. CreateAndUpdateGoogleCalendarAction (string)
. ShareGoogleCalendarAction (string)
. UseGoogleCalendarAction (string)
. ZendeskAction (string)
. CreateAndUpdateZendeskAction (string)
. ShareZendeskAction (string)
. UseZendeskAction (string)
. SmartsheetAction (string)
. CreateAndUpdateSmartsheetAction (string)
. ShareSmartsheetAction (string)
. UseSmartsheetAction (string)
. SAPBusinessPartnerAction (string)
. CreateAndUpdateSAPBusinessPartnerAction (string)
. ShareSAPBusinessPartnerAction (string)
. UseSAPBusinessPartnerAction (string)
. SAPProductMasterDataAction (string)
. CreateAndUpdateSAPProductMasterDataAction (string)
. ShareSAPProductMasterDataAction (string)
. UseSAPProductMasterDataAction (string)
. SAPPhysicalInventoryAction (string)
. CreateAndUpdateSAPPhysicalInventoryAction (string)
. ShareSAPPhysicalInventoryAction (string)
. UseSAPPhysicalInventoryAction (string)
. SAPBillOfMaterialAction (string)
. CreateAndUpdateSAPBillOfMaterialAction (string)
. ShareSAPBillOfMaterialAction (string)
. UseSAPBillOfMaterialAction (string)
. SAPMaterialStockAction (string)
. CreateAndUpdateSAPMaterialStockAction (string)
. ShareSAPMaterialStockAction (string)
. UseSAPMaterialStockAction (string)
. FactSetAction (string)
. CreateAndUpdateFactSetAction (string)
. ShareFactSetAction (string)
. UseFactSetAction (string)
. AmazonSThreeAction (string)
. CreateAndUpdateAmazonSThreeAction (string)
. ShareAmazonSThreeAction (string)
. UseAmazonSThreeAction (string)
. TextractAction (string)
. CreateAndUpdateTextractAction (string)
. ShareTextractAction (string)
. UseTextractAction (string)
. ComprehendAction (string)
. CreateAndUpdateComprehendAction (string)
. ShareComprehendAction (string)
. UseComprehendAction (string)
. ComprehendMedicalAction (string)
. CreateAndUpdateComprehendMedicalAction (string)
. ShareComprehendMedicalAction (string)
. UseComprehendMedicalAction (string)
. AmazonBedrockARSAction (string)
. CreateAndUpdateAmazonBedrockARSAction (string)
. ShareAmazonBedrockARSAction (string)
. UseAmazonBedrockARSAction (string)
. AmazonBedrockFSAction (string)
. CreateAndUpdateAmazonBedrockFSAction (string)
. ShareAmazonBedrockFSAction (string)
. UseAmazonBedrockFSAction (string)
. AmazonBedrockKRSAction (string)
. CreateAndUpdateAmazonBedrockKRSAction (string)
. ShareAmazonBedrockKRSAction (string)
. UseAmazonBedrockKRSAction (string)
. MCPAction (string)
. CreateAndUpdateMCPAction (string)
. ShareMCPAction (string)
. UseMCPAction (string)
. OpenAPIAction (string)
. CreateAndUpdateOpenAPIAction (string)
. ShareOpenAPIAction (string)
. UseOpenAPIAction (string)
. SandPGMIAction (string)
. CreateAndUpdateSandPGMIAction (string)
. ShareSandPGMIAction (string)
. UseSandPGMIAction (string)
. SandPGlobalEnergyAction (string)
. CreateAndUpdateSandPGlobalEnergyAction (string)
. ShareSandPGlobalEnergyAction (string)
. UseSandPGlobalEnergyAction (string)
. BambooHRAction (string)
. CreateAndUpdateBambooHRAction (string)
. ShareBambooHRAction (string)
. UseBambooHRAction (string)
. BoxAgentAction (string)
. CreateAndUpdateBoxAgentAction (string)
. ShareBoxAgentAction (string)
. UseBoxAgentAction (string)
. CanvaAgentAction (string)
. CreateAndUpdateCanvaAgentAction (string)
. ShareCanvaAgentAction (string)
. UseCanvaAgentAction (string)
. GithubAction (string)
. CreateAndUpdateGithubAction (string)
. ShareGithubAction (string)
. UseGithubAction (string)
. NotionAction (string)
. CreateAndUpdateNotionAction (string)
. ShareNotionAction (string)
. UseNotionAction (string)
. LinearAction (string)
. CreateAndUpdateLinearAction (string)
. ShareLinearAction (string)
. UseLinearAction (string)
. HuggingFaceAction (string)
. CreateAndUpdateHuggingFaceAction (string)
. ShareHuggingFaceAction (string)
. UseHuggingFaceAction (string)
. MondayAction (string)
. CreateAndUpdateMondayAction (string)
. ShareMondayAction (string)
. UseMondayAction (string)
. HubspotAction (string)
. CreateAndUpdateHubspotAction (string)
. ShareHubspotAction (string)
. UseHubspotAction (string)
. IntercomAction (string)
. CreateAndUpdateIntercomAction (string)
. ShareIntercomAction (string)
. UseIntercomAction (string)
. NewRelicAction (string)
. CreateAndUpdateNewRelicAction (string)
. ShareNewRelicAction (string)
. UseNewRelicAction (string)
. Space (string)
. ChatAgent (string)
. CreateChatAgents (string)
. Research (string)
. SelfUpgradeUserRole (string)
} (object)
Tags (array)
quicksight/create_dashboardCreates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight 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 AmazonAwsAccountId (string) required
DashboardId (string) required
Name (string) required
Parameters: {
. StringParameters (array)
. IntegerParameters (array)
. DecimalParameters (array)
. DateTimeParameters (array)
} (object)
Permissions (array)
SourceEntity: {
. SourceTemplate (object)
} (object)
Tags (array)
VersionDescription (string)
DashboardPublishOptions: {
. AdHocFilteringOption (object)
. ExportToCSVOption (object)
. SheetControlsOption (object)
. VisualPublishOptions (object)
. SheetLayoutElementMaximizationOption (object)
. VisualMenuOption (object)
. VisualAxisSortOption (object)
. ExportWithHiddenFieldsOption (object)
. DataPointDrillUpDownOption (object)
. DataPointMenuLabelOption (object)
. DataPointTooltipOption (object)
. DataQAEnabledOption (object)
. QuickSuiteActionsOption (object)
. ExecutiveSummaryOption (object)
. DataStoriesSharingOption (object)
} (object)
ThemeArn (string)
Definition: {
. DataSetIdentifierDeclarations (array)
. Sheets (array)
. CalculatedFields (array)
. ParameterDeclarations (array)
. FilterGroups (array)
. ColumnConfigurations (array)
. AnalysisDefaults (object)
. Options (object)
. StaticFiles (array)
} (object)
ValidationStrategy: {
. Mode (string)
} (object)
FolderArns (array)
LinkSharingConfiguration: {
. Permissions (array)
} (object)
LinkEntities (array)
quicksight/create_data_setCreates a dataset. This operation doesn't support datasets that include uploaded files as a source.AwsAccountId (string) required
DataSetId (string) required
Name (string) required
PhysicalTableMap (object) required
LogicalTableMap (object)
ImportMode (string) required
ColumnGroups (array)
FieldFolders (object)
Permissions (array)
RowLevelPermissionDataSet: {
. Namespace (string)
. Arn (string)
. PermissionPolicy (string)
. FormatVersion (string)
. Status (string)
} (object)
RowLevelPermissionTagConfiguration: {
. Status (string)
. TagRules (array)
. TagRuleConfigurations (array)
} (object)
ColumnLevelPermissionRules (array)
Tags (array)
DataSetUsageConfiguration: {
. DisableUseAsDirectQuerySource (boolean)
. DisableUseAsImportedSource (boolean)
} (object)
DatasetParameters (array)
FolderArns (array)
PerformanceConfiguration: {
. UniqueKeys (array)
} (object)
UseAs (string)
DataPrepConfiguration: {
. SourceTableMap (object)
. TransformStepMap (object)
. DestinationTableMap (object)
} (object)
SemanticModelConfiguration: {
. TableMap (object)
} (object)
quicksight/create_data_sourceCreates a data source.AwsAccountId (string) required
DataSourceId (string) required
Name (string) required
Type (string) required
DataSourceParameters (undefined)
Credentials: {
. CredentialPair (object)
. CopySourceArn (string)
. SecretArn (string)
. KeyPairCredentials (object)
. WebProxyCredentials (object)
} (object)
Permissions (array)
VpcConnectionProperties: {
. VpcConnectionArn (string)
} (object)
SslProperties: {
. DisableSsl (boolean)
} (object)
Tags (array)
FolderArns (array)
quicksight/create_folderCreates an empty shared folder.AwsAccountId (string) required
FolderId (string) required
Name (string)
FolderType (string)
ParentFolderArn (string)
Permissions (array)
Tags (array)
SharingModel (string)
quicksight/create_folder_membershipAdds an asset, such as a dashboard, analysis, or dataset into a folder.AwsAccountId (string) required
FolderId (string) required
MemberId (string) required
MemberType (string) required
quicksight/create_groupUse the CreateGroup operation to create a group in Quick Sight. 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 Amazon Web Services Support. The permissions resource is arn:aws:quicksight:::group/default/ . The response is a group object.GroupName (string) required
Description (string)
AwsAccountId (string) required
Namespace (string) required
quicksight/create_group_membershipAdds an Amazon Quick Sight user to an Amazon Quick Sight group.MemberName (string) required
GroupName (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/create_iampolicy_assignmentCreates 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 Quick Sight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.AwsAccountId (string) required
AssignmentName (string) required
AssignmentStatus (string) required
PolicyArn (string)
Identities (object)
Namespace (string) required
quicksight/create_ingestionCreates 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 acDataSetId (string) required
IngestionId (string) required
AwsAccountId (string) required
IngestionType (string)
quicksight/create_namespaceEnterprise edition only Creates a new namespace for you to use with Amazon Quick Sight. A namespace allows you to isolate the Quick Sight 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 Quick Sight. The namespace must be unique within the Amazon Web SAwsAccountId (string) required
Namespace (string) required
IdentityStore (string) required
Tags (array)
quicksight/create_refresh_scheduleCreates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.DataSetId (string) required
AwsAccountId (string) required
Schedule: {
. ScheduleId (string)
. ScheduleFrequency (object)
. StartAfterDateTime (string)
. RefreshType (string)
. Arn (string)
} (object) required
quicksight/create_role_membershipUse CreateRoleMembership to add an existing Quick Sight group to an existing role.MemberName (string) required
AwsAccountId (string) required
Namespace (string) required
Role (string) required
quicksight/create_templateCreates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses. A template is an entity in Quick Sight 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 dashboardsAwsAccountId (string) required
TemplateId (string) required
Name (string)
Permissions (array)
SourceEntity: {
. SourceAnalysis (object)
. SourceTemplate (object)
} (object)
Tags (array)
VersionDescription (string)
Definition: {
. DataSetConfigurations (array)
. Sheets (array)
. CalculatedFields (array)
. ParameterDeclarations (array)
. FilterGroups (array)
. ColumnConfigurations (array)
. AnalysisDefaults (object)
. Options (object)
. QueryExecutionOptions (object)
. StaticFiles (array)
} (object)
ValidationStrategy: {
. Mode (string)
} (object)
quicksight/create_template_aliasCreates a template alias for a template.AwsAccountId (string) required
TemplateId (string) required
AliasName (string) required
TemplateVersionNumber (integer) required
quicksight/create_themeCreates 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 Quick Sight in the Amazon Quick Sight User Guide.AwsAccountId (string) required
ThemeId (string) required
Name (string) required
BaseThemeId (string) required
VersionDescription (string)
Configuration: {
. DataColorPalette (object)
. UIColorPalette (object)
. Sheet (object)
. Typography (object)
} (object) required
Permissions (array)
Tags (array)
quicksight/create_theme_aliasCreates a theme alias for a theme.AwsAccountId (string) required
ThemeId (string) required
AliasName (string) required
ThemeVersionNumber (integer) required
quicksight/create_topicCreates a new Q topic.AwsAccountId (string) required
TopicId (string) required
Topic: {
. Name (string)
. Description (string)
. UserExperienceVersion (string)
. DataSets (array)
. ConfigOptions (object)
} (object) required
Tags (array)
FolderArns (array)
CustomInstructions: {
. CustomInstructionsString (string)
} (object)
quicksight/create_topic_refresh_scheduleCreates a topic refresh schedule.AwsAccountId (string) required
TopicId (string) required
DatasetArn (string) required
DatasetName (string)
RefreshSchedule: {
. IsEnabled (boolean)
. BasedOnSpiceSchedule (boolean)
. StartingAt (string)
. Timezone (string)
. RepeatAt (string)
. TopicScheduleType (string)
} (object) required
quicksight/create_vpcconnectionCreates a new VPC connection.AwsAccountId (string) required
VPCConnectionId (string) required
Name (string) required
SubnetIds (array) required
SecurityGroupIds (array) required
DnsResolvers (array)
RoleArn (string) required
Tags (array)
quicksight/delete_account_customizationThis API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations: All customizations are removed including themes, branding, and visual settings This action cannot be undone through the API Users will see default Quick Sight styling after customizations are deleted Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate. Deletes all Amazon Quick SigAwsAccountId (string) required
Namespace (string)
quicksight/delete_account_custom_permissionUnapplies a custom permissions profile from an account.AwsAccountId (string) required
quicksight/delete_account_subscriptionDeleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions: Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources. Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions. Embedded content failure – All embedded dashboAwsAccountId (string) required
quicksight/delete_action_connectorHard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.AwsAccountId (string) required
ActionConnectorId (string) required
quicksight/delete_analysisDeletes an analysis from Amazon Quick Sight. 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 Quick Sight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon Quick Sight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operationAwsAccountId (string) required
AnalysisId (string) required
RecoveryWindowInDays (integer)
ForceDeleteWithoutRecovery (boolean)
quicksight/delete_brandThis API permanently deletes the specified Quick Sight brand. When you delete a brand: The brand and all its associated branding elements are permanently removed Any applications or dashboards using this brand will revert to default styling This action cannot be undone through the API Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand. Deletes an Quick Sight brand.AwsAccountId (string) required
BrandId (string) required
quicksight/delete_brand_assignmentDeletes a brand assignment.AwsAccountId (string) required
quicksight/delete_custom_permissionsDeletes a custom permissions profile.AwsAccountId (string) required
CustomPermissionsName (string) required
quicksight/delete_dashboardDeletes a dashboard.AwsAccountId (string) required
DashboardId (string) required
VersionNumber (integer)
quicksight/delete_data_setDeletes a dataset.AwsAccountId (string) required
DataSetId (string) required
quicksight/delete_data_set_refresh_propertiesDeletes the dataset refresh properties of the dataset.AwsAccountId (string) required
DataSetId (string) required
quicksight/delete_data_sourceDeletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.AwsAccountId (string) required
DataSourceId (string) required
quicksight/delete_default_qbusiness_applicationDeletes a linked Amazon Q Business application from an Quick Sight accountAwsAccountId (string) required
Namespace (string)
quicksight/delete_folderDeletes an empty folder.AwsAccountId (string) required
FolderId (string) required
quicksight/delete_folder_membershipRemoves an asset, such as a dashboard, analysis, or dataset, from a folder.AwsAccountId (string) required
FolderId (string) required
MemberId (string) required
MemberType (string) required
quicksight/delete_groupRemoves a user group from Amazon Quick Sight.GroupName (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/delete_group_membershipRemoves a user from a group so that the user is no longer a member of the group.MemberName (string) required
GroupName (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/delete_iampolicy_assignmentDeletes an existing IAM policy assignment.AwsAccountId (string) required
AssignmentName (string) required
Namespace (string) required
quicksight/delete_identity_propagation_configDeletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application. This operation is only supported for Quick Sight accounts that use IAM Identity Center.AwsAccountId (string) required
Service (string) required
quicksight/delete_namespaceDeletes 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.AwsAccountId (string) required
Namespace (string) required
quicksight/delete_refresh_scheduleDeletes a refresh schedule from a dataset.DataSetId (string) required
AwsAccountId (string) required
ScheduleId (string) required
quicksight/delete_role_custom_permissionRemoves custom permissions from the role.Role (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/delete_role_membershipRemoves a group from a role.MemberName (string) required
Role (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/delete_templateDeletes a template.AwsAccountId (string) required
TemplateId (string) required
VersionNumber (integer)
quicksight/delete_template_aliasDeletes 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.AwsAccountId (string) required
TemplateId (string) required
AliasName (string) required
quicksight/delete_themeDeletes a theme.AwsAccountId (string) required
ThemeId (string) required
VersionNumber (integer)
quicksight/delete_theme_aliasDeletes 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.AwsAccountId (string) required
ThemeId (string) required
AliasName (string) required
quicksight/delete_topicDeletes a topic.AwsAccountId (string) required
TopicId (string) required
quicksight/delete_topic_refresh_scheduleDeletes a topic refresh schedule.AwsAccountId (string) required
TopicId (string) required
DatasetId (string) required
quicksight/delete_userDeletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.UserName (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/delete_user_by_principal_idDeletes a user identified by its principal ID.PrincipalId (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/delete_user_custom_permissionDeletes a custom permissions profile from a user.UserName (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/delete_vpcconnectionDeletes a VPC connection.AwsAccountId (string) required
VPCConnectionId (string) required
quicksight/describe_account_customizationDescribes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace. The Quick Sight 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 potentiaAwsAccountId (string) required
Namespace (string)
Resolved (boolean)
quicksight/describe_account_custom_permissionDescribes the custom permissions profile that is applied to an account.AwsAccountId (string) required
quicksight/describe_account_settingsDescribes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.AwsAccountId (string) required
quicksight/describe_account_subscriptionUse the DescribeAccountSubscription operation to receive a description of an Quick Sight 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.AwsAccountId (string) required
quicksight/describe_action_connectorRetrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.AwsAccountId (string) required
ActionConnectorId (string) required
quicksight/describe_action_connector_permissionsRetrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.AwsAccountId (string) required
ActionConnectorId (string) required
quicksight/describe_analysisProvides a summary of the metadata for an analysis.AwsAccountId (string) required
AnalysisId (string) required
quicksight/describe_analysis_definitionProvides a detailed description of the definition of an analysis. If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.AwsAccountId (string) required
AnalysisId (string) required
quicksight/describe_analysis_permissionsProvides the read and write permissions for an analysis.AwsAccountId (string) required
AnalysisId (string) required
quicksight/describe_asset_bundle_export_jobDescribes an existing export job. Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed. Job descriptions are available for 14 days after the job starts.AwsAccountId (string) required
AssetBundleExportJobId (string) required
quicksight/describe_asset_bundle_import_jobDescribes an existing import job. Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.AwsAccountId (string) required
AssetBundleImportJobId (string) required
quicksight/describe_brandDescribes a brand.AwsAccountId (string) required
BrandId (string) required
VersionId (string)
quicksight/describe_brand_assignmentDescribes a brand assignment.AwsAccountId (string) required
quicksight/describe_brand_published_versionDescribes the published version of the brand.AwsAccountId (string) required
BrandId (string) required
quicksight/describe_custom_permissionsDescribes a custom permissions profile.AwsAccountId (string) required
CustomPermissionsName (string) required
quicksight/describe_dashboardProvides a summary for a dashboard.AwsAccountId (string) required
DashboardId (string) required
VersionNumber (integer)
AliasName (string)
quicksight/describe_dashboard_definitionProvides a detailed description of the definition of a dashboard. If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.AwsAccountId (string) required
DashboardId (string) required
VersionNumber (integer)
AliasName (string)
quicksight/describe_dashboard_permissionsDescribes read and write permissions for a dashboard.AwsAccountId (string) required
DashboardId (string) required
quicksight/describe_dashboard_snapshot_jobDescribes an existing snapshot job. Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus. Registered user support This API can be called as before to get status of a job started by the same Quick Sight user. Possible error scenarios Request will fail with an Access Denied error in the following scenarios: The credentials have expired. Job has been started by a different user. Impersonated Quick Sight user doesn't have acAwsAccountId (string) required
DashboardId (string) required
SnapshotJobId (string) required
quicksight/describe_dashboard_snapshot_job_resultDescribes the result of an existing snapshot job that has finished running. A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call. If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id has not reached a terminal state.. Registered user support This API can be called as before to get the result of a job started by the same Quick Sight user. The result for the userAwsAccountId (string) required
DashboardId (string) required
SnapshotJobId (string) required
quicksight/describe_dashboards_qaconfigurationDescribes an existing dashboard QA configuration.AwsAccountId (string) required
quicksight/describe_data_setDescribes a dataset. This operation doesn't support datasets that include uploaded files as a source.AwsAccountId (string) required
DataSetId (string) required
quicksight/describe_data_set_permissionsDescribes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.AwsAccountId (string) required
DataSetId (string) required
quicksight/describe_data_set_refresh_propertiesDescribes the refresh properties of a dataset.AwsAccountId (string) required
DataSetId (string) required
quicksight/describe_data_sourceDescribes a data source.AwsAccountId (string) required
DataSourceId (string) required
quicksight/describe_data_source_permissionsDescribes the resource permissions for a data source.AwsAccountId (string) required
DataSourceId (string) required
quicksight/describe_default_qbusiness_applicationDescribes a Amazon Q Business application that is linked to an Quick Sight account.AwsAccountId (string) required
Namespace (string)
quicksight/describe_folderDescribes a folder.AwsAccountId (string) required
FolderId (string) required
quicksight/describe_folder_permissionsDescribes permissions for a folder.AwsAccountId (string) required
FolderId (string) required
Namespace (string)
MaxResults (integer)
NextToken (string)
quicksight/describe_folder_resolved_permissionsDescribes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.AwsAccountId (string) required
FolderId (string) required
Namespace (string)
MaxResults (integer)
NextToken (string)
quicksight/describe_groupReturns an Amazon Quick Sight group's description and Amazon Resource Name ARN.GroupName (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/describe_group_membershipUse 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.MemberName (string) required
GroupName (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/describe_iampolicy_assignmentDescribes an existing IAM policy assignment, as specified by the assignment name.AwsAccountId (string) required
AssignmentName (string) required
Namespace (string) required
quicksight/describe_ingestionDescribes a SPICE ingestion.AwsAccountId (string) required
DataSetId (string) required
IngestionId (string) required
quicksight/describe_ip_restrictionProvides a summary and status of IP rules.AwsAccountId (string) required
quicksight/describe_key_registrationDescribes all customer managed key registrations in a Quick Sight account.AwsAccountId (string) required
DefaultKeyOnly (boolean)
quicksight/describe_namespaceDescribes the current namespace.AwsAccountId (string) required
Namespace (string) required
quicksight/describe_qpersonalization_configurationDescribes a personalization configuration.AwsAccountId (string) required
quicksight/describe_quick_sight_qsearch_configurationDescribes the state of a Quick Sight Q Search configuration.AwsAccountId (string) required
quicksight/describe_refresh_scheduleProvides a summary of a refresh schedule.AwsAccountId (string) required
DataSetId (string) required
ScheduleId (string) required
quicksight/describe_role_custom_permissionDescribes all custom permissions that are mapped to a role.Role (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/describe_self_upgrade_configurationDescribes the self-upgrade configuration for a Quick Suite account.AwsAccountId (string) required
Namespace (string) required
quicksight/describe_templateDescribes a template's metadata.AwsAccountId (string) required
TemplateId (string) required
VersionNumber (integer)
AliasName (string)
quicksight/describe_template_aliasDescribes the template alias for a template.AwsAccountId (string) required
TemplateId (string) required
AliasName (string) required
quicksight/describe_template_definitionProvides a detailed description of the definition of a template. If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.AwsAccountId (string) required
TemplateId (string) required
VersionNumber (integer)
AliasName (string)
quicksight/describe_template_permissionsDescribes read and write permissions on a template.AwsAccountId (string) required
TemplateId (string) required
quicksight/describe_themeDescribes a theme.AwsAccountId (string) required
ThemeId (string) required
VersionNumber (integer)
AliasName (string)
quicksight/describe_theme_aliasDescribes the alias for a theme.AwsAccountId (string) required
ThemeId (string) required
AliasName (string) required
quicksight/describe_theme_permissionsDescribes the read and write permissions for a theme.AwsAccountId (string) required
ThemeId (string) required
quicksight/describe_topicDescribes a topic.AwsAccountId (string) required
TopicId (string) required
quicksight/describe_topic_permissionsDescribes the permissions of a topic.AwsAccountId (string) required
TopicId (string) required
quicksight/describe_topic_refreshDescribes the status of a topic refresh.AwsAccountId (string) required
TopicId (string) required
RefreshId (string) required
quicksight/describe_topic_refresh_scheduleDeletes a topic refresh schedule.AwsAccountId (string) required
TopicId (string) required
DatasetId (string) required
quicksight/describe_userReturns information about a user, given the user name.UserName (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/describe_vpcconnectionDescribes a VPC connection.AwsAccountId (string) required
VPCConnectionId (string) required
quicksight/generate_embed_url_for_anonymous_userGenerates an embed URL that you can use to embed an Amazon Quick Suite 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 theAwsAccountId (string) required
SessionLifetimeInMinutes (integer)
Namespace (string) required
SessionTags (array)
AuthorizedResourceArns (array) required
ExperienceConfiguration: {
. Dashboard (object)
. DashboardVisual (object)
. QSearchBar (object)
. GenerativeQnA (object)
} (object) required
AllowedDomains (array)
quicksight/generate_embed_url_for_registered_userGenerates an embed URL that you can use to embed an Amazon Quick Suite experience in your website. This action can be used for any type of user registered in an Amazon Quick Suite account. Before you use this action, make sure that you have configured the relevant Amazon Quick Suite 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-usedAwsAccountId (string) required
SessionLifetimeInMinutes (integer)
UserArn (string) required
ExperienceConfiguration: {
. Dashboard (object)
. QuickSightConsole (object)
. QSearchBar (object)
. DashboardVisual (object)
. GenerativeQnA (object)
. QuickChat (object)
} (object) required
AllowedDomains (array)
quicksight/generate_embed_url_for_registered_user_with_identityGenerates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for. This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to thAwsAccountId (string) required
SessionLifetimeInMinutes (integer)
ExperienceConfiguration: {
. Dashboard (object)
. QuickSightConsole (object)
. QSearchBar (object)
. DashboardVisual (object)
. GenerativeQnA (object)
. QuickChat (object)
} (object) required
AllowedDomains (array)
quicksight/get_dashboard_embed_urlGenerates a temporary session URL and authorization codebearer token that you can use to embed an Amazon Quick Sight 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 aftAwsAccountId (string) required
DashboardId (string) required
IdentityType (string) required
SessionLifetimeInMinutes (integer)
UndoRedoDisabled (boolean)
ResetDisabled (boolean)
StatePersistenceEnabled (boolean)
UserArn (string)
Namespace (string)
AdditionalDashboardIds (array)
quicksight/get_flow_metadataRetrieves the metadata of a flow, not including its definition specifying the steps.AwsAccountId (string) required
FlowId (string) required
quicksight/get_flow_permissionsGet permissions for a flow.AwsAccountId (string) required
FlowId (string) required
quicksight/get_identity_contextRetrieves the identity context for a Quick Sight user in a specified namespace, allowing you to obtain identity tokens that can be used with identity-enhanced IAM role sessions to call identity-aware APIs. Currently, you can call the following APIs with identity-enhanced Credentials StartDashboardSnapshotJob DescribeDashboardSnapshotJob DescribeDashboardSnapshotJobResult Supported Authentication Methods This API supports Quick Sight native users, IAM federated users, and Active Directory users.AwsAccountId (string) required
UserIdentifier (undefined) required
Namespace (string)
SessionExpiresAt (string)
quicksight/get_session_embed_urlGenerates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight 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 Quick Sight 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 usAwsAccountId (string) required
EntryPoint (string)
SessionLifetimeInMinutes (integer)
UserArn (string)
quicksight/list_action_connectorsLists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.AwsAccountId (string) required
MaxResults (integer)
NextToken (string)
quicksight/list_analysesLists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_asset_bundle_export_jobsLists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_asset_bundle_import_jobsLists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_brandsLists all brands in an Quick Sight account.AwsAccountId (string) required
MaxResults (integer)
NextToken (string)
quicksight/list_custom_permissionsReturns a list of all the custom permissions profiles.AwsAccountId (string) required
MaxResults (integer)
NextToken (string)
quicksight/list_dashboardsLists dashboards in an Amazon Web Services account.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_dashboard_versionsLists all the versions of the dashboards in the Amazon Quick Sight subscription.AwsAccountId (string) required
DashboardId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_data_setsLists 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/.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_data_sourcesLists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_flowsLists flows in an Amazon Web Services account.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_folder_membersList all assets DASHBOARD, ANALYSIS, and DATASET in a folder.AwsAccountId (string) required
FolderId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_foldersLists all folders in an account.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_folders_for_resourceList all folders that a resource is a member of.AwsAccountId (string) required
ResourceArn (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_group_membershipsLists member users in a group.GroupName (string) required
NextToken (string)
MaxResults (integer)
AwsAccountId (string) required
Namespace (string) required
quicksight/list_groupsLists all user groups in Amazon Quick Sight.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
Namespace (string) required
quicksight/list_iampolicy_assignmentsLists the IAM policy assignments in the current Amazon Quick Sight account.AwsAccountId (string) required
AssignmentStatus (string)
Namespace (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_iampolicy_assignments_for_userLists all of 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.AwsAccountId (string) required
UserName (string) required
NextToken (string)
MaxResults (integer)
Namespace (string) required
quicksight/list_identity_propagation_configsLists all services and authorized targets that the Quick Sight IAM Identity Center application can access. This operation is only supported for Quick Sight accounts that use IAM Identity Center.AwsAccountId (string) required
MaxResults (integer)
NextToken (string)
quicksight/list_ingestionsLists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.DataSetId (string) required
NextToken (string)
AwsAccountId (string) required
MaxResults (integer)
quicksight/list_namespacesLists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_refresh_schedulesLists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.AwsAccountId (string) required
DataSetId (string) required
quicksight/list_role_membershipsLists all groups that are associated with a role.Role (string) required
NextToken (string)
MaxResults (integer)
AwsAccountId (string) required
Namespace (string) required
quicksight/list_self_upgradesLists all self-upgrade requests for a Quick Suite account.AwsAccountId (string) required
Namespace (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_tags_for_resourceLists the tags assigned to a resource.ResourceArn (string) required
quicksight/list_template_aliasesLists all the aliases of a template.AwsAccountId (string) required
TemplateId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_templatesLists all the templates in the current Amazon Quick Sight account.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_template_versionsLists all the versions of the templates in the current Amazon Quick Sight account.AwsAccountId (string) required
TemplateId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_theme_aliasesLists all the aliases of a theme.AwsAccountId (string) required
ThemeId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_themesLists all the themes in the current Amazon Web Services account.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
Type (string)
quicksight/list_theme_versionsLists all the versions of the themes in the current Amazon Web Services account.AwsAccountId (string) required
ThemeId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_topic_refresh_schedulesLists all of the refresh schedules for a topic.AwsAccountId (string) required
TopicId (string) required
quicksight/list_topic_reviewed_answersLists all reviewed answers for a Q Topic.AwsAccountId (string) required
TopicId (string) required
quicksight/list_topicsLists all of the topics within an account.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_user_groupsLists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.UserName (string) required
AwsAccountId (string) required
Namespace (string) required
NextToken (string)
MaxResults (integer)
quicksight/list_usersReturns a list of all of the Amazon Quick Sight users belonging to this account.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
Namespace (string) required
quicksight/list_vpcconnectionsLists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
quicksight/predict_qaresultsPredicts existing visuals or generates new visuals to answer a given query. This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Quick Suite with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Quick Suite resource andAwsAccountId (string) required
QueryText (string) required
IncludeQuickSightQIndex (string)
IncludeGeneratedAnswer (string)
MaxTopicsToConsider (integer)
quicksight/put_data_set_refresh_propertiesCreates or updates the dataset refresh properties for the dataset.AwsAccountId (string) required
DataSetId (string) required
DataSetRefreshProperties: {
. RefreshConfiguration (object)
. FailureConfiguration (object)
} (object) required
quicksight/register_userCreates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management IAM identity or role specified in the request. When you register a new user from the Quick Sight API, Quick Sight generates a registration URL. The user accesses this registration URL to create their account. Quick Sight doesn't send a registration email to users who are registered from the Quick Sight API. If you want new users to receive a registration email, then add those users in the QuicIdentityType (string) required
Email (string) required
UserRole (string) required
IamArn (string)
SessionName (string)
AwsAccountId (string) required
Namespace (string) required
UserName (string)
CustomPermissionsName (string)
ExternalLoginFederationProviderType (string)
CustomFederationProviderUrl (string)
ExternalLoginId (string)
Tags (array)
quicksight/restore_analysisRestores an analysis.AwsAccountId (string) required
AnalysisId (string) required
RestoreToFolders (boolean)
quicksight/search_action_connectorsSearches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.AwsAccountId (string) required
MaxResults (integer)
NextToken (string)
Filters (array) required
quicksight/search_analysesSearches 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.AwsAccountId (string) required
Filters (array) required
NextToken (string)
MaxResults (integer)
quicksight/search_dashboardsSearches 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.AwsAccountId (string) required
Filters (array) required
NextToken (string)
MaxResults (integer)
quicksight/search_data_setsUse the SearchDataSets operation to search for datasets that belong to an account.AwsAccountId (string) required
Filters (array) required
NextToken (string)
MaxResults (integer)
quicksight/search_data_sourcesUse the SearchDataSources operation to search for data sources that belong to an account.AwsAccountId (string) required
Filters (array) required
NextToken (string)
MaxResults (integer)
quicksight/search_flowsSearch for the flows in an Amazon Web Services account.AwsAccountId (string) required
Filters (array) required
NextToken (string)
MaxResults (integer)
quicksight/search_foldersSearches the subfolders in a folder.AwsAccountId (string) required
Filters (array) required
NextToken (string)
MaxResults (integer)
quicksight/search_groupsUse the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters.AwsAccountId (string) required
NextToken (string)
MaxResults (integer)
Namespace (string) required
Filters (array) required
quicksight/search_topicsSearches for any Q topic that exists in an Quick Suite account.AwsAccountId (string) required
Filters (array) required
NextToken (string)
MaxResults (integer)
quicksight/start_asset_bundle_export_jobStarts an Asset Bundle export job. An Asset Bundle export job exports specified Amazon Quick Sight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon Quick Sight accounAwsAccountId (string) required
AssetBundleExportJobId (string) required
ResourceArns (array) required
IncludeAllDependencies (boolean)
ExportFormat (string) required
CloudFormationOverridePropertyConfiguration: {
. ResourceIdOverrideConfiguration (object)
. VPCConnections (array)
. RefreshSchedules (array)
. DataSources (array)
. DataSets (array)
. Themes (array)
. Analyses (array)
. Dashboards (array)
. Folders (array)
} (object)
IncludePermissions (boolean)
IncludeTags (boolean)
ValidationStrategy: {
. StrictModeForAllResources (boolean)
} (object)
IncludeFolderMemberships (boolean)
IncludeFolderMembers (string)
quicksight/start_asset_bundle_import_jobStarts an Asset Bundle import job. An Asset Bundle import job imports specified Amazon Quick Sight assets into an Amazon Quick Sight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon Quick Sight account. Each Amazon Quick Sight account can run up to 5 import jobs concurrently. The API caller must have the necessary 'creaAwsAccountId (string) required
AssetBundleImportJobId (string) required
AssetBundleImportSource: {
. Body (string)
. S3Uri (string)
} (object) required
OverrideParameters: {
. ResourceIdOverrideConfiguration (object)
. VPCConnections (array)
. RefreshSchedules (array)
. DataSources (array)
. DataSets (array)
. Themes (array)
. Analyses (array)
. Dashboards (array)
. Folders (array)
} (object)
FailureAction (string)
OverridePermissions: {
. DataSources (array)
. DataSets (array)
. Themes (array)
. Analyses (array)
. Dashboards (array)
. Folders (array)
} (object)
OverrideTags: {
. VPCConnections (array)
. DataSources (array)
. DataSets (array)
. Themes (array)
. Analyses (array)
. Dashboards (array)
. Folders (array)
} (object)
OverrideValidationStrategy: {
. StrictModeForAllResources (boolean)
} (object)
quicksight/start_dashboard_snapshot_jobStarts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call. 1 PDF 1 Excel workbook that includes up to 5 table or pivot table visuals 5 CSVs from table or pivot table visuals Exporting CSV, Excel, or Pixel Perfect PDF reports requires Pixel Perfect Report Add-on. The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotAwsAccountId (string) required
DashboardId (string) required
SnapshotJobId (string) required
UserConfiguration: {
. AnonymousUsers (array)
} (object)
SnapshotConfiguration: {
. FileGroups (array)
. DestinationConfiguration (object)
. Parameters (object)
} (object) required
quicksight/start_dashboard_snapshot_job_scheduleStarts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email. Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code. For more information, see Scheduling and sending Amazon Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide.AwsAccountId (string) required
DashboardId (string) required
ScheduleId (string) required
quicksight/tag_resourceAssigns one or more tags key-value pairs to the specified Amazon Quick Sight 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 tagResourceArn (string) required
Tags (array) required
quicksight/untag_resourceRemoves a tag or tags from a resource.ResourceArn (string) required
TagKeys (array) required
quicksight/update_account_customizationUpdates Amazon Quick Sight customizations. 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 Quick Sight 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.AwsAccountId (string) required
Namespace (string)
AccountCustomization: {
. DefaultTheme (string)
. DefaultEmailCustomizationTemplate (string)
} (object) required
quicksight/update_account_custom_permissionApplies a custom permissions profile to an account.CustomPermissionsName (string) required
AwsAccountId (string) required
quicksight/update_account_settingsUpdates the Amazon Quick Sight settings in your Amazon Web Services account.AwsAccountId (string) required
DefaultNamespace (string) required
NotificationEmail (string)
TerminationProtectionEnabled (boolean)
quicksight/update_action_connectorUpdates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector's name, description, authentication configuration, and which actions are enabled. For more information, https://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html.AwsAccountId (string) required
ActionConnectorId (string) required
Name (string) required
AuthenticationConfig: {
. AuthenticationType (string)
. AuthenticationMetadata
} (object) required
Description (string)
VpcConnectionArn (string)
quicksight/update_action_connector_permissionsUpdates the permissions for an action connector by granting or revoking access for specific users and groups. You can control who can view, use, or manage the action connector.AwsAccountId (string) required
ActionConnectorId (string) required
GrantPermissions (array)
RevokePermissions (array)
quicksight/update_analysisUpdates an analysis in Amazon Quick SightAwsAccountId (string) required
AnalysisId (string) required
Name (string) required
Parameters: {
. StringParameters (array)
. IntegerParameters (array)
. DecimalParameters (array)
. DateTimeParameters (array)
} (object)
SourceEntity: {
. SourceTemplate (object)
} (object)
ThemeArn (string)
Definition: {
. DataSetIdentifierDeclarations (array)
. Sheets (array)
. CalculatedFields (array)
. ParameterDeclarations (array)
. FilterGroups (array)
. ColumnConfigurations (array)
. AnalysisDefaults (object)
. Options (object)
. QueryExecutionOptions (object)
. StaticFiles (array)
} (object)
ValidationStrategy: {
. Mode (string)
} (object)
quicksight/update_analysis_permissionsUpdates the read and write permissions for an analysis.AwsAccountId (string) required
AnalysisId (string) required
GrantPermissions (array)
RevokePermissions (array)
quicksight/update_application_with_token_exchange_grantUpdates an Quick Suite application with a token exchange grant. This operation only supports Quick Suite applications that are registered with IAM Identity Center.AwsAccountId (string) required
Namespace (string) required
quicksight/update_brandUpdates a brand.AwsAccountId (string) required
BrandId (string) required
BrandDefinition: {
. BrandName (string)
. Description (string)
. ApplicationTheme (object)
. LogoConfiguration (object)
} (object)
quicksight/update_brand_assignmentUpdates a brand assignment.AwsAccountId (string) required
BrandArn (string) required
quicksight/update_brand_published_versionUpdates the published version of a brand.AwsAccountId (string) required
BrandId (string) required
VersionId (string) required
quicksight/update_custom_permissionsUpdates a custom permissions profile.AwsAccountId (string) required
CustomPermissionsName (string) required
Capabilities: {
. ExportToCsv (string)
. ExportToExcel (string)
. ExportToPdf (string)
. PrintReports (string)
. CreateAndUpdateThemes (string)
. AddOrRunAnomalyDetectionForAnalyses (string)
. ShareAnalyses (string)
. CreateAndUpdateDatasets (string)
. ShareDatasets (string)
. SubscribeDashboardEmailReports (string)
. CreateAndUpdateDashboardEmailReports (string)
. ShareDashboards (string)
. CreateAndUpdateThresholdAlerts (string)
. RenameSharedFolders (string)
. CreateSharedFolders (string)
. CreateAndUpdateDataSources (string)
. ShareDataSources (string)
. ViewAccountSPICECapacity (string)
. CreateSPICEDataset (string)
. ExportToPdfInScheduledReports (string)
. ExportToCsvInScheduledReports (string)
. ExportToExcelInScheduledReports (string)
. IncludeContentInScheduledReportsEmail (string)
. Dashboard (string)
. Analysis (string)
. Automate (string)
. Flow (string)
. PublishWithoutApproval (string)
. UseBedrockModels (string)
. PerformFlowUiTask (string)
. UseAgentWebSearch (string)
. KnowledgeBase (string)
. Action (string)
. GenericHTTPAction (string)
. CreateAndUpdateGenericHTTPAction (string)
. ShareGenericHTTPAction (string)
. UseGenericHTTPAction (string)
. AsanaAction (string)
. CreateAndUpdateAsanaAction (string)
. ShareAsanaAction (string)
. UseAsanaAction (string)
. SlackAction (string)
. CreateAndUpdateSlackAction (string)
. ShareSlackAction (string)
. UseSlackAction (string)
. ServiceNowAction (string)
. CreateAndUpdateServiceNowAction (string)
. ShareServiceNowAction (string)
. UseServiceNowAction (string)
. SalesforceAction (string)
. CreateAndUpdateSalesforceAction (string)
. ShareSalesforceAction (string)
. UseSalesforceAction (string)
. MSExchangeAction (string)
. CreateAndUpdateMSExchangeAction (string)
. ShareMSExchangeAction (string)
. UseMSExchangeAction (string)
. PagerDutyAction (string)
. CreateAndUpdatePagerDutyAction (string)
. SharePagerDutyAction (string)
. UsePagerDutyAction (string)
. JiraAction (string)
. CreateAndUpdateJiraAction (string)
. ShareJiraAction (string)
. UseJiraAction (string)
. ConfluenceAction (string)
. CreateAndUpdateConfluenceAction (string)
. ShareConfluenceAction (string)
. UseConfluenceAction (string)
. OneDriveAction (string)
. CreateAndUpdateOneDriveAction (string)
. ShareOneDriveAction (string)
. UseOneDriveAction (string)
. SharePointAction (string)
. CreateAndUpdateSharePointAction (string)
. ShareSharePointAction (string)
. UseSharePointAction (string)
. MSTeamsAction (string)
. CreateAndUpdateMSTeamsAction (string)
. ShareMSTeamsAction (string)
. UseMSTeamsAction (string)
. GoogleCalendarAction (string)
. CreateAndUpdateGoogleCalendarAction (string)
. ShareGoogleCalendarAction (string)
. UseGoogleCalendarAction (string)
. ZendeskAction (string)
. CreateAndUpdateZendeskAction (string)
. ShareZendeskAction (string)
. UseZendeskAction (string)
. SmartsheetAction (string)
. CreateAndUpdateSmartsheetAction (string)
. ShareSmartsheetAction (string)
. UseSmartsheetAction (string)
. SAPBusinessPartnerAction (string)
. CreateAndUpdateSAPBusinessPartnerAction (string)
. ShareSAPBusinessPartnerAction (string)
. UseSAPBusinessPartnerAction (string)
. SAPProductMasterDataAction (string)
. CreateAndUpdateSAPProductMasterDataAction (string)
. ShareSAPProductMasterDataAction (string)
. UseSAPProductMasterDataAction (string)
. SAPPhysicalInventoryAction (string)
. CreateAndUpdateSAPPhysicalInventoryAction (string)
. ShareSAPPhysicalInventoryAction (string)
. UseSAPPhysicalInventoryAction (string)
. SAPBillOfMaterialAction (string)
. CreateAndUpdateSAPBillOfMaterialAction (string)
. ShareSAPBillOfMaterialAction (string)
. UseSAPBillOfMaterialAction (string)
. SAPMaterialStockAction (string)
. CreateAndUpdateSAPMaterialStockAction (string)
. ShareSAPMaterialStockAction (string)
. UseSAPMaterialStockAction (string)
. FactSetAction (string)
. CreateAndUpdateFactSetAction (string)
. ShareFactSetAction (string)
. UseFactSetAction (string)
. AmazonSThreeAction (string)
. CreateAndUpdateAmazonSThreeAction (string)
. ShareAmazonSThreeAction (string)
. UseAmazonSThreeAction (string)
. TextractAction (string)
. CreateAndUpdateTextractAction (string)
. ShareTextractAction (string)
. UseTextractAction (string)
. ComprehendAction (string)
. CreateAndUpdateComprehendAction (string)
. ShareComprehendAction (string)
. UseComprehendAction (string)
. ComprehendMedicalAction (string)
. CreateAndUpdateComprehendMedicalAction (string)
. ShareComprehendMedicalAction (string)
. UseComprehendMedicalAction (string)
. AmazonBedrockARSAction (string)
. CreateAndUpdateAmazonBedrockARSAction (string)
. ShareAmazonBedrockARSAction (string)
. UseAmazonBedrockARSAction (string)
. AmazonBedrockFSAction (string)
. CreateAndUpdateAmazonBedrockFSAction (string)
. ShareAmazonBedrockFSAction (string)
. UseAmazonBedrockFSAction (string)
. AmazonBedrockKRSAction (string)
. CreateAndUpdateAmazonBedrockKRSAction (string)
. ShareAmazonBedrockKRSAction (string)
. UseAmazonBedrockKRSAction (string)
. MCPAction (string)
. CreateAndUpdateMCPAction (string)
. ShareMCPAction (string)
. UseMCPAction (string)
. OpenAPIAction (string)
. CreateAndUpdateOpenAPIAction (string)
. ShareOpenAPIAction (string)
. UseOpenAPIAction (string)
. SandPGMIAction (string)
. CreateAndUpdateSandPGMIAction (string)
. ShareSandPGMIAction (string)
. UseSandPGMIAction (string)
. SandPGlobalEnergyAction (string)
. CreateAndUpdateSandPGlobalEnergyAction (string)
. ShareSandPGlobalEnergyAction (string)
. UseSandPGlobalEnergyAction (string)
. BambooHRAction (string)
. CreateAndUpdateBambooHRAction (string)
. ShareBambooHRAction (string)
. UseBambooHRAction (string)
. BoxAgentAction (string)
. CreateAndUpdateBoxAgentAction (string)
. ShareBoxAgentAction (string)
. UseBoxAgentAction (string)
. CanvaAgentAction (string)
. CreateAndUpdateCanvaAgentAction (string)
. ShareCanvaAgentAction (string)
. UseCanvaAgentAction (string)
. GithubAction (string)
. CreateAndUpdateGithubAction (string)
. ShareGithubAction (string)
. UseGithubAction (string)
. NotionAction (string)
. CreateAndUpdateNotionAction (string)
. ShareNotionAction (string)
. UseNotionAction (string)
. LinearAction (string)
. CreateAndUpdateLinearAction (string)
. ShareLinearAction (string)
. UseLinearAction (string)
. HuggingFaceAction (string)
. CreateAndUpdateHuggingFaceAction (string)
. ShareHuggingFaceAction (string)
. UseHuggingFaceAction (string)
. MondayAction (string)
. CreateAndUpdateMondayAction (string)
. ShareMondayAction (string)
. UseMondayAction (string)
. HubspotAction (string)
. CreateAndUpdateHubspotAction (string)
. ShareHubspotAction (string)
. UseHubspotAction (string)
. IntercomAction (string)
. CreateAndUpdateIntercomAction (string)
. ShareIntercomAction (string)
. UseIntercomAction (string)
. NewRelicAction (string)
. CreateAndUpdateNewRelicAction (string)
. ShareNewRelicAction (string)
. UseNewRelicAction (string)
. Space (string)
. ChatAgent (string)
. CreateChatAgents (string)
. Research (string)
. SelfUpgradeUserRole (string)
} (object)
quicksight/update_dashboardUpdates 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.AwsAccountId (string) required
DashboardId (string) required
Name (string) required
SourceEntity: {
. SourceTemplate (object)
} (object)
Parameters: {
. StringParameters (array)
. IntegerParameters (array)
. DecimalParameters (array)
. DateTimeParameters (array)
} (object)
VersionDescription (string)
DashboardPublishOptions: {
. AdHocFilteringOption (object)
. ExportToCSVOption (object)
. SheetControlsOption (object)
. VisualPublishOptions (object)
. SheetLayoutElementMaximizationOption (object)
. VisualMenuOption (object)
. VisualAxisSortOption (object)
. ExportWithHiddenFieldsOption (object)
. DataPointDrillUpDownOption (object)
. DataPointMenuLabelOption (object)
. DataPointTooltipOption (object)
. DataQAEnabledOption (object)
. QuickSuiteActionsOption (object)
. ExecutiveSummaryOption (object)
. DataStoriesSharingOption (object)
} (object)
ThemeArn (string)
Definition: {
. DataSetIdentifierDeclarations (array)
. Sheets (array)
. CalculatedFields (array)
. ParameterDeclarations (array)
. FilterGroups (array)
. ColumnConfigurations (array)
. AnalysisDefaults (object)
. Options (object)
. StaticFiles (array)
} (object)
ValidationStrategy: {
. Mode (string)
} (object)
quicksight/update_dashboard_linksUpdates the linked analyses on a dashboard.AwsAccountId (string) required
DashboardId (string) required
LinkEntities (array) required
quicksight/update_dashboard_permissionsUpdates read and write permissions on a dashboard.AwsAccountId (string) required
DashboardId (string) required
GrantPermissions (array)
RevokePermissions (array)
GrantLinkPermissions (array)
RevokeLinkPermissions (array)
quicksight/update_dashboard_published_versionUpdates the published version of a dashboard.AwsAccountId (string) required
DashboardId (string) required
VersionNumber (integer) required
quicksight/update_dashboards_qaconfigurationUpdates a Dashboard QA configuration.AwsAccountId (string) required
DashboardsQAStatus (string) required
quicksight/update_data_setUpdates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.AwsAccountId (string) required
DataSetId (string) required
Name (string) required
PhysicalTableMap (object) required
LogicalTableMap (object)
ImportMode (string) required
ColumnGroups (array)
FieldFolders (object)
RowLevelPermissionDataSet: {
. Namespace (string)
. Arn (string)
. PermissionPolicy (string)
. FormatVersion (string)
. Status (string)
} (object)
RowLevelPermissionTagConfiguration: {
. Status (string)
. TagRules (array)
. TagRuleConfigurations (array)
} (object)
ColumnLevelPermissionRules (array)
DataSetUsageConfiguration: {
. DisableUseAsDirectQuerySource (boolean)
. DisableUseAsImportedSource (boolean)
} (object)
DatasetParameters (array)
PerformanceConfiguration: {
. UniqueKeys (array)
} (object)
DataPrepConfiguration: {
. SourceTableMap (object)
. TransformStepMap (object)
. DestinationTableMap (object)
} (object)
SemanticModelConfiguration: {
. TableMap (object)
} (object)
quicksight/update_data_set_permissionsUpdates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.AwsAccountId (string) required
DataSetId (string) required
GrantPermissions (array)
RevokePermissions (array)
quicksight/update_data_sourceUpdates a data source.AwsAccountId (string) required
DataSourceId (string) required
Name (string) required
DataSourceParameters (undefined)
Credentials: {
. CredentialPair (object)
. CopySourceArn (string)
. SecretArn (string)
. KeyPairCredentials (object)
. WebProxyCredentials (object)
} (object)
VpcConnectionProperties: {
. VpcConnectionArn (string)
} (object)
SslProperties: {
. DisableSsl (boolean)
} (object)
quicksight/update_data_source_permissionsUpdates the permissions to a data source.AwsAccountId (string) required
DataSourceId (string) required
GrantPermissions (array)
RevokePermissions (array)
quicksight/update_default_qbusiness_applicationUpdates a Amazon Q Business application that is linked to a Quick Sight account.AwsAccountId (string) required
Namespace (string)
ApplicationId (string) required
quicksight/update_flow_permissionsUpdates permissions against principals on a flow.AwsAccountId (string) required
FlowId (string) required
GrantPermissions (array)
RevokePermissions (array)
quicksight/update_folderUpdates the name of a folder.AwsAccountId (string) required
FolderId (string) required
Name (string) required
quicksight/update_folder_permissionsUpdates permissions of a folder.AwsAccountId (string) required
FolderId (string) required
GrantPermissions (array)
RevokePermissions (array)
quicksight/update_groupChanges a group description.GroupName (string) required
Description (string)
AwsAccountId (string) required
Namespace (string) required
quicksight/update_iampolicy_assignmentUpdates 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.AwsAccountId (string) required
AssignmentName (string) required
Namespace (string) required
AssignmentStatus (string)
PolicyArn (string)
Identities (object)
quicksight/update_identity_propagation_configAdds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access. This operation is only supported for Quick Sight accounts using IAM Identity CenterAwsAccountId (string) required
Service (string) required
AuthorizedTargets (array)
quicksight/update_ip_restrictionUpdates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.AwsAccountId (string) required
IpRestrictionRuleMap (object)
VpcIdRestrictionRuleMap (object)
VpcEndpointIdRestrictionRuleMap (object)
Enabled (boolean)
quicksight/update_key_registrationUpdates a customer managed key in a Quick Sight account.AwsAccountId (string) required
KeyRegistration (array) required
quicksight/update_public_sharing_settingsThis API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing: Dashboards can be shared publicly This setting affects your entire Amazon Web Services account and all Quick Sight users Before proceeding: Ensure you understand the security implications and have proper IAM permissions configured. Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon Quick SightAwsAccountId (string) required
PublicSharingEnabled (boolean)
quicksight/update_qpersonalization_configurationUpdates a personalization configuration.AwsAccountId (string) required
PersonalizationMode (string) required
quicksight/update_quick_sight_qsearch_configurationUpdates the state of a Quick Sight Q Search configuration.AwsAccountId (string) required
QSearchStatus (string) required
quicksight/update_refresh_scheduleUpdates a refresh schedule for a dataset.DataSetId (string) required
AwsAccountId (string) required
Schedule: {
. ScheduleId (string)
. ScheduleFrequency (object)
. StartAfterDateTime (string)
. RefreshType (string)
. Arn (string)
} (object) required
quicksight/update_role_custom_permissionUpdates the custom permissions that are associated with a role.CustomPermissionsName (string) required
Role (string) required
AwsAccountId (string) required
Namespace (string) required
quicksight/update_self_upgradeUpdates a self-upgrade request for a Quick Suite user by approving, denying, or verifying the request.AwsAccountId (string) required
Namespace (string) required
UpgradeRequestId (string) required
Action (string) required
quicksight/update_self_upgrade_configurationUpdates the self-upgrade configuration for a Quick Suite account.AwsAccountId (string) required
Namespace (string) required
SelfUpgradeStatus (string) required
quicksight/update_spicecapacity_configurationUpdates the SPICE capacity configuration for a Quick Sight account.AwsAccountId (string) required
PurchaseMode (string) required
quicksight/update_templateUpdates a template from an existing Amazon Quick Sight analysis or another template.AwsAccountId (string) required
TemplateId (string) required
SourceEntity: {
. SourceAnalysis (object)
. SourceTemplate (object)
} (object)
VersionDescription (string)
Name (string)
Definition: {
. DataSetConfigurations (array)
. Sheets (array)
. CalculatedFields (array)
. ParameterDeclarations (array)
. FilterGroups (array)
. ColumnConfigurations (array)
. AnalysisDefaults (object)
. Options (object)
. QueryExecutionOptions (object)
. StaticFiles (array)
} (object)
ValidationStrategy: {
. Mode (string)
} (object)
quicksight/update_template_aliasUpdates the template alias of a template.AwsAccountId (string) required
TemplateId (string) required
AliasName (string) required
TemplateVersionNumber (integer) required
quicksight/update_template_permissionsUpdates the resource permissions for a template.AwsAccountId (string) required
TemplateId (string) required
GrantPermissions (array)
RevokePermissions (array)
quicksight/update_themeUpdates a theme.AwsAccountId (string) required
ThemeId (string) required
Name (string)
BaseThemeId (string) required
VersionDescription (string)
Configuration: {
. DataColorPalette (object)
. UIColorPalette (object)
. Sheet (object)
. Typography (object)
} (object)
quicksight/update_theme_aliasUpdates an alias of a theme.AwsAccountId (string) required
ThemeId (string) required
AliasName (string) required
ThemeVersionNumber (integer) required
quicksight/update_theme_permissionsUpdates 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' 'qAwsAccountId (string) required
ThemeId (string) required
GrantPermissions (array)
RevokePermissions (array)
quicksight/update_topicUpdates a topic.AwsAccountId (string) required
TopicId (string) required
Topic: {
. Name (string)
. Description (string)
. UserExperienceVersion (string)
. DataSets (array)
. ConfigOptions (object)
} (object) required
CustomInstructions: {
. CustomInstructionsString (string)
} (object)
quicksight/update_topic_permissionsUpdates the permissions of a topic.AwsAccountId (string) required
TopicId (string) required
GrantPermissions (array)
RevokePermissions (array)
quicksight/update_topic_refresh_scheduleUpdates a topic refresh schedule.AwsAccountId (string) required
TopicId (string) required
DatasetId (string) required
RefreshSchedule: {
. IsEnabled (boolean)
. BasedOnSpiceSchedule (boolean)
. StartingAt (string)
. Timezone (string)
. RepeatAt (string)
. TopicScheduleType (string)
} (object) required
quicksight/update_userUpdates an Amazon Quick Sight user.UserName (string) required
AwsAccountId (string) required
Namespace (string) required
Email (string) required
Role (string) required
CustomPermissionsName (string)
UnapplyCustomPermissions (boolean)
ExternalLoginFederationProviderType (string)
CustomFederationProviderUrl (string)
ExternalLoginId (string)
quicksight/update_user_custom_permissionUpdates a custom permissions profile for a user.UserName (string) required
AwsAccountId (string) required
Namespace (string) required
CustomPermissionsName (string) required
quicksight/update_vpcconnectionUpdates a VPC connection.AwsAccountId (string) required
VPCConnectionId (string) required
Name (string) required
SubnetIds (array) required
SecurityGroupIds (array) required
DnsResolvers (array)
RoleArn (string) required
ram/accept_resource_share_invitationAccepts 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.resourceShareInvitationArn (string) required
clientToken (string)
ram/associate_resource_shareAdds the specified list of principals, resources, and source constraints 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.resourceShareArn (string) required
resourceArns (array)
principals (array)
clientToken (string)
sources (array)
ram/associate_resource_share_permissionAdds 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.resourceShareArn (string) required
permissionArn (string) required
replace (boolean)
clientToken (string)
permissionVersion (integer)
ram/create_permissionCreates a customer managed permission for a specified resource type that you can attach to resource shares. It is created in the Amazon Web Services Region in which you call the operation.name (string) required
resourceType (string) required
policyTemplate (string) required
clientToken (string)
tags (array)
ram/create_permission_versionCreates a new version of the specified customer managed permission. The new version is automatically set as the default version of the customer managed permission. New resource shares automatically use the default permission. Existing resource shares continue to use their original permission versions, but you can use ReplacePermissionAssociations to update them. If the specified customer managed permission already has the maximum of 5 versions, then you must delete one of the existing versions bpermissionArn (string) required
policyTemplate (string) required
clientToken (string)
ram/create_resource_shareCreates 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, the permissions to grant those principals, and optionally source constraints to enhance security for service principal sharing. 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 applname (string) required
resourceArns (array)
principals (array)
tags (array)
allowExternalPrincipals (boolean)
clientToken (string)
permissionArns (array)
sources (array)
ram/delete_permissionDeletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation. You can delete a customer managed permission only if it isn't attached to any resource share. The operation deletes all versions associated with the customer managed permission.permissionArn (string) required
clientToken (string)
ram/delete_permission_versionDeletes one version of a customer managed permission. The version you specify must not be attached to any resource share and must not be the default version for the permission. If a customer managed permission has the maximum of 5 versions, then you must delete at least one version before you can create another.permissionArn (string) required
permissionVersion (integer) required
clientToken (string)
ram/delete_resource_shareDeletes 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 through this resource share.resourceShareArn (string) required
clientToken (string)
ram/disassociate_resource_shareRemoves the specified principals, resources, or source constraints from participating in the specified resource share.resourceShareArn (string) required
resourceArns (array)
principals (array)
clientToken (string)
sources (array)
ram/disassociate_resource_share_permissionRemoves a managed permission from a resource share. Permission changes take effect immediately. You can remove a managed permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.resourceShareArn (string) required
permissionArn (string) required
clientToken (string)
ram/enable_sharing_with_aws_organizationEnables resource sharing within your organization in Organizations. This operation creates a service-linked role called AWSServiceRoleForResourceAccessManager that has the IAM managed policy named AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in the calling account's organization by specifying the organization ID, or all of the accounts in an organiNo parameters
ram/get_permissionRetrieves the contents of a managed permission in JSON format.permissionArn (string) required
permissionVersion (integer)
ram/get_resource_policiesRetrieves the resource policies for the specified resources that you own and have shared. Always check the NextToken response parameter for a null value when calling a paginated 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.resourceArns (array) required
principal (string)
nextToken (string)
maxResults (integer)
ram/get_resource_share_associationsRetrieves the lists of resources and principals that associated for resource shares that you own. Always check the NextToken response parameter for a null value when calling a paginated 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.associationType (string) required
resourceShareArns (array)
resourceArn (string)
principal (string)
associationStatus (string)
nextToken (string)
maxResults (integer)
ram/get_resource_share_invitationsRetrieves details about invitations that you have received for resource shares. Always check the NextToken response parameter for a null value when calling a paginated 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.resourceShareInvitationArns (array)
resourceShareArns (array)
nextToken (string)
maxResults (integer)
ram/get_resource_sharesRetrieves details about the resource shares that you own or that are shared with you. Always check the NextToken response parameter for a null value when calling a paginated 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.resourceShareArns (array)
resourceShareStatus (string)
resourceOwner (string) required
name (string)
tagFilters (array)
nextToken (string)
maxResults (integer)
permissionArn (string)
permissionVersion (integer)
ram/list_pending_invitation_resourcesLists 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. Always check the NextToken response parameter for a null value when calling a paginated 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 resultsresourceShareInvitationArn (string) required
nextToken (string)
maxResults (integer)
resourceRegionScope (string)
ram/list_permission_associationsLists information about the managed permission and its associations to any resource shares that use this managed permission. This lets you see which resource shares use which versions of the specified managed permission. Always check the NextToken response parameter for a null value when calling a paginated 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 mpermissionArn (string)
permissionVersion (integer)
associationStatus (string)
resourceType (string)
featureSet (string)
defaultVersion (boolean)
nextToken (string)
maxResults (integer)
ram/list_permissionsRetrieves a list of available RAM permissions that you can use for the supported resource types. Always check the NextToken response parameter for a null value when calling a paginated 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.resourceType (string)
nextToken (string)
maxResults (integer)
permissionType (string)
ram/list_permission_versionsLists the available versions of the specified RAM permission. Always check the NextToken response parameter for a null value when calling a paginated 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.permissionArn (string) required
nextToken (string)
maxResults (integer)
ram/list_principalsLists the principals that you are sharing resources with or that are sharing resources with you. Always check the NextToken response parameter for a null value when calling a paginated 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.resourceOwner (string) required
resourceArn (string)
principals (array)
resourceType (string)
resourceShareArns (array)
nextToken (string)
maxResults (integer)
ram/list_replace_permission_associations_workRetrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation. Always check the NextToken response parameter for a null value when calling a paginated 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.workIds (array)
status (string)
nextToken (string)
maxResults (integer)
ram/list_resourcesLists the resources that you added to a resource share or the resources that are shared with you. Always check the NextToken response parameter for a null value when calling a paginated 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.resourceOwner (string) required
principal (string)
resourceType (string)
resourceArns (array)
resourceShareArns (array)
nextToken (string)
maxResults (integer)
resourceRegionScope (string)
ram/list_resource_share_permissionsLists the RAM permissions that are associated with a resource share. Always check the NextToken response parameter for a null value when calling a paginated 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.resourceShareArn (string) required
nextToken (string)
maxResults (integer)
ram/list_resource_typesLists the resource types that can be shared by RAM.nextToken (string)
maxResults (integer)
resourceRegionScope (string)
ram/list_source_associationsLists source associations for resource shares. Source associations control which sources can be used with service principals in resource shares. This operation provides visibility into source associations for resource share owners. You can filter the results by resource share Amazon Resource Name ARN, source ID, source type, or association status. We recommend using pagination to ensure that the operation returns quickly and successfully.resourceShareArns (array)
sourceId (string)
sourceType (string)
associationStatus (string)
nextToken (string)
maxResults (integer)
ram/promote_permission_created_from_policyWhen you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet=CREATED_FROM_POLICY with a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM. This operation creates a separate, fully manageable customer managed permission that has the same IAM permissions aspermissionArn (string) required
name (string) required
clientToken (string)
ram/promote_resource_share_created_from_policyWhen you attach a resource-based policy to a resource, RAM automatically creates a resource share of featureSet=CREATED_FROM_POLICY with a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM. This operation promotes the resource share to a STANDARD resource share that is fully manageable in RAM. When you proresourceShareArn (string) required
ram/reject_resource_share_invitationRejects an invitation to a resource share from another Amazon Web Services account.resourceShareInvitationArn (string) required
clientToken (string)
ram/replace_permission_associationsUpdates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target managed permission. You can optionally specify that the update applies to only resource shares that currently use a specified version. This enables you to update to the latest version, without changing the which managed permission is used. You can use this operation to update all of your resource shares to use the current default version offromPermissionArn (string) required
fromPermissionVersion (integer)
toPermissionArn (string) required
clientToken (string)
ram/set_default_permission_versionDesignates the specified version number as the default version for the specified customer managed permission. New resource shares automatically use this new default permission. Existing resource shares continue to use their original permission version, but you can use ReplacePermissionAssociations to update them.permissionArn (string) required
permissionVersion (integer) required
clientToken (string)
ram/tag_resourceAdds the specified tag keys and values to a resource share or managed permission. If you choose a resource share, the tags are attached to only the resource share, not to the resources that are in the resource share. The tags on a managed permission are the same for all versions of the managed permission.resourceShareArn (string)
tags (array) required
resourceArn (string)
ram/untag_resourceRemoves the specified tag key and value pairs from the specified resource share or managed permission.resourceShareArn (string)
tagKeys (array) required
resourceArn (string)
ram/update_resource_shareModifies some of the properties of the specified resource share.resourceShareArn (string) required
name (string)
allowExternalPrincipals (boolean)
clientToken (string)
rbin/create_ruleCreates a Recycle Bin retention rule. You can create two types of retention rules: Tag-level retention rules - These retention rules use resource tags to identify the resources to protect. For each retention rule, you specify one or more tag key and value pairs. Resources of the specified type that have at least one of these tag key and value pairs are automatically retained in the Recycle Bin upon deletion. Use this type of retention rule to protect specific resources in your account based on tRetentionPeriod: {
. RetentionPeriodValue (integer)
. RetentionPeriodUnit (string)
} (object) required
Description (string)
Tags (array)
ResourceType (string) required
ResourceTags (array)
LockConfiguration: {
. UnlockDelay (object)
} (object)
ExcludeResourceTags (array)
rbin/delete_ruleDeletes a Recycle Bin retention rule. For more information, see Delete Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.Identifier (string) required
rbin/get_ruleGets information about a Recycle Bin retention rule.Identifier (string) required
rbin/list_rulesLists the Recycle Bin retention rules in the Region.MaxResults (integer)
NextToken (string)
ResourceType (string) required
ResourceTags (array)
LockState (string)
ExcludeResourceTags (array)
rbin/list_tags_for_resourceLists the tags assigned to a retention rule.ResourceArn (string) required
rbin/lock_ruleLocks a Region-level retention rule. A locked retention rule can't be modified or deleted. You can't lock tag-level retention rules, or Region-level retention rules that have exclusion tags.Identifier (string) required
LockConfiguration: {
. UnlockDelay (object)
} (object) required
rbin/tag_resourceAssigns tags to the specified retention rule.ResourceArn (string) required
Tags (array) required
rbin/unlock_ruleUnlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires.Identifier (string) required
rbin/untag_resourceUnassigns a tag from a retention rule.ResourceArn (string) required
TagKeys (array) required
rbin/update_ruleUpdates an existing Recycle Bin retention rule. You can update a retention rule's description, resource tags, and retention period at any time after creation. You can't update a retention rule's resource type after creation. For more information, see Update Recycle Bin retention rules in the Amazon Elastic Compute Cloud User Guide.Identifier (string) required
RetentionPeriod: {
. RetentionPeriodValue (integer)
. RetentionPeriodUnit (string)
} (object)
Description (string)
ResourceType (string)
ResourceTags (array)
ExcludeResourceTags (array)
rds_data/batch_execute_statementRuns 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 seresourceArn (string) required
secretArn (string) required
sql (string) required
database (string)
schema (string)
parameterSets (array)
transactionId (string)
rds_data/begin_transactionStarts 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. For Aurora MySQL, DDL statements inside a transaction cause an implicit commit. We recommend that you run each MySQL DDL statement in a separate ExecuteStatement call with continueAfterTimeoutresourceArn (string) required
secretArn (string) required
database (string)
schema (string)
rds_data/commit_transactionEnds a SQL transaction started with the BeginTransaction operation and commits the changes.resourceArn (string) required
secretArn (string) required
transactionId (string) required
rds_data/execute_sqlRuns one or more SQL statements. This operation isn't supported for Aurora Serverless v2 and provisioned DB clusters. For Aurora Serverless v1 DB clusters, the operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.dbClusterOrInstanceArn (string) required
awsSecretStoreArn (string) required
sqlStatements (string) required
database (string)
schema (string)
rds_data/execute_statementRuns 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.resourceArn (string) required
secretArn (string) required
sql (string) required
database (string)
schema (string)
parameters (array)
transactionId (string)
includeResultMetadata (boolean)
continueAfterTimeout (boolean)
resultSetOptions: {
. decimalReturnType (string)
. longReturnType (string)
} (object)
formatRecordsAs (string)
rds_data/rollback_transactionPerforms a rollback of a transaction. Rolling back a transaction cancels its changes.resourceArn (string) required
secretArn (string) required
transactionId (string) required
rds/add_role_to_dbclusterAssociates an Identity and Access Management IAM role with a DB cluster.DBClusterIdentifier (string) required
RoleArn (string) required
FeatureName (string)
rds/add_role_to_dbinstanceAssociates 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.DBInstanceIdentifier (string) required
RoleArn (string) required
FeatureName (string) required
rds/add_source_identifier_to_subscriptionAdds a source identifier to an existing RDS event notification subscription.SubscriptionName (string) required
SourceIdentifier (string) required
rds/add_tags_to_resourceAdds 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 your relational database resources, see Tagging Amazon RDS Resources or Tagging Amazon Aurora and Amazon RDS Resources.ResourceName (string) required
Tags (array) required
rds/apply_pending_maintenance_actionApplies a pending maintenance action to a resource for example, to a DB instance.ResourceIdentifier (string) required
ApplyAction (string) required
OptInType (string) required
rds/authorize_dbsecurity_group_ingressEnables 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-VPDBSecurityGroupName (string) required
CIDRIP (string)
EC2SecurityGroupName (string)
EC2SecurityGroupId (string)
EC2SecurityGroupOwnerId (string)
rds/backtrack_dbclusterBacktracks 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.DBClusterIdentifier (string) required
BacktrackTo (string) required
Force (boolean)
UseEarliestTimeOnPointInTimeUnavailable (boolean)
rds/cancel_export_taskCancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.ExportTaskIdentifier (string) required
rds/copy_dbcluster_parameter_groupCopies the specified DB cluster parameter group. You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.SourceDBClusterParameterGroupIdentifier (string) required
TargetDBClusterParameterGroupIdentifier (string) required
TargetDBClusterParameterGroupDescription (string) required
Tags (array)
rds/copy_dbcluster_snapshotCopies 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. ToSourceDBClusterSnapshotIdentifier (string) required
TargetDBClusterSnapshotIdentifier (string) required
KmsKeyId (string)
PreSignedUrl (string)
CopyTags (boolean)
Tags (array)
rds/copy_dbparameter_groupCopies the specified DB parameter group. You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family.SourceDBParameterGroupIdentifier (string) required
TargetDBParameterGroupIdentifier (string) required
TargetDBParameterGroupDescription (string) required
Tags (array)
rds/copy_dbsnapshotCopies 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.SourceDBSnapshotIdentifier (string) required
TargetDBSnapshotIdentifier (string) required
KmsKeyId (string)
Tags (array)
CopyTags (boolean)
PreSignedUrl (string)
OptionGroupName (string)
TargetCustomAvailabilityZone (string)
SnapshotTarget (string)
CopyOptionGroup (boolean)
SnapshotAvailabilityZone (string)
rds/copy_option_groupCopies the specified option group.SourceOptionGroupIdentifier (string) required
TargetOptionGroupIdentifier (string) required
TargetOptionGroupDescription (string) required
Tags (array)
rds/create_blue_green_deploymentCreates a blue/green deployment. A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment, and it stays in sync with the current production environment. You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, chaBlueGreenDeploymentName (string) required
Source (string) required
TargetEngineVersion (string)
TargetDBParameterGroupName (string)
TargetDBClusterParameterGroupName (string)
Tags (array)
TargetDBInstanceClass (string)
UpgradeTargetStorageConfig (boolean)
TargetIops (integer)
TargetStorageType (string)
TargetAllocatedStorage (integer)
TargetStorageThroughput (integer)
rds/create_custom_dbengine_versionCreates a custom DB engine version CEV.Engine (string) required
EngineVersion (string) required
DatabaseInstallationFilesS3BucketName (string)
DatabaseInstallationFilesS3Prefix (string)
DatabaseInstallationFiles (array)
ImageId (string)
KMSKeyId (string)
SourceCustomDbEngineVersionIdentifier (string)
UseAwsProvidedLatestImage (boolean)
Description (string)
Manifest (string)
Tags (array)
rds/create_dbclusterCreates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of anoAvailabilityZones (array)
BackupRetentionPeriod (integer)
CharacterSetName (string)
DatabaseName (string)
DBClusterIdentifier (string) required
DBClusterParameterGroupName (string)
VpcSecurityGroupIds (array)
DBSubnetGroupName (string)
Engine (string) required
EngineVersion (string)
Port (integer)
MasterUsername (string)
MasterUserPassword (string)
OptionGroupName (string)
PreferredBackupWindow (string)
PreferredMaintenanceWindow (string)
ReplicationSourceIdentifier (string)
Tags (array)
StorageEncrypted (boolean)
KmsKeyId (string)
PreSignedUrl (string)
EnableIAMDatabaseAuthentication (boolean)
BacktrackWindow (integer)
EnableCloudwatchLogsExports (array)
EngineMode (string)
ScalingConfiguration: {
. MinCapacity (integer)
. MaxCapacity (integer)
. AutoPause (boolean)
. SecondsUntilAutoPause (integer)
. TimeoutAction (string)
. SecondsBeforeTimeout (integer)
} (object)
RdsCustomClusterConfiguration: {
. InterconnectSubnetId (string)
. TransitGatewayMulticastDomainId (string)
. ReplicaMode (string)
} (object)
DBClusterInstanceClass (string)
AllocatedStorage (integer)
StorageType (string)
Iops (integer)
PubliclyAccessible (boolean)
AutoMinorVersionUpgrade (boolean)
DeletionProtection (boolean)
GlobalClusterIdentifier (string)
EnableHttpEndpoint (boolean)
CopyTagsToSnapshot (boolean)
Domain (string)
DomainIAMRoleName (string)
EnableGlobalWriteForwarding (boolean)
NetworkType (string)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
. SecondsUntilAutoPause (integer)
} (object)
MonitoringInterval (integer)
MonitoringRoleArn (string)
DatabaseInsightsMode (string)
EnablePerformanceInsights (boolean)
PerformanceInsightsKMSKeyId (string)
PerformanceInsightsRetentionPeriod (integer)
EnableLimitlessDatabase (boolean)
ClusterScalabilityType (string)
DBSystemId (string)
ManageMasterUserPassword (boolean)
EnableLocalWriteForwarding (boolean)
MasterUserSecretKmsKeyId (string)
CACertificateIdentifier (string)
EngineLifecycleSupport (string)
TagSpecifications (array)
MasterUserAuthenticationType (string)
rds/create_dbcluster_endpointCreates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action applies only to Aurora DB clusters.DBClusterIdentifier (string) required
DBClusterEndpointIdentifier (string) required
EndpointType (string) required
StaticMembers (array)
ExcludedMembers (array)
Tags (array)
rds/create_dbcluster_parameter_groupCreates 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 clusterDBClusterParameterGroupName (string) required
DBParameterGroupFamily (string) required
Description (string) required
Tags (array)
rds/create_dbcluster_snapshotCreates 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 DB cluster deployments in the Amazon RDS User Guide.DBClusterSnapshotIdentifier (string) required
DBClusterIdentifier (string) required
Tags (array)
rds/create_dbinstanceCreates 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 ADBName (string)
DBInstanceIdentifier (string) required
AllocatedStorage (integer)
DBInstanceClass (string) required
Engine (string) required
MasterUsername (string)
MasterUserPassword (string)
DBSecurityGroups (array)
VpcSecurityGroupIds (array)
AvailabilityZone (string)
DBSubnetGroupName (string)
PreferredMaintenanceWindow (string)
DBParameterGroupName (string)
BackupRetentionPeriod (integer)
PreferredBackupWindow (string)
Port (integer)
MultiAZ (boolean)
EngineVersion (string)
AutoMinorVersionUpgrade (boolean)
LicenseModel (string)
Iops (integer)
StorageThroughput (integer)
OptionGroupName (string)
CharacterSetName (string)
NcharCharacterSetName (string)
PubliclyAccessible (boolean)
Tags (array)
DBClusterIdentifier (string)
StorageType (string)
TdeCredentialArn (string)
TdeCredentialPassword (string)
StorageEncrypted (boolean)
KmsKeyId (string)
Domain (string)
DomainFqdn (string)
DomainOu (string)
DomainAuthSecretArn (string)
DomainDnsIps (array)
CopyTagsToSnapshot (boolean)
MonitoringInterval (integer)
MonitoringRoleArn (string)
DomainIAMRoleName (string)
PromotionTier (integer)
Timezone (string)
EnableIAMDatabaseAuthentication (boolean)
DatabaseInsightsMode (string)
EnablePerformanceInsights (boolean)
PerformanceInsightsKMSKeyId (string)
PerformanceInsightsRetentionPeriod (integer)
EnableCloudwatchLogsExports (array)
ProcessorFeatures (array)
DeletionProtection (boolean)
MaxAllocatedStorage (integer)
EnableCustomerOwnedIp (boolean)
NetworkType (string)
BackupTarget (string)
CustomIamInstanceProfile (string)
DBSystemId (string)
CACertificateIdentifier (string)
ManageMasterUserPassword (boolean)
MasterUserSecretKmsKeyId (string)
MultiTenant (boolean)
DedicatedLogVolume (boolean)
EngineLifecycleSupport (string)
AdditionalStorageVolumes (array)
TagSpecifications (array)
MasterUserAuthenticationType (string)
rds/create_dbinstance_read_replicaCreates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the Amazon RDS User Guide. Amazon Aurora doesn't supporDBInstanceIdentifier (string) required
SourceDBInstanceIdentifier (string)
DBInstanceClass (string)
AvailabilityZone (string)
Port (integer)
MultiAZ (boolean)
AutoMinorVersionUpgrade (boolean)
Iops (integer)
StorageThroughput (integer)
OptionGroupName (string)
DBParameterGroupName (string)
PubliclyAccessible (boolean)
Tags (array)
DBSubnetGroupName (string)
VpcSecurityGroupIds (array)
StorageType (string)
CopyTagsToSnapshot (boolean)
MonitoringInterval (integer)
MonitoringRoleArn (string)
KmsKeyId (string)
PreSignedUrl (string)
EnableIAMDatabaseAuthentication (boolean)
DatabaseInsightsMode (string)
EnablePerformanceInsights (boolean)
PerformanceInsightsKMSKeyId (string)
PerformanceInsightsRetentionPeriod (integer)
EnableCloudwatchLogsExports (array)
ProcessorFeatures (array)
UseDefaultProcessorFeatures (boolean)
DeletionProtection (boolean)
Domain (string)
DomainIAMRoleName (string)
DomainFqdn (string)
DomainOu (string)
DomainAuthSecretArn (string)
DomainDnsIps (array)
ReplicaMode (string)
EnableCustomerOwnedIp (boolean)
NetworkType (string)
MaxAllocatedStorage (integer)
BackupTarget (string)
CustomIamInstanceProfile (string)
AllocatedStorage (integer)
SourceDBClusterIdentifier (string)
DedicatedLogVolume (boolean)
UpgradeStorageConfig (boolean)
CACertificateIdentifier (string)
AdditionalStorageVolumes (array)
TagSpecifications (array)
rds/create_dbparameter_groupCreates 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 wDBParameterGroupName (string) required
DBParameterGroupFamily (string) required
Description (string) required
Tags (array)
rds/create_dbproxyCreates a new DB proxy.DBProxyName (string) required
EngineFamily (string) required
DefaultAuthScheme (string)
Auth (array)
RoleArn (string) required
VpcSubnetIds (array) required
VpcSecurityGroupIds (array)
RequireTLS (boolean)
IdleClientTimeout (integer)
DebugLogging (boolean)
Tags (array)
EndpointNetworkType (string)
TargetConnectionNetworkType (string)
rds/create_dbproxy_endpointCreates 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.DBProxyName (string) required
DBProxyEndpointName (string) required
VpcSubnetIds (array) required
VpcSecurityGroupIds (array)
TargetRole (string)
Tags (array)
EndpointNetworkType (string)
rds/create_dbsecurity_groupCreates 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 instancDBSecurityGroupName (string) required
DBSecurityGroupDescription (string) required
Tags (array)
rds/create_dbshard_groupCreates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group. Valid for: Aurora DB clusters onlyDBShardGroupIdentifier (string) required
DBClusterIdentifier (string) required
ComputeRedundancy (integer)
MaxACU (number) required
MinACU (number)
PubliclyAccessible (boolean)
Tags (array)
rds/create_dbsnapshotCreates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.DBSnapshotIdentifier (string) required
DBInstanceIdentifier (string) required
Tags (array)
rds/create_dbsubnet_groupCreates 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.DBSubnetGroupName (string) required
DBSubnetGroupDescription (string) required
SubnetIds (array) required
Tags (array)
rds/create_event_subscriptionCreates 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 categoriSubscriptionName (string) required
SnsTopicArn (string) required
SourceType (string)
EventCategories (array)
SourceIds (array)
Enabled (boolean)
Tags (array)
rds/create_global_clusterCreates 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 create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora clusteGlobalClusterIdentifier (string) required
SourceDBClusterIdentifier (string)
Engine (string)
EngineVersion (string)
EngineLifecycleSupport (string)
DeletionProtection (boolean)
DatabaseName (string)
StorageEncrypted (boolean)
Tags (array)
rds/create_integrationCreates a zero-ETL integration with Amazon Redshift.SourceArn (string) required
TargetArn (string) required
IntegrationName (string) required
KMSKeyId (string)
AdditionalEncryptionContext (object)
Tags (array)
DataFilter (string)
Description (string)
rds/create_option_groupCreates a new option group. You can create up to 20 option groups. This command doesn't apply to RDS Custom.OptionGroupName (string) required
EngineName (string) required
MajorEngineVersion (string) required
OptionGroupDescription (string) required
Tags (array)
rds/create_tenant_databaseCreates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database CDB instances are supported.DBInstanceIdentifier (string) required
TenantDBName (string) required
MasterUsername (string) required
MasterUserPassword (string)
CharacterSetName (string)
NcharCharacterSetName (string)
ManageMasterUserPassword (boolean)
MasterUserSecretKmsKeyId (string)
Tags (array)
rds/delete_blue_green_deploymentDeletes a blue/green deployment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.BlueGreenDeploymentIdentifier (string) required
DeleteTarget (boolean)
rds/delete_custom_dbengine_versionDeletes 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 SerEngine (string) required
EngineVersion (string) required
rds/delete_dbclusterThe 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. If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User GuiDBClusterIdentifier (string) required
SkipFinalSnapshot (boolean)
FinalDBSnapshotIdentifier (string)
DeleteAutomatedBackups (boolean)
rds/delete_dbcluster_automated_backupDeletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name ARN of the automated backups.DbClusterResourceId (string) required
rds/delete_dbcluster_endpointDeletes a custom endpoint and removes it from an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.DBClusterEndpointIdentifier (string) required
rds/delete_dbcluster_parameter_groupDeletes 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 DB cluster deployments in the Amazon RDS User Guide.DBClusterParameterGroupName (string) required
rds/delete_dbcluster_snapshotDeletes 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 DB cluster deployments in the Amazon RDS User Guide.DBClusterSnapshotIdentifier (string) required
rds/delete_dbinstanceDeletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. However, manual DB snapshots of the DB instance aren't deleted. If you request a final DB snapshot, the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use DescribeDBInstance. When a DB instance is in a failurDBInstanceIdentifier (string) required
SkipFinalSnapshot (boolean)
FinalDBSnapshotIdentifier (string)
DeleteAutomatedBackups (boolean)
rds/delete_dbinstance_automated_backupDeletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name ARN of the automated backups.DbiResourceId (string)
DBInstanceAutomatedBackupsArn (string)
rds/delete_dbparameter_groupDeletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.DBParameterGroupName (string) required
rds/delete_dbproxyDeletes an existing DB proxy.DBProxyName (string) required
rds/delete_dbproxy_endpointDeletes 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.DBProxyEndpointName (string) required
rds/delete_dbsecurity_groupDeletes 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.DBSecurityGroupName (string) required
rds/delete_dbshard_groupDeletes an Aurora Limitless Database DB shard group.DBShardGroupIdentifier (string) required
rds/delete_dbsnapshotDeletes 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.DBSnapshotIdentifier (string) required
rds/delete_dbsubnet_groupDeletes a DB subnet group. The specified database subnet group must not be associated with any DB instances.DBSubnetGroupName (string) required
rds/delete_event_subscriptionDeletes an RDS event notification subscription.SubscriptionName (string) required
rds/delete_global_clusterDeletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first. This action only applies to Aurora DB clusters.GlobalClusterIdentifier (string) required
rds/delete_integrationDeletes a zero-ETL integration with Amazon Redshift.IntegrationIdentifier (string) required
rds/delete_option_groupDeletes an existing option group.OptionGroupName (string) required
rds/delete_tenant_databaseDeletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database CDB instances. You can't delete a tenant database when it is the only tenant in the DB instance.DBInstanceIdentifier (string) required
TenantDBName (string) required
SkipFinalSnapshot (boolean)
FinalDBSnapshotIdentifier (string)
rds/deregister_dbproxy_targetsRemove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.DBProxyName (string) required
TargetGroupName (string)
DBInstanceIdentifiers (array)
DBClusterIdentifiers (array)
rds/describe_account_attributesLists 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.No parameters
rds/describe_blue_green_deploymentsDescribes one or more blue/green deployments. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.BlueGreenDeploymentIdentifier (string)
Filters (array)
Marker (string)
MaxRecords (integer)
rds/describe_certificatesLists the set of certificate authority CA certificates provided by Amazon RDS for this Amazon Web Services account. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.CertificateIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_dbcluster_automated_backupsDisplays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the DescribeDBClusterAutomatedBackups and DescribeDBClusters operations. All parameters are optional.DbClusterResourceId (string)
DBClusterIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_dbcluster_backtracksReturns 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.DBClusterIdentifier (string) required
BacktrackIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_dbcluster_endpointsReturns information about endpoints for an Amazon Aurora DB cluster. This action only applies to Aurora DB clusters.DBClusterIdentifier (string)
DBClusterEndpointIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_dbcluster_parameter_groupsReturns 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 DB cluster deployments in the Amazon RDS User Guide.DBClusterParameterGroupName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_dbcluster_parametersReturns 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 DB cluster deployments in the Amazon RDS User Guide.DBClusterParameterGroupName (string) required
Source (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_dbclustersDescribes existing 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 DB cluster deployments in the Amazon RDS User Guide. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.DBClusterIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
IncludeShared (boolean)
rds/describe_dbcluster_snapshot_attributesReturns 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 bDBClusterSnapshotIdentifier (string) required
rds/describe_dbcluster_snapshotsReturns 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 DB cluster deployments in the Amazon RDS User Guide.DBClusterIdentifier (string)
DBClusterSnapshotIdentifier (string)
SnapshotType (string)
Filters (array)
MaxRecords (integer)
Marker (string)
IncludeShared (boolean)
IncludePublic (boolean)
DbClusterResourceId (string)
rds/describe_dbengine_versionsDescribes the properties of specific versions of DB engines.Engine (string)
EngineVersion (string)
DBParameterGroupFamily (string)
Filters (array)
MaxRecords (integer)
Marker (string)
DefaultOnly (boolean)
ListSupportedCharacterSets (boolean)
ListSupportedTimezones (boolean)
IncludeAll (boolean)
rds/describe_dbinstance_automated_backupsDisplays 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.DbiResourceId (string)
DBInstanceIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
DBInstanceAutomatedBackupsArn (string)
rds/describe_dbinstancesDescribes provisioned RDS instances. This API supports pagination. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.DBInstanceIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_dblog_filesReturns a list of DB log files for the DB instance. This command doesn't apply to RDS Custom.DBInstanceIdentifier (string) required
FilenameContains (string)
FileLastWritten (integer)
FileSize (integer)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_dbmajor_engine_versionsDescribes the properties of specific major versions of DB engines.Engine (string)
MajorEngineVersion (string)
Marker (string)
MaxRecords (integer)
rds/describe_dbparameter_groupsReturns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.DBParameterGroupName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_dbparametersReturns the detailed parameter list for a particular DB parameter group.DBParameterGroupName (string) required
Source (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_dbproxiesReturns information about DB proxies.DBProxyName (string)
Filters (array)
Marker (string)
MaxRecords (integer)
rds/describe_dbproxy_endpointsReturns information about DB proxy endpoints.DBProxyName (string)
DBProxyEndpointName (string)
Filters (array)
Marker (string)
MaxRecords (integer)
rds/describe_dbproxy_target_groupsReturns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.DBProxyName (string) required
TargetGroupName (string)
Filters (array)
Marker (string)
MaxRecords (integer)
rds/describe_dbproxy_targetsReturns information about DBProxyTarget objects. This API supports pagination.DBProxyName (string) required
TargetGroupName (string)
Filters (array)
Marker (string)
MaxRecords (integer)
rds/describe_dbrecommendationsDescribes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.LastUpdatedAfter (string)
LastUpdatedBefore (string)
Locale (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_dbsecurity_groupsReturns 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 notDBSecurityGroupName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_dbshard_groupsDescribes existing Aurora Limitless Database DB shard groups.DBShardGroupIdentifier (string)
Filters (array)
Marker (string)
MaxRecords (integer)
rds/describe_dbsnapshot_attributesReturns 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. ToDBSnapshotIdentifier (string) required
rds/describe_dbsnapshotsReturns information about DB snapshots. This API action supports pagination.DBInstanceIdentifier (string)
DBSnapshotIdentifier (string)
SnapshotType (string)
Filters (array)
MaxRecords (integer)
Marker (string)
IncludeShared (boolean)
IncludePublic (boolean)
DbiResourceId (string)
rds/describe_dbsnapshot_tenant_databasesDescribes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration. You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.DBInstanceIdentifier (string)
DBSnapshotIdentifier (string)
SnapshotType (string)
Filters (array)
MaxRecords (integer)
Marker (string)
DbiResourceId (string)
rds/describe_dbsubnet_groupsReturns 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.DBSubnetGroupName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_engine_default_cluster_parametersReturns 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.DBParameterGroupFamily (string) required
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_engine_default_parametersReturns the default engine and system parameter information for the specified database engine.DBParameterGroupFamily (string) required
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_event_categoriesDisplays 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 .SourceType (string)
Filters (array)
rds/describe_eventsReturns 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 AmazonSourceIdentifier (string)
SourceType (string)
StartTime (string)
EndTime (string)
Duration (integer)
EventCategories (array)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_event_subscriptionsLists 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.SubscriptionName (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_export_tasksReturns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.ExportTaskIdentifier (string)
SourceArn (string)
Filters (array)
Marker (string)
MaxRecords (integer)
SourceType (string)
rds/describe_global_clustersReturns 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.GlobalClusterIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_integrationsDescribe one or more zero-ETL integrations with Amazon Redshift.IntegrationIdentifier (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_option_group_optionsDescribes all available options for the specified engine.EngineName (string) required
MajorEngineVersion (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_option_groupsDescribes the available option groups.OptionGroupName (string)
Filters (array)
Marker (string)
MaxRecords (integer)
EngineName (string)
MajorEngineVersion (string)
rds/describe_orderable_dbinstance_optionsDescribes the orderable DB instance options for a specified DB engine.Engine (string) required
EngineVersion (string)
DBInstanceClass (string)
LicenseModel (string)
AvailabilityZoneGroup (string)
Vpc (boolean)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_pending_maintenance_actionsReturns a list of resources for example, DB instances that have at least one pending maintenance action. This API follows an eventual consistency model. This means that the result of the DescribePendingMaintenanceActions command might not be immediately visible to all subsequent RDS commands. Keep this in mind when you use DescribePendingMaintenanceActions immediately after using a previous API command such as ApplyPendingMaintenanceActions.ResourceIdentifier (string)
Filters (array)
Marker (string)
MaxRecords (integer)
rds/describe_reserved_dbinstancesReturns information about reserved DB instances for this account, or about a specified reserved DB instance.ReservedDBInstanceId (string)
ReservedDBInstancesOfferingId (string)
DBInstanceClass (string)
Duration (string)
ProductDescription (string)
OfferingType (string)
MultiAZ (boolean)
LeaseId (string)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_reserved_dbinstances_offeringsLists available reserved DB instance offerings.ReservedDBInstancesOfferingId (string)
DBInstanceClass (string)
Duration (string)
ProductDescription (string)
OfferingType (string)
MultiAZ (boolean)
Filters (array)
MaxRecords (integer)
Marker (string)
rds/describe_source_regionsReturns 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 informationRegionName (string)
MaxRecords (integer)
Marker (string)
Filters (array)
rds/describe_tenant_databasesDescribes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.DBInstanceIdentifier (string)
TenantDBName (string)
Filters (array)
Marker (string)
MaxRecords (integer)
rds/describe_valid_dbinstance_modificationsYou 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.DBInstanceIdentifier (string) required
rds/disable_http_endpointDisables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API. For more information, see Using RDS Data API in the Amazon Aurora User Guide. This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the EnableHttpEndpoint parameter of the ModifyDBCluster operation.ResourceArn (string) required
rds/download_dblog_file_portionDownloads all or a portion of the specified log file, up to 1 MB in size. This command doesn't apply to RDS Custom. This operation uses resources on database instances. Because of this, we recommend publishing database logs to CloudWatch and then using the GetLogEvents operation. For more information, see GetLogEvents in the Amazon CloudWatch Logs API Reference.DBInstanceIdentifier (string) required
LogFileName (string) required
Marker (string)
NumberOfLines (integer)
rds/enable_http_endpointEnables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled. When enabled, this endpoint provides a connectionless web service API RDS Data API for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS query editor. For more information, see Using RDS Data API in the Amazon Aurora User Guide. This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint fResourceArn (string) required
rds/failover_dbclusterForces 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, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby read-only instances in the DB cluster to be the primary DB instance the cluster writer. Failover timesDBClusterIdentifier (string) required
TargetDBInstanceIdentifier (string)
rds/failover_global_clusterPromotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called 'managed planned failovers.' Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead. How you uGlobalClusterIdentifier (string) required
TargetDbClusterIdentifier (string) required
AllowDataLoss (boolean)
Switchover (boolean)
rds/list_tags_for_resourceLists 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 or Tagging Amazon Aurora and Amazon RDS Resources in the Amazon Aurora User Guide.ResourceName (string) required
Filters (array)
rds/modify_activity_streamChanges 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 and MicrosoResourceArn (string)
AuditPolicyState (string)
rds/modify_certificatesOverride 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 theCertificateIdentifier (string)
RemoveCustomerOverride (boolean)
rds/modify_current_dbcluster_capacitySet 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 forDBClusterIdentifier (string) required
Capacity (integer)
SecondsBeforeTimeout (integer)
TimeoutAction (string)
rds/modify_custom_dbengine_versionModifies 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 servicEngine (string) required
EngineVersion (string) required
Description (string)
Status (string)
rds/modify_dbclusterModifies the settings of 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 DB cluster deployments in the Amazon RDS User Guide.DBClusterIdentifier (string) required
NewDBClusterIdentifier (string)
ApplyImmediately (boolean)
BackupRetentionPeriod (integer)
DBClusterParameterGroupName (string)
VpcSecurityGroupIds (array)
Port (integer)
MasterUserPassword (string)
OptionGroupName (string)
PreferredBackupWindow (string)
PreferredMaintenanceWindow (string)
EnableIAMDatabaseAuthentication (boolean)
BacktrackWindow (integer)
CloudwatchLogsExportConfiguration: {
. EnableLogTypes (array)
. DisableLogTypes (array)
} (object)
EngineVersion (string)
AllowMajorVersionUpgrade (boolean)
DBInstanceParameterGroupName (string)
Domain (string)
DomainIAMRoleName (string)
ScalingConfiguration: {
. MinCapacity (integer)
. MaxCapacity (integer)
. AutoPause (boolean)
. SecondsUntilAutoPause (integer)
. TimeoutAction (string)
. SecondsBeforeTimeout (integer)
} (object)
DeletionProtection (boolean)
EnableHttpEndpoint (boolean)
CopyTagsToSnapshot (boolean)
EnableGlobalWriteForwarding (boolean)
DBClusterInstanceClass (string)
AllocatedStorage (integer)
StorageType (string)
Iops (integer)
AutoMinorVersionUpgrade (boolean)
NetworkType (string)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
. SecondsUntilAutoPause (integer)
} (object)
MonitoringInterval (integer)
MonitoringRoleArn (string)
DatabaseInsightsMode (string)
EnablePerformanceInsights (boolean)
PerformanceInsightsKMSKeyId (string)
PerformanceInsightsRetentionPeriod (integer)
ManageMasterUserPassword (boolean)
RotateMasterUserPassword (boolean)
EnableLocalWriteForwarding (boolean)
MasterUserSecretKmsKeyId (string)
EngineMode (string)
AllowEngineModeChange (boolean)
AwsBackupRecoveryPointArn (string)
EnableLimitlessDatabase (boolean)
CACertificateIdentifier (string)
MasterUserAuthenticationType (string)
rds/modify_dbcluster_endpointModifies the properties of an endpoint in an Amazon Aurora DB cluster. This operation only applies to Aurora DB clusters.DBClusterEndpointIdentifier (string) required
EndpointType (string)
StaticMembers (array)
ExcludedMembers (array)
rds/modify_dbcluster_parameter_groupModifies 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. There are two types of parameters - dynamic parameters and static parameters. Changes to dynamic parameters are applied to the DB cluster immediately without a reboot. Changes to static parameters are applied only after the DB cluster is rebooted, which can be donDBClusterParameterGroupName (string) required
Parameters (array) required
rds/modify_dbcluster_snapshot_attributeAdds 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 WDBClusterSnapshotIdentifier (string) required
AttributeName (string) required
ValuesToAdd (array)
ValuesToRemove (array)
rds/modify_dbinstanceModifies 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.DBInstanceIdentifier (string) required
AllocatedStorage (integer)
DBInstanceClass (string)
DBSubnetGroupName (string)
DBSecurityGroups (array)
VpcSecurityGroupIds (array)
ApplyImmediately (boolean)
MasterUserPassword (string)
DBParameterGroupName (string)
BackupRetentionPeriod (integer)
PreferredBackupWindow (string)
PreferredMaintenanceWindow (string)
MultiAZ (boolean)
EngineVersion (string)
AllowMajorVersionUpgrade (boolean)
AutoMinorVersionUpgrade (boolean)
LicenseModel (string)
Iops (integer)
StorageThroughput (integer)
OptionGroupName (string)
NewDBInstanceIdentifier (string)
StorageType (string)
TdeCredentialArn (string)
TdeCredentialPassword (string)
CACertificateIdentifier (string)
Domain (string)
DomainFqdn (string)
DomainOu (string)
DomainAuthSecretArn (string)
DomainDnsIps (array)
DisableDomain (boolean)
CopyTagsToSnapshot (boolean)
MonitoringInterval (integer)
DBPortNumber (integer)
PubliclyAccessible (boolean)
MonitoringRoleArn (string)
DomainIAMRoleName (string)
PromotionTier (integer)
EnableIAMDatabaseAuthentication (boolean)
DatabaseInsightsMode (string)
EnablePerformanceInsights (boolean)
PerformanceInsightsKMSKeyId (string)
PerformanceInsightsRetentionPeriod (integer)
CloudwatchLogsExportConfiguration: {
. EnableLogTypes (array)
. DisableLogTypes (array)
} (object)
ProcessorFeatures (array)
UseDefaultProcessorFeatures (boolean)
DeletionProtection (boolean)
MaxAllocatedStorage (integer)
CertificateRotationRestart (boolean)
ReplicaMode (string)
AutomationMode (string)
ResumeFullAutomationModeMinutes (integer)
EnableCustomerOwnedIp (boolean)
NetworkType (string)
AwsBackupRecoveryPointArn (string)
ManageMasterUserPassword (boolean)
RotateMasterUserPassword (boolean)
MasterUserSecretKmsKeyId (string)
MultiTenant (boolean)
DedicatedLogVolume (boolean)
Engine (string)
AdditionalStorageVolumes (array)
TagSpecifications (array)
MasterUserAuthenticationType (string)
rds/modify_dbparameter_groupModifies 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 operation before the parameter group is uDBParameterGroupName (string) required
Parameters (array) required
rds/modify_dbproxyChanges the settings for an existing DB proxy.DBProxyName (string) required
NewDBProxyName (string)
DefaultAuthScheme (string)
Auth (array)
RequireTLS (boolean)
IdleClientTimeout (integer)
DebugLogging (boolean)
RoleArn (string)
SecurityGroups (array)
rds/modify_dbproxy_endpointChanges the settings for an existing DB proxy endpoint.DBProxyEndpointName (string) required
NewDBProxyEndpointName (string)
VpcSecurityGroupIds (array)
rds/modify_dbproxy_target_groupModifies the properties of a DBProxyTargetGroup.TargetGroupName (string) required
DBProxyName (string) required
ConnectionPoolConfig: {
. MaxConnectionsPercent (integer)
. MaxIdleConnectionsPercent (integer)
. ConnectionBorrowTimeout (integer)
. SessionPinningFilters (array)
. InitQuery (string)
} (object)
NewName (string)
rds/modify_dbrecommendationUpdates the recommendation status and recommended action status for the specified recommendation.RecommendationId (string) required
Locale (string)
Status (string)
RecommendedActionUpdates (array)
rds/modify_dbshard_groupModifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.DBShardGroupIdentifier (string) required
MaxACU (number)
MinACU (number)
ComputeRedundancy (integer)
rds/modify_dbsnapshotUpdates 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 MariaDB, MySQL, PostgreSQL, and Oracle. This operation doesn't apply to RDS Custom or RDS for Db2.DBSnapshotIdentifier (string) required
EngineVersion (string)
OptionGroupName (string)
rds/modify_dbsnapshot_attributeAdds 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 theDBSnapshotIdentifier (string) required
AttributeName (string) required
ValuesToAdd (array)
ValuesToRemove (array)
rds/modify_dbsubnet_groupModifies 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.DBSubnetGroupName (string) required
DBSubnetGroupDescription (string)
SubnetIds (array) required
rds/modify_event_subscriptionModifies 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.SubscriptionName (string) required
SnsTopicArn (string)
SourceType (string)
EventCategories (array)
Enabled (boolean)
rds/modify_global_clusterModifies a setting for an Amazon Aurora global database 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 operation only applies to Aurora global database clusters.GlobalClusterIdentifier (string) required
NewGlobalClusterIdentifier (string)
DeletionProtection (boolean)
EngineVersion (string)
AllowMajorVersionUpgrade (boolean)
rds/modify_integrationModifies a zero-ETL integration with Amazon Redshift.IntegrationIdentifier (string) required
IntegrationName (string)
DataFilter (string)
Description (string)
rds/modify_option_groupModifies an existing option group.OptionGroupName (string) required
OptionsToInclude (array)
OptionsToRemove (array)
ApplyImmediately (boolean)
rds/modify_tenant_databaseModifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only for RDS for Oracle CDB instances using the multi-tenant configuration.DBInstanceIdentifier (string) required
TenantDBName (string) required
MasterUserPassword (string)
NewTenantDBName (string)
ManageMasterUserPassword (boolean)
RotateMasterUserPassword (boolean)
MasterUserSecretKmsKeyId (string)
rds/promote_read_replicaPromotes 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 automatedDBInstanceIdentifier (string) required
BackupRetentionPeriod (integer)
PreferredBackupWindow (string)
TagSpecifications (array)
rds/promote_read_replica_dbclusterPromotes a read replica DB cluster to a standalone DB cluster.DBClusterIdentifier (string) required
rds/purchase_reserved_dbinstances_offeringPurchases a reserved DB instance offering.ReservedDBInstancesOfferingId (string) required
ReservedDBInstanceId (string)
DBInstanceCount (integer)
Tags (array)
rds/reboot_dbclusterYou 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 iDBClusterIdentifier (string) required
rds/reboot_dbinstanceYou 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 inDBInstanceIdentifier (string) required
ForceFailover (boolean)
rds/reboot_dbshard_groupYou might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for the changes to take effect. This operation applies only to Aurora Limitless Database DBb shard groups.DBShardGroupIdentifier (string) required
rds/register_dbproxy_targetsAssociate one or more DBProxyTarget data structures with a DBProxyTargetGroup.DBProxyName (string) required
TargetGroupName (string)
DBInstanceIdentifiers (array)
DBClusterIdentifiers (array)
rds/remove_from_global_clusterDetaches 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 operation only applies to Aurora DB clusters.GlobalClusterIdentifier (string) required
DbClusterIdentifier (string) required
rds/remove_role_from_dbclusterRemoves 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 DB cluster deployments in the Amazon RDS User Guide.DBClusterIdentifier (string) required
RoleArn (string) required
FeatureName (string)
rds/remove_role_from_dbinstanceDisassociates an Amazon Web Services Identity and Access Management IAM role from a DB instance.DBInstanceIdentifier (string) required
RoleArn (string) required
FeatureName (string) required
rds/remove_source_identifier_from_subscriptionRemoves a source identifier from an existing RDS event notification subscription.SubscriptionName (string) required
SourceIdentifier (string) required
rds/remove_tags_from_resourceRemoves 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 or Tagging Amazon Aurora and Amazon RDS Resources in the Amazon Aurora User Guide.ResourceName (string) required
TagKeys (array) required
rds/reset_dbcluster_parameter_groupModifies 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 musDBClusterParameterGroupName (string) required
ResetAllParameters (boolean)
Parameters (array)
rds/reset_dbparameter_groupModifies 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.DBParameterGroupName (string) required
ResetAllParameters (boolean)
Parameters (array)
rds/restore_dbcluster_from_s3Creates 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 operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster,AvailabilityZones (array)
BackupRetentionPeriod (integer)
CharacterSetName (string)
DatabaseName (string)
DBClusterIdentifier (string) required
DBClusterParameterGroupName (string)
VpcSecurityGroupIds (array)
DBSubnetGroupName (string)
Engine (string) required
EngineVersion (string)
Port (integer)
MasterUsername (string) required
MasterUserPassword (string)
OptionGroupName (string)
PreferredBackupWindow (string)
PreferredMaintenanceWindow (string)
Tags (array)
StorageEncrypted (boolean)
KmsKeyId (string)
EnableIAMDatabaseAuthentication (boolean)
SourceEngine (string) required
SourceEngineVersion (string) required
S3BucketName (string) required
S3Prefix (string)
S3IngestionRoleArn (string) required
BacktrackWindow (integer)
EnableCloudwatchLogsExports (array)
DeletionProtection (boolean)
CopyTagsToSnapshot (boolean)
Domain (string)
DomainIAMRoleName (string)
StorageType (string)
NetworkType (string)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
. SecondsUntilAutoPause (integer)
} (object)
ManageMasterUserPassword (boolean)
MasterUserSecretKmsKeyId (string)
EngineLifecycleSupport (string)
TagSpecifications (array)
rds/restore_dbcluster_from_snapshotCreates 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 operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB clusterAvailabilityZones (array)
DBClusterIdentifier (string) required
SnapshotIdentifier (string) required
Engine (string) required
EngineVersion (string)
Port (integer)
DBSubnetGroupName (string)
DatabaseName (string)
OptionGroupName (string)
VpcSecurityGroupIds (array)
Tags (array)
KmsKeyId (string)
EnableIAMDatabaseAuthentication (boolean)
BacktrackWindow (integer)
EnableCloudwatchLogsExports (array)
EngineMode (string)
ScalingConfiguration: {
. MinCapacity (integer)
. MaxCapacity (integer)
. AutoPause (boolean)
. SecondsUntilAutoPause (integer)
. TimeoutAction (string)
. SecondsBeforeTimeout (integer)
} (object)
DBClusterParameterGroupName (string)
DeletionProtection (boolean)
CopyTagsToSnapshot (boolean)
Domain (string)
DomainIAMRoleName (string)
DBClusterInstanceClass (string)
StorageType (string)
Iops (integer)
PubliclyAccessible (boolean)
NetworkType (string)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
. SecondsUntilAutoPause (integer)
} (object)
RdsCustomClusterConfiguration: {
. InterconnectSubnetId (string)
. TransitGatewayMulticastDomainId (string)
. ReplicaMode (string)
} (object)
MonitoringInterval (integer)
MonitoringRoleArn (string)
EnablePerformanceInsights (boolean)
PerformanceInsightsKMSKeyId (string)
PerformanceInsightsRetentionPeriod (integer)
BackupRetentionPeriod (integer)
PreferredBackupWindow (string)
EngineLifecycleSupport (string)
TagSpecifications (array)
rds/restore_dbcluster_to_point_in_timeRestores 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. Unless the RestoreType is set to copy-on-write, the restore may occur in a different Availability Zone AZ from the original DB cluster. The AZ whereDBClusterIdentifier (string) required
RestoreType (string)
SourceDBClusterIdentifier (string)
RestoreToTime (string)
UseLatestRestorableTime (boolean)
Port (integer)
DBSubnetGroupName (string)
OptionGroupName (string)
VpcSecurityGroupIds (array)
Tags (array)
KmsKeyId (string)
EnableIAMDatabaseAuthentication (boolean)
BacktrackWindow (integer)
EnableCloudwatchLogsExports (array)
DBClusterParameterGroupName (string)
DeletionProtection (boolean)
CopyTagsToSnapshot (boolean)
Domain (string)
DomainIAMRoleName (string)
DBClusterInstanceClass (string)
StorageType (string)
PubliclyAccessible (boolean)
Iops (integer)
NetworkType (string)
SourceDbClusterResourceId (string)
ServerlessV2ScalingConfiguration: {
. MinCapacity (number)
. MaxCapacity (number)
. SecondsUntilAutoPause (integer)
} (object)
ScalingConfiguration: {
. MinCapacity (integer)
. MaxCapacity (integer)
. AutoPause (boolean)
. SecondsUntilAutoPause (integer)
. TimeoutAction (string)
. SecondsBeforeTimeout (integer)
} (object)
EngineMode (string)
RdsCustomClusterConfiguration: {
. InterconnectSubnetId (string)
. TransitGatewayMulticastDomainId (string)
. ReplicaMode (string)
} (object)
MonitoringInterval (integer)
MonitoringRoleArn (string)
EnablePerformanceInsights (boolean)
PerformanceInsightsKMSKeyId (string)
PerformanceInsightsRetentionPeriod (integer)
BackupRetentionPeriod (integer)
PreferredBackupWindow (string)
EngineLifecycleSupport (string)
TagSpecifications (array)
rds/restore_dbinstance_from_dbsnapshotCreates 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 toDBInstanceIdentifier (string) required
DBSnapshotIdentifier (string)
DBInstanceClass (string)
Port (integer)
AvailabilityZone (string)
DBSubnetGroupName (string)
MultiAZ (boolean)
PubliclyAccessible (boolean)
AutoMinorVersionUpgrade (boolean)
LicenseModel (string)
DBName (string)
Engine (string)
Iops (integer)
StorageThroughput (integer)
OptionGroupName (string)
Tags (array)
StorageType (string)
TdeCredentialArn (string)
TdeCredentialPassword (string)
VpcSecurityGroupIds (array)
Domain (string)
DomainFqdn (string)
DomainOu (string)
DomainAuthSecretArn (string)
DomainDnsIps (array)
CopyTagsToSnapshot (boolean)
DomainIAMRoleName (string)
EnableIAMDatabaseAuthentication (boolean)
EnableCloudwatchLogsExports (array)
ProcessorFeatures (array)
UseDefaultProcessorFeatures (boolean)
DBParameterGroupName (string)
DeletionProtection (boolean)
EnableCustomerOwnedIp (boolean)
NetworkType (string)
BackupTarget (string)
CustomIamInstanceProfile (string)
AllocatedStorage (integer)
DBClusterSnapshotIdentifier (string)
BackupRetentionPeriod (integer)
PreferredBackupWindow (string)
DedicatedLogVolume (boolean)
CACertificateIdentifier (string)
EngineLifecycleSupport (string)
AdditionalStorageVolumes (array)
TagSpecifications (array)
ManageMasterUserPassword (boolean)
MasterUserSecretKmsKeyId (string)
rds/restore_dbinstance_from_s3Amazon 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 Restoring a backup into an Amazon RDS for MySQL DB instance in the Amazon RDS User Guide. This operation doesn't apply to RDS Custom.DBName (string)
DBInstanceIdentifier (string) required
AllocatedStorage (integer)
DBInstanceClass (string) required
Engine (string) required
MasterUsername (string)
MasterUserPassword (string)
DBSecurityGroups (array)
VpcSecurityGroupIds (array)
AvailabilityZone (string)
DBSubnetGroupName (string)
PreferredMaintenanceWindow (string)
DBParameterGroupName (string)
BackupRetentionPeriod (integer)
PreferredBackupWindow (string)
Port (integer)
MultiAZ (boolean)
EngineVersion (string)
AutoMinorVersionUpgrade (boolean)
LicenseModel (string)
Iops (integer)
StorageThroughput (integer)
OptionGroupName (string)
PubliclyAccessible (boolean)
Tags (array)
StorageType (string)
StorageEncrypted (boolean)
KmsKeyId (string)
CopyTagsToSnapshot (boolean)
MonitoringInterval (integer)
MonitoringRoleArn (string)
EnableIAMDatabaseAuthentication (boolean)
SourceEngine (string) required
SourceEngineVersion (string) required
S3BucketName (string) required
S3Prefix (string)
S3IngestionRoleArn (string) required
DatabaseInsightsMode (string)
EnablePerformanceInsights (boolean)
PerformanceInsightsKMSKeyId (string)
PerformanceInsightsRetentionPeriod (integer)
EnableCloudwatchLogsExports (array)
ProcessorFeatures (array)
UseDefaultProcessorFeatures (boolean)
DeletionProtection (boolean)
MaxAllocatedStorage (integer)
NetworkType (string)
ManageMasterUserPassword (boolean)
MasterUserSecretKmsKeyId (string)
DedicatedLogVolume (boolean)
CACertificateIdentifier (string)
EngineLifecycleSupport (string)
AdditionalStorageVolumes (array)
TagSpecifications (array)
rds/restore_dbinstance_to_point_in_timeRestores 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 instanceSourceDBInstanceIdentifier (string)
TargetDBInstanceIdentifier (string) required
RestoreTime (string)
UseLatestRestorableTime (boolean)
DBInstanceClass (string)
Port (integer)
AvailabilityZone (string)
DBSubnetGroupName (string)
MultiAZ (boolean)
PubliclyAccessible (boolean)
AutoMinorVersionUpgrade (boolean)
LicenseModel (string)
DBName (string)
Engine (string)
Iops (integer)
StorageThroughput (integer)
OptionGroupName (string)
CopyTagsToSnapshot (boolean)
Tags (array)
StorageType (string)
TdeCredentialArn (string)
TdeCredentialPassword (string)
VpcSecurityGroupIds (array)
Domain (string)
DomainIAMRoleName (string)
DomainFqdn (string)
DomainOu (string)
DomainAuthSecretArn (string)
DomainDnsIps (array)
EnableIAMDatabaseAuthentication (boolean)
EnableCloudwatchLogsExports (array)
ProcessorFeatures (array)
UseDefaultProcessorFeatures (boolean)
DBParameterGroupName (string)
DeletionProtection (boolean)
SourceDbiResourceId (string)
MaxAllocatedStorage (integer)
EnableCustomerOwnedIp (boolean)
NetworkType (string)
SourceDBInstanceAutomatedBackupsArn (string)
BackupTarget (string)
CustomIamInstanceProfile (string)
AllocatedStorage (integer)
BackupRetentionPeriod (integer)
PreferredBackupWindow (string)
DedicatedLogVolume (boolean)
CACertificateIdentifier (string)
EngineLifecycleSupport (string)
AdditionalStorageVolumes (array)
TagSpecifications (array)
ManageMasterUserPassword (boolean)
MasterUserSecretKmsKeyId (string)
rds/revoke_dbsecurity_group_ingressRevokes 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 GuiDBSecurityGroupName (string) required
CIDRIP (string)
EC2SecurityGroupName (string)
EC2SecurityGroupId (string)
EC2SecurityGroupOwnerId (string)
rds/start_activity_streamStarts a database activity stream to monitor activity on the database. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.ResourceArn (string) required
Mode (string) required
KmsKeyId (string) required
ApplyImmediately (boolean)
EngineNativeAuditFieldsIncluded (boolean)
rds/start_dbclusterStarts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster operation. For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide. This operation only applies to Aurora DB clusters.DBClusterIdentifier (string) required
rds/start_dbinstanceStarts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance operation. 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.DBInstanceIdentifier (string) required
rds/start_dbinstance_automated_backups_replicationEnables 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.SourceDBInstanceArn (string) required
BackupRetentionPeriod (integer)
KmsKeyId (string)
PreSignedUrl (string)
Tags (array)
rds/start_export_taskStarts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket. You can't export snapshot data from RDS Custom DB instances. For more information, see Supported Regions and DB engines for exporting snapshots to S3 in Amazon RDS. For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the Amazon RDS User Guide or Exporting DB cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide. ForExportTaskIdentifier (string) required
SourceArn (string) required
S3BucketName (string) required
IamRoleArn (string) required
KmsKeyId (string) required
S3Prefix (string)
ExportOnly (array)
rds/stop_activity_streamStops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream operation. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the Amazon Aurora User Guide or Monitoring Amazon RDS with Database Activity Streams in the Amazon RDS User Guide.ResourceArn (string) required
ApplyImmediately (boolean)
rds/stop_dbclusterStops 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 operation only applies to Aurora DB clusters.DBClusterIdentifier (string) required
rds/stop_dbinstanceStops an Amazon RDS DB instance temporarily. 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. The instance restarts automatically after 7 days. 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,DBInstanceIdentifier (string) required
DBSnapshotIdentifier (string)
rds/stop_dbinstance_automated_backups_replicationStops 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.SourceDBInstanceArn (string) required
rds/switchover_blue_green_deploymentSwitches over a blue/green deployment. Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.BlueGreenDeploymentIdentifier (string) required
SwitchoverTimeout (integer)
rds/switchover_global_clusterSwitches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called 'managed planned failovers.' Aurora promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary read-only cluster, maintaining the orginal replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primaGlobalClusterIdentifier (string) required
TargetDbClusterIdentifier (string) required
rds/switchover_read_replicaSwitches 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.DBInstanceIdentifier (string) required
redshift_data/batch_execute_statementRuns 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, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the databaseSqls (array) required
ClusterIdentifier (string)
SecretArn (string)
DbUser (string)
Database (string)
WithEvent (boolean)
StatementName (string)
WorkgroupName (string)
ClientToken (string)
ResultFormat (string)
SessionKeepAliveSeconds (integer)
SessionId (string)
redshift_data/cancel_statementCancels a running query. To be canceled, a query must be running. For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.Id (string) required
redshift_data/describe_statementDescribes 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. For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.Id (string) required
redshift_data/describe_tableDescribes 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, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When yClusterIdentifier (string)
SecretArn (string)
DbUser (string)
Database (string) required
ConnectedDatabase (string)
Schema (string)
Table (string)
NextToken (string)
MaxResults (integer)
WorkgroupName (string)
redshift_data/execute_statementRuns 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, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to aSql (string) required
ClusterIdentifier (string)
SecretArn (string)
DbUser (string)
Database (string)
WithEvent (boolean)
StatementName (string)
Parameters (array)
WorkgroupName (string)
ClientToken (string)
ResultFormat (string)
SessionKeepAliveSeconds (integer)
SessionId (string)
redshift_data/get_statement_resultFetches the temporarily cached result of an SQL statement in JSON format. The ExecuteStatement or BatchExecuteStatement operation that ran the SQL statement must have specified ResultFormat as JSON , or let the format default to JSON. A token is returned to page through the statement results. For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.Id (string) required
NextToken (string)
redshift_data/get_statement_result_v2Fetches the temporarily cached result of an SQL statement in CSV format. The ExecuteStatement or BatchExecuteStatement operation that ran the SQL statement must have specified ResultFormat as CSV. A token is returned to page through the statement results. For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.Id (string) required
NextToken (string)
redshift_data/list_databasesList 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, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provideClusterIdentifier (string)
Database (string) required
SecretArn (string)
DbUser (string)
NextToken (string)
MaxResults (integer)
WorkgroupName (string)
redshift_data/list_schemasLists 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, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide aClusterIdentifier (string)
SecretArn (string)
DbUser (string)
Database (string) required
ConnectedDatabase (string)
SchemaPattern (string)
NextToken (string)
MaxResults (integer)
WorkgroupName (string)
redshift_data/list_statementsList of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list. When you use identity-enhanced role sessions to list statements, you must provide either the cluster-identifier or workgroup-name parameter. This ensures that the IdC user can only access the Amazon Redshift IdC applications they are assigned. For more information, see Trusted identity propagation overview. For more information about the Amazon Redshift Data API and CLINextToken (string)
MaxResults (integer)
StatementName (string)
Status (string)
RoleLevel (boolean)
Database (string)
ClusterIdentifier (string)
WorkgroupName (string)
redshift_data/list_tablesList 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, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database youClusterIdentifier (string)
SecretArn (string)
DbUser (string)
Database (string) required
ConnectedDatabase (string)
SchemaPattern (string)
TablePattern (string)
NextToken (string)
MaxResults (integer)
WorkgroupName (string)
redshift_serverless/create_custom_domain_associationCreates a custom domain association for Amazon Redshift Serverless.workgroupName (string) required
customDomainName (string) required
customDomainCertificateArn (string) required
redshift_serverless/delete_custom_domain_associationDeletes a custom domain association for Amazon Redshift Serverless.workgroupName (string) required
customDomainName (string) required
redshift_serverless/delete_resource_policyDeletes the specified resource policy.resourceArn (string) required
redshift_serverless/get_credentialsReturns 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. 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. If the DbName parameter is specified, the IAM polidbName (string)
durationSeconds (integer)
workgroupName (string)
customDomainName (string)
redshift_serverless/get_custom_domain_associationGets information about a specific custom domain association.customDomainName (string) required
workgroupName (string) required
redshift_serverless/get_identity_center_auth_tokenReturns an Identity Center authentication token for accessing Amazon Redshift Serverless workgroups. The token provides secure access to data within the specified workgroups using Identity Center identity propagation. The token expires after a specified duration and must be refreshed for continued access. The Identity and Access Management IAM user or role that runs GetIdentityCenterAuthToken must have appropriate permissions to access the specified workgroups and Identity Center integration musworkgroupNames (array) required
redshift_serverless/get_resource_policyReturns a resource policy.resourceArn (string) required
redshift_serverless/get_trackGet the Redshift Serverless version for a specified track.trackName (string) required
redshift_serverless/list_custom_domain_associationsLists custom domain associations for Amazon Redshift Serverless.nextToken (string)
maxResults (integer)
customDomainName (string)
customDomainCertificateArn (string)
redshift_serverless/list_tags_for_resourceLists the tags assigned to a resource.resourceArn (string) required
redshift_serverless/list_tracksList the Amazon Redshift Serverless versions.nextToken (string)
maxResults (integer)
redshift_serverless/put_resource_policyCreates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.resourceArn (string) required
policy (string) required
redshift_serverless/tag_resourceAssigns one or more tags to a resource.resourceArn (string) required
tags (array) required
redshift_serverless/untag_resourceRemoves a tag or set of tags from a resource.resourceArn (string) required
tagKeys (array) required
redshift_serverless/update_custom_domain_associationUpdates an Amazon Redshift Serverless certificate associated with a custom domain.workgroupName (string) required
customDomainName (string) required
customDomainCertificateArn (string) required
redshift_serverless/create_endpoint_accessCreates an Amazon Redshift Serverless managed VPC endpoint.endpointName (string) required
subnetIds (array) required
workgroupName (string) required
vpcSecurityGroupIds (array)
ownerAccount (string)
redshift_serverless/delete_endpoint_accessDeletes an Amazon Redshift Serverless managed VPC endpoint.endpointName (string) required
redshift_serverless/get_endpoint_accessReturns information, such as the name, about a VPC endpoint.endpointName (string) required
redshift_serverless/list_endpoint_accessReturns an array of EndpointAccess objects and relevant information.nextToken (string)
maxResults (integer)
workgroupName (string)
vpcId (string)
ownerAccount (string)
redshift_serverless/update_endpoint_accessUpdates an Amazon Redshift Serverless managed endpoint.endpointName (string) required
vpcSecurityGroupIds (array)
redshift_serverless/list_managed_workgroupsReturns information about a list of specified managed workgroups in your account.sourceArn (string)
nextToken (string)
maxResults (integer)
redshift_serverless/update_lakehouse_configurationModifies the lakehouse configuration for a namespace. This operation allows you to manage Amazon Redshift federated permissions and Amazon Web Services IAM Identity Center trusted identity propagation.namespaceName (string) required
lakehouseRegistration (string)
catalogName (string)
lakehouseIdcRegistration (string)
lakehouseIdcApplicationArn (string)
dryRun (boolean)
redshift_serverless/get_namespaceReturns information about a namespace in Amazon Redshift Serverless.namespaceName (string) required
redshift_serverless/update_namespaceUpdates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request.namespaceName (string) required
adminUserPassword (string)
adminUsername (string)
kmsKeyId (string)
defaultIamRoleArn (string)
iamRoles (array)
logExports (array)
manageAdminPassword (boolean)
adminPasswordSecretKmsKeyId (string)
redshift_serverless/delete_namespaceDeletes 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.namespaceName (string) required
finalSnapshotName (string)
finalSnapshotRetentionPeriod (integer)
redshift_serverless/list_namespacesReturns information about a list of specified namespaces.nextToken (string)
maxResults (integer)
redshift_serverless/create_namespaceCreates a namespace in Amazon Redshift Serverless.namespaceName (string) required
adminUsername (string)
adminUserPassword (string)
dbName (string)
kmsKeyId (string)
defaultIamRoleArn (string)
iamRoles (array)
logExports (array)
tags (array)
manageAdminPassword (boolean)
adminPasswordSecretKmsKeyId (string)
redshiftIdcApplicationArn (string)
redshift_serverless/convert_recovery_point_to_snapshotConverts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.recoveryPointId (string) required
snapshotName (string) required
retentionPeriod (integer)
tags (array)
redshift_serverless/get_recovery_pointReturns information about a recovery point.recoveryPointId (string) required
redshift_serverless/list_recovery_pointsReturns an array of recovery points.nextToken (string)
maxResults (integer)
startTime (string)
endTime (string)
namespaceName (string)
namespaceArn (string)
redshift_serverless/restore_from_recovery_pointRestore the data from a recovery point.recoveryPointId (string) required
namespaceName (string) required
workgroupName (string) required
redshift_serverless/restore_table_from_recovery_pointRestores a table from a recovery point to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.namespaceName (string) required
workgroupName (string) required
recoveryPointId (string) required
sourceDatabaseName (string) required
sourceSchemaName (string)
sourceTableName (string) required
targetDatabaseName (string)
targetSchemaName (string)
newTableName (string) required
activateCaseSensitiveIdentifier (boolean)
redshift_serverless/create_reservationCreates an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units RPUs for a year at a discount from Serverless on-demand OD rates.capacity (integer) required
offeringId (string) required
clientToken (string)
redshift_serverless/get_reservationGets an Amazon Redshift Serverless reservation. A reservation gives you the option to commit to a specified number of Redshift Processing Units RPUs for a year at a discount from Serverless on-demand OD rates.reservationId (string) required
redshift_serverless/get_reservation_offeringReturns the reservation offering. The offering determines the payment schedule for the reservation.offeringId (string) required
redshift_serverless/list_reservation_offeringsReturns the current reservation offerings in your account.nextToken (string)
maxResults (integer)
redshift_serverless/list_reservationsReturns a list of Reservation objects.nextToken (string)
maxResults (integer)
redshift_serverless/create_scheduled_actionCreates 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 CreateSnapshot API operation.scheduledActionName (string) required
targetAction (undefined) required
schedule (undefined) required
roleArn (string) required
namespaceName (string) required
enabled (boolean)
scheduledActionDescription (string)
startTime (string)
endTime (string)
redshift_serverless/delete_scheduled_actionDeletes a scheduled action.scheduledActionName (string) required
redshift_serverless/get_scheduled_actionReturns information about a scheduled action.scheduledActionName (string) required
redshift_serverless/list_scheduled_actionsReturns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.nextToken (string)
maxResults (integer)
namespaceName (string)
redshift_serverless/update_scheduled_actionUpdates a scheduled action.scheduledActionName (string) required
targetAction (undefined)
schedule (undefined)
roleArn (string)
enabled (boolean)
scheduledActionDescription (string)
startTime (string)
endTime (string)
redshift_serverless/create_snapshotCreates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.namespaceName (string) required
snapshotName (string) required
retentionPeriod (integer)
tags (array)
redshift_serverless/create_snapshot_copy_configurationCreates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.namespaceName (string) required
destinationRegion (string) required
snapshotRetentionPeriod (integer)
destinationKmsKeyId (string)
redshift_serverless/delete_snapshotDeletes a snapshot from Amazon Redshift Serverless.snapshotName (string) required
redshift_serverless/delete_snapshot_copy_configurationDeletes a snapshot copy configurationsnapshotCopyConfigurationId (string) required
redshift_serverless/get_snapshotReturns information about a specific snapshot.snapshotName (string)
ownerAccount (string)
snapshotArn (string)
redshift_serverless/get_table_restore_statusReturns information about a TableRestoreStatus object.tableRestoreRequestId (string) required
redshift_serverless/list_snapshot_copy_configurationsReturns a list of snapshot copy configurations.namespaceName (string)
nextToken (string)
maxResults (integer)
redshift_serverless/list_snapshotsReturns a list of snapshots.nextToken (string)
maxResults (integer)
namespaceName (string)
namespaceArn (string)
ownerAccount (string)
startTime (string)
endTime (string)
redshift_serverless/list_table_restore_statusReturns information about an array of TableRestoreStatus objects.nextToken (string)
maxResults (integer)
namespaceName (string)
workgroupName (string)
redshift_serverless/restore_from_snapshotRestores a namespace from a snapshot.namespaceName (string) required
workgroupName (string) required
snapshotName (string)
snapshotArn (string)
ownerAccount (string)
manageAdminPassword (boolean)
adminPasswordSecretKmsKeyId (string)
redshift_serverless/restore_table_from_snapshotRestores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.namespaceName (string) required
workgroupName (string) required
snapshotName (string) required
sourceDatabaseName (string) required
sourceSchemaName (string)
sourceTableName (string) required
targetDatabaseName (string)
targetSchemaName (string)
newTableName (string) required
activateCaseSensitiveIdentifier (boolean)
redshift_serverless/update_snapshotUpdates a snapshot.snapshotName (string) required
retentionPeriod (integer)
redshift_serverless/update_snapshot_copy_configurationUpdates a snapshot copy configuration.snapshotCopyConfigurationId (string) required
snapshotRetentionPeriod (integer)
redshift_serverless/create_usage_limitCreates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.resourceArn (string) required
usageType (string) required
amount (integer) required
period (string)
breachAction (string)
redshift_serverless/delete_usage_limitDeletes a usage limit from Amazon Redshift Serverless.usageLimitId (string) required
redshift_serverless/get_usage_limitReturns information about a usage limit.usageLimitId (string) required
redshift_serverless/list_usage_limitsLists all usage limits within Amazon Redshift Serverless.resourceArn (string)
usageType (string)
nextToken (string)
maxResults (integer)
redshift_serverless/update_usage_limitUpdate a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.usageLimitId (string) required
amount (integer)
breachAction (string)
redshift_serverless/get_workgroupReturns information about a specific workgroup.workgroupName (string) required
redshift_serverless/update_workgroupUpdates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request. VPC Block Public Access BPA enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA turned oworkgroupName (string) required
baseCapacity (integer)
enhancedVpcRouting (boolean)
configParameters (array)
publiclyAccessible (boolean)
subnetIds (array)
securityGroupIds (array)
port (integer)
maxCapacity (integer)
ipAddressType (string)
pricePerformanceTarget: {
. status (string)
. level (integer)
} (object)
trackName (string)
extraComputeForAutomaticOptimization (boolean)
redshift_serverless/delete_workgroupDeletes a workgroup.workgroupName (string) required
redshift_serverless/list_workgroupsReturns information about a list of specified workgroups.nextToken (string)
maxResults (integer)
ownerAccount (string)
redshift_serverless/create_workgroupCreates an workgroup in Amazon Redshift Serverless. VPC Block Public Access BPA enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA turned on, the following capabilities are blocked: Creating a public access workgroup Modifying a private workgroup to public Adding a subnet with VPC BPA turned on to the workgroup when thworkgroupName (string) required
namespaceName (string) required
baseCapacity (integer)
enhancedVpcRouting (boolean)
configParameters (array)
securityGroupIds (array)
subnetIds (array)
publiclyAccessible (boolean)
tags (array)
port (integer)
maxCapacity (integer)
pricePerformanceTarget: {
. status (string)
. level (integer)
} (object)
ipAddressType (string)
trackName (string)
extraComputeForAutomaticOptimization (boolean)
redshift/accept_reserved_node_exchangeExchanges 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.ReservedNodeId (string) required
TargetReservedNodeOfferingId (string) required
redshift/add_partnerAdds 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.AccountId (string) required
ClusterIdentifier (string) required
DatabaseName (string) required
PartnerName (string) required
redshift/associate_data_share_consumerFrom 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.DataShareArn (string) required
AssociateEntireAccount (boolean)
ConsumerArn (string)
ConsumerRegion (string)
AllowWrites (boolean)
redshift/authorize_cluster_security_group_ingressAdds 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 EC2SecurClusterSecurityGroupName (string) required
CIDRIP (string)
EC2SecurityGroupName (string)
EC2SecurityGroupOwnerId (string)
redshift/authorize_data_shareFrom 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.DataShareArn (string) required
ConsumerIdentifier (string) required
AllowWrites (boolean)
redshift/authorize_endpoint_accessGrants access to a cluster.ClusterIdentifier (string)
Account (string) required
VpcIds (array)
redshift/authorize_snapshot_accessAuthorizes 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.SnapshotIdentifier (string)
SnapshotArn (string)
SnapshotClusterIdentifier (string)
AccountWithRestoreAccess (string) required
redshift/batch_delete_cluster_snapshotsDeletes a set of cluster snapshots.Identifiers (array) required
redshift/batch_modify_cluster_snapshotsModifies the settings for a set of cluster snapshots.SnapshotIdentifierList (array) required
ManualSnapshotRetentionPeriod (integer)
Force (boolean)
redshift/cancel_resizeCancels a resize operation for a cluster.ClusterIdentifier (string) required
redshift/copy_cluster_snapshotCopies 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 dSourceSnapshotIdentifier (string) required
SourceSnapshotClusterIdentifier (string)
TargetSnapshotIdentifier (string) required
ManualSnapshotRetentionPeriod (integer)
redshift/create_authentication_profileCreates an authentication profile with the specified parameters.AuthenticationProfileName (string) required
AuthenticationProfileContent (string) required
redshift/create_clusterCreates 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. VPC Block Public Access BPA enables you to block resources in VPCs and subnets that you own in a Region from reaDBName (string)
ClusterIdentifier (string) required
ClusterType (string)
NodeType (string) required
MasterUsername (string) required
MasterUserPassword (string)
ClusterSecurityGroups (array)
VpcSecurityGroupIds (array)
ClusterSubnetGroupName (string)
AvailabilityZone (string)
PreferredMaintenanceWindow (string)
ClusterParameterGroupName (string)
AutomatedSnapshotRetentionPeriod (integer)
ManualSnapshotRetentionPeriod (integer)
Port (integer)
ClusterVersion (string)
AllowVersionUpgrade (boolean)
NumberOfNodes (integer)
PubliclyAccessible (boolean)
Encrypted (boolean)
HsmClientCertificateIdentifier (string)
HsmConfigurationIdentifier (string)
ElasticIp (string)
Tags (array)
KmsKeyId (string)
EnhancedVpcRouting (boolean)
AdditionalInfo (string)
IamRoles (array)
MaintenanceTrackName (string)
SnapshotScheduleIdentifier (string)
AvailabilityZoneRelocation (boolean)
AquaConfigurationStatus (string)
DefaultIamRoleArn (string)
LoadSampleData (string)
ManageMasterPassword (boolean)
MasterPasswordSecretKmsKeyId (string)
IpAddressType (string)
MultiAZ (boolean)
RedshiftIdcApplicationArn (string)
CatalogName (string)
ExtraComputeForAutomaticOptimization (boolean)
redshift/create_cluster_parameter_groupCreates 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 RedshParameterGroupName (string) required
ParameterGroupFamily (string) required
Description (string) required
Tags (array)
redshift/create_cluster_security_groupCreates 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.ClusterSecurityGroupName (string) required
Description (string) required
Tags (array)
redshift/create_cluster_snapshotCreates 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.SnapshotIdentifier (string) required
ClusterIdentifier (string) required
ManualSnapshotRetentionPeriod (integer)
Tags (array)
redshift/create_cluster_subnet_groupCreates 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.ClusterSubnetGroupName (string) required
Description (string) required
SubnetIds (array) required
Tags (array)
redshift/create_custom_domain_associationUsed to create a custom domain name for a cluster. Properties include the custom domain name, the cluster the custom domain is associated with, and the certificate Amazon Resource Name ARN.CustomDomainName (string) required
CustomDomainCertificateArn (string) required
ClusterIdentifier (string) required
redshift/create_endpoint_accessCreates a Redshift-managed VPC endpoint.ClusterIdentifier (string)
ResourceOwner (string)
EndpointName (string) required
SubnetGroupName (string) required
VpcSecurityGroupIds (array)
redshift/create_event_subscriptionCreates 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 willSubscriptionName (string) required
SnsTopicArn (string) required
SourceType (string)
SourceIds (array)
EventCategories (array)
Severity (string)
Enabled (boolean)
Tags (array)
redshift/create_hsm_client_certificateCreates 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 tHsmClientCertificateIdentifier (string) required
Tags (array)
redshift/create_hsm_configurationCreates 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 RedshiHsmConfigurationIdentifier (string) required
Description (string) required
HsmIpAddress (string) required
HsmPartitionName (string) required
HsmPartitionPassword (string) required
HsmServerPublicCertificate (string) required
Tags (array)
redshift/create_integrationCreates a zero-ETL integration or S3 event integration with Amazon Redshift.SourceArn (string) required
TargetArn (string) required
IntegrationName (string) required
KMSKeyId (string)
TagList (array)
AdditionalEncryptionContext (object)
Description (string)
redshift/create_redshift_idc_applicationCreates an Amazon Redshift application for use with IAM Identity Center.IdcInstanceArn (string) required
RedshiftIdcApplicationName (string) required
IdentityNamespace (string)
IdcDisplayName (string) required
IamRoleArn (string) required
AuthorizedTokenIssuerList (array)
ServiceIntegrations (array)
ApplicationType (string)
Tags (array)
SsoTagKeys (array)
redshift/create_scheduled_actionCreates 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.ScheduledActionName (string) required
TargetAction: {
. ResizeCluster (object)
. PauseCluster (object)
. ResumeCluster (object)
} (object) required
Schedule (string) required
IamRole (string) required
ScheduledActionDescription (string)
StartTime (string)
EndTime (string)
Enable (boolean)
redshift/create_snapshot_copy_grantCreates 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.SnapshotCopyGrantName (string) required
KmsKeyId (string)
Tags (array)
redshift/create_snapshot_scheduleCreate a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.ScheduleDefinitions (array)
ScheduleIdentifier (string)
ScheduleDescription (string)
Tags (array)
DryRun (boolean)
NextInvocations (integer)
redshift/create_tagsAdds 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.ResourceName (string) required
Tags (array) required
redshift/create_usage_limitCreates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.ClusterIdentifier (string) required
FeatureType (string) required
LimitType (string) required
Amount (integer) required
Period (string)
BreachAction (string)
Tags (array)
redshift/deauthorize_data_shareFrom a datashare producer account, removes authorization from the specified datashare.DataShareArn (string) required
ConsumerIdentifier (string) required
redshift/delete_authentication_profileDeletes an authentication profile.AuthenticationProfileName (string) required
redshift/delete_clusterDeletes 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, seClusterIdentifier (string) required
SkipFinalClusterSnapshot (boolean)
FinalClusterSnapshotIdentifier (string)
FinalClusterSnapshotRetentionPeriod (integer)
redshift/delete_cluster_parameter_groupDeletes a specified Amazon Redshift parameter group. You cannot delete a parameter group if it is associated with a cluster.ParameterGroupName (string) required
redshift/delete_cluster_security_groupDeletes 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.ClusterSecurityGroupName (string) required
redshift/delete_cluster_snapshotDeletes 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.SnapshotIdentifier (string) required
SnapshotClusterIdentifier (string)
redshift/delete_cluster_subnet_groupDeletes the specified cluster subnet group.ClusterSubnetGroupName (string) required
redshift/delete_custom_domain_associationContains information about deleting a custom domain association for a cluster.ClusterIdentifier (string) required
CustomDomainName (string) required
redshift/delete_endpoint_accessDeletes a Redshift-managed VPC endpoint.EndpointName (string) required
redshift/delete_event_subscriptionDeletes an Amazon Redshift event notification subscription.SubscriptionName (string) required
redshift/delete_hsm_client_certificateDeletes the specified HSM client certificate.HsmClientCertificateIdentifier (string) required
redshift/delete_hsm_configurationDeletes the specified Amazon Redshift HSM configuration.HsmConfigurationIdentifier (string) required
redshift/delete_integrationDeletes a zero-ETL integration or S3 event integration with Amazon Redshift.IntegrationArn (string) required
redshift/delete_partnerDeletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.AccountId (string) required
ClusterIdentifier (string) required
DatabaseName (string) required
PartnerName (string) required
redshift/delete_redshift_idc_applicationDeletes an Amazon Redshift IAM Identity Center application.RedshiftIdcApplicationArn (string) required
redshift/delete_resource_policyDeletes the resource policy for a specified resource.ResourceArn (string) required
redshift/delete_scheduled_actionDeletes a scheduled action.ScheduledActionName (string) required
redshift/delete_snapshot_copy_grantDeletes the specified snapshot copy grant.SnapshotCopyGrantName (string) required
redshift/delete_snapshot_scheduleDeletes a snapshot schedule.ScheduleIdentifier (string) required
redshift/delete_tagsDeletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.ResourceName (string) required
TagKeys (array) required
redshift/delete_usage_limitDeletes a usage limit from a cluster.UsageLimitId (string) required
redshift/deregister_namespaceDeregisters a cluster or serverless namespace from the Amazon Web Services Glue Data Catalog.NamespaceIdentifier (undefined) required
ConsumerIdentifiers (array) required
redshift/describe_account_attributesReturns a list of attributes attached to an accountAttributeNames (array)
redshift/describe_authentication_profilesDescribes an authentication profile.AuthenticationProfileName (string)
redshift/describe_cluster_db_revisionsReturns an array of ClusterDbRevision objects.ClusterIdentifier (string)
MaxRecords (integer)
Marker (string)
redshift/describe_cluster_parameter_groupsReturns 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 specifyParameterGroupName (string)
MaxRecords (integer)
Marker (string)
TagKeys (array)
TagValues (array)
redshift/describe_cluster_parametersReturns 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 moreParameterGroupName (string) required
Source (string)
MaxRecords (integer)
Marker (string)
redshift/describe_clustersReturns 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 vaClusterIdentifier (string)
MaxRecords (integer)
Marker (string)
TagKeys (array)
TagValues (array)
redshift/describe_cluster_security_groupsReturns 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 exaClusterSecurityGroupName (string)
MaxRecords (integer)
Marker (string)
TagKeys (array)
TagValues (array)
redshift/describe_cluster_snapshotsReturns 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 hClusterIdentifier (string)
SnapshotIdentifier (string)
SnapshotArn (string)
SnapshotType (string)
StartTime (string)
EndTime (string)
MaxRecords (integer)
Marker (string)
OwnerAccount (string)
TagKeys (array)
TagValues (array)
ClusterExists (boolean)
SortingEntities (array)
redshift/describe_cluster_subnet_groupsReturns 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 valuClusterSubnetGroupName (string)
MaxRecords (integer)
Marker (string)
TagKeys (array)
TagValues (array)
redshift/describe_cluster_tracksReturns a list of all the available maintenance tracks.MaintenanceTrackName (string)
MaxRecords (integer)
Marker (string)
redshift/describe_cluster_versionsReturns 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.ClusterVersion (string)
ClusterParameterGroupFamily (string)
MaxRecords (integer)
Marker (string)
redshift/describe_custom_domain_associationsContains information about custom domain associations for a cluster.CustomDomainName (string)
CustomDomainCertificateArn (string)
MaxRecords (integer)
Marker (string)
redshift/describe_data_sharesShows the status of any inbound or outbound datashares available in the specified account.DataShareArn (string)
MaxRecords (integer)
Marker (string)
redshift/describe_data_shares_for_consumerReturns a list of datashares where the account identifier being called is a consumer account identifier.ConsumerArn (string)
Status (string)
MaxRecords (integer)
Marker (string)
redshift/describe_data_shares_for_producerReturns a list of datashares when the account identifier being called is a producer account identifier.ProducerArn (string)
Status (string)
MaxRecords (integer)
Marker (string)
redshift/describe_default_cluster_parametersReturns 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.ParameterGroupFamily (string) required
MaxRecords (integer)
Marker (string)
redshift/describe_endpoint_accessDescribes a Redshift-managed VPC endpoint.ClusterIdentifier (string)
ResourceOwner (string)
EndpointName (string)
VpcId (string)
MaxRecords (integer)
Marker (string)
redshift/describe_endpoint_authorizationDescribes an endpoint authorization.ClusterIdentifier (string)
Account (string)
Grantee (boolean)
MaxRecords (integer)
Marker (string)
redshift/describe_event_categoriesDisplays 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.SourceType (string)
redshift/describe_eventsReturns 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.SourceIdentifier (string)
SourceType (string)
StartTime (string)
EndTime (string)
Duration (integer)
MaxRecords (integer)
Marker (string)
redshift/describe_event_subscriptionsLists 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 cSubscriptionName (string)
MaxRecords (integer)
Marker (string)
TagKeys (array)
TagValues (array)
redshift/describe_hsm_client_certificatesReturns 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 thatHsmClientCertificateIdentifier (string)
MaxRecords (integer)
Marker (string)
TagKeys (array)
TagValues (array)
redshift/describe_hsm_configurationsReturns 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 hHsmConfigurationIdentifier (string)
MaxRecords (integer)
Marker (string)
TagKeys (array)
TagValues (array)
redshift/describe_inbound_integrationsReturns a list of inbound integrations.IntegrationArn (string)
TargetArn (string)
MaxRecords (integer)
Marker (string)
redshift/describe_integrationsDescribes one or more zero-ETL or S3 event integrations with Amazon Redshift.IntegrationArn (string)
MaxRecords (integer)
Marker (string)
Filters (array)
redshift/describe_logging_statusDescribes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.ClusterIdentifier (string) required
redshift/describe_node_configuration_optionsReturns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.ActionType (string) required
ClusterIdentifier (string)
SnapshotIdentifier (string)
SnapshotArn (string)
OwnerAccount (string)
Filters (array)
Marker (string)
MaxRecords (integer)
redshift/describe_orderable_cluster_optionsReturns 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 infoClusterVersion (string)
NodeType (string)
MaxRecords (integer)
Marker (string)
redshift/describe_partnersReturns information about the partner integrations defined for a cluster.AccountId (string) required
ClusterIdentifier (string) required
DatabaseName (string)
PartnerName (string)
redshift/describe_redshift_idc_applicationsLists the Amazon Redshift IAM Identity Center applications.RedshiftIdcApplicationArn (string)
MaxRecords (integer)
Marker (string)
redshift/describe_reserved_node_exchange_statusReturns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.ReservedNodeId (string)
ReservedNodeExchangeRequestId (string)
MaxRecords (integer)
Marker (string)
redshift/describe_reserved_node_offeringsReturns 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 offeReservedNodeOfferingId (string)
MaxRecords (integer)
Marker (string)
redshift/describe_reserved_nodesReturns the descriptions of the reserved nodes.ReservedNodeId (string)
MaxRecords (integer)
Marker (string)
redshift/describe_resizeReturns 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.ClusterIdentifier (string) required
redshift/describe_scheduled_actionsDescribes properties of scheduled actions.ScheduledActionName (string)
TargetActionType (string)
StartTime (string)
EndTime (string)
Active (boolean)
Filters (array)
Marker (string)
MaxRecords (integer)
redshift/describe_snapshot_copy_grantsReturns 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.SnapshotCopyGrantName (string)
MaxRecords (integer)
Marker (string)
TagKeys (array)
TagValues (array)
redshift/describe_snapshot_schedulesReturns a list of snapshot schedules.ClusterIdentifier (string)
ScheduleIdentifier (string)
TagKeys (array)
TagValues (array)
Marker (string)
MaxRecords (integer)
redshift/describe_storageReturns account level backups storage size and provisional storage.No parameters
redshift/describe_table_restore_statusLists 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.ClusterIdentifier (string)
TableRestoreRequestId (string)
MaxRecords (integer)
Marker (string)
redshift/describe_tagsReturns 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 specResourceName (string)
ResourceType (string)
MaxRecords (integer)
Marker (string)
TagKeys (array)
TagValues (array)
redshift/describe_usage_limitsShows 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 spUsageLimitId (string)
ClusterIdentifier (string)
FeatureType (string)
MaxRecords (integer)
Marker (string)
TagKeys (array)
TagValues (array)
redshift/disable_loggingStops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.ClusterIdentifier (string) required
redshift/disable_snapshot_copyDisables 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.ClusterIdentifier (string) required
redshift/disassociate_data_share_consumerFrom a datashare consumer account, remove association for the specified datashare.DataShareArn (string) required
DisassociateEntireAccount (boolean)
ConsumerArn (string)
ConsumerRegion (string)
redshift/enable_loggingStarts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.ClusterIdentifier (string) required
BucketName (string)
S3KeyPrefix (string)
LogDestinationType (string)
LogExports (array)
redshift/enable_snapshot_copyEnables the automatic copy of snapshots from one region to another region for a specified cluster.ClusterIdentifier (string) required
DestinationRegion (string) required
RetentionPeriod (integer)
SnapshotCopyGrantName (string)
ManualSnapshotRetentionPeriod (integer)
redshift/failover_primary_computeFails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.ClusterIdentifier (string) required
redshift/get_cluster_credentialsReturns 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 morDbUser (string) required
DbName (string)
ClusterIdentifier (string)
DurationSeconds (integer)
AutoCreate (boolean)
DbGroups (array)
CustomDomainName (string)
redshift/get_cluster_credentials_with_iamReturns 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 accessDbName (string)
ClusterIdentifier (string)
DurationSeconds (integer)
CustomDomainName (string)
redshift/get_identity_center_auth_tokenGenerates an encrypted authentication token that propagates the caller's Amazon Web Services IAM Identity Center identity to Amazon Redshift clusters. This API extracts the Amazon Web Services IAM Identity Center identity from enhanced credentials and creates a secure token that Amazon Redshift drivers can use for authentication. The token is encrypted using Key Management Service KMS and can only be decrypted by the specified Amazon Redshift clusters. The token contains the caller's Amazon WebClusterIds (array) required
redshift/get_reserved_node_exchange_configuration_optionsGets 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.ActionType (string) required
ClusterIdentifier (string)
SnapshotIdentifier (string)
MaxRecords (integer)
Marker (string)
redshift/get_reserved_node_exchange_offeringsReturns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.ReservedNodeId (string) required
MaxRecords (integer)
Marker (string)
redshift/get_resource_policyGet the resource policy for a specified resource.ResourceArn (string) required
redshift/list_recommendationsList the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.ClusterIdentifier (string)
NamespaceArn (string)
MaxRecords (integer)
Marker (string)
redshift/modify_aqua_configurationThis operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA Advanced Query Accelerator.ClusterIdentifier (string) required
AquaConfigurationStatus (string)
redshift/modify_authentication_profileModifies an authentication profile.AuthenticationProfileName (string) required
AuthenticationProfileContent (string) required
redshift/modify_clusterModifies 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 reClusterIdentifier (string) required
ClusterType (string)
NodeType (string)
NumberOfNodes (integer)
ClusterSecurityGroups (array)
VpcSecurityGroupIds (array)
MasterUserPassword (string)
ClusterParameterGroupName (string)
AutomatedSnapshotRetentionPeriod (integer)
ManualSnapshotRetentionPeriod (integer)
PreferredMaintenanceWindow (string)
ClusterVersion (string)
AllowVersionUpgrade (boolean)
HsmClientCertificateIdentifier (string)
HsmConfigurationIdentifier (string)
NewClusterIdentifier (string)
PubliclyAccessible (boolean)
ElasticIp (string)
EnhancedVpcRouting (boolean)
MaintenanceTrackName (string)
Encrypted (boolean)
KmsKeyId (string)
AvailabilityZoneRelocation (boolean)
AvailabilityZone (string)
Port (integer)
ManageMasterPassword (boolean)
MasterPasswordSecretKmsKeyId (string)
IpAddressType (string)
MultiAZ (boolean)
ExtraComputeForAutomaticOptimization (boolean)
redshift/modify_cluster_db_revisionModifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.ClusterIdentifier (string) required
RevisionTarget (string) required
redshift/modify_cluster_iam_rolesModifies 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.ClusterIdentifier (string) required
AddIamRoles (array)
RemoveIamRoles (array)
DefaultIamRoleArn (string)
redshift/modify_cluster_maintenanceModifies the maintenance settings of a cluster.ClusterIdentifier (string) required
DeferMaintenance (boolean)
DeferMaintenanceIdentifier (string)
DeferMaintenanceStartTime (string)
DeferMaintenanceEndTime (string)
DeferMaintenanceDuration (integer)
redshift/modify_cluster_parameter_groupModifies 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.ParameterGroupName (string) required
Parameters (array) required
redshift/modify_cluster_snapshotModifies the settings for a snapshot. This exanmple modifies the manual retention period setting for a cluster snapshot.SnapshotIdentifier (string) required
ManualSnapshotRetentionPeriod (integer)
Force (boolean)
redshift/modify_cluster_snapshot_scheduleModifies a snapshot schedule for a cluster.ClusterIdentifier (string) required
ScheduleIdentifier (string)
DisassociateSchedule (boolean)
redshift/modify_cluster_subnet_groupModifies 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. VPC Block Public Access BPA enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked: CClusterSubnetGroupName (string) required
Description (string)
SubnetIds (array) required
redshift/modify_custom_domain_associationContains information for changing a custom domain association.CustomDomainName (string) required
CustomDomainCertificateArn (string) required
ClusterIdentifier (string) required
redshift/modify_endpoint_accessModifies a Redshift-managed VPC endpoint.EndpointName (string) required
VpcSecurityGroupIds (array)
redshift/modify_event_subscriptionModifies an existing Amazon Redshift event notification subscription.SubscriptionName (string) required
SnsTopicArn (string)
SourceType (string)
SourceIds (array)
EventCategories (array)
Severity (string)
Enabled (boolean)
redshift/modify_integrationModifies a zero-ETL integration or S3 event integration with Amazon Redshift.IntegrationArn (string) required
Description (string)
IntegrationName (string)
redshift/modify_lakehouse_configurationModifies the lakehouse configuration for a cluster. This operation allows you to manage Amazon Redshift federated permissions and Amazon Web Services IAM Identity Center trusted identity propagation.ClusterIdentifier (string) required
LakehouseRegistration (string)
CatalogName (string)
LakehouseIdcRegistration (string)
LakehouseIdcApplicationArn (string)
DryRun (boolean)
redshift/modify_redshift_idc_applicationChanges an existing Amazon Redshift IAM Identity Center application.RedshiftIdcApplicationArn (string) required
IdentityNamespace (string)
IamRoleArn (string)
IdcDisplayName (string)
AuthorizedTokenIssuerList (array)
ServiceIntegrations (array)
redshift/modify_scheduled_actionModifies a scheduled action.ScheduledActionName (string) required
TargetAction: {
. ResizeCluster (object)
. PauseCluster (object)
. ResumeCluster (object)
} (object)
Schedule (string)
IamRole (string)
ScheduledActionDescription (string)
StartTime (string)
EndTime (string)
Enable (boolean)
redshift/modify_snapshot_copy_retention_periodModifies 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 newlyClusterIdentifier (string) required
RetentionPeriod (integer) required
Manual (boolean)
redshift/modify_snapshot_scheduleModifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.ScheduleIdentifier (string) required
ScheduleDefinitions (array) required
redshift/modify_usage_limitModifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.UsageLimitId (string) required
Amount (integer)
BreachAction (string)
redshift/pause_clusterPauses a cluster.ClusterIdentifier (string) required
redshift/purchase_reserved_node_offeringAllows 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.ReservedNodeOfferingId (string) required
NodeCount (integer)
redshift/put_resource_policyUpdates the resource policy for a specified resource.ResourceArn (string) required
Policy (string) required
redshift/reboot_clusterReboots 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.ClusterIdentifier (string) required
redshift/register_namespaceRegisters a cluster or serverless namespace to the Amazon Web Services Glue Data Catalog.NamespaceIdentifier (undefined) required
ConsumerIdentifiers (array) required
redshift/reject_data_shareFrom a datashare consumer account, rejects the specified datashare.DataShareArn (string) required
redshift/reset_cluster_parameter_groupSets 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.ParameterGroupName (string) required
ResetAllParameters (boolean)
Parameters (array)
redshift/resize_clusterChanges 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: dc2.large dc2.8xlarge ra3.large ra3.xlplus ra3.4xlarge ra3.16xlarge The type of nodes that yoClusterIdentifier (string) required
ClusterType (string)
NodeType (string)
NumberOfNodes (integer)
Classic (boolean)
ReservedNodeId (string)
TargetReservedNodeOfferingId (string)
redshift/restore_from_cluster_snapshotCreates 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 alsoClusterIdentifier (string) required
SnapshotIdentifier (string)
SnapshotArn (string)
SnapshotClusterIdentifier (string)
Port (integer)
AvailabilityZone (string)
AllowVersionUpgrade (boolean)
ClusterSubnetGroupName (string)
PubliclyAccessible (boolean)
OwnerAccount (string)
HsmClientCertificateIdentifier (string)
HsmConfigurationIdentifier (string)
ElasticIp (string)
ClusterParameterGroupName (string)
ClusterSecurityGroups (array)
VpcSecurityGroupIds (array)
PreferredMaintenanceWindow (string)
AutomatedSnapshotRetentionPeriod (integer)
ManualSnapshotRetentionPeriod (integer)
KmsKeyId (string)
NodeType (string)
EnhancedVpcRouting (boolean)
AdditionalInfo (string)
IamRoles (array)
MaintenanceTrackName (string)
SnapshotScheduleIdentifier (string)
NumberOfNodes (integer)
AvailabilityZoneRelocation (boolean)
AquaConfigurationStatus (string)
DefaultIamRoleArn (string)
ReservedNodeId (string)
TargetReservedNodeOfferingId (string)
Encrypted (boolean)
ManageMasterPassword (boolean)
MasterPasswordSecretKmsKeyId (string)
IpAddressType (string)
MultiAZ (boolean)
CatalogName (string)
RedshiftIdcApplicationArn (string)
redshift/restore_table_from_cluster_snapshotCreates 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 taClusterIdentifier (string) required
SnapshotIdentifier (string) required
SourceDatabaseName (string) required
SourceSchemaName (string)
SourceTableName (string) required
TargetDatabaseName (string)
TargetSchemaName (string)
NewTableName (string) required
EnableCaseSensitiveIdentifier (boolean)
redshift/resume_clusterResumes a paused cluster.ClusterIdentifier (string) required
redshift/revoke_cluster_security_group_ingressRevokes 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.ClusterSecurityGroupName (string) required
CIDRIP (string)
EC2SecurityGroupName (string)
EC2SecurityGroupOwnerId (string)
redshift/revoke_endpoint_accessRevokes access to a cluster.ClusterIdentifier (string)
Account (string)
VpcIds (array)
Force (boolean)
redshift/revoke_snapshot_accessRemoves 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.SnapshotIdentifier (string)
SnapshotArn (string)
SnapshotClusterIdentifier (string)
AccountWithRestoreAccess (string) required
redshift/rotate_encryption_keyRotates the encryption keys for a cluster.ClusterIdentifier (string) required
redshift/update_partner_statusUpdates the status of a partner integration.AccountId (string) required
ClusterIdentifier (string) required
DatabaseName (string) required
PartnerName (string) required
Status (string) required
StatusMessage (string)
rekognition/associate_facesAssociates one or more faces with an existing UserID. Takes an array of FaceIds. Each FaceId that are present in the FaceIds list is associated with the provided UserID. The number of FaceIds that can be used as input in a single request is limited to 100. Note that the total number of faces that can be associated with a single UserID is also limited to 100. Once a UserID has 100 faces associated with it, no additional faces can be added. If more API calls are made after the limit is reached, aCollectionId (string) required
UserId (string) required
FaceIds (array) required
UserMatchThreshold (number)
ClientRequestToken (string)
rekognition/compare_facesCompares 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 tSourceImage: {
. Bytes (string)
. S3Object (object)
} (object) required
TargetImage: {
. Bytes (string)
. S3Object (object)
} (object) required
SimilarityThreshold (number)
QualityFilter (string)
rekognition/copy_project_versionThis operation applies only to Amazon Rekognition Custom Labels. 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 projectSourceProjectArn (string) required
SourceProjectVersionArn (string) required
DestinationProjectArn (string) required
VersionName (string) required
OutputConfig: {
. S3Bucket (string)
. S3KeyPrefix (string)
} (object) required
Tags (object)
KmsKeyId (string)
rekognition/create_collectionCreates 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-CollectionId (string) required
Tags (object)
rekognition/create_datasetThis operation applies only to Amazon Rekognition Custom Labels. 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 ARNDatasetSource: {
. GroundTruthManifest (object)
. DatasetArn (string)
} (object)
DatasetType (string) required
ProjectArn (string) required
Tags (object)
rekognition/create_face_liveness_sessionThis API operation initiates a Face Liveness session. It returns a SessionId, which you can use to start streaming Face Liveness video and get the results for a Face Liveness session. You can use the OutputConfig option in the Settings parameter to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images. If no Amazon S3 bucket is defined, raw bytes are sent instead. You can use AuditImagesLimit to limit the number of audit images returned when GetFaceLKmsKeyId (string)
Settings: {
. OutputConfig (object)
. AuditImagesLimit (integer)
. ChallengePreferences (array)
} (object)
ClientRequestToken (string)
rekognition/create_projectCreates a new Amazon Rekognition project. A project is a group of resources datasets, model versions that you use to create and manage a Amazon Rekognition Custom Labels Model or custom adapter. You can specify a feature to create the project with, if no feature is specified then Custom Labels is used by default. For adapters, you can also choose whether or not to have the project auto update by using the AutoUpdate argument. This operation requires permissions to perform the rekognition:CreatePProjectName (string) required
Feature (string)
AutoUpdate (string)
Tags (object)
rekognition/create_project_versionCreates a new version of Amazon Rekognition project like a Custom Labels model or a custom adapter and begins training. Models and adapters are managed as part of a Rekognition project. The response from CreateProjectVersion is an Amazon Resource Name ARN for the project version. The FeatureConfig operation argument allows you to configure specific model or adapter settings. You can provide a description to the project version by using the VersionDescription argment. Training can take a while toProjectArn (string) required
VersionName (string) required
OutputConfig: {
. S3Bucket (string)
. S3KeyPrefix (string)
} (object) required
TrainingData: {
. Assets (array)
} (object)
TestingData: {
. Assets (array)
. AutoCreate (boolean)
} (object)
Tags (object)
KmsKeyId (string)
VersionDescription (string)
FeatureConfig: {
. ContentModeration (object)
} (object)
rekognition/create_stream_processorCreates 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 for receivInput: {
. KinesisVideoStream (object)
} (object) required
Output: {
. KinesisDataStream (object)
. S3Destination (object)
} (object) required
Name (string) required
Settings: {
. FaceSearch (object)
. ConnectedHome (object)
} (object) required
RoleArn (string) required
Tags (object)
NotificationChannel: {
. SNSTopicArn (string)
} (object)
KmsKeyId (string)
RegionsOfInterest (array)
DataSharingPreference: {
. OptIn (boolean)
} (object)
rekognition/create_userCreates a new User within a collection specified by CollectionId. Takes UserId as a parameter, which is a user provided ID which should be unique within the collection. The provided UserId will alias the system generated UUID to make the UserId more user friendly. Uses a ClientToken, an idempotency token that ensures a call to CreateUser completes only once. If the value is not supplied, the AWS SDK generates an idempotency token for the requests. This prevents retries after a network error resuCollectionId (string) required
UserId (string) required
ClientRequestToken (string)
rekognition/delete_collectionDeletes 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.CollectionId (string) required
rekognition/delete_datasetThis operation applies only to Amazon Rekognition Custom Labels. 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 StatDatasetArn (string) required
rekognition/delete_facesDeletes 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.CollectionId (string) required
FaceIds (array) required
rekognition/delete_projectDeletes a Amazon Rekognition project. To delete a project you must first delete all models or adapters associated with the project. To delete a model or adapter, 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 permProjectArn (string) required
rekognition/delete_project_policyThis operation applies only to Amazon Rekognition Custom Labels. 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. This operation requires permissions to perform the rekognition:DeleteProjectPolicy action.ProjectArn (string) required
PolicyName (string) required
PolicyRevisionId (string)
rekognition/delete_project_versionDeletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom adapter. You can't delete a project version if it is running or if it is training. To check the status of a project version, use the Status field returned from DescribeProjectVersions. To stop a project version call StopProjectVersion. If the project version is training, wait until it finishes. This operation requires permissions to perform the rekognition:DeleteProjectVersion actionProjectVersionArn (string) required
rekognition/delete_stream_processorDeletes 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.Name (string) required
rekognition/delete_userDeletes the specified UserID within the collection. Faces that are associated with the UserID are disassociated from the UserID before deleting the specified UserID. If the specified Collection or UserID is already deleted or not found, a ResourceNotFoundException will be thrown. If the action is successful with a 200 response, an empty HTTP body is returned.CollectionId (string) required
UserId (string) required
ClientRequestToken (string)
rekognition/describe_collectionDescribes 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.CollectionId (string) required
rekognition/describe_datasetThis operation applies only to Amazon Rekognition Custom Labels. 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.DatasetArn (string) required
rekognition/describe_projectsGets information about your Rekognition projects. This operation requires permissions to perform the rekognition:DescribeProjects action.NextToken (string)
MaxResults (integer)
ProjectNames (array)
Features (array)
rekognition/describe_project_versionsLists and describes the versions of an Amazon Rekognition project. You can specify up to 10 model or adapter versions in ProjectVersionArns. If you don't specify a value, descriptions for all model/adapter versions in the project are returned. This operation requires permissions to perform the rekognition:DescribeProjectVersions action.ProjectArn (string) required
VersionNames (array)
NextToken (string)
MaxResults (integer)
rekognition/describe_stream_processorProvides 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.Name (string) required
rekognition/detect_custom_labelsThis operation applies only to Amazon Rekognition Custom Labels. 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 oProjectVersionArn (string) required
Image: {
. Bytes (string)
. S3Object (object)
} (object) required
MaxResults (integer)
MinConfidence (number)
rekognition/detect_facesDetects 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, pose, presence of facial occlusion, and so on. The face-detection algorithm is most effective on frontal faces. For non-fImage: {
. Bytes (string)
. S3Object (object)
} (object) required
Attributes (array)
rekognition/detect_labelsDetects 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. 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 AmazonImage: {
. Bytes (string)
. S3Object (object)
} (object) required
MaxLabels (integer)
MinConfidence (number)
Features (array)
Settings: {
. GeneralLabels (object)
. ImageProperties (object)
} (object)
rekognition/detect_moderation_labelsDetects 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 theImage: {
. Bytes (string)
. S3Object (object)
} (object) required
MinConfidence (number)
HumanLoopConfig: {
. HumanLoopName (string)
. FlowDefinitionArn (string)
. DataAttributes (object)
} (object)
ProjectVersion (string)
rekognition/detect_protective_equipmentDetects 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,Image: {
. Bytes (string)
. S3Object (object)
} (object) required
SummarizationAttributes: {
. MinConfidence (number)
. RequiredEquipmentTypes (array)
} (object)
rekognition/detect_textDetects 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,Image: {
. Bytes (string)
. S3Object (object)
} (object) required
Filters: {
. WordFilter (object)
. RegionsOfInterest (array)
} (object)
rekognition/disassociate_facesRemoves the association between a Face supplied in an array of FaceIds and the User. If the User is not present already, then a ResourceNotFound exception is thrown. If successful, an array of faces that are disassociated from the User is returned. If a given face is already disassociated from the given UserID, it will be ignored and not be returned in the response. If a given face is already associated with a different User or not found in the collection it will be returned as part of UnsuccessCollectionId (string) required
UserId (string) required
ClientRequestToken (string)
FaceIds (array) required
rekognition/distribute_dataset_entriesThis operation applies only to Amazon Rekognition Custom Labels. 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 mustDatasets (array) required
rekognition/get_celebrity_infoGets 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.Id (string) required
rekognition/get_celebrity_recognitionGets 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 tJobId (string) required
MaxResults (integer)
NextToken (string)
SortBy (string)
rekognition/get_content_moderationGets 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 RekognitionJobId (string) required
MaxResults (integer)
NextToken (string)
SortBy (string)
AggregateBy (string)
rekognition/get_face_detectionGets 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 dJobId (string) required
MaxResults (integer)
NextToken (string)
rekognition/get_face_liveness_session_resultsRetrieves the results of a specific Face Liveness session. It requires the sessionId as input, which was created using CreateFaceLivenessSession. Returns the corresponding Face Liveness confidence score, a reference image that includes a face bounding box, and audit images that also contain face bounding boxes. The Face Liveness confidence score ranges from 0 to 100. The number of audit images returned by GetFaceLivenessSessionResults is defined by the AuditImagesLimit paramater when calling CreSessionId (string) required
rekognition/get_face_searchGets 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 times 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 AmaJobId (string) required
MaxResults (integer)
NextToken (string)
SortBy (string)
rekognition/get_label_detectionGets 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 valueJobId (string) required
MaxResults (integer)
NextToken (string)
SortBy (string)
AggregateBy (string)
rekognition/get_media_analysis_jobRetrieves the results for a given media analysis job. Takes a JobId returned by StartMediaAnalysisJob.JobId (string) required
rekognition/get_person_trackingEnd of support notice: On October 31, 2025, AWS will discontinue support for Amazon Rekognition People Pathing. After October 31, 2025, you will no longer be able to use the Rekognition People Pathing capability. For more information, visit this blog post. 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 finisJobId (string) required
MaxResults (integer)
NextToken (string)
SortBy (string)
rekognition/get_segment_detectionGets 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 resJobId (string) required
MaxResults (integer)
NextToken (string)
rekognition/get_text_detectionGets 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 detecJobId (string) required
MaxResults (integer)
NextToken (string)
rekognition/index_facesDetects 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 mCollectionId (string) required
Image: {
. Bytes (string)
. S3Object (object)
} (object) required
ExternalImageId (string)
DetectionAttributes (array)
MaxFaces (integer)
QualityFilter (string)
rekognition/list_collectionsReturns 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.NextToken (string)
MaxResults (integer)
rekognition/list_dataset_entriesThis operation applies only to Amazon Rekognition Custom Labels. 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 informaDatasetArn (string) required
ContainsLabels (array)
Labeled (boolean)
SourceRefContains (string)
HasErrors (boolean)
NextToken (string)
MaxResults (integer)
rekognition/list_dataset_labelsThis operation applies only to Amazon Rekognition Custom Labels. 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.DatasetArn (string) required
NextToken (string)
MaxResults (integer)
rekognition/list_facesReturns 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.CollectionId (string) required
NextToken (string)
MaxResults (integer)
UserId (string)
FaceIds (array)
rekognition/list_media_analysis_jobsReturns a list of media analysis jobs. Results are sorted by CreationTimestamp in descending order.NextToken (string)
MaxResults (integer)
rekognition/list_project_policiesThis operation applies only to Amazon Rekognition Custom Labels. 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. This operation requires permissions to perform the rekognition:ListProjectPolicies action.ProjectArn (string) required
NextToken (string)
MaxResults (integer)
rekognition/list_stream_processorsGets a list of stream processors that you have created with CreateStreamProcessor.NextToken (string)
MaxResults (integer)
rekognition/list_tags_for_resourceReturns 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.ResourceArn (string) required
rekognition/list_usersReturns metadata of the User such as UserID in the specified collection. Anonymous User to reserve faces without any identity is not returned as part of this request. The results are sorted by system generated primary key ID. If the response is truncated, NextToken is returned in the response that can be used in the subsequent request to retrieve the next set of identities.CollectionId (string) required
MaxResults (integer)
NextToken (string)
rekognition/put_project_policyThis operation applies only to Amazon Rekognition Custom Labels. 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. Only applies to Custom Labels projects. For more information about the format of a project policy document, see AttachingProjectArn (string) required
PolicyName (string) required
PolicyRevisionId (string)
PolicyDocument (string) required
rekognition/recognize_celebritiesReturns 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, RecognizeCelebritiImage: {
. Bytes (string)
. S3Object (object)
} (object) required
rekognition/search_facesFor 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 speCollectionId (string) required
FaceId (string) required
MaxFaces (integer)
FaceMatchThreshold (number)
rekognition/search_faces_by_imageFor 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 facCollectionId (string) required
Image: {
. Bytes (string)
. S3Object (object)
} (object) required
MaxFaces (integer)
FaceMatchThreshold (number)
QualityFilter (string)
rekognition/search_usersSearches for UserIDs within a collection based on a FaceId or UserId. This API can be used to find the closest UserID with a highest similarity to associate a face. The request must be provided with either FaceId or UserId. The operation returns an array of UserID that match the FaceId or UserId, ordered by similarity score with the highest similarity first.CollectionId (string) required
UserId (string)
FaceId (string)
UserMatchThreshold (number)
MaxUsers (integer)
rekognition/search_users_by_imageSearches for UserIDs using a supplied image. It first detects the largest face in the image, and then searches a specified collection for matching UserIDs. The operation returns an array of UserIDs that match the face in the supplied image, ordered by similarity score with the highest similarity first. It also returns a bounding box for the face found in the input image. Information about faces detected in the supplied image, but not used for the search, is returned in an array of UnsearchedFaceCollectionId (string) required
Image: {
. Bytes (string)
. S3Object (object)
} (object) required
UserMatchThreshold (number)
MaxUsers (integer)
QualityFilter (string)
rekognition/start_celebrity_recognitionStarts 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 youVideo: {
. S3Object (object)
} (object) required
ClientRequestToken (string)
NotificationChannel: {
. SNSTopicArn (string)
. RoleArn (string)
} (object)
JobTag (string)
rekognition/start_content_moderationStarts 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, AmazoVideo: {
. S3Object (object)
} (object) required
MinConfidence (number)
ClientRequestToken (string)
NotificationChannel: {
. SNSTopicArn (string)
. RoleArn (string)
} (object)
JobTag (string)
rekognition/start_face_detectionStarts 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 reVideo: {
. S3Object (object)
} (object) required
ClientRequestToken (string)
NotificationChannel: {
. SNSTopicArn (string)
. RoleArn (string)
} (object)
FaceAttributes (string)
JobTag (string)
rekognition/start_face_searchStarts 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 specifyVideo: {
. S3Object (object)
} (object) required
ClientRequestToken (string)
FaceMatchThreshold (number)
CollectionId (string) required
NotificationChannel: {
. SNSTopicArn (string)
. RoleArn (string)
} (object)
JobTag (string)
rekognition/start_label_detectionStarts 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. StaVideo: {
. S3Object (object)
} (object) required
ClientRequestToken (string)
MinConfidence (number)
NotificationChannel: {
. SNSTopicArn (string)
. RoleArn (string)
} (object)
JobTag (string)
Features (array)
Settings: {
. GeneralLabels (object)
} (object)
rekognition/start_media_analysis_jobInitiates a new media analysis job. Accepts a manifest file in an Amazon S3 bucket. The output is a manifest file and a summary of the manifest stored in the Amazon S3 bucket.ClientRequestToken (string)
JobName (string)
OperationsConfig: {
. DetectModerationLabels (object)
} (object) required
Input: {
. S3Object (object)
} (object) required
OutputConfig: {
. S3Bucket (string)
. S3KeyPrefix (string)
} (object) required
KmsKeyId (string)
rekognition/start_person_trackingEnd of support notice: On October 31, 2025, AWS will discontinue support for Amazon Rekognition People Pathing. After October 31, 2025, you will no longer be able to use the Rekognition People Pathing capability. For more information, visit this blog post. 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. StartPerVideo: {
. S3Object (object)
} (object) required
ClientRequestToken (string)
NotificationChannel: {
. SNSTopicArn (string)
. RoleArn (string)
} (object)
JobTag (string)
rekognition/start_project_versionThis operation applies only to Amazon Rekognition Custom Labels. 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. This operation requires permissions to perform the rekogniProjectVersionArn (string) required
MinInferenceUnits (integer) required
MaxInferenceUnits (integer)
rekognition/start_segment_detectionStarts 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 NotificationVideo: {
. S3Object (object)
} (object) required
ClientRequestToken (string)
NotificationChannel: {
. SNSTopicArn (string)
. RoleArn (string)
} (object)
JobTag (string)
Filters: {
. TechnicalCueFilter (object)
. ShotFilter (object)
} (object)
SegmentTypes (array) required
rekognition/start_stream_processorStarts 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.Name (string) required
StartSelector: {
. KVSStreamStartSelector (object)
} (object)
StopSelector: {
. MaxDurationInSeconds (integer)
} (object)
rekognition/start_text_detectionStarts 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 resVideo: {
. S3Object (object)
} (object) required
ClientRequestToken (string)
NotificationChannel: {
. SNSTopicArn (string)
. RoleArn (string)
} (object)
JobTag (string)
Filters: {
. WordFilter (object)
. RegionsOfInterest (array)
} (object)
rekognition/stop_project_versionThis operation applies only to Amazon Rekognition Custom Labels. Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions. Only applies to Custom Labels projects. This operation requires permissions to perform the rekognition:StopProjectVersion action.ProjectVersionArn (string) required
rekognition/stop_stream_processorStops a running stream processor that was created by CreateStreamProcessor.Name (string) required
rekognition/tag_resourceAdds 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.ResourceArn (string) required
Tags (object) required
rekognition/untag_resourceRemoves 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.ResourceArn (string) required
TagKeys (array) required
rekognition/update_dataset_entriesThis operation applies only to Amazon Rekognition Custom Labels. 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 exiDatasetArn (string) required
Changes: {
. GroundTruth (string)
} (object) required
rekognition/update_stream_processorAllows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters.Name (string) required
SettingsForUpdate: {
. ConnectedHomeForUpdate (object)
} (object)
RegionsOfInterestForUpdate (array)
DataSharingPreferenceForUpdate: {
. OptIn (boolean)
} (object)
ParametersToDelete (array)
rekognitionstreaming/start_face_liveness_sessionStarts a Face Liveness video stream and liveness detection process for a given session. Requires sessionId, ChallengeVersions, VideoWidth, VideoHeight and a RequestEventStream as input. The event stream contains information about different events for the session, including the challenge information used for verification. The maximum video size for Face Liveness is 10 MB. Face Liveness throws a ValidationException if the video does not match the necessary formatting and size parameters.SessionId (string) required
VideoWidth (string) required
VideoHeight (string) required
ChallengeVersions (string) required
LivenessRequestStream (undefined)
repostspace/batch_add_channel_role_to_accessorsAdd role to multiple users or groups in a private re:Post channel.spaceId (string) required
channelId (string) required
accessorIds (array) required
channelRole (string) required
repostspace/batch_add_roleAdd a role to multiple users or groups in a private re:Post.spaceId (string) required
accessorIds (array) required
role (string) required
repostspace/batch_remove_channel_role_from_accessorsRemove a role from multiple users or groups in a private re:Post channel.spaceId (string) required
channelId (string) required
accessorIds (array) required
channelRole (string) required
repostspace/batch_remove_roleRemove a role from multiple users or groups in a private re:Post.spaceId (string) required
accessorIds (array) required
role (string) required
repostspace/create_channelCreates a channel in an AWS re:Post Private private re:Post.spaceId (string) required
channelName (string) required
channelDescription (string)
repostspace/create_spaceCreates an AWS re:Post Private private re:Post.name (string) required
subdomain (string) required
tier (string) required
description (string)
userKMSKey (string)
tags (object)
roleArn (string)
supportedEmailDomains: {
. enabled (string)
. allowedDomains (array)
} (object)
repostspace/delete_spaceDeletes an AWS re:Post Private private re:Post.spaceId (string) required
repostspace/deregister_adminRemoves the user or group from the list of administrators of the private re:Post.spaceId (string) required
adminId (string) required
repostspace/get_channelDisplays information about a channel in a private re:Post.spaceId (string) required
channelId (string) required
repostspace/get_spaceDisplays information about the AWS re:Post Private private re:Post.spaceId (string) required
repostspace/list_channelsReturns the list of channel within a private re:Post with some information about each channel.spaceId (string) required
nextToken (string)
maxResults (integer)
repostspace/list_spacesReturns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.nextToken (string)
maxResults (integer)
repostspace/list_tags_for_resourceReturns the tags that are associated with the AWS re:Post Private resource specified by the resourceArn. The only resource that can be tagged is a private re:Post.resourceArn (string) required
repostspace/register_adminAdds a user or group to the list of administrators of the private re:Post.spaceId (string) required
adminId (string) required
repostspace/send_invitesSends an invitation email to selected users and groups.spaceId (string) required
accessorIds (array) required
title (string) required
body (string) required
repostspace/tag_resourceAssociates tags with an AWS re:Post Private resource. Currently, the only resource that can be tagged is the private re:Post. If you specify a new tag key for the resource, the tag is appended to the list of tags that are 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.resourceArn (string) required
tags (object) required
repostspace/untag_resourceRemoves the association of the tag with the AWS re:Post Private resource.resourceArn (string) required
tagKeys (array) required
repostspace/update_channelModifies an existing channel.spaceId (string) required
channelId (string) required
channelName (string) required
channelDescription (string)
repostspace/update_spaceModifies an existing AWS re:Post Private private re:Post.spaceId (string) required
description (string)
tier (string)
roleArn (string)
supportedEmailDomains: {
. enabled (string)
. allowedDomains (array)
} (object)
resiliencehub/accept_resource_grouping_recommendationsAccepts the resource grouping recommendations suggested by Resilience Hub for your application.appArn (string) required
entries (array) required
resiliencehub/add_draft_app_version_resource_mappingsAdds the source of resource-maps to the draft version of an application. During assessment, Resilience Hub will use these resource-maps to resolve the latest physical ID for each resource in the application template. For more information about different types of resources supported by Resilience Hub and how to add them in your application, see Step 2: How is your application managed? in the Resilience Hub User Guide.appArn (string) required
resourceMappings (array) required
resiliencehub/batch_update_recommendation_statusEnables you to include or exclude one or more operational recommendations.appArn (string) required
requestEntries (array) required
resiliencehub/create_appCreates an Resilience Hub application. An 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 CloudFormation stacks, Resource Groups, Terraform state files, AppRegistry applications, and an appropriate resiliency policy. In addition, you can also add resources that are located on Amazon Elasticname (string) required
description (string)
policyArn (string)
tags (object)
clientToken (string)
assessmentSchedule (string)
permissionModel: {
. type (string)
. invokerRoleName (string)
. crossAccountRoleArns (array)
} (object)
eventSubscriptions (array)
awsApplicationArn (string)
resiliencehub/create_app_version_app_componentCreates a new Application Component in the Resilience Hub application. This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.appArn (string) required
id (string)
name (string) required
type (string) required
additionalInfo (object)
clientToken (string)
resiliencehub/create_app_version_resourceAdds a resource to the Resilience Hub application and assigns it to the specified Application Components. If you specify a new Application Component, Resilience Hub will automatically create the Application Component. This action has no effect outside Resilience Hub. This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API. To update application version wappArn (string) required
resourceName (string)
logicalResourceId: {
. identifier (string)
. logicalStackName (string)
. resourceGroupName (string)
. terraformSourceName (string)
. eksSourceName (string)
} (object) required
physicalResourceId (string) required
awsRegion (string)
awsAccountId (string)
resourceType (string) required
appComponents (array) required
additionalInfo (object)
clientToken (string)
resiliencehub/create_recommendation_templateCreates a new recommendation template for the Resilience Hub application.recommendationIds (array)
format (string)
recommendationTypes (array)
assessmentArn (string) required
name (string) required
clientToken (string)
tags (object)
bucketName (string)
resiliencehub/create_resiliency_policyCreates a resiliency policy for an application. Resilience Hub allows you to provide a value of zero for rtoInSecs and rpoInSecs of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for rtoInSecs and rpoInSecs, the estimated workload RTO and estimated workload RPO result will be near zero and the Compliance status for your application will be set to Policy breached.policyName (string) required
policyDescription (string)
dataLocationConstraint (string)
tier (string) required
policy (object) required
clientToken (string)
tags (object)
resiliencehub/delete_appDeletes an Resilience Hub application. This is a destructive action that can't be undone.appArn (string) required
forceDelete (boolean)
clientToken (string)
resiliencehub/delete_app_assessmentDeletes an Resilience Hub application assessment. This is a destructive action that can't be undone.assessmentArn (string) required
clientToken (string)
resiliencehub/delete_app_input_sourceDeletes the input source and all of its imported resources from the Resilience Hub application.appArn (string) required
sourceArn (string)
terraformSource: {
. s3StateFileUrl (string)
} (object)
clientToken (string)
eksSourceClusterNamespace: {
. eksClusterArn (string)
. namespace (string)
} (object)
resiliencehub/delete_app_version_app_componentDeletes an Application Component from the Resilience Hub application. This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API. You will not be able to delete an Application Component if it has resources associated with it.appArn (string) required
id (string) required
clientToken (string)
resiliencehub/delete_app_version_resourceDeletes a resource from the Resilience Hub application. You can only delete a manually added resource. To exclude non-manually added resources, use the UpdateAppVersionResource API. This action has no effect outside Resilience Hub. This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.appArn (string) required
resourceName (string)
logicalResourceId: {
. identifier (string)
. logicalStackName (string)
. resourceGroupName (string)
. terraformSourceName (string)
. eksSourceName (string)
} (object)
physicalResourceId (string)
awsRegion (string)
awsAccountId (string)
clientToken (string)
resiliencehub/delete_recommendation_templateDeletes a recommendation template. This is a destructive action that can't be undone.recommendationTemplateArn (string) required
clientToken (string)
resiliencehub/delete_resiliency_policyDeletes a resiliency policy. This is a destructive action that can't be undone.policyArn (string) required
clientToken (string)
resiliencehub/describe_appDescribes an Resilience Hub application.appArn (string) required
resiliencehub/describe_app_assessmentDescribes an assessment for an Resilience Hub application.assessmentArn (string) required
resiliencehub/describe_app_versionDescribes the Resilience Hub application version.appArn (string) required
appVersion (string) required
resiliencehub/describe_app_version_app_componentDescribes an Application Component in the Resilience Hub application.appArn (string) required
appVersion (string) required
id (string) required
resiliencehub/describe_app_version_resourceDescribes a resource of the Resilience Hub application. This API accepts only one of the following parameters to describe the resource: resourceName logicalResourceId physicalResourceId Along with physicalResourceId, you can also provide awsAccountId, and awsRegionappArn (string) required
appVersion (string) required
resourceName (string)
logicalResourceId: {
. identifier (string)
. logicalStackName (string)
. resourceGroupName (string)
. terraformSourceName (string)
. eksSourceName (string)
} (object)
physicalResourceId (string)
awsRegion (string)
awsAccountId (string)
resiliencehub/describe_app_version_resources_resolution_statusReturns the resolution status for the specified resolution identifier for an application version. If resolutionId is not specified, the current resolution status is returned.appArn (string) required
appVersion (string) required
resolutionId (string)
resiliencehub/describe_app_version_templateDescribes details about an Resilience Hub application.appArn (string) required
appVersion (string) required
resiliencehub/describe_draft_app_version_resources_import_statusDescribes the status of importing resources to an application version. If you get a 404 error with ResourceImportStatusNotFoundAppMetadataException, you must call importResourcesToDraftAppVersion after creating the application and before calling describeDraftAppVersionResourcesImportStatus to obtain the status.appArn (string) required
resiliencehub/describe_metrics_exportDescribes the metrics of the application configuration being exported.metricsExportId (string) required
resiliencehub/describe_resiliency_policyDescribes a specified resiliency policy for an 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.policyArn (string) required
resiliencehub/describe_resource_grouping_recommendation_taskDescribes the resource grouping recommendation tasks run by Resilience Hub for your application.appArn (string) required
groupingId (string)
resiliencehub/import_resources_to_draft_app_versionImports resources to Resilience Hub application draft version from different input sources. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.appArn (string) required
sourceArns (array)
terraformSources (array)
importStrategy (string)
eksSources (array)
resiliencehub/list_alarm_recommendationsLists the alarm recommendations for an Resilience Hub application.assessmentArn (string) required
nextToken (string)
maxResults (integer)
resiliencehub/list_app_assessment_compliance_driftsList of compliance drifts that were detected while running an assessment.assessmentArn (string) required
nextToken (string)
maxResults (integer)
resiliencehub/list_app_assessment_resource_driftsList of resource drifts that were detected while running an assessment.assessmentArn (string) required
nextToken (string)
maxResults (integer)
resiliencehub/list_app_assessmentsLists the assessments for an Resilience Hub application. You can use request parameters to refine the results for the response object.appArn (string)
assessmentName (string)
assessmentStatus (array)
complianceStatus (string)
invoker (string)
reverseOrder (boolean)
nextToken (string)
maxResults (integer)
resiliencehub/list_app_component_compliancesLists the compliances for an Resilience Hub Application Component.nextToken (string)
maxResults (integer)
assessmentArn (string) required
resiliencehub/list_app_component_recommendationsLists the recommendations for an Resilience Hub Application Component.assessmentArn (string) required
nextToken (string)
maxResults (integer)
resiliencehub/list_app_input_sourcesLists all the input sources of the Resilience Hub application. For more information about the input sources supported by Resilience Hub, see Discover the structure and describe your Resilience Hub application.appArn (string) required
appVersion (string) required
nextToken (string)
maxResults (integer)
resiliencehub/list_appsLists your Resilience Hub applications. You can filter applications using only one filter at a time or without using any filter. If you try to filter applications using multiple filters, you will get the following error: An error occurred ValidationException when calling the ListApps operation: Only one filter is supported for this operation.nextToken (string)
maxResults (integer)
name (string)
appArn (string)
fromLastAssessmentTime (string)
toLastAssessmentTime (string)
reverseOrder (boolean)
awsApplicationArn (string)
resiliencehub/list_app_version_app_componentsLists all the Application Components in the Resilience Hub application.appArn (string) required
appVersion (string) required
nextToken (string)
maxResults (integer)
resiliencehub/list_app_version_resource_mappingsLists 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.appArn (string) required
appVersion (string) required
nextToken (string)
maxResults (integer)
resiliencehub/list_app_version_resourcesLists all the resources in an Resilience Hub application.appArn (string) required
appVersion (string) required
resolutionId (string)
nextToken (string)
maxResults (integer)
resiliencehub/list_app_versionsLists the different versions for the Resilience Hub applications.appArn (string) required
nextToken (string)
maxResults (integer)
startTime (string)
endTime (string)
resiliencehub/list_metricsLists the metrics that can be exported.nextToken (string)
maxResults (integer)
fields (array)
dataSource (string)
conditions (array)
sorts (array)
resiliencehub/list_recommendation_templatesLists the recommendation templates for the Resilience Hub applications.assessmentArn (string)
reverseOrder (boolean)
status (array)
recommendationTemplateArn (string)
name (string)
nextToken (string)
maxResults (integer)
resiliencehub/list_resiliency_policiesLists the resiliency policies for the Resilience Hub applications.policyName (string)
nextToken (string)
maxResults (integer)
resiliencehub/list_resource_grouping_recommendationsLists the resource grouping recommendations suggested by Resilience Hub for your application.appArn (string)
nextToken (string)
maxResults (integer)
resiliencehub/list_sop_recommendationsLists the standard operating procedure SOP recommendations for the Resilience Hub applications.nextToken (string)
maxResults (integer)
assessmentArn (string) required
resiliencehub/list_suggested_resiliency_policiesLists the suggested resiliency policies for the Resilience Hub applications.nextToken (string)
maxResults (integer)
resiliencehub/list_tags_for_resourceLists the tags for your resources in your Resilience Hub applications.resourceArn (string) required
resiliencehub/list_test_recommendationsLists the test recommendations for the Resilience Hub application.nextToken (string)
maxResults (integer)
assessmentArn (string) required
resiliencehub/list_unsupported_app_version_resourcesLists the resources that are not currently supported in 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.appArn (string) required
appVersion (string) required
resolutionId (string)
nextToken (string)
maxResults (integer)
resiliencehub/publish_app_versionPublishes a new version of a specific Resilience Hub application.appArn (string) required
versionName (string)
resiliencehub/put_draft_app_version_templateAdds or updates the app template for an Resilience Hub application draft version.appArn (string) required
appTemplateBody (string) required
resiliencehub/reject_resource_grouping_recommendationsRejects resource grouping recommendations.appArn (string) required
entries (array) required
resiliencehub/remove_draft_app_version_resource_mappingsRemoves resource mappings from a draft application version.appArn (string) required
resourceNames (array)
logicalStackNames (array)
appRegistryAppNames (array)
resourceGroupNames (array)
terraformSourceNames (array)
eksSourceNames (array)
resiliencehub/resolve_app_version_resourcesResolves the resources for an application version.appArn (string) required
appVersion (string) required
resiliencehub/start_app_assessmentCreates a new application assessment for an application.appArn (string) required
appVersion (string) required
assessmentName (string) required
clientToken (string)
tags (object)
resiliencehub/start_metrics_exportInitiates the export task of metrics.bucketName (string)
clientToken (string)
resiliencehub/start_resource_grouping_recommendation_taskStarts grouping recommendation task.appArn (string) required
resiliencehub/tag_resourceApplies one or more tags to a resource.resourceArn (string) required
tags (object) required
resiliencehub/untag_resourceRemoves one or more tags from a resource.resourceArn (string) required
tagKeys (array) required
resiliencehub/update_appUpdates an application.appArn (string) required
description (string)
policyArn (string)
clearResiliencyPolicyArn (boolean)
assessmentSchedule (string)
permissionModel: {
. type (string)
. invokerRoleName (string)
. crossAccountRoleArns (array)
} (object)
eventSubscriptions (array)
resiliencehub/update_app_versionUpdates the Resilience Hub application version. This API updates the Resilience Hub application draft version. To use this information for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API.appArn (string) required
additionalInfo (object)
resiliencehub/update_app_version_app_componentUpdates an existing Application Component in the Resilience Hub application. This API updates the Resilience Hub application draft version. To use this Application Component for running assessments, you must publish the Resilience Hub application using the PublishAppVersion API.appArn (string) required
id (string) required
name (string)
type (string)
additionalInfo (object)
resiliencehub/update_app_version_resourceUpdates the resource details in the Resilience Hub application. This action has no effect outside Resilience Hub. This API updates the Resilience Hub application draft version. To use this resource for running resiliency assessments, you must publish the Resilience Hub application using the PublishAppVersion API. To update application version with new physicalResourceID, you must call ResolveAppVersionResources API.appArn (string) required
resourceName (string)
logicalResourceId: {
. identifier (string)
. logicalStackName (string)
. resourceGroupName (string)
. terraformSourceName (string)
. eksSourceName (string)
} (object)
physicalResourceId (string)
awsRegion (string)
awsAccountId (string)
resourceType (string)
appComponents (array)
additionalInfo (object)
excluded (boolean)
resiliencehub/update_resiliency_policyUpdates a resiliency policy. Resilience Hub allows you to provide a value of zero for rtoInSecs and rpoInSecs of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for rtoInSecs and rpoInSecs, the estimated workload RTO and estimated workload RPO result will be near zero and the Compliance status for your application will be set to Policy breached.policyArn (string) required
policyName (string)
policyDescription (string)
dataLocationConstraint (string)
tier (string)
policy (object)
resource_explorer_2/batch_get_viewRetrieves details about a list of views.ViewArns (array)
resource_explorer_2/create_resource_explorer_setupCreates a Resource Explorer setup configuration across multiple Amazon Web Services Regions. This operation sets up indexes and views in the specified Regions. This operation can also be used to set an aggregator Region for cross-Region resource search.RegionList (array) required
AggregatorRegions (array)
ViewName (string) required
resource_explorer_2/delete_resource_explorer_setupDeletes a Resource Explorer setup configuration. This operation removes indexes and views from the specified Regions or all Regions where Resource Explorer is configured.RegionList (array)
DeleteInAllRegions (boolean)
resource_explorer_2/disassociate_default_viewAfter you call this operation, the affected Amazon Web Services Region no longer has a default view. All Search operations in that Region must explicitly specify a view or the operation fails. You can configure a new default by calling the AssociateDefaultView operation. If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.No parameters
resource_explorer_2/get_account_level_service_configurationRetrieves the status of your account's Amazon Web Services service access, and validates the service linked role required to access the multi-account search feature. Only the management account can invoke this API call.No parameters
resource_explorer_2/get_default_viewRetrieves the Amazon Resource Name ARN of the view that is the default for the Amazon Web Services Region in which you call this operation. You can then call GetView to retrieve the details of that view.No parameters
resource_explorer_2/get_indexRetrieves details about the Amazon Web Services Resource Explorer index in the Amazon Web Services Region in which you invoked the operation.No parameters
resource_explorer_2/get_managed_viewRetrieves details of the specified Amazon Web Services-managed view.ManagedViewArn (string) required
resource_explorer_2/get_resource_explorer_setupRetrieves the status and details of a Resource Explorer setup operation. This operation returns information about the progress of creating or deleting Resource Explorer configurations across Regions.TaskId (string) required
MaxResults (integer)
NextToken (string)
resource_explorer_2/get_service_indexRetrieves information about the Resource Explorer index in the current Amazon Web Services Region. This operation returns the ARN and type of the index if one exists.No parameters
resource_explorer_2/get_service_viewRetrieves details about a specific Resource Explorer service view. This operation returns the configuration and properties of the specified view.ServiceViewArn (string) required
resource_explorer_2/list_indexes_for_membersRetrieves a list of a member's indexes in all Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer. Only the management account or a delegated administrator with service access enabled can invoke this API call.AccountIdList (array) required
MaxResults (integer)
NextToken (string)
resource_explorer_2/list_managed_viewsLists the Amazon resource names ARNs of the Amazon Web Services-managed views available in the Amazon Web Services Region in which you call this operation.MaxResults (integer)
NextToken (string)
ServicePrincipal (string)
resource_explorer_2/list_resourcesReturns a list of resources and their details that match the specified criteria. This query must use a view. If you don’t explicitly specify a view, then Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation.Filters: {
. FilterString (string)
} (object)
MaxResults (integer)
ViewArn (string)
NextToken (string)
resource_explorer_2/list_service_indexesLists all Resource Explorer indexes across the specified Amazon Web Services Regions. This operation returns information about indexes including their ARNs, types, and Regions.Regions (array)
MaxResults (integer)
NextToken (string)
resource_explorer_2/list_service_viewsLists all Resource Explorer service views available in the current Amazon Web Services account. This operation returns the ARNs of available service views.MaxResults (integer)
NextToken (string)
resource_explorer_2/list_streaming_access_for_servicesReturns a list of Amazon Web Services services that have been granted streaming access to your Resource Explorer data. Streaming access allows Amazon Web Services services to receive real-time updates about your resources as they are indexed by Resource Explorer.MaxResults (integer)
NextToken (string)
resource_explorer_2/list_supported_resource_typesRetrieves a list of all resource types currently supported by Amazon Web Services Resource Explorer.NextToken (string)
MaxResults (integer)
resource_explorer_2/list_tags_for_resourceLists the tags that are attached to the specified resource.resourceArn (string) required
resource_explorer_2/searchSearches for resources and displays details about all resources that match the specified criteria. You must specify a query string. All search queries must use a view. If you don't explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the QueryString parameter supplied to this operation and the SearchFilter parameter atQueryString (string) required
MaxResults (integer)
ViewArn (string)
NextToken (string)
resource_explorer_2/tag_resourceAdds one or more tag key and value pairs to an Amazon Web Services Resource Explorer view or index.resourceArn (string) required
Tags (object)
resource_explorer_2/untag_resourceRemoves one or more tag key and value pairs from an Amazon Web Services Resource Explorer view or index.resourceArn (string) required
tagKeys (array) required
resource_explorer_2/create_indexTurns on Amazon Web Services Resource Explorer in the Amazon Web Services Region in which you called this operation by creating an index. Resource Explorer begins discovering the resources in this Region and stores the details about the resources in the index so that they can be queried by using the Search operation. You can create only one index in a Region. This operation creates only a local index. To promote the local index in one Amazon Web Services Region into the aggregator index for theClientToken (string)
Tags (object)
resource_explorer_2/update_index_typeChanges the type of the index from one of the following types to the other. For more information about indexes and the role they perform in Amazon Web Services Resource Explorer, see Turning on cross-Region search by creating an aggregator index in the Amazon Web Services Resource Explorer User Guide. AGGREGATOR index type The index contains information about resources from all Amazon Web Services Regions in the Amazon Web Services account in which you've created a Resource Explorer index. ResouArn (string) required
Type (string) required
resource_explorer_2/delete_indexDeletes the specified index and turns off Amazon Web Services Resource Explorer in the specified Amazon Web Services Region. When you delete an index, Resource Explorer stops discovering and indexing resources in that Region. Resource Explorer also deletes all views in that Region. These actions occur as asynchronous background tasks. You can check to see when the actions are complete by using the GetIndex operation and checking the Status response value. If the index you delete is the aggregatoArn (string) required
resource_explorer_2/list_indexesRetrieves a list of all of the indexes in Amazon Web Services Regions that are currently collecting resource information for Amazon Web Services Resource Explorer.Type (string)
Regions (array)
MaxResults (integer)
NextToken (string)
resource_explorer_2/create_viewCreates a view that users can query by using the Search operation. Results from queries that you make using this view include only resources that match the view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views in the Amazon Web Services Resource Explorer User Guide. Only the principals with an IAM identity-based policy that grants Allow to the Search action on a Resource with the Amazon resource name ARN of this view can Search using views youClientToken (string)
ViewName (string) required
IncludedProperties (array)
Scope (string)
Filters: {
. FilterString (string)
} (object)
Tags (object)
resource_explorer_2/get_viewRetrieves details of the specified view.ViewArn (string) required
resource_explorer_2/update_viewModifies some of the details of a view. You can change the filter string and the list of included properties. You can't change the name of the view.ViewArn (string) required
IncludedProperties (array)
Filters: {
. FilterString (string)
} (object)
resource_explorer_2/delete_viewDeletes the specified view. If the specified view is the default view for its Amazon Web Services Region, then all Search operations in that Region must explicitly specify the view to use until you configure a new default by calling the AssociateDefaultView operation.ViewArn (string) required
resource_explorer_2/list_viewsLists the Amazon resource names ARNs of the views available in the Amazon Web Services Region in which you call this operation. Always check the NextToken response parameter for a null value when calling a paginated 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.NextToken (string)
MaxResults (integer)
resource_explorer_2/associate_default_viewSets the specified view as the default for the Amazon Web Services Region in which you call this operation. When a user performs a Search that doesn't explicitly specify which view to use, then Amazon Web Services Resource Explorer automatically chooses this default view for searches performed in this Amazon Web Services Region. If an Amazon Web Services Region doesn't have a default view configured, then users must explicitly specify a view with every Search operation performed in that Region.ViewArn (string) required
resource_groups_tagging_api/describe_report_creationDescribes 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.No parameters
resource_groups_tagging_api/get_compliance_summaryReturns 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. RepTargetIdFilters (array)
RegionFilters (array)
ResourceTypeFilters (array)
TagKeyFilters (array)
GroupBy (array)
MaxResults (integer)
PaginationToken (string)
resource_groups_tagging_api/get_resourcesReturns 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 OPaginationToken (string)
TagFilters (array)
ResourcesPerPage (integer)
TagsPerPage (integer)
ResourceTypeFilters (array)
IncludeComplianceDetails (boolean)
ExcludeCompliantResources (boolean)
ResourceARNList (array)
resource_groups_tagging_api/get_tag_keysReturns 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 thPaginationToken (string)
resource_groups_tagging_api/get_tag_valuesReturns 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 PaginationToPaginationToken (string)
Key (string) required
resource_groups_tagging_api/list_required_tagsLists the required tags for supported resource types in an Amazon Web Services account.NextToken (string)
MaxResults (integer)
resource_groups_tagging_api/start_report_creationGenerates 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://amzn-s3-demo-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv For more information about evaluating resource compliance with tag policies, including the required permissions,S3Bucket (string) required
resource_groups_tagging_api/tag_resourcesApplies 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, seeResourceARNList (array) required
Tags (object) required
resource_groups_tagging_api/untag_resourcesRemoves 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 waResourceARNList (array) required
TagKeys (array) required
resource_groups/cancel_tag_sync_taskCancels the specified tag-sync task. Minimum permissions To run this command, you must have the following permissions: resource-groups:CancelTagSyncTask on the application group resource-groups:DeleteGroupTaskArn (string) required
resource_groups/create_groupCreates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide. For more information about service-linked groups and service configurations, see Service configurations for Resource Groups. Minimum permissions To run this command, you must have the following permissions: resourcName (string) required
Description (string)
ResourceQuery: {
. Type (string)
. Query (string)
} (object)
Tags (object)
Configuration (array)
Criticality (integer)
Owner (string)
DisplayName (string)
resource_groups/delete_groupDeletes 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:DeleteGroupGroupName (string)
Group (string)
resource_groups/get_account_settingsRetrieves the current status of optional features in Resource Groups.No parameters
resource_groups/get_groupReturns information about a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetGroupGroupName (string)
Group (string)
resource_groups/get_group_configurationRetrieves 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:GetGroupConfigurationGroup (string)
resource_groups/get_group_queryRetrieves 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:GetGroupQueryGroupName (string)
Group (string)
resource_groups/get_tagsReturns a list of tags that are associated with a resource group, specified by an Amazon resource name ARN. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetTagsArn (string) required
resource_groups/get_tag_sync_taskReturns information about a specified tag-sync task. Minimum permissions To run this command, you must have the following permissions: resource-groups:GetTagSyncTask on the application groupTaskArn (string) required
resource_groups/group_resourcesAdds the specified resources to the specified group. You can only use this operation with the following groups: AWS::EC2::HostManagement AWS::EC2::CapacityReservationPool AWS::ResourceGroups::ApplicationGroup Other resource group types and resource types are not currently supported by this operation. Minimum permissions To run this command, you must have the following permissions: resource-groups:GroupResourcesGroup (string) required
ResourceArns (array) required
resource_groups/list_grouping_statusesReturns the status of the last grouping or ungrouping action for each resource in the specified application group.Group (string) required
MaxResults (integer)
Filters (array)
NextToken (string)
resource_groups/list_group_resourcesReturns a list of Amazon resource names 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:GetResourcesGroupName (string)
Group (string)
Filters (array)
MaxResults (integer)
NextToken (string)
resource_groups/list_groupsReturns a list of existing Resource Groups in your account. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListGroupsFilters (array)
MaxResults (integer)
NextToken (string)
resource_groups/list_tag_sync_tasksReturns a list of tag-sync tasks. Minimum permissions To run this command, you must have the following permissions: resource-groups:ListTagSyncTasks with the group passed in the filters as the resource or if using no filtersFilters (array)
MaxResults (integer)
NextToken (string)
resource_groups/put_group_configurationAttaches 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:PutGroupConfigurationGroup (string)
Configuration (array)
resource_groups/search_resourcesReturns a list of Amazon Web Services 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:GetResourcesResourceQuery: {
. Type (string)
. Query (string)
} (object) required
MaxResults (integer)
NextToken (string)
resource_groups/start_tag_sync_taskCreates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application. To start a tag-sync task, you need a resource tagging role. The resource tagging role grants permissions to tag and untag applications resources and must include a trust policy that allows Resource Groups to assume the role and perform resource tagging tasks on your behalf. For instructions on creating a tag-sync task, see Create a tag-sync using the Resource Groups API in the AGroup (string) required
TagKey (string)
TagValue (string)
ResourceQuery: {
. Type (string)
. Query (string)
} (object)
RoleArn (string) required
resource_groups/tagAdds tags to a resource group with the specified Amazon resource name 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 permissionsArn (string) required
Tags (object) required
resource_groups/ungroup_resourcesRemoves the specified resources from the specified group. This operation works only with static groups that you populated using the GroupResources operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries. Minimum permissions To run this command, you must have the following permissions: resource-groups:UngroupResourcesGroup (string) required
ResourceArns (array) required
resource_groups/untagDeletes tags from a specified resource group. Minimum permissions To run this command, you must have the following permissions: resource-groups:UntagArn (string) required
Keys (array) required
resource_groups/update_account_settingsTurns on or turns off optional features in Resource Groups. The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS. You can call the GetAccountSettings operation to check for completion by looking for GroupLifecycleEventsStatus to change to ACTIVE.GroupLifecycleEventsDesiredStatus (string)
resource_groups/update_groupUpdates 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:UpdateGroupGroupName (string)
Group (string)
Description (string)
Criticality (integer)
Owner (string)
DisplayName (string)
resource_groups/update_group_queryUpdates 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:UpdateGroupQueryGroupName (string)
Group (string)
ResourceQuery: {
. Type (string)
. Query (string)
} (object) required
rolesanywhere/list_tags_for_resourceLists the tags attached to the resource. Required permissions: rolesanywhere:ListTagsForResource.resourceArn (string) required
rolesanywhere/put_notification_settingsAttaches a list of notification settings to a trust anchor. A notification setting includes information such as event name, threshold, status of the notification setting, and the channel to notify. Required permissions: rolesanywhere:PutNotificationSettings.trustAnchorId (string) required
notificationSettings (array) required
rolesanywhere/reset_notification_settingsResets the custom notification setting to IAM Roles Anywhere default setting. Required permissions: rolesanywhere:ResetNotificationSettings.trustAnchorId (string) required
notificationSettingKeys (array) required
rolesanywhere/tag_resourceAttaches tags to a resource. Required permissions: rolesanywhere:TagResource.resourceArn (string) required
tags (array) required
rolesanywhere/untag_resourceRemoves tags from the resource. Required permissions: rolesanywhere:UntagResource.resourceArn (string) required
tagKeys (array) required
rolesanywhere/disable_crlDisables a certificate revocation list CRL. Required permissions: rolesanywhere:DisableCrl.crlId (string) required
rolesanywhere/enable_crlEnables a certificate revocation list CRL. When enabled, certificates stored in the CRL are unauthorized to receive session credentials. Required permissions: rolesanywhere:EnableCrl.crlId (string) required
rolesanywhere/import_crlImports the certificate revocation list CRL. A CRL is a list of certificates that have been revoked by the issuing certificate Authority CA.In order to be properly imported, a CRL must be in PEM format. IAM Roles Anywhere validates against the CRL before issuing credentials. Required permissions: rolesanywhere:ImportCrl.name (string) required
crlData (string) required
enabled (boolean)
tags (array)
trustAnchorArn (string) required
rolesanywhere/get_crlGets a certificate revocation list CRL. Required permissions: rolesanywhere:GetCrl.crlId (string) required
rolesanywhere/update_crlUpdates the certificate revocation list CRL. A CRL is a list of certificates that have been revoked by the issuing certificate authority CA. IAM Roles Anywhere validates against the CRL before issuing credentials. Required permissions: rolesanywhere:UpdateCrl.crlId (string) required
name (string)
crlData (string)
rolesanywhere/delete_crlDeletes a certificate revocation list CRL. Required permissions: rolesanywhere:DeleteCrl.crlId (string) required
rolesanywhere/list_crlsLists all certificate revocation lists CRL in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListCrls.nextToken (string)
pageSize (integer)
rolesanywhere/delete_attribute_mappingDelete an entry from the attribute mapping rules enforced by a given profile.profileId (string) required
certificateField (string) required
specifiers (array)
rolesanywhere/disable_profileDisables a profile. When disabled, temporary credential requests with this profile fail. Required permissions: rolesanywhere:DisableProfile.profileId (string) required
rolesanywhere/enable_profileEnables temporary credential requests for a profile. Required permissions: rolesanywhere:EnableProfile.profileId (string) required
rolesanywhere/put_attribute_mappingPut an entry in the attribute mapping rules that will be enforced by a given profile. A mapping specifies a certificate field and one or more specifiers that have contextual meanings.profileId (string) required
certificateField (string) required
mappingRules (array) required
rolesanywhere/create_profileCreates a profile, a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies. Required permissions: rolesanywhere:CreateProfile.name (string) required
requireInstanceProperties (boolean)
sessionPolicy (string)
roleArns (array) required
managedPolicyArns (array)
durationSeconds (integer)
enabled (boolean)
tags (array)
acceptRoleSessionName (boolean)
rolesanywhere/get_profileGets a profile. Required permissions: rolesanywhere:GetProfile.profileId (string) required
rolesanywhere/update_profileUpdates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies. Required permissions: rolesanywhere:UpdateProfile.profileId (string) required
name (string)
sessionPolicy (string)
roleArns (array)
managedPolicyArns (array)
durationSeconds (integer)
acceptRoleSessionName (boolean)
rolesanywhere/delete_profileDeletes a profile. Required permissions: rolesanywhere:DeleteProfile.profileId (string) required
rolesanywhere/list_profilesLists all profiles in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListProfiles.nextToken (string)
pageSize (integer)
rolesanywhere/get_subjectGets a subject, which associates a certificate identity with authentication attempts. The subject stores auditing information such as the 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.subjectId (string) required
rolesanywhere/list_subjectsLists the subjects in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListSubjects.nextToken (string)
pageSize (integer)
rolesanywhere/disable_trust_anchorDisables a trust anchor. When disabled, temporary credential requests specifying this trust anchor are unauthorized. Required permissions: rolesanywhere:DisableTrustAnchor.trustAnchorId (string) required
rolesanywhere/enable_trust_anchorEnables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation. Required permissions: rolesanywhere:EnableTrustAnchor.trustAnchorId (string) required
rolesanywhere/create_trust_anchorCreates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority CA. You can define a trust anchor as a reference to an Private Certificate Authority Private CA or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials. Required permissions: rolesanywhere:CreateTrustAnchor.name (string) required
source: {
. sourceType (string)
. sourceData
} (object) required
enabled (boolean)
tags (array)
notificationSettings (array)
rolesanywhere/get_trust_anchorGets a trust anchor. Required permissions: rolesanywhere:GetTrustAnchor.trustAnchorId (string) required
rolesanywhere/update_trust_anchorUpdates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority CA by configuring a trust anchor. You can define a trust anchor as a reference to an Private Certificate Authority Private CA or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials. Required permissions: rolesanywhere:UpdateTrustAnchor.trustAnchorId (string) required
name (string)
source: {
. sourceType (string)
. sourceData
} (object)
rolesanywhere/delete_trust_anchorDeletes a trust anchor. Required permissions: rolesanywhere:DeleteTrustAnchor.trustAnchorId (string) required
rolesanywhere/list_trust_anchorsLists the trust anchors in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListTrustAnchors.nextToken (string)
pageSize (integer)
route_53_domains/accept_domain_transfer_from_another_aws_accountAccepts 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 whDomainName (string) required
Password (string) required
route_53_domains/associate_delegation_signer_to_domainCreates a delegation signer DS record in the registry zone for this domain name. Note that creating DS record at the registry impacts DNSSEC validation of your DNS records. This action may render your domain name unavailable on the internet if the steps are completed in the wrong order, or with incorrect timing. For more information about DNSSEC signing, see Configuring DNSSEC signing in the Route 53 developer guide.DomainName (string) required
SigningAttributes: {
. Algorithm (integer)
. Flags (integer)
. PublicKey (string)
} (object) required
route_53_domains/cancel_domain_transfer_to_another_aws_accountCancels 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 infoDomainName (string) required
route_53_domains/check_domain_availabilityThis 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.DomainName (string) required
IdnLangCode (string)
route_53_domains/check_domain_transferabilityChecks whether a domain name can be transferred to Amazon Route 53.DomainName (string) required
AuthCode (string)
route_53_domains/delete_domainThis 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 iDomainName (string) required
route_53_domains/delete_tags_for_domainThis operation deletes the specified tags for a domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.DomainName (string) required
TagsToDelete (array) required
route_53_domains/disable_domain_auto_renewThis operation disables automatic renewal of domain registration for the specified domain.DomainName (string) required
route_53_domains/disable_domain_transfer_lockThis 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.DomainName (string) required
route_53_domains/disassociate_delegation_signer_from_domainDeletes a delegation signer DS record in the registry zone for this domain name.DomainName (string) required
Id (string) required
route_53_domains/enable_domain_auto_renewThis 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 soDomainName (string) required
route_53_domains/enable_domain_transfer_lockThis 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.DomainName (string) required
route_53_domains/get_contact_reachability_statusFor 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.domainName (string)
route_53_domains/get_domain_detailThis 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.DomainName (string) required
route_53_domains/get_domain_suggestionsThe GetDomainSuggestions operation returns a list of suggested domain names.DomainName (string) required
SuggestionCount (integer) required
OnlyAvailable (boolean) required
route_53_domains/get_operation_detailThis operation returns the current status of an operation that is not completed.OperationId (string) required
route_53_domains/list_domainsThis operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account if no filtering conditions are used.FilterConditions (array)
SortCondition: {
. Name (string)
. SortOrder (string)
} (object)
Marker (string)
MaxItems (integer)
route_53_domains/list_operationsReturns 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.SubmittedSince (string)
Marker (string)
MaxItems (integer)
Status (array)
Type (array)
SortBy (string)
SortOrder (string)
route_53_domains/list_pricesLists the following prices for either all the TLDs supported by Route 53, or the specified TLD: Registration Transfer Owner change Domain renewal Domain restorationTld (string)
Marker (string)
MaxItems (integer)
route_53_domains/list_tags_for_domainThis 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.DomainName (string) required
route_53_domains/push_domainMoves a domain from Amazon Web Services to another registrar. Supported actions: Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means that the domain is ready to be transferred to another registrar.DomainName (string) required
Target (string) required
route_53_domains/register_domainThis operation registers a domain. 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 auto renew, so your domain registration will renew automatically each year. We'll notify you in advance oDomainName (string) required
IdnLangCode (string)
DurationInYears (integer) required
AutoRenew (boolean)
AdminContact: {
. FirstName (string)
. LastName (string)
. ContactType (string)
. OrganizationName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. City (string)
. State (string)
. CountryCode (string)
. ZipCode (string)
. PhoneNumber (string)
. Email (string)
. Fax (string)
. ExtraParams (array)
} (object) required
RegistrantContact: {
. FirstName (string)
. LastName (string)
. ContactType (string)
. OrganizationName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. City (string)
. State (string)
. CountryCode (string)
. ZipCode (string)
. PhoneNumber (string)
. Email (string)
. Fax (string)
. ExtraParams (array)
} (object) required
TechContact: {
. FirstName (string)
. LastName (string)
. ContactType (string)
. OrganizationName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. City (string)
. State (string)
. CountryCode (string)
. ZipCode (string)
. PhoneNumber (string)
. Email (string)
. Fax (string)
. ExtraParams (array)
} (object) required
PrivacyProtectAdminContact (boolean)
PrivacyProtectRegistrantContact (boolean)
PrivacyProtectTechContact (boolean)
BillingContact: {
. FirstName (string)
. LastName (string)
. ContactType (string)
. OrganizationName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. City (string)
. State (string)
. CountryCode (string)
. ZipCode (string)
. PhoneNumber (string)
. Email (string)
. Fax (string)
. ExtraParams (array)
} (object)
PrivacyProtectBillingContact (boolean)
route_53_domains/reject_domain_transfer_from_another_aws_accountRejects 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.DomainName (string) required
route_53_domains/renew_domainThis 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.DomainName (string) required
DurationInYears (integer)
CurrentExpiryYear (integer) required
route_53_domains/resend_contact_reachability_emailFor 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.domainName (string)
route_53_domains/resend_operation_authorizationResend the form of authorization email for this operation.OperationId (string) required
route_53_domains/retrieve_domain_auth_codeThis operation returns the authorization code for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.DomainName (string) required
route_53_domains/transfer_domainTransfers a domain from another registrar to Amazon Route 53. 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 TransferDomainToAnothDomainName (string) required
IdnLangCode (string)
DurationInYears (integer) required
Nameservers (array)
AuthCode (string)
AutoRenew (boolean)
AdminContact: {
. FirstName (string)
. LastName (string)
. ContactType (string)
. OrganizationName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. City (string)
. State (string)
. CountryCode (string)
. ZipCode (string)
. PhoneNumber (string)
. Email (string)
. Fax (string)
. ExtraParams (array)
} (object) required
RegistrantContact: {
. FirstName (string)
. LastName (string)
. ContactType (string)
. OrganizationName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. City (string)
. State (string)
. CountryCode (string)
. ZipCode (string)
. PhoneNumber (string)
. Email (string)
. Fax (string)
. ExtraParams (array)
} (object) required
TechContact: {
. FirstName (string)
. LastName (string)
. ContactType (string)
. OrganizationName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. City (string)
. State (string)
. CountryCode (string)
. ZipCode (string)
. PhoneNumber (string)
. Email (string)
. Fax (string)
. ExtraParams (array)
} (object) required
PrivacyProtectAdminContact (boolean)
PrivacyProtectRegistrantContact (boolean)
PrivacyProtectTechContact (boolean)
BillingContact: {
. FirstName (string)
. LastName (string)
. ContactType (string)
. OrganizationName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. City (string)
. State (string)
. CountryCode (string)
. ZipCode (string)
. PhoneNumber (string)
. Email (string)
. Fax (string)
. ExtraParams (array)
} (object)
PrivacyProtectBillingContact (boolean)
route_53_domains/transfer_domain_to_another_aws_accountTransfers 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 tDomainName (string) required
AccountId (string) required
route_53_domains/update_domain_contactThis 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 operation. If the request is not completed successfully, the domain registrant will be notified by email.DomainName (string) required
AdminContact: {
. FirstName (string)
. LastName (string)
. ContactType (string)
. OrganizationName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. City (string)
. State (string)
. CountryCode (string)
. ZipCode (string)
. PhoneNumber (string)
. Email (string)
. Fax (string)
. ExtraParams (array)
} (object)
RegistrantContact: {
. FirstName (string)
. LastName (string)
. ContactType (string)
. OrganizationName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. City (string)
. State (string)
. CountryCode (string)
. ZipCode (string)
. PhoneNumber (string)
. Email (string)
. Fax (string)
. ExtraParams (array)
} (object)
TechContact: {
. FirstName (string)
. LastName (string)
. ContactType (string)
. OrganizationName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. City (string)
. State (string)
. CountryCode (string)
. ZipCode (string)
. PhoneNumber (string)
. Email (string)
. Fax (string)
. ExtraParams (array)
} (object)
Consent: {
. MaxPrice (number)
. Currency (string)
} (object)
BillingContact: {
. FirstName (string)
. LastName (string)
. ContactType (string)
. OrganizationName (string)
. AddressLine1 (string)
. AddressLine2 (string)
. City (string)
. State (string)
. CountryCode (string)
. ZipCode (string)
. PhoneNumber (string)
. Email (string)
. Fax (string)
. ExtraParams (array)
} (object)
route_53_domains/update_domain_contact_privacyThis operation updates the specified domain contact's privacy setting. When privacy protection is enabled, your contact information is replaced with contact information for the registrar or with the phrase 'REDACTED FOR PRIVACY', or 'On behalf of owner.' While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts. This operation affects only the contact information for the specified contact type administrative, registrantDomainName (string) required
AdminPrivacy (boolean)
RegistrantPrivacy (boolean)
TechPrivacy (boolean)
BillingPrivacy (boolean)
route_53_domains/update_domain_nameserversThis 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.DomainName (string) required
FIAuthKey (string)
Nameservers (array) required
route_53_domains/update_tags_for_domainThis operation adds or updates tags for a specified domain. All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.DomainName (string) required
TagsToUpdate (array)
route_53_domains/view_billingReturns all the domain-related billing records for the current Amazon Web Services account for a specified periodStart (string)
End (string)
Marker (string)
MaxItems (integer)
route_53/activate_key_signing_keyActivates a key-signing key KSK so that it can be used for signing by DNSSEC. This operation changes the KSK status to ACTIVE.HostedZoneId (string) required
Name (string) required
route_53/associate_vpcwith_hosted_zoneAssociates 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. THostedZoneId (string) required
VPC: {
. VPCRegion (string)
. VPCId (string)
} (object) required
Comment (string)
route_53/change_cidr_collectionCreates, 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 CId (string) required
CollectionVersion (integer)
Changes (array) required
route_53/change_resource_record_setsCreates, 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 ChangeHostedZoneId (string) required
ChangeBatch: {
. Comment (string)
. Changes (array)
} (object) required
route_53/change_tags_for_resourceAdds, 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.ResourceType (string) required
ResourceId (string) required
AddTags (array)
RemoveTagKeys (array)
route_53/create_cidr_collectionCreates a CIDR collection in the current Amazon Web Services account.Name (string) required
CallerReference (string) required
route_53/create_health_checkCreates 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 ZoneCallerReference (string) required
HealthCheckConfig: {
. IPAddress (string)
. Port (integer)
. Type (string)
. ResourcePath (string)
. FullyQualifiedDomainName (string)
. SearchString (string)
. RequestInterval (integer)
. FailureThreshold (integer)
. MeasureLatency (boolean)
. Inverted (boolean)
. Disabled (boolean)
. HealthThreshold (integer)
. ChildHealthChecks (array)
. EnableSNI (boolean)
. Regions (array)
. AlarmIdentifier (object)
. InsufficientDataHealthStatus (string)
. RoutingControlArn (string)
} (object) required
route_53/create_hosted_zoneCreates 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,Name (string) required
VPC: {
. VPCRegion (string)
. VPCId (string)
} (object)
CallerReference (string) required
HostedZoneConfig: {
. Comment (string)
. PrivateZone (boolean)
} (object)
DelegationSetId (string)
route_53/create_key_signing_keyCreates a new key-signing key KSK associated with a hosted zone. You can only have two KSKs per hosted zone.CallerReference (string) required
HostedZoneId (string) required
KeyManagementServiceArn (string) required
Name (string) required
Status (string) required
route_53/create_query_logging_configCreates 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 aHostedZoneId (string) required
CloudWatchLogsLogGroupArn (string) required
route_53/create_reusable_delegation_setCreates 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 whiCallerReference (string) required
HostedZoneId (string)
route_53/create_traffic_policyCreates 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.Name (string) required
Document (string) required
Comment (string)
route_53/create_traffic_policy_instanceCreates 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. After you submit an CreateTrafficPolicyInstance request, there'sHostedZoneId (string) required
Name (string) required
TTL (integer) required
TrafficPolicyId (string) required
TrafficPolicyVersion (integer) required
route_53/create_traffic_policy_versionCreates 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 anotherId (string) required
Document (string) required
Comment (string)
route_53/create_vpcassociation_authorizationAuthorizes 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 createdHostedZoneId (string) required
VPC: {
. VPCRegion (string)
. VPCId (string)
} (object) required
route_53/deactivate_key_signing_keyDeactivates a key-signing key KSK so that it will not be used for signing by DNSSEC. This operation changes the KSK status to INACTIVE.HostedZoneId (string) required
Name (string) required
route_53/delete_cidr_collectionDeletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted.Id (string) required
route_53/delete_health_checkDeletes 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 DevelHealthCheckId (string) required
route_53/delete_hosted_zoneDeletes 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 resoId (string) required
route_53/delete_key_signing_keyDeletes 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.HostedZoneId (string) required
Name (string) required
route_53/delete_query_logging_configDeletes 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.Id (string) required
route_53/delete_reusable_delegation_setDeletes 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.Id (string) required
route_53/delete_traffic_policyDeletes 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.Id (string) required
Version (integer) required
route_53/delete_traffic_policy_instanceDeletes 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.Id (string) required
route_53/delete_vpcassociation_authorizationRemoves 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, DeleteVPCAssHostedZoneId (string) required
VPC: {
. VPCRegion (string)
. VPCId (string)
} (object) required
route_53/disable_hosted_zone_dnssecDisables DNSSEC signing in a specific hosted zone. This action does not deactivate any key-signing keys KSKs that are active in the hosted zone.HostedZoneId (string) required
route_53/disassociate_vpcfrom_hosted_zoneDisassociates 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 automaticallHostedZoneId (string) required
VPC: {
. VPCRegion (string)
. VPCId (string)
} (object) required
Comment (string)
route_53/enable_hosted_zone_dnssecEnables DNSSEC signing in a specific hosted zone.HostedZoneId (string) required
route_53/get_account_limitGets 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 theType (string) required
route_53/get_changeReturns 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 managing the hosted zone. This is the initial status of all change batch requests. INSYNC indicates that the changes have propagated to all Route 53 DNS servers managing the hosted zone.Id (string) required
route_53/get_checker_ip_rangesRoute 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.No parameters
route_53/get_dnssecReturns information about DNSSEC for a specific hosted zone, including the key-signing keys KSKs in the hosted zone.HostedZoneId (string) required
route_53/get_geo_locationGets 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 forContinentCode (string)
CountryCode (string)
SubdivisionCode (string)
route_53/get_health_checkGets information about a specified health check.HealthCheckId (string) required
route_53/get_health_check_countRetrieves the number of health checks that are associated with the current Amazon Web Services account.No parameters
route_53/get_health_check_last_failure_reasonGets the reason that a specified health check failed most recently.HealthCheckId (string) required
route_53/get_health_check_statusGets 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.HealthCheckId (string) required
route_53/get_hosted_zoneGets information about a specified hosted zone including the four name servers assigned to the hosted zone. returns the VPCs associated with the specified hosted zone and does not reflect the VPC associations by Route 53 Profiles. To get the associations to a Profile, call the ListProfileAssociations API.Id (string) required
route_53/get_hosted_zone_countRetrieves the number of hosted zones that are associated with the current Amazon Web Services account.No parameters
route_53/get_hosted_zone_limitGets 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.Type (string) required
HostedZoneId (string) required
route_53/get_query_logging_configGets information about a specified configuration for DNS query logging. For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries.Id (string) required
route_53/get_reusable_delegation_setRetrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.Id (string) required
route_53/get_reusable_delegation_set_limitGets 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.Type (string) required
DelegationSetId (string) required
route_53/get_traffic_policyGets information about a specific traffic policy version. For information about how of deleting a traffic policy affects the response from GetTrafficPolicy, see DeleteTrafficPolicy.Id (string) required
Version (integer) required
route_53/get_traffic_policy_instanceGets information about a specified traffic policy instance. Use GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element. In the Route 53 console, traffic policy instances are known as policy records.Id (string) required
route_53/get_traffic_policy_instance_countGets the number of traffic policy instances that are associated with the current Amazon Web Services account.No parameters
route_53/list_cidr_blocksReturns a paginated list of location objects and their CIDR blocks.CollectionId (string) required
LocationName (string)
NextToken (string)
MaxResults (integer)
route_53/list_cidr_collectionsReturns a paginated list of CIDR collections in the Amazon Web Services account metadata only.NextToken (string)
MaxResults (integer)
route_53/list_cidr_locationsReturns a paginated list of CIDR locations for the given collection metadata only, does not include CIDR blocks.CollectionId (string) required
NextToken (string)
MaxResults (integer)
route_53/list_geo_locationsRetrieves 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 GeoLocatiStartContinentCode (string)
StartCountryCode (string)
StartSubdivisionCode (string)
MaxItems (integer)
route_53/list_health_checksRetrieve a list of the health checks that are associated with the current Amazon Web Services account.Marker (string)
MaxItems (integer)
route_53/list_hosted_zonesRetrieves 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.Marker (string)
MaxItems (integer)
DelegationSetId (string)
HostedZoneType (string)
route_53/list_hosted_zones_by_nameRetrieves 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 PDNSName (string)
HostedZoneId (string)
MaxItems (integer)
route_53/list_hosted_zones_by_vpcLists 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 OwniVPCId (string) required
VPCRegion (string) required
MaxItems (integer)
NextToken (string)
route_53/list_query_logging_configsLists 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.HostedZoneId (string)
NextToken (string)
MaxResults (integer)
route_53/list_resource_record_setsLists 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 iHostedZoneId (string) required
StartRecordName (string)
StartRecordType (string)
StartRecordIdentifier (string)
MaxItems (integer)
route_53/list_reusable_delegation_setsRetrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.Marker (string)
MaxItems (integer)
route_53/list_tags_for_resourceLists 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.ResourceType (string) required
ResourceId (string) required
route_53/list_tags_for_resourcesLists 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.ResourceType (string) required
ResourceIds (array) required
route_53/list_traffic_policiesGets 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.TrafficPolicyIdMarker (string)
MaxItems (integer)
route_53/list_traffic_policy_instancesGets 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 parameterHostedZoneIdMarker (string)
TrafficPolicyInstanceNameMarker (string)
TrafficPolicyInstanceTypeMarker (string)
MaxItems (integer)
route_53/list_traffic_policy_instances_by_hosted_zoneGets 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 MaxItemsHostedZoneId (string) required
TrafficPolicyInstanceNameMarker (string)
TrafficPolicyInstanceTypeMarker (string)
MaxItems (integer)
route_53/list_traffic_policy_instances_by_policyGets 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 uTrafficPolicyId (string) required
TrafficPolicyVersion (integer) required
HostedZoneIdMarker (string)
TrafficPolicyInstanceNameMarker (string)
TrafficPolicyInstanceTypeMarker (string)
MaxItems (integer)
route_53/list_traffic_policy_versionsGets information about all of the versions for a specified traffic policy. Traffic policy versions are listed in numerical order by VersionNumber.Id (string) required
TrafficPolicyVersionMarker (string)
MaxItems (integer)
route_53/list_vpcassociation_authorizationsGets 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.HostedZoneId (string) required
NextToken (string)
MaxResults (integer)
route_53/test_dnsanswerGets 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. The TestDnsAnswer returns information similar to what you would expect from the answer section of the dig command. Therefore, if you query for the name servers of a subdomain that point to the parent name servers, thoseHostedZoneId (string) required
RecordName (string) required
RecordType (string) required
ResolverIP (string)
EDNS0ClientSubnetIP (string)
EDNS0ClientSubnetMask (string)
route_53/update_health_checkUpdates 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.HealthCheckId (string) required
HealthCheckVersion (integer)
IPAddress (string)
Port (integer)
ResourcePath (string)
FullyQualifiedDomainName (string)
SearchString (string)
FailureThreshold (integer)
Inverted (boolean)
Disabled (boolean)
HealthThreshold (integer)
ChildHealthChecks (array)
EnableSNI (boolean)
Regions (array)
AlarmIdentifier: {
. Region (string)
. Name (string)
} (object)
InsufficientDataHealthStatus (string)
ResetElements (array)
route_53/update_hosted_zone_commentUpdates the comment for a specified hosted zone.Id (string) required
Comment (string)
route_53/update_hosted_zone_featuresUpdates the features configuration for a hosted zone. This operation allows you to enable or disable specific features for your hosted zone, such as accelerated recovery. Accelerated recovery enables you to update DNS records in your public hosted zone even when the us-east-1 region is unavailable.HostedZoneId (string) required
EnableAcceleratedRecovery (boolean)
route_53/update_traffic_policy_commentUpdates the comment for a specified traffic policy version.Id (string) required
Version (integer) required
Comment (string) required
route_53/update_traffic_policy_instanceAfter you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets that are specified in the traffic policy definition. Use GetTrafficPolicyInstance with the id of updated traffic policy instance confirm that the UpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element. Updates the resource record sets in a specified hosted zone that were created based on the settings in a specifiedId (string) required
TTL (integer) required
TrafficPolicyId (string) required
TrafficPolicyVersion (integer) required
route53_recovery_cluster/get_routing_control_stateGet 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 set to ON, traffic flows to a cell. When the state is set to 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 DeveRoutingControlArn (string) required
route53_recovery_cluster/list_routing_controlsList 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 setControlPanelArn (string)
NextToken (string)
MaxResults (integer)
route53_recovery_cluster/update_routing_control_stateSet the state of the routing control to reroute traffic. You can set the value to 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 ruRoutingControlArn (string) required
RoutingControlState (string) required
SafetyRulesToOverride (array)
route53_recovery_cluster/update_routing_control_statesSet 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 yUpdateRoutingControlStateEntries (array) required
SafetyRulesToOverride (array)
route53_recovery_control_config/create_clusterCreate 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.ClientToken (string)
ClusterName (string) required
Tags (object)
NetworkType (string)
route53_recovery_control_config/create_control_panelCreates 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.ClientToken (string)
ClusterArn (string) required
ControlPanelName (string) required
Tags (object)
route53_recovery_control_config/create_routing_controlCreates 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.ClientToken (string)
ClusterArn (string) required
ControlPanelArn (string)
RoutingControlName (string) required
route53_recovery_control_config/create_safety_ruleCreates 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 transactionAssertionRule: {
. AssertedControls (array)
. ControlPanelArn (string)
. Name (string)
. RuleConfig (object)
. WaitPeriodMs (integer)
} (object)
ClientToken (string)
GatingRule: {
. ControlPanelArn (string)
. GatingControls (array)
. Name (string)
. RuleConfig (object)
. TargetControls (array)
. WaitPeriodMs (integer)
} (object)
Tags (object)
route53_recovery_control_config/delete_clusterDelete a cluster.ClusterArn (string) required
route53_recovery_control_config/delete_control_panelDeletes a control panel.ControlPanelArn (string) required
route53_recovery_control_config/delete_routing_controlDeletes a routing control.RoutingControlArn (string) required
route53_recovery_control_config/delete_safety_ruleDeletes a safety rule./SafetyRuleArn (string) required
route53_recovery_control_config/describe_clusterDisplay the details about a cluster. The response includes the cluster name, endpoints, status, and Amazon Resource Name ARN.ClusterArn (string) required
route53_recovery_control_config/describe_control_panelDisplays details about a control panel.ControlPanelArn (string) required
route53_recovery_control_config/describe_routing_controlDisplays 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.RoutingControlArn (string) required
route53_recovery_control_config/describe_safety_ruleReturns information about a safety rule.SafetyRuleArn (string) required
route53_recovery_control_config/get_resource_policyGet information about the resource policy for a cluster.ResourceArn (string) required
route53_recovery_control_config/list_associated_route53health_checksReturns an array of all Amazon Route 53 health checks associated with a specific routing control.MaxResults (integer)
NextToken (string)
RoutingControlArn (string) required
route53_recovery_control_config/list_clustersReturns an array of all the clusters in an account.MaxResults (integer)
NextToken (string)
route53_recovery_control_config/list_control_panelsReturns an array of control panels in an account or in a cluster.ClusterArn (string)
MaxResults (integer)
NextToken (string)
route53_recovery_control_config/list_routing_controlsReturns 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.ControlPanelArn (string) required
MaxResults (integer)
NextToken (string)
route53_recovery_control_config/list_safety_rulesList the safety rules the assertion rules and gating rules that you've defined for the routing controls in a control panel.ControlPanelArn (string) required
MaxResults (integer)
NextToken (string)
route53_recovery_control_config/list_tags_for_resourceLists the tags for a resource.ResourceArn (string) required
route53_recovery_control_config/tag_resourceAdds a tag to a resource.ResourceArn (string) required
Tags (object) required
route53_recovery_control_config/untag_resourceRemoves a tag from a resource.ResourceArn (string) required
TagKeys (array) required
route53_recovery_control_config/update_clusterUpdates an existing cluster. You can only update the network type of a cluster.ClusterArn (string) required
NetworkType (string) required
route53_recovery_control_config/update_control_panelUpdates a control panel. The only update you can make to a control panel is to change the name of the control panel.ControlPanelArn (string) required
ControlPanelName (string) required
route53_recovery_control_config/update_routing_controlUpdates 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.RoutingControlArn (string) required
RoutingControlName (string) required
route53_recovery_control_config/update_safety_ruleUpdate 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.AssertionRuleUpdate: {
. Name (string)
. SafetyRuleArn (string)
. WaitPeriodMs (integer)
} (object)
GatingRuleUpdate: {
. Name (string)
. SafetyRuleArn (string)
. WaitPeriodMs (integer)
} (object)
route53_recovery_readiness/create_cellCreates a cell in an account.CellName (string) required
Cells (array)
Tags (object)
route53_recovery_readiness/create_cross_account_authorizationCreates 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.CrossAccountAuthorization (string) required
route53_recovery_readiness/create_readiness_checkCreates 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.ReadinessCheckName (string) required
ResourceSetName (string) required
Tags (object)
route53_recovery_readiness/create_recovery_groupCreates 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.Cells (array)
RecoveryGroupName (string) required
Tags (object)
route53_recovery_readiness/create_resource_setCreates 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.ResourceSetName (string) required
ResourceSetType (string) required
Resources (array) required
Tags (object)
route53_recovery_readiness/delete_cellDelete a cell. When successful, the response code is 204, with no response body.CellName (string) required
route53_recovery_readiness/delete_cross_account_authorizationDeletes cross account readiness authorization.CrossAccountAuthorization (string) required
route53_recovery_readiness/delete_readiness_checkDeletes a readiness check.ReadinessCheckName (string) required
route53_recovery_readiness/delete_recovery_groupDeletes a recovery group.RecoveryGroupName (string) required
route53_recovery_readiness/delete_resource_setDeletes a resource set.ResourceSetName (string) required
route53_recovery_readiness/get_architecture_recommendationsGets recommendations about architecture designs for improving resiliency for an application, based on a recovery group.MaxResults (integer)
NextToken (string)
RecoveryGroupName (string) required
route53_recovery_readiness/get_cellGets 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.CellName (string) required
route53_recovery_readiness/get_cell_readiness_summaryGets readiness for a cell. Aggregates the readiness of all the resources that are associated with the cell into a single value.CellName (string) required
MaxResults (integer)
NextToken (string)
route53_recovery_readiness/get_readiness_checkGets details about a readiness check.ReadinessCheckName (string) required
route53_recovery_readiness/get_readiness_check_resource_statusGets 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.MaxResults (integer)
NextToken (string)
ReadinessCheckName (string) required
ResourceIdentifier (string) required
route53_recovery_readiness/get_readiness_check_statusGets 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.MaxResults (integer)
NextToken (string)
ReadinessCheckName (string) required
route53_recovery_readiness/get_recovery_groupGets details about a recovery group, including a list of the cells that are included in it.RecoveryGroupName (string) required
route53_recovery_readiness/get_recovery_group_readiness_summaryDisplays 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.MaxResults (integer)
NextToken (string)
RecoveryGroupName (string) required
route53_recovery_readiness/get_resource_setDisplays the details about a resource set, including a list of the resources in the set.ResourceSetName (string) required
route53_recovery_readiness/list_cellsLists the cells for an account.MaxResults (integer)
NextToken (string)
route53_recovery_readiness/list_cross_account_authorizationsLists the cross-account readiness authorizations that are in place for an account.MaxResults (integer)
NextToken (string)
route53_recovery_readiness/list_readiness_checksLists the readiness checks for an account.MaxResults (integer)
NextToken (string)
route53_recovery_readiness/list_recovery_groupsLists the recovery groups in an account.MaxResults (integer)
NextToken (string)
route53_recovery_readiness/list_resource_setsLists the resource sets in an account.MaxResults (integer)
NextToken (string)
route53_recovery_readiness/list_rulesLists all readiness rules, or lists the readiness rules for a specific resource type.MaxResults (integer)
NextToken (string)
ResourceType (string)
route53_recovery_readiness/list_tags_for_resourcesLists the tags for a resource.ResourceArn (string) required
route53_recovery_readiness/tag_resourceAdds a tag to a resource.ResourceArn (string) required
Tags (object) required
route53_recovery_readiness/untag_resourceRemoves a tag from a resource.ResourceArn (string) required
TagKeys (array) required
route53_recovery_readiness/update_cellUpdates a cell to replace the list of nested cells with a new list of nested cells.CellName (string) required
Cells (array) required
route53_recovery_readiness/update_readiness_checkUpdates a readiness check.ReadinessCheckName (string) required
ResourceSetName (string) required
route53_recovery_readiness/update_recovery_groupUpdates a recovery group.Cells (array) required
RecoveryGroupName (string) required
route53_recovery_readiness/update_resource_setUpdates a resource set.ResourceSetName (string) required
ResourceSetType (string) required
Resources (array) required
route53globalresolver/disassociate_hosted_zoneDisassociates a Route 53 private hosted zone from a Route 53 Global Resolver resource.hostedZoneId (string) required
resourceArn (string) required
route53globalresolver/list_tags_for_resourceLists the tags associated with a Route 53 Global Resolver resource.resourceArn (string) required
route53globalresolver/tag_resourceAdds or updates tags for a Route 53 Global Resolver resource. Tags are key-value pairs that help you organize and identify your resources.resourceArn (string) required
tags (object) required
route53globalresolver/untag_resourceRemoves tags from a Route 53 Global Resolver resource.resourceArn (string) required
tagKeys (array) required
route53globalresolver/create_access_sourceCreates an access source for a DNS view. Access sources define IP addresses or CIDR ranges that are allowed to send DNS queries to the Route 53 Global Resolver, along with the permitted DNS protocols.cidr (string) required
clientToken (string)
ipAddressType (string)
name (string)
dnsViewId (string) required
protocol (string) required
tags (object)
route53globalresolver/get_access_sourceRetrieves information about an access source.accessSourceId (string) required
route53globalresolver/update_access_sourceUpdates the configuration of an access source.accessSourceId (string) required
cidr (string)
ipAddressType (string)
name (string)
protocol (string)
route53globalresolver/delete_access_sourceDeletes an access source. This operation cannot be undone.accessSourceId (string) required
route53globalresolver/list_access_sourcesLists all access sources with pagination support.maxResults (integer)
nextToken (string)
filters (object)
route53globalresolver/create_access_tokenCreates an access token for a DNS view. Access tokens provide token-based authentication for DNS-over-HTTPS DoH and DNS-over-TLS DoT connections to the Route 53 Global Resolver.clientToken (string)
dnsViewId (string) required
expiresAt (string)
name (string)
tags (object)
route53globalresolver/get_access_tokenRetrieves information about an access token.accessTokenId (string) required
route53globalresolver/update_access_tokenUpdates the configuration of an access token.accessTokenId (string) required
name (string) required
route53globalresolver/delete_access_tokenDeletes an access token. This operation cannot be undone.accessTokenId (string) required
route53globalresolver/list_access_tokensLists all access tokens for a DNS view with pagination support.maxResults (integer)
nextToken (string)
dnsViewId (string) required
filters (object)
route53globalresolver/disable_dnsviewDisables a DNS view, preventing it from serving DNS queries.dnsViewId (string) required
route53globalresolver/enable_dnsviewEnables a disabled DNS view, allowing it to serve DNS queries again.dnsViewId (string) required
route53globalresolver/create_dnsviewCreates a DNS view within a Route 53 Global Resolver. A DNS view models end users, user groups, networks, and devices, and serves as a parent resource that holds configurations controlling access, authorization, DNS firewall rules, and forwarding rules.globalResolverId (string) required
clientToken (string)
name (string) required
dnssecValidation (string)
ednsClientSubnet (string)
firewallRulesFailOpen (string)
description (string)
tags (object)
route53globalresolver/get_dnsviewRetrieves information about a DNS view.dnsViewId (string) required
route53globalresolver/update_dnsviewUpdates the configuration of a DNS view.dnsViewId (string) required
name (string)
description (string)
dnssecValidation (string)
ednsClientSubnet (string)
firewallRulesFailOpen (string)
route53globalresolver/delete_dnsviewDeletes a DNS view. This operation cannot be undone.dnsViewId (string) required
route53globalresolver/list_dnsviewsLists all DNS views for a Route 53 Global Resolver with pagination support.maxResults (integer)
nextToken (string)
globalResolverId (string) required
route53globalresolver/import_firewall_domainsImports a list of domains from an Amazon S3 file into a firewall domain list. The file should contain one domain per line.domainFileUrl (string) required
firewallDomainListId (string) required
operation (string) required
route53globalresolver/list_firewall_domainsLists all the domains in DNS Firewall domain list you have created.maxResults (integer)
nextToken (string)
firewallDomainListId (string) required
route53globalresolver/update_firewall_domainsUpdates a DNS Firewall domain list from an array of specified domains.domains (array) required
firewallDomainListId (string) required
operation (string) required
route53globalresolver/create_firewall_domain_listCreates a firewall domain list. Domain lists are reusable sets of domain specifications that you use in DNS firewall rules to allow, block, or alert on DNS queries to specific domains.clientToken (string)
globalResolverId (string) required
description (string)
name (string) required
tags (object)
route53globalresolver/get_firewall_domain_listRetrieves information about a firewall domain list.firewallDomainListId (string) required
route53globalresolver/delete_firewall_domain_listDeletes a firewall domain list. This operation cannot be undone.firewallDomainListId (string) required
route53globalresolver/list_firewall_domain_listsLists all firewall domain lists for a Route 53 Global Resolver with pagination support.maxResults (integer)
nextToken (string)
globalResolverId (string)
route53globalresolver/batch_create_firewall_ruleCreates multiple DNS firewall rules in a single operation. This is more efficient than creating rules individually when you need to set up multiple rules at once.firewallRules (array) required
route53globalresolver/batch_delete_firewall_ruleDeletes multiple DNS firewall rules in a single operation. This is more efficient than deleting rules individually.firewallRules (array) required
route53globalresolver/batch_update_firewall_ruleUpdates multiple DNS firewall rules in a single operation. This is more efficient than updating rules individually.firewallRules (array) required
route53globalresolver/create_firewall_ruleCreates a DNS firewall rule. Firewall rules define actions ALLOW, BLOCK, or ALERT to take on DNS queries that match specified domain lists, managed domain lists, or advanced threat protections.action (string) required
blockOverrideDnsType (string)
blockOverrideDomain (string)
blockOverrideTtl (integer)
blockResponse (string)
clientToken (string)
confidenceThreshold (string)
description (string)
dnsAdvancedProtection (string)
firewallDomainListId (string)
name (string) required
priority (integer)
dnsViewId (string) required
qType (string)
route53globalresolver/get_firewall_ruleRetrieves information about a DNS firewall rule.firewallRuleId (string) required
route53globalresolver/update_firewall_ruleUpdates the configuration of a DNS firewall rule.action (string)
blockOverrideDnsType (string)
blockOverrideDomain (string)
blockOverrideTtl (integer)
blockResponse (string)
clientToken (string) required
confidenceThreshold (string)
description (string)
dnsAdvancedProtection (string)
firewallRuleId (string) required
name (string)
priority (integer)
route53globalresolver/delete_firewall_ruleDeletes a DNS firewall rule. This operation cannot be undone.firewallRuleId (string) required
route53globalresolver/list_firewall_rulesLists all DNS firewall rules for a DNS view with pagination support.maxResults (integer)
nextToken (string)
dnsViewId (string) required
filters (object)
route53globalresolver/create_global_resolverCreates a new Route 53 Global Resolver instance. A Route 53 Global Resolver is a global, internet-accessible DNS resolver that provides secure DNS resolution for both public and private domains through global anycast IP addresses.clientToken (string)
description (string)
name (string) required
observabilityRegion (string)
regions (array) required
tags (object)
route53globalresolver/get_global_resolverRetrieves information about a Route 53 Global Resolver instance.globalResolverId (string) required
route53globalresolver/update_global_resolverUpdates the configuration of a Route 53 Global Resolver instance. You can modify the name, description, and observability region.globalResolverId (string) required
name (string)
observabilityRegion (string)
description (string)
route53globalresolver/delete_global_resolverDeletes a Route 53 Global Resolver instance. This operation cannot be undone. All associated DNS views, access sources, tokens, and firewall rules are also deleted.globalResolverId (string) required
route53globalresolver/list_global_resolversLists all Route 53 Global Resolver instances in your account with pagination support.maxResults (integer)
nextToken (string)
route53globalresolver/associate_hosted_zoneAssociates a Route 53 private hosted zone with a Route 53 Global Resolver resource. This allows the resolver to resolve DNS queries for the private hosted zone from anywhere globally.hostedZoneId (string) required
resourceArn (string) required
name (string) required
route53globalresolver/get_hosted_zone_associationRetrieves information about a hosted zone association.hostedZoneAssociationId (string) required
route53globalresolver/update_hosted_zone_associationUpdates the configuration of a hosted zone association.hostedZoneAssociationId (string) required
name (string)
route53globalresolver/list_hosted_zone_associationsLists all hosted zone associations for a Route 53 Global Resolver resource with pagination support.maxResults (integer)
nextToken (string)
resourceArn (string) required
route53globalresolver/get_managed_firewall_domain_listRetrieves information about an AWS-managed firewall domain list. Managed domain lists contain domains associated with malicious activity, content categories, or specific threats.managedFirewallDomainListId (string) required
route53globalresolver/list_managed_firewall_domain_listsReturns a paginated list of the AWS Managed DNS Lists and the categories for DNS Firewall. The categories are either THREAT or CONTENT.maxResults (integer)
nextToken (string)
managedFirewallDomainListType (string) required
route53profiles/associate_profileAssociates a Route 53 Profiles profile with a VPC. A VPC can have only one Profile associated with it, but a Profile can be associated with 1000 of VPCs and you can request a higher quota. For more information, see https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html limits-api-entities.ProfileId (string) required
ResourceId (string) required
Name (string) required
Tags (array)
route53profiles/associate_resource_to_profileAssociates a DNS reource configuration to a Route 53 Profile.ProfileId (string) required
ResourceArn (string) required
Name (string) required
ResourceProperties (string)
route53profiles/create_profileCreates an empty Route 53 Profile.Name (string) required
ClientToken (string) required
Tags (array)
route53profiles/delete_profileDeletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.ProfileId (string) required
route53profiles/disassociate_profileDissociates a specified Route 53 Profile from the specified VPC.ProfileId (string) required
ResourceId (string) required
route53profiles/disassociate_resource_from_profileDissoaciated a specified resource, from the Route 53 Profile.ProfileId (string) required
ResourceArn (string) required
route53profiles/get_profileReturns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.ProfileId (string) required
route53profiles/get_profile_associationRetrieves a Route 53 Profile association for a VPC. A VPC can have only one Profile association, but a Profile can be associated with up to 5000 VPCs.ProfileAssociationId (string) required
route53profiles/get_profile_resource_associationReturns information about a specified Route 53 Profile resource association.ProfileResourceAssociationId (string) required
route53profiles/list_profile_associationsLists all the VPCs that the specified Route 53 Profile is associated with.ResourceId (string)
ProfileId (string)
MaxResults (integer)
NextToken (string)
route53profiles/list_profile_resource_associationsLists all the resource associations for the specified Route 53 Profile.ProfileId (string) required
ResourceType (string)
MaxResults (integer)
NextToken (string)
route53profiles/list_profilesLists all the Route 53 Profiles associated with your Amazon Web Services account.MaxResults (integer)
NextToken (string)
route53profiles/list_tags_for_resourceLists the tags that you associated with the specified resource.ResourceArn (string) required
route53profiles/tag_resourceAdds one or more tags to a specified resource.ResourceArn (string) required
Tags (object) required
route53profiles/untag_resourceRemoves one or more tags from a specified resource.ResourceArn (string) required
TagKeys (array) required
route53profiles/update_profile_resource_associationUpdates the specified Route 53 Profile resourse association.ProfileResourceAssociationId (string) required
Name (string)
ResourceProperties (string)
route53resolver/associate_firewall_rule_groupAssociates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.CreatorRequestId (string) required
FirewallRuleGroupId (string) required
VpcId (string) required
Priority (integer) required
Name (string) required
MutationProtection (string)
Tags (array)
route53resolver/associate_resolver_endpoint_ip_addressAdds 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.ResolverEndpointId (string) required
IpAddress: {
. IpId (string)
. SubnetId (string)
. Ip (string)
. Ipv6 (string)
} (object) required
route53resolver/associate_resolver_query_log_configAssociates 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 DResolverQueryLogConfigId (string) required
ResourceId (string) required
route53resolver/associate_resolver_ruleAssociates 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.ResolverRuleId (string) required
Name (string)
VPCId (string) required
route53resolver/create_firewall_domain_listCreates 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.CreatorRequestId (string) required
Name (string) required
Tags (array)
route53resolver/create_firewall_ruleCreates a single DNS Firewall rule in the specified rule group, using the specified domain list.CreatorRequestId (string) required
FirewallRuleGroupId (string) required
FirewallDomainListId (string)
Priority (integer) required
Action (string) required
BlockResponse (string)
BlockOverrideDomain (string)
BlockOverrideDnsType (string)
BlockOverrideTtl (integer)
Name (string) required
FirewallDomainRedirectionAction (string)
Qtype (string)
DnsThreatProtection (string)
ConfidenceThreshold (string)
route53resolver/create_firewall_rule_groupCreates 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.CreatorRequestId (string) required
Name (string) required
Tags (array)
route53resolver/create_outpost_resolverCreates a Route 53 Resolver on an Outpost.CreatorRequestId (string) required
Name (string) required
InstanceCount (integer)
PreferredInstanceType (string) required
OutpostArn (string) required
Tags (array)
route53resolver/create_resolver_endpointCreates 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.CreatorRequestId (string) required
Name (string)
SecurityGroupIds (array) required
Direction (string) required
IpAddresses (array) required
OutpostArn (string)
PreferredInstanceType (string)
Tags (array)
ResolverEndpointType (string)
Protocols (array)
RniEnhancedMetricsEnabled (boolean)
TargetNameServerMetricsEnabled (boolean)
route53resolver/create_resolver_query_log_configCreates 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 AmazonName (string) required
DestinationArn (string) required
CreatorRequestId (string) required
Tags (array)
route53resolver/create_resolver_ruleFor 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.CreatorRequestId (string) required
Name (string)
RuleType (string) required
DomainName (string)
TargetIps (array)
ResolverEndpointId (string)
Tags (array)
DelegationRecord (string)
route53resolver/delete_firewall_domain_listDeletes the specified domain list.FirewallDomainListId (string) required
route53resolver/delete_firewall_ruleDeletes the specified firewall rule.FirewallRuleGroupId (string) required
FirewallDomainListId (string)
FirewallThreatProtectionId (string)
Qtype (string)
route53resolver/delete_firewall_rule_groupDeletes the specified firewall rule group.FirewallRuleGroupId (string) required
route53resolver/delete_outpost_resolverDeletes a Resolver on the Outpost.Id (string) required
route53resolver/delete_resolver_endpointDeletes 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.ResolverEndpointId (string) required
route53resolver/delete_resolver_query_log_configDeletes 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 DisassociateResolverQueryResolverQueryLogConfigId (string) required
route53resolver/delete_resolver_ruleDeletes 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.ResolverRuleId (string) required
route53resolver/disassociate_firewall_rule_groupDisassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.FirewallRuleGroupAssociationId (string) required
route53resolver/disassociate_resolver_endpoint_ip_addressRemoves 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.ResolverEndpointId (string) required
IpAddress: {
. IpId (string)
. SubnetId (string)
. Ip (string)
. Ipv6 (string)
} (object) required
route53resolver/disassociate_resolver_query_log_configDisassociates 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.ResolverQueryLogConfigId (string) required
ResourceId (string) required
route53resolver/disassociate_resolver_ruleRemoves 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.VPCId (string) required
ResolverRuleId (string) required
route53resolver/get_firewall_configRetrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud Amazon VPC.ResourceId (string) required
route53resolver/get_firewall_domain_listRetrieves the specified firewall domain list.FirewallDomainListId (string) required
route53resolver/get_firewall_rule_groupRetrieves the specified firewall rule group.FirewallRuleGroupId (string) required
route53resolver/get_firewall_rule_group_associationRetrieves 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.FirewallRuleGroupAssociationId (string) required
route53resolver/get_firewall_rule_group_policyReturns 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.Arn (string) required
route53resolver/get_outpost_resolverGets information about a specified Resolver on the Outpost, such as its instance count and type, name, and the current status of the Resolver.Id (string) required
route53resolver/get_resolver_configRetrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.ResourceId (string) required
route53resolver/get_resolver_dnssec_configGets DNSSEC validation information for a specified resource.ResourceId (string) required
route53resolver/get_resolver_endpointGets 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.ResolverEndpointId (string) required
route53resolver/get_resolver_query_log_configGets 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.ResolverQueryLogConfigId (string) required
route53resolver/get_resolver_query_log_config_associationGets 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.ResolverQueryLogConfigAssociationId (string) required
route53resolver/get_resolver_query_log_config_policyGets 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.Arn (string) required
route53resolver/get_resolver_ruleGets 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.ResolverRuleId (string) required
route53resolver/get_resolver_rule_associationGets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using AssociateResolverRule.ResolverRuleAssociationId (string) required
route53resolver/get_resolver_rule_policyGets 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.Arn (string) required
route53resolver/import_firewall_domainsImports 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.FirewallDomainListId (string) required
Operation (string) required
DomainFileUrl (string) required
route53resolver/list_firewall_configsRetrieves 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.MaxResults (integer)
NextToken (string)
route53resolver/list_firewall_domain_listsRetrieves 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.MaxResults (integer)
NextToken (string)
route53resolver/list_firewall_domainsRetrieves 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.FirewallDomainListId (string) required
MaxResults (integer)
NextToken (string)
route53resolver/list_firewall_rule_group_associationsRetrieves 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.FirewallRuleGroupId (string)
VpcId (string)
Priority (integer)
Status (string)
MaxResults (integer)
NextToken (string)
route53resolver/list_firewall_rule_groupsRetrieves 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.MaxResults (integer)
NextToken (string)
route53resolver/list_firewall_rulesRetrieves 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.FirewallRuleGroupId (string) required
Priority (integer)
Action (string)
MaxResults (integer)
NextToken (string)
route53resolver/list_outpost_resolversLists all the Resolvers on Outposts that were created using the current Amazon Web Services account.OutpostArn (string)
MaxResults (integer)
NextToken (string)
route53resolver/list_resolver_configsRetrieves the Resolver configurations that you have defined. Route 53 Resolver uses the configurations to manage DNS resolution behavior for your VPCs.MaxResults (integer)
NextToken (string)
route53resolver/list_resolver_dnssec_configsLists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account.MaxResults (integer)
NextToken (string)
Filters (array)
route53resolver/list_resolver_endpoint_ip_addressesGets the IP addresses for a specified Resolver endpoint.ResolverEndpointId (string) required
MaxResults (integer)
NextToken (string)
route53resolver/list_resolver_endpointsLists all the Resolver endpoints that were created using the current Amazon Web Services account.MaxResults (integer)
NextToken (string)
Filters (array)
route53resolver/list_resolver_query_log_config_associationsLists information about associations between Amazon VPCs and query logging configurations.MaxResults (integer)
NextToken (string)
Filters (array)
SortBy (string)
SortOrder (string)
route53resolver/list_resolver_query_log_configsLists 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.MaxResults (integer)
NextToken (string)
Filters (array)
SortBy (string)
SortOrder (string)
route53resolver/list_resolver_rule_associationsLists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account.MaxResults (integer)
NextToken (string)
Filters (array)
route53resolver/list_resolver_rulesLists the Resolver rules that were created using the current Amazon Web Services account.MaxResults (integer)
NextToken (string)
Filters (array)
route53resolver/list_tags_for_resourceLists the tags that you associated with the specified resource.ResourceArn (string) required
MaxResults (integer)
NextToken (string)
route53resolver/put_firewall_rule_group_policyAttaches 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.Arn (string) required
FirewallRuleGroupPolicy (string) required
route53resolver/put_resolver_query_log_config_policySpecifies 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.Arn (string) required
ResolverQueryLogConfigPolicy (string) required
route53resolver/put_resolver_rule_policySpecifies 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.Arn (string) required
ResolverRulePolicy (string) required
route53resolver/tag_resourceAdds one or more tags to a specified resource.ResourceArn (string) required
Tags (array) required
route53resolver/untag_resourceRemoves one or more tags from a specified resource.ResourceArn (string) required
TagKeys (array) required
route53resolver/update_firewall_configUpdates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud Amazon VPC.ResourceId (string) required
FirewallFailOpen (string) required
route53resolver/update_firewall_domainsUpdates the firewall domain list from an array of domain specifications.FirewallDomainListId (string) required
Operation (string) required
Domains (array) required
route53resolver/update_firewall_ruleUpdates the specified firewall rule.FirewallRuleGroupId (string) required
FirewallDomainListId (string)
FirewallThreatProtectionId (string)
Priority (integer)
Action (string)
BlockResponse (string)
BlockOverrideDomain (string)
BlockOverrideDnsType (string)
BlockOverrideTtl (integer)
Name (string)
FirewallDomainRedirectionAction (string)
Qtype (string)
DnsThreatProtection (string)
ConfidenceThreshold (string)
route53resolver/update_firewall_rule_group_associationChanges the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering for the VPC.FirewallRuleGroupAssociationId (string) required
Priority (integer)
MutationProtection (string)
Name (string)
route53resolver/update_outpost_resolverYou can use UpdateOutpostResolver to update the instance count, type, or name of a Resolver on an Outpost.Id (string) required
Name (string)
InstanceCount (integer)
PreferredInstanceType (string)
route53resolver/update_resolver_configUpdates the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.ResourceId (string) required
AutodefinedReverseFlag (string) required
route53resolver/update_resolver_dnssec_configUpdates an existing DNSSEC validation configuration. If there is no existing DNSSEC validation configuration, one is created.ResourceId (string) required
Validation (string) required
route53resolver/update_resolver_endpointUpdates the name, or endpoint type for an inbound or an outbound Resolver endpoint. You can only update between IPV4 and DUALSTACK, IPV6 endpoint type can't be updated to other type.ResolverEndpointId (string) required
Name (string)
ResolverEndpointType (string)
UpdateIpAddresses (array)
Protocols (array)
RniEnhancedMetricsEnabled (boolean)
TargetNameServerMetricsEnabled (boolean)
route53resolver/update_resolver_ruleUpdates 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.ResolverRuleId (string) required
Config: {
. Name (string)
. TargetIps (array)
. ResolverEndpointId (string)
} (object) required
rtbfabric/list_requester_gatewaysLists requester gateways.maxResults (integer)
nextToken (string)
rtbfabric/list_responder_gatewaysLists reponder gateways.maxResults (integer)
nextToken (string)
rtbfabric/list_tags_for_resourceLists tags for a resource.resourceArn (string) required
rtbfabric/tag_resourceAssigns one or more tags key-value pairs to the specified resource.resourceArn (string) required
tags (object) required
rtbfabric/untag_resourceRemoves a tag or tags from a resource.resourceArn (string) required
tagKeys (array) required
rtbfabric/accept_linkAccepts a link request between gateways. When a requester gateway requests to link with a responder gateway, the responder can use this operation to accept the link request and establish the connection.gatewayId (string) required
linkId (string) required
attributes: {
. responderErrorMasking (array)
. customerProvidedId (string)
} (object)
logSettings: {
. applicationLogs (object)
} (object) required
rtbfabric/reject_linkRejects a link request between gateways. When a requester gateway requests to link with a responder gateway, the responder can use this operation to decline the link request.gatewayId (string) required
linkId (string) required
rtbfabric/update_linkUpdates the configuration of a link between gateways. Allows you to modify settings and parameters for an existing link.gatewayId (string) required
linkId (string) required
logSettings: {
. applicationLogs (object)
} (object)
rtbfabric/update_link_module_flowUpdates a link module flow.clientToken (string) required
gatewayId (string) required
linkId (string) required
modules (array) required
rtbfabric/create_linkCreates a new link between gateways. Establishes a connection that allows gateways to communicate and exchange bid requests and responses.gatewayId (string) required
peerGatewayId (string) required
attributes: {
. responderErrorMasking (array)
. customerProvidedId (string)
} (object)
httpResponderAllowed (boolean)
tags (object)
logSettings: {
. applicationLogs (object)
} (object) required
rtbfabric/get_linkRetrieves information about a link between gateways. Returns detailed information about the link configuration, status, and associated gateways.gatewayId (string) required
linkId (string) required
rtbfabric/delete_linkDeletes a link between gateways. Permanently removes the connection between gateways. This action cannot be undone.gatewayId (string) required
linkId (string) required
rtbfabric/list_linksLists links associated with gateways. Returns a list of all links for the specified gateways, including their status and configuration details.gatewayId (string) required
nextToken (string)
maxResults (integer)
rtbfabric/update_requester_gatewayUpdates a requester gateway.clientToken (string) required
gatewayId (string) required
description (string)
rtbfabric/create_requester_gatewayCreates a requester gateway.vpcId (string) required
subnetIds (array) required
securityGroupIds (array) required
clientToken (string) required
description (string)
tags (object)
rtbfabric/get_requester_gatewayRetrieves information about a requester gateway.gatewayId (string) required
rtbfabric/delete_requester_gatewayDeletes a requester gateway.gatewayId (string) required
rtbfabric/delete_outbound_external_linkDeletes an outbound external link.gatewayId (string) required
linkId (string) required
rtbfabric/get_outbound_external_linkRetrieves information about an outbound external link.gatewayId (string) required
linkId (string) required
rtbfabric/create_outbound_external_linkCreates an outbound external link.clientToken (string) required
gatewayId (string) required
attributes: {
. responderErrorMasking (array)
. customerProvidedId (string)
} (object)
publicEndpoint (string) required
logSettings: {
. applicationLogs (object)
} (object) required
tags (object)
rtbfabric/update_responder_gatewayUpdates a responder gateway.domainName (string)
port (integer) required
protocol (string) required
trustStoreConfiguration: {
. certificateAuthorityCertificates (array)
} (object)
managedEndpointConfiguration (undefined)
clientToken (string) required
gatewayId (string) required
description (string)
rtbfabric/create_responder_gatewayCreates a responder gateway. A domain name or managed endpoint is required.vpcId (string) required
subnetIds (array) required
securityGroupIds (array) required
domainName (string)
port (integer) required
protocol (string) required
trustStoreConfiguration: {
. certificateAuthorityCertificates (array)
} (object)
managedEndpointConfiguration (undefined)
clientToken (string) required
description (string)
tags (object)
rtbfabric/get_responder_gatewayRetrieves information about a responder gateway.gatewayId (string) required
rtbfabric/delete_responder_gatewayDeletes a responder gateway.gatewayId (string) required
rtbfabric/delete_inbound_external_linkDeletes an inbound external link.gatewayId (string) required
linkId (string) required
rtbfabric/get_inbound_external_linkRetrieves information about an inbound external link.gatewayId (string) required
linkId (string) required
rtbfabric/create_inbound_external_linkCreates an inbound external link.clientToken (string) required
gatewayId (string) required
attributes: {
. responderErrorMasking (array)
. customerProvidedId (string)
} (object)
logSettings: {
. applicationLogs (object)
} (object) required
tags (object)
rum/list_tags_for_resourceDisplays the tags associated with a CloudWatch RUM resource.ResourceArn (string) required
rum/put_rum_eventsSends 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.Id (string) required
BatchId (string) required
AppMonitorDetails: {
. name (string)
. id (string)
. version (string)
} (object) required
UserDetails: {
. userId (string)
. sessionId (string)
} (object) required
RumEvents (array) required
Alias (string)
rum/tag_resourceAssigns 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 rResourceArn (string) required
Tags (object) required
rum/untag_resourceRemoves one or more tags from the specified resource.ResourceArn (string) required
TagKeys (array) required
rum/batch_create_rum_metric_definitionsSpecifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently. By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in CloudWatch metrics that you can collect with CloudWatch RUM. In addition to these default metrics, you can choose to send extended metrics, custom metrics, or both. Extended metrics let you send metrics with additional dimensionsAppMonitorName (string) required
Destination (string) required
DestinationArn (string)
MetricDefinitions (array) required
rum/batch_delete_rum_metric_definitionsRemoves the specified metrics from being sent to an extended metrics destination. If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still deleted. The maximum number of metric definitions that you can specify in one BatchDeleteRumMetricDefinitions operation is 200.AppMonitorName (string) required
Destination (string) required
DestinationArn (string)
MetricDefinitionIds (array) required
rum/batch_get_rum_metric_definitionsRetrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.AppMonitorName (string) required
Destination (string) required
DestinationArn (string)
MaxResults (integer)
NextToken (string)
rum/create_app_monitorCreates 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 applicaName (string) required
Domain (string)
DomainList (array)
Tags (object)
AppMonitorConfiguration: {
. IdentityPoolId (string)
. ExcludedPages (array)
. IncludedPages (array)
. FavoritePages (array)
. SessionSampleRate (number)
. GuestRoleArn (string)
. AllowCookies (boolean)
. Telemetries (array)
. EnableXRay (boolean)
} (object)
CwLogEnabled (boolean)
CustomEvents: {
. Status (string)
} (object)
DeobfuscationConfiguration: {
. JavaScriptSourceMaps (object)
} (object)
Platform (string)
rum/delete_resource_policyRemoves the association of a resource-based policy from an app monitor.Name (string) required
PolicyRevisionId (string)
rum/delete_rum_metrics_destinationDeletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.AppMonitorName (string) required
Destination (string) required
DestinationArn (string)
rum/get_app_monitor_dataRetrieves 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.Name (string) required
TimeRange: {
. After (integer)
. Before (integer)
} (object) required
Filters (array)
MaxResults (integer)
NextToken (string)
rum/get_resource_policyUse this operation to retrieve information about a resource-based policy that is attached to an app monitor.Name (string) required
rum/list_rum_metrics_destinationsReturns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor. For more information about extended metrics, see AddRumMetrics.AppMonitorName (string) required
MaxResults (integer)
NextToken (string)
rum/put_resource_policyUse this operation to assign a resource-based policy to a CloudWatch RUM app monitor to control access to it. Each app monitor can have one resource-based policy. The maximum size of the policy is 4 KB. To learn more about using resource policies with RUM, see Using resource-based policies with CloudWatch RUM.Name (string) required
PolicyDocument (string) required
PolicyRevisionId (string)
rum/put_rum_metrics_destinationCreates or updates a destination to receive extended metrics from CloudWatch RUM. You can send extended metrics to CloudWatch or to a CloudWatch Evidently experiment. For more information about extended metrics, see BatchCreateRumMetricDefinitions.AppMonitorName (string) required
Destination (string) required
DestinationArn (string)
IamRoleArn (string)
rum/update_rum_metric_definitionModifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.AppMonitorName (string) required
Destination (string) required
DestinationArn (string)
MetricDefinition: {
. Name (string)
. ValueKey (string)
. UnitLabel (string)
. DimensionKeys (object)
. EventPattern (string)
. Namespace (string)
} (object) required
MetricDefinitionId (string) required
rum/get_app_monitorRetrieves the complete configuration information for one app monitor.Name (string) required
rum/update_app_monitorUpdates 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 conName (string) required
Domain (string)
DomainList (array)
AppMonitorConfiguration: {
. IdentityPoolId (string)
. ExcludedPages (array)
. IncludedPages (array)
. FavoritePages (array)
. SessionSampleRate (number)
. GuestRoleArn (string)
. AllowCookies (boolean)
. Telemetries (array)
. EnableXRay (boolean)
} (object)
CwLogEnabled (boolean)
CustomEvents: {
. Status (string)
} (object)
DeobfuscationConfiguration: {
. JavaScriptSourceMaps (object)
} (object)
rum/delete_app_monitorDeletes an existing app monitor. This immediately stops the collection of data.Name (string) required
rum/list_app_monitorsReturns a list of the Amazon CloudWatch RUM app monitors in the account.MaxResults (integer)
NextToken (string)
s3_control/associate_access_grants_identity_centerAssociate your S3 Access Grants instance with an Amazon Web Services IAM Identity Center instance. Use this action if you want to create access grants for users or groups from your corporate identity directory. First, you must add your corporate identity directory to Amazon Web Services IAM Identity Center. Then, you can associate this IAM Identity Center instance with your S3 Access Grants instance. Permissions You must have the s3:AssociateAccessGrantsIdentityCenter permission to use this operAccountId (string) required
IdentityCenterArn (string) required
s3_control/create_access_grantCreates an access grant that gives a grantee access to your S3 data. The grantee can be an IAM user or role or a directory user, or group. Before you can create a grant, you must have an S3 Access Grants instance in the same Region as the S3 data. You can create an S3 Access Grants instance using the CreateAccessGrantsInstance. You must also have registered at least one S3 data location in your S3 Access Grants instance using CreateAccessGrantsLocation. Permissions You must have the s3:CreateAccAccountId (string) required
AccessGrantsLocationId (string) required
AccessGrantsLocationConfiguration: {
. S3SubPrefix (string)
} (object)
Grantee: {
. GranteeType (string)
. GranteeIdentifier (string)
} (object) required
Permission (string) required
ApplicationArn (string)
S3PrefixType (string)
Tags (array)
s3_control/create_access_grants_instanceCreates an S3 Access Grants instance, which serves as a logical grouping for access grants. You can create one S3 Access Grants instance per Region per account. Permissions You must have the s3:CreateAccessGrantsInstance permission to use this operation. Additional Permissions To associate an IAM Identity Center instance with your S3 Access Grants instance, you must also have the sso:DescribeInstance, sso:CreateApplication, sso:PutApplicationGrant, and sso:PutApplicationAuthenticationMethod permAccountId (string) required
IdentityCenterArn (string)
Tags (array)
s3_control/create_access_grants_locationThe S3 data location that you would like to register in your S3 Access Grants instance. Your S3 data must be in the same Region as your S3 Access Grants instance. The location can be one of the following: The default S3 location s3:// A bucket - S3:// A bucket and prefix - S3:/// When you register a location, you must include the IAM role that has permission to manage the S3 location that you are registering. Give S3 Access Grants permission to assume this role using a policy. S3 Access Grants aAccountId (string) required
LocationScope (string) required
IAMRoleArn (string) required
Tags (array)
s3_control/create_access_pointCreates an access point and associates it to a specified bucket. For more information, see Managing access to shared datasets with access points or Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide. To create an access point and attach it to a volume on an Amazon FSx file system, see CreateAndAttachS3AccessPoint in the Amazon FSx API Reference. S3 on Outposts only supports VPC-style access points. For more information, see Accessing Amazon S3AccountId (string) required
Name (string) required
Bucket (string) required
VpcConfiguration: {
. VpcId (string)
} (object)
PublicAccessBlockConfiguration: {
. BlockPublicAcls (boolean)
. IgnorePublicAcls (boolean)
. BlockPublicPolicy (boolean)
. RestrictPublicBuckets (boolean)
} (object)
BucketAccountId (string)
Scope: {
. Prefixes (array)
. Permissions (array)
} (object)
Tags (array)
s3_control/create_access_point_for_object_lambdaThis operation is not supported by directory buckets. 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 ListAccessPointsForObjectLambdaAccountId (string) required
Name (string) required
Configuration: {
. SupportingAccessPoint (string)
. CloudWatchMetricsEnabled (boolean)
. AllowedFeatures (array)
. TransformationConfigurations (array)
} (object) required
s3_control/create_bucketThis 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 buckeACL (string)
Bucket (string) required
CreateBucketConfiguration: {
. LocationConstraint (string)
} (object)
GrantFullControl (string)
GrantRead (string)
GrantReadACP (string)
GrantWrite (string)
GrantWriteACP (string)
ObjectLockEnabledForBucket (boolean)
OutpostId (string)
s3_control/create_jobThis operation creates an S3 Batch Operations job. 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. Permissions For information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3 User Guide. Related actions include: DescribAccountId (string) required
ConfirmationRequired (boolean)
Operation: {
. LambdaInvoke (object)
. S3PutObjectCopy (object)
. S3PutObjectAcl (object)
. S3PutObjectTagging (object)
. S3DeleteObjectTagging (object)
. S3InitiateRestoreObject (object)
. S3PutObjectLegalHold (object)
. S3PutObjectRetention (object)
. S3ReplicateObject (object)
. S3ComputeObjectChecksum (object)
. S3UpdateObjectEncryption (object)
} (object) required
Report: {
. Bucket (string)
. Format (string)
. Enabled (boolean)
. Prefix (string)
. ReportScope (string)
. ExpectedBucketOwner (string)
} (object) required
ClientRequestToken (string) required
Manifest: {
. Spec (object)
. Location (object)
} (object)
Description (string)
Priority (integer) required
RoleArn (string) required
Tags (array)
ManifestGenerator (undefined)
s3_control/create_multi_region_access_pointThis operation is not supported by directory buckets. 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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3AccountId (string) required
ClientToken (string) required
Details: {
. Name (string)
. PublicAccessBlock (object)
. Regions (array)
} (object) required
s3_control/create_storage_lens_groupCreates a new S3 Storage Lens group and associates it with the specified Amazon Web Services account ID. An S3 Storage Lens group is a custom grouping of objects based on prefix, suffix, object tags, object size, object age, or a combination of these filters. For each Storage Lens group that you’ve created, you can also optionally add Amazon Web Services resource tags. For more information about S3 Storage Lens groups, see Working with S3 Storage Lens groups. To use this operation, you must haveAccountId (string) required
StorageLensGroup: {
. Name (string)
. Filter (object)
. StorageLensGroupArn (string)
} (object) required
Tags (array)
s3_control/delete_access_grantDeletes the access grant from the S3 Access Grants instance. You cannot undo an access grant deletion and the grantee will no longer have access to the S3 data. Permissions You must have the s3:DeleteAccessGrant permission to use this operation.AccountId (string) required
AccessGrantId (string) required
s3_control/delete_access_grants_instanceDeletes your S3 Access Grants instance. You must first delete the access grants and locations before S3 Access Grants can delete the instance. See DeleteAccessGrant and DeleteAccessGrantsLocation. If you have associated an IAM Identity Center instance with your S3 Access Grants instance, you must first dissassociate the Identity Center instance from the S3 Access Grants instance before you can delete the S3 Access Grants instance. See AssociateAccessGrantsIdentityCenter and DissociateAccessGrantAccountId (string) required
s3_control/delete_access_grants_instance_resource_policyDeletes the resource policy of the S3 Access Grants instance. The resource policy is used to manage cross-account access to your S3 Access Grants instance. By deleting the resource policy, you delete any cross-account permissions to your S3 Access Grants instance. Permissions You must have the s3:DeleteAccessGrantsInstanceResourcePolicy permission to use this operation.AccountId (string) required
s3_control/delete_access_grants_locationDeregisters a location from your S3 Access Grants instance. You can only delete a location registration from an S3 Access Grants instance if there are no grants associated with this location. See Delete a grant for information on how to delete grants. You need to have at least one registered location in your S3 Access Grants instance in order to create access grants. Permissions You must have the s3:DeleteAccessGrantsLocation permission to use this operation.AccountId (string) required
AccessGrantsLocationId (string) required
s3_control/delete_access_pointDeletes 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 actionsAccountId (string) required
Name (string) required
s3_control/delete_access_point_for_object_lambdaThis operation is not supported by directory buckets. Deletes the specified Object Lambda Access Point. The following actions are related to DeleteAccessPointForObjectLambda: CreateAccessPointForObjectLambda GetAccessPointForObjectLambda ListAccessPointsForObjectLambdaAccountId (string) required
Name (string) required
s3_control/delete_access_point_policyDeletes 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 secAccountId (string) required
Name (string) required
s3_control/delete_access_point_policy_for_object_lambdaThis operation is not supported by directory buckets. Removes the resource policy for an Object Lambda Access Point. The following actions are related to DeleteAccessPointPolicyForObjectLambda: GetAccessPointPolicyForObjectLambda PutAccessPointPolicyForObjectLambdaAccountId (string) required
Name (string) required
s3_control/delete_access_point_scopeDeletes an existing access point scope for a directory bucket. When you delete the scope of an access point, all prefixes and permissions are deleted. To use this operation, you must have the permission to perform the s3express:DeleteAccessPointScope action. For information about REST API errors, see REST error responses.AccountId (string) required
Name (string) required
s3_control/delete_bucketThis 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 pasAccountId (string) required
Bucket (string) required
s3_control/delete_bucket_lifecycle_configurationThis 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 rulAccountId (string) required
Bucket (string) required
s3_control/delete_bucket_policyThis 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 buckAccountId (string) required
Bucket (string) required
s3_control/delete_bucket_replicationThis operation deletes an Amazon S3 on Outposts bucket's replication configuration. To delete an S3 bucket's replication configuration, see DeleteBucketReplication in the Amazon S3 API Reference. Deletes the replication configuration from the specified S3 on Outposts bucket. To use this operation, you must have permissions to perform the s3-outposts:PutReplicationConfiguration action. The Outposts bucket owner has this permission by default and can grant it to others. For more information aboutAccountId (string) required
Bucket (string) required
s3_control/delete_bucket_taggingThis 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 actioAccountId (string) required
Bucket (string) required
s3_control/delete_job_taggingRemoves the entire tag set from the specified S3 Batch Operations job. Permissions To use the DeleteJobTagging 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 PutJobTaggingAccountId (string) required
JobId (string) required
s3_control/delete_multi_region_access_pointThis operation is not supported by directory buckets. 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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide. This request is asynchronous, meaniAccountId (string) required
ClientToken (string) required
Details: {
. Name (string)
} (object) required
s3_control/delete_public_access_blockThis operation is not supported by directory buckets. Removes the PublicAccessBlock configuration for an Amazon Web Services account. This operation might be restricted when the account is managed by organization-level Block Public Access policies. You’ll get an Access Denied 403 error when the account is managed by organization-level Block Public Access policies. Organization-level policies override account-level settings, preventing direct account-level modifications. For more information, seeAccountId (string) required
s3_control/delete_storage_lens_configurationThis operation is not supported by directory buckets. 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.ConfigId (string) required
AccountId (string) required
s3_control/delete_storage_lens_configuration_taggingThis operation is not supported by directory buckets. 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.ConfigId (string) required
AccountId (string) required
s3_control/delete_storage_lens_groupDeletes an existing S3 Storage Lens group. To use this operation, you must have the permission to perform the s3:DeleteStorageLensGroup action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups. For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.Name (string) required
AccountId (string) required
s3_control/describe_jobRetrieves the configuration parameters and status for a Batch Operations job. For more information, see S3 Batch Operations in the Amazon S3 User Guide. Permissions To use the DescribeJob operation, you must have permission to perform the s3:DescribeJob action. Related actions include: CreateJob ListJobs UpdateJobPriority UpdateJobStatusAccountId (string) required
JobId (string) required
s3_control/describe_multi_region_access_point_operationThis operation is not supported by directory buckets. 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 Using Multi-Region Access Points in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPoint: CreateMultiRegionAccessPoint DeleteMultiRegionAccessPoint GetMultiRegionAccessPoint ListMultiRegionAccessPointsAccountId (string) required
RequestTokenARN (string) required
s3_control/dissociate_access_grants_identity_centerDissociates the Amazon Web Services IAM Identity Center instance from the S3 Access Grants instance. Permissions You must have the s3:DissociateAccessGrantsIdentityCenter permission to use this operation. Additional Permissions You must have the sso:DeleteApplication permission to use this operation.AccountId (string) required
s3_control/get_access_grantGet the details of an access grant from your S3 Access Grants instance. Permissions You must have the s3:GetAccessGrant permission to use this operation.AccountId (string) required
AccessGrantId (string) required
s3_control/get_access_grants_instanceRetrieves the S3 Access Grants instance for a Region in your account. Permissions You must have the s3:GetAccessGrantsInstance permission to use this operation. GetAccessGrantsInstance is not supported for cross-account access. You can only call the API from the account that owns the S3 Access Grants instance.AccountId (string) required
s3_control/get_access_grants_instance_for_prefixRetrieve the S3 Access Grants instance that contains a particular prefix. Permissions You must have the s3:GetAccessGrantsInstanceForPrefix permission for the caller account to use this operation. Additional Permissions The prefix owner account must grant you the following permissions to their S3 Access Grants instance: s3:GetAccessGrantsInstanceForPrefix.AccountId (string) required
S3Prefix (string) required
s3_control/get_access_grants_instance_resource_policyReturns the resource policy of the S3 Access Grants instance. Permissions You must have the s3:GetAccessGrantsInstanceResourcePolicy permission to use this operation.AccountId (string) required
s3_control/get_access_grants_locationRetrieves the details of a particular location registered in your S3 Access Grants instance. Permissions You must have the s3:GetAccessGrantsLocation permission to use this operation.AccountId (string) required
AccessGrantsLocationId (string) required
s3_control/get_access_pointReturns 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 ExamplesAccountId (string) required
Name (string) required
s3_control/get_access_point_configuration_for_object_lambdaThis operation is not supported by directory buckets. Returns configuration for an Object Lambda Access Point. The following actions are related to GetAccessPointConfigurationForObjectLambda: PutAccessPointConfigurationForObjectLambdaAccountId (string) required
Name (string) required
s3_control/get_access_point_for_object_lambdaThis operation is not supported by directory buckets. Returns configuration information about the specified Object Lambda Access Point The following actions are related to GetAccessPointForObjectLambda: CreateAccessPointForObjectLambda DeleteAccessPointForObjectLambda ListAccessPointsForObjectLambdaAccountId (string) required
Name (string) required
s3_control/get_access_point_policyReturns the access point policy associated with the specified access point. The following actions are related to GetAccessPointPolicy: PutAccessPointPolicy DeleteAccessPointPolicyAccountId (string) required
Name (string) required
s3_control/get_access_point_policy_for_object_lambdaThis operation is not supported by directory buckets. Returns the resource policy for an Object Lambda Access Point. The following actions are related to GetAccessPointPolicyForObjectLambda: DeleteAccessPointPolicyForObjectLambda PutAccessPointPolicyForObjectLambdaAccountId (string) required
Name (string) required
s3_control/get_access_point_policy_statusThis operation is not supported by directory buckets. 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.AccountId (string) required
Name (string) required
s3_control/get_access_point_policy_status_for_object_lambdaThis operation is not supported by directory buckets. Returns the status of the resource policy associated with an Object Lambda Access Point.AccountId (string) required
Name (string) required
s3_control/get_access_point_scopeReturns the access point scope for a directory bucket. To use this operation, you must have the permission to perform the s3express:GetAccessPointScope action. For information about REST API errors, see REST error responses.AccountId (string) required
Name (string) required
s3_control/get_bucketGets 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 pAccountId (string) required
Bucket (string) required
s3_control/get_bucket_lifecycle_configurationThis 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-outpostsAccountId (string) required
Bucket (string) required
s3_control/get_bucket_policyThis 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 tAccountId (string) required
Bucket (string) required
s3_control/get_bucket_replicationThis operation gets an Amazon S3 on Outposts bucket's replication configuration. To get an S3 bucket's replication configuration, see GetBucketReplication in the Amazon S3 API Reference. Returns the replication configuration of an S3 on Outposts bucket. For more information about S3 on Outposts, see Using Amazon S3 on Outposts in the Amazon S3 User Guide. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide. It canAccountId (string) required
Bucket (string) required
s3_control/get_bucket_taggingThis 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:AccountId (string) required
Bucket (string) required
s3_control/get_bucket_versioningThis operation returns the versioning state for S3 on Outposts buckets only. 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 S3 Versioning, you can save multiple distinct copies of your objects 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 requeAccountId (string) required
Bucket (string) required
s3_control/get_data_accessReturns a temporary access credential from S3 Access Grants to the grantee or client application. The temporary credential is an Amazon Web Services STS token that grants them access to the S3 data. Permissions You must have the s3:GetDataAccess permission to use this operation. Additional Permissions The IAM role that S3 Access Grants assumes must have the following permissions specified in the trust policy when registering the location: sts:AssumeRole, for directory users or groups sts:SetContAccountId (string) required
Target (string) required
Permission (string) required
DurationSeconds (integer)
Privilege (string)
TargetType (string)
s3_control/get_job_taggingReturns the tags on an S3 Batch Operations job. Permissions To use the GetJobTagging 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 DeleteJobTaggingAccountId (string) required
JobId (string) required
s3_control/get_multi_region_access_pointThis operation is not supported by directory buckets. 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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPoint: CreateMultiRegionAccessPoint DeleteMultiRegionAccessPointAccountId (string) required
Name (string) required
s3_control/get_multi_region_access_point_policyThis operation is not supported by directory buckets. 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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPointPolicy: GetMultiRegionAccessPointPolicyStatus PutMultiRegionAcAccountId (string) required
Name (string) required
s3_control/get_multi_region_access_point_policy_statusThis operation is not supported by directory buckets. 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 working with Multi-Region Access Points, see Multi-Region Access Point restrictions and limitations in the Amazon S3 User Guide. The following actions are related to GetMultiRegionAccessPointPolicyStatus: GetMultiRegiAccountId (string) required
Name (string) required
s3_control/get_multi_region_access_point_routesThis operation is not supported by directory buckets. Returns the routing configuration for a Multi-Region Access Point, indicating which Regions are active or passive. To obtain routing control changes and failover requests, use the Amazon S3 failover control infrastructure endpoints in these five Amazon Web Services Regions: us-east-1 us-west-2 ap-southeast-2 ap-northeast-1 eu-west-1AccountId (string) required
Mrap (string) required
s3_control/get_public_access_blockThis operation is not supported by directory buckets. Retrieves the PublicAccessBlock configuration for an Amazon Web Services account. This operation returns the effective account-level configuration, which may inherit from organization-level policies. For more information, see Using Amazon S3 block public access. Related actions include: DeletePublicAccessBlock PutPublicAccessBlockAccountId (string) required
s3_control/get_storage_lens_configurationThis operation is not supported by directory buckets. 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. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary 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 SConfigId (string) required
AccountId (string) required
s3_control/get_storage_lens_configuration_taggingThis operation is not supported by directory buckets. 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.ConfigId (string) required
AccountId (string) required
s3_control/get_storage_lens_groupRetrieves the Storage Lens group configuration details. To use this operation, you must have the permission to perform the s3:GetStorageLensGroup action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups. For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.Name (string) required
AccountId (string) required
s3_control/list_access_grantsReturns the list of access grants in your S3 Access Grants instance. Permissions You must have the s3:ListAccessGrants permission to use this operation.AccountId (string) required
NextToken (string)
MaxResults (integer)
GranteeType (string)
GranteeIdentifier (string)
Permission (string)
GrantScope (string)
ApplicationArn (string)
s3_control/list_access_grants_instancesReturns a list of S3 Access Grants instances. An S3 Access Grants instance serves as a logical grouping for your individual access grants. You can only have one S3 Access Grants instance per Region per account. Permissions You must have the s3:ListAccessGrantsInstances permission to use this operation.AccountId (string) required
NextToken (string)
MaxResults (integer)
s3_control/list_access_grants_locationsReturns a list of the locations registered in your S3 Access Grants instance. Permissions You must have the s3:ListAccessGrantsLocations permission to use this operation.AccountId (string) required
NextToken (string)
MaxResults (integer)
LocationScope (string)
s3_control/list_access_pointsThis operation is not supported by directory buckets. Returns a list of the access points. You can retrieve up to 1,000 access points per call. If the call returns 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. Returns only access points attached to S3 buckets by default. To return all access points specify DataSourceType as ALL. All Amazon S3 on OutpostsAccountId (string) required
Bucket (string)
NextToken (string)
MaxResults (integer)
DataSourceId (string)
DataSourceType (string)
s3_control/list_access_points_for_directory_bucketsReturns a list of the access points that are owned by the Amazon Web Services account and that are associated with the specified directory bucket. To list access points for general purpose buckets, see ListAccesspoints. To use this operation, you must have the permission to perform the s3express:ListAccessPointsForDirectoryBuckets action. For information about REST API errors, see REST error responses.AccountId (string) required
DirectoryBucket (string)
NextToken (string)
MaxResults (integer)
s3_control/list_access_points_for_object_lambdaThis operation is not supported by directory buckets. 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 GetAccessPointForObjectLambdaAccountId (string) required
NextToken (string)
MaxResults (integer)
s3_control/list_caller_access_grantsUse this API to list the access grants that grant the caller access to Amazon S3 data through S3 Access Grants. The caller grantee can be an Identity and Access Management IAM identity or Amazon Web Services Identity Center corporate directory identity. You must pass the Amazon Web Services account of the S3 data owner grantor in the request. You can, optionally, narrow the results by GrantScope, using a fragment of the data's S3 path, and S3 Access Grants will return only the grants with a pathAccountId (string) required
GrantScope (string)
NextToken (string)
MaxResults (integer)
AllowedByApplication (boolean)
s3_control/list_jobsLists current S3 Batch Operations jobs as well as the jobs that have ended within the last 90 days for the Amazon Web Services account making the request. For more information, see S3 Batch Operations in the Amazon S3 User Guide. Permissions To use the ListJobs operation, you must have permission to perform the s3:ListJobs action. Related actions include: CreateJob DescribeJob UpdateJobPriority UpdateJobStatusAccountId (string) required
JobStatuses (array)
NextToken (string)
MaxResults (integer)
s3_control/list_multi_region_access_pointsThis operation is not supported by directory buckets. 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 working with Multi-Region Access Points, see Multi-Region AAccountId (string) required
NextToken (string)
MaxResults (integer)
s3_control/list_regional_bucketsThis operation is not supported by directory buckets. 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.AccountId (string) required
NextToken (string)
MaxResults (integer)
OutpostId (string)
s3_control/list_storage_lens_configurationsThis operation is not supported by directory buckets. 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.AccountId (string) required
NextToken (string)
s3_control/list_storage_lens_groupsLists all the Storage Lens groups in the specified home Region. To use this operation, you must have the permission to perform the s3:ListStorageLensGroups action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups. For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.AccountId (string) required
NextToken (string)
s3_control/list_tags_for_resourceThis operation allows you to list all of the tags for a specified resource. Each tag is a label consisting of a key and value. Tags can help you organize, track costs for, and control access to resources. This operation is only supported for the following Amazon S3 resources: General purpose buckets Access Points for directory buckets Access Points for general purpose buckets Directory buckets S3 Storage Lens groups S3 Access Grants instances, registered locations, and grants. Permissions For geAccountId (string) required
ResourceArn (string) required
s3_control/put_access_grants_instance_resource_policyUpdates the resource policy of the S3 Access Grants instance. Permissions You must have the s3:PutAccessGrantsInstanceResourcePolicy permission to use this operation.AccountId (string) required
Policy (string) required
Organization (string)
s3_control/put_access_point_configuration_for_object_lambdaThis operation is not supported by directory buckets. Replaces configuration for an Object Lambda Access Point. The following actions are related to PutAccessPointConfigurationForObjectLambda: GetAccessPointConfigurationForObjectLambdaAccountId (string) required
Name (string) required
Configuration: {
. SupportingAccessPoint (string)
. CloudWatchMetricsEnabled (boolean)
. AllowedFeatures (array)
. TransformationConfigurations (array)
} (object) required
s3_control/put_access_point_policyAssociates 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 OutAccountId (string) required
Name (string) required
Policy (string) required
s3_control/put_access_point_policy_for_object_lambdaThis operation is not supported by directory buckets. 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 GetAccessPointPolicyForObjectLambdaAccountId (string) required
Name (string) required
Policy (string) required
s3_control/put_access_point_scopeCreates or replaces the access point scope for a directory bucket. You can use the access point scope to restrict access to specific prefixes, API operations, or a combination of both. You can specify any amount of prefixes, but the total length of characters of all prefixes must be less than 256 bytes in size. To use this operation, you must have the permission to perform the s3express:PutAccessPointScope action. For information about REST API errors, see REST error responses.AccountId (string) required
Name (string) required
Scope: {
. Prefixes (array)
. Permissions (array)
} (object) required
s3_control/put_bucket_lifecycle_configurationThis 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 APAccountId (string) required
Bucket (string) required
LifecycleConfiguration: {
. Rules (array)
} (object)
s3_control/put_bucket_policyThis 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 OutpoAccountId (string) required
Bucket (string) required
ConfirmRemoveSelfBucketAccess (boolean)
Policy (string) required
s3_control/put_bucket_replicationThis action creates an Amazon S3 on Outposts bucket's replication configuration. To create an S3 bucket's replication configuration, see PutBucketReplication in the Amazon S3 API Reference. Creates a replication configuration or replaces an existing one. For information about S3 replication on Outposts configuration, see Replicating objects for S3 on Outposts in the Amazon S3 User Guide. It can take a while to propagate PUT or DELETE requests for a replication configuration to all S3 on OutpostsAccountId (string) required
Bucket (string) required
ReplicationConfiguration: {
. Role (string)
. Rules (array)
} (object) required
s3_control/put_bucket_taggingThis 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, organiAccountId (string) required
Bucket (string) required
Tagging: {
. TagSet (array)
} (object) required
s3_control/put_bucket_versioningThis operation sets the versioning state for S3 on Outposts buckets only. 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 S3 Versioning, you can save multiple distinct copies of your objects 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 objecAccountId (string) required
Bucket (string) required
MFA (string)
VersioningConfiguration: {
. MFADelete (string)
. Status (string)
} (object) required
s3_control/put_job_taggingSets 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 operation to replace the tag set with the one youAccountId (string) required
JobId (string) required
Tags (array) required
s3_control/put_multi_region_access_point_policyThis operation is not supported by directory buckets. 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 working with Multi-Region Access Points, see Multi-Region AccessAccountId (string) required
ClientToken (string) required
Details: {
. Name (string)
. Policy (string)
} (object) required
s3_control/put_public_access_blockThis operation is not supported by directory buckets. Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. This operation may be restricted when the account is managed by organization-level Block Public Access policies. You might get an Access Denied 403 error when the account is managed by organization-level Block Public Access policies. Organization-level policies override account-level settings, preventing direct account-level modifications. For this opePublicAccessBlockConfiguration: {
. BlockPublicAcls (boolean)
. IgnorePublicAcls (boolean)
. BlockPublicPolicy (boolean)
. RestrictPublicBuckets (boolean)
} (object) required
AccountId (string) required
s3_control/put_storage_lens_configurationThis operation is not supported by directory buckets. 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. For a complete list of S3 Storage Lens metrics, see S3 Storage Lens metrics glossary 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 LenConfigId (string) required
AccountId (string) required
StorageLensConfiguration: {
. Id (string)
. AccountLevel (object)
. Include (object)
. Exclude (object)
. DataExport (object)
. ExpandedPrefixesDataExport (object)
. IsEnabled (boolean)
. AwsOrg (object)
. StorageLensArn (string)
. PrefixDelimiter (string)
} (object) required
Tags (array)
s3_control/put_storage_lens_configuration_taggingThis operation is not supported by directory buckets. 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.ConfigId (string) required
AccountId (string) required
Tags (array) required
s3_control/submit_multi_region_access_point_routesThis operation is not supported by directory buckets. Submits an updated route configuration for a Multi-Region Access Point. This API operation updates the routing status for the specified Regions from active to passive, or from passive to active. A value of 0 indicates a passive status, which means that traffic won't be routed to the specified Region. A value of 100 indicates an active status, which means that traffic will be routed to the specified Region. At least one Region must be active aAccountId (string) required
Mrap (string) required
RouteUpdates (array) required
s3_control/tag_resourceCreates a new user-defined tag or updates an existing tag. Each tag is a label consisting of a key and value that is applied to your resource. Tags can help you organize, track costs for, and control access to your resources. You can add up to 50 Amazon Web Services resource tags for each S3 resource. This operation is only supported for the following Amazon S3 resource: General purpose buckets Access Points for directory buckets Access Points for general purpose buckets Directory buckets S3 StoAccountId (string) required
ResourceArn (string) required
Tags (array) required
s3_control/untag_resourceThis operation removes the specified user-defined tags from an S3 resource. You can pass one or more tag keys. This operation is only supported for the following Amazon S3 resources: General purpose buckets Access Points for directory buckets Access Points for general purpose buckets Directory buckets S3 Storage Lens groups S3 Access Grants instances, registered locations, and grants. Permissions For general purpose buckets, access points for general purpose buckets, Storage Lens groups, and S3AccountId (string) required
ResourceArn (string) required
TagKeys (array) required
s3_control/update_access_grants_locationUpdates the IAM role of a registered location in your S3 Access Grants instance. Permissions You must have the s3:UpdateAccessGrantsLocation permission to use this operation. Additional Permissions You must also have the following permission: iam:PassRoleAccountId (string) required
AccessGrantsLocationId (string) required
IAMRoleArn (string) required
s3_control/update_job_priorityUpdates an existing S3 Batch Operations job's priority. For more information, see S3 Batch Operations in the Amazon S3 User Guide. Permissions To use the UpdateJobPriority operation, you must have permission to perform the s3:UpdateJobPriority action. Related actions include: CreateJob ListJobs DescribeJob UpdateJobStatusAccountId (string) required
JobId (string) required
Priority (integer) required
s3_control/update_job_statusUpdates the status for the specified job. Use this operation 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. Permissions To use the UpdateJobStatus operation, you must have permission to perform the s3:UpdateJobStatus action. Related actions include: CreateJob ListJobs DescribeJob UpdateJobStatusAccountId (string) required
JobId (string) required
RequestedJobStatus (string) required
StatusUpdateReason (string)
s3_control/update_storage_lens_groupUpdates the existing Storage Lens group. To use this operation, you must have the permission to perform the s3:UpdateStorageLensGroup action. For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups. For information about Storage Lens groups errors, see List of Amazon S3 Storage Lens error codes.Name (string) required
AccountId (string) required
StorageLensGroup: {
. Name (string)
. Filter (object)
. StorageLensGroupArn (string)
} (object) required
s3/abort_multipart_uploadThis operation 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 aBucket (string) required
Key (string) required
UploadId (string) required
RequestPayer (string)
ExpectedBucketOwner (string)
IfMatchInitiatedTime (string)
s3/complete_multipart_uploadCompletes a multipart upload by assembling previously uploaded parts. You first initiate the multipart upload and then upload all parts using the UploadPart operation or the UploadPartCopy operation. After successfully uploading all relevant parts of an upload, you call this CompleteMultipartUpload operation 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 CompleteMultipartUpload request, yoBucket (string) required
Key (string) required
MultipartUpload: {
. Parts (array)
} (object)
UploadId (string) required
ChecksumCRC32 (string)
ChecksumCRC32C (string)
ChecksumCRC64NVME (string)
ChecksumSHA1 (string)
ChecksumSHA256 (string)
ChecksumType (string)
MpuObjectSize (integer)
RequestPayer (string)
ExpectedBucketOwner (string)
IfMatch (string)
IfNoneMatch (string)
SSECustomerAlgorithm (string)
SSECustomerKey (string)
SSECustomerKeyMD5 (string)
s3/copy_objectCreates a copy of an object that is already stored in Amazon S3. End of support notice: As of October 1, 2025, Amazon S3 has discontinued support for Email Grantee Access Control Lists ACLs. If you attempt to use an Email Grantee ACL in a request after October 1, 2025, the request will receive an HTTP 405 Method Not Allowed error. This change affects the following Amazon Web Services Regions: US East N. Virginia, US West N. California, US West Oregon, Asia Pacific Singapore, Asia Pacific Sydney,ACL (string)
Bucket (string) required
CacheControl (string)
ChecksumAlgorithm (string)
ContentDisposition (string)
ContentEncoding (string)
ContentLanguage (string)
ContentType (string)
CopySource (string) required
CopySourceIfMatch (string)
CopySourceIfModifiedSince (string)
CopySourceIfNoneMatch (string)
CopySourceIfUnmodifiedSince (string)
Expires (string)
GrantFullControl (string)
GrantRead (string)
GrantReadACP (string)
GrantWriteACP (string)
IfMatch (string)
IfNoneMatch (string)
Key (string) required
Metadata (object)
MetadataDirective (string)
TaggingDirective (string)
ServerSideEncryption (string)
StorageClass (string)
WebsiteRedirectLocation (string)
SSECustomerAlgorithm (string)
SSECustomerKey (string)
SSECustomerKeyMD5 (string)
SSEKMSKeyId (string)
SSEKMSEncryptionContext (string)
BucketKeyEnabled (boolean)
CopySourceSSECustomerAlgorithm (string)
CopySourceSSECustomerKey (string)
CopySourceSSECustomerKeyMD5 (string)
RequestPayer (string)
Tagging (string)
ObjectLockMode (string)
ObjectLockRetainUntilDate (string)
ObjectLockLegalHoldStatus (string)
ExpectedBucketOwner (string)
ExpectedSourceBucketOwner (string)
s3/create_bucketThis action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see CreateBucket . Creates a new S3 bucket. To create a bucket, you must set up 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. There are two types of buckets: general purpose buckets and directory buckets. For more information about these bucket types, see Creating,ACL (string)
Bucket (string) required
CreateBucketConfiguration: {
. LocationConstraint (string)
. Location (object)
. Bucket (object)
. Tags (array)
} (object)
GrantFullControl (string)
GrantRead (string)
GrantReadACP (string)
GrantWrite (string)
GrantWriteACP (string)
ObjectLockEnabledForBucket (boolean)
ObjectOwnership (string)
s3/create_bucket_metadata_configurationCreates an S3 Metadata V2 metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. Permissions To use this operation, you must have the following permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. If you want to encrypt your metadata tables with server-side encryption with Key Management Service KMS keys SSE-KMS, you need additionBucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
MetadataConfiguration: {
. JournalTableConfiguration (object)
. InventoryTableConfiguration (object)
} (object) required
ExpectedBucketOwner (string)
s3/create_bucket_metadata_table_configurationWe recommend that you create your S3 Metadata configurations by using the V2 CreateBucketMetadataConfiguration API operation. We no longer recommend using the V1 CreateBucketMetadataTableConfiguration API operation. If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table. Creates a V1 S3 Metadata configBucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
MetadataTableConfiguration: {
. S3TablesDestination (object)
} (object) required
ExpectedBucketOwner (string)
s3/create_multipart_uploadEnd of support notice: As of October 1, 2025, Amazon S3 has discontinued support for Email Grantee Access Control Lists ACLs. If you attempt to use an Email Grantee ACL in a request after October 1, 2025, the request will receive an HTTP 405 Method Not Allowed error. This change affects 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, and South America São Paulo.ACL (string)
Bucket (string) required
CacheControl (string)
ContentDisposition (string)
ContentEncoding (string)
ContentLanguage (string)
ContentType (string)
Expires (string)
GrantFullControl (string)
GrantRead (string)
GrantReadACP (string)
GrantWriteACP (string)
Key (string) required
Metadata (object)
ServerSideEncryption (string)
StorageClass (string)
WebsiteRedirectLocation (string)
SSECustomerAlgorithm (string)
SSECustomerKey (string)
SSECustomerKeyMD5 (string)
SSEKMSKeyId (string)
SSEKMSEncryptionContext (string)
BucketKeyEnabled (boolean)
RequestPayer (string)
Tagging (string)
ObjectLockMode (string)
ObjectLockRetainUntilDate (string)
ObjectLockLegalHoldStatus (string)
ExpectedBucketOwner (string)
ChecksumAlgorithm (string)
ChecksumType (string)
s3/create_sessionCreates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint API operations on directory buckets. For more information about Zonal endpoint API operations that include the Availability Zone in the request endpoint, see S3 Express One Zone APIs in the Amazon S3 User Guide. To make Zonal endpoint API requests on a directory bucket, use the CreateSession API operation. Specifically, you grant s3express:CreateSession permisSessionMode (string)
Bucket (string) required
ServerSideEncryption (string)
SSEKMSKeyId (string)
SSEKMSEncryptionContext (string)
BucketKeyEnabled (boolean)
s3/delete_bucketDeletes 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. Directory buckets - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed. Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the fBucket (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_analytics_configurationThis operation is not supported for directory buckets. 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 S3Bucket (string) required
Id (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_corsThis operation is not supported for directory buckets. 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 You must URL encode any signed header values that contaBucket (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_encryptionThis implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys SSE-S3. General purpose buckets - For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide. Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption configuration in directBucket (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_intelligent_tiering_configurationThis operation is not supported for directory buckets. 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 beBucket (string) required
Id (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_inventory_configurationThis operation is not supported for directory buckets. Deletes an S3 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 ResourceBucket (string) required
Id (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_lifecycleDeletes 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. Permissions General purpose bucket permissions - By default, all Amazon S3 resources are private, including buckets, objects, and related subresources for example, lifBucket (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_metadata_configurationDeletes an S3 Metadata configuration from a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. You can use the V2 DeleteBucketMetadataConfiguration API operation with V1 or V2 metadata configurations. However, if you try to use the V1 DeleteBucketMetadataTableConfiguration API operation with V2 configurations, you will receive an HTTP 405 Method Not Allowed error. Permissions To use this operation, you must have the s3:DeleBucket (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_metadata_table_configurationWe recommend that you delete your S3 Metadata configurations by using the V2 DeleteBucketMetadataTableConfiguration API operation. We no longer recommend using the V1 DeleteBucketMetadataTableConfiguration API operation. If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table. Deletes a V1 S3 Metadata cBucket (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_metrics_configurationThis operation is not supported for directory buckets. 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 PermissiBucket (string) required
Id (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_ownership_controlsThis operation is not supported for directory buckets. 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 You must URL encodBucket (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_policyDeletes the policy of a specified bucket. Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For mBucket (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_replicationThis operation is not supported for directory buckets. 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 replicatiBucket (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_taggingThis operation is not supported for directory buckets. Deletes tags from the general purpose bucket if attribute based access control ABAC is not enabled for the bucket. When you enable ABAC for a general purpose bucket, you can no longer use this operation for that bucket and must use UntagResource instead. if ABAC is not enabled for the bucket. When you enable ABAC for a general purpose bucket, you can no longer use this operation for that bucket and must use UntagResource instead. To use thisBucket (string) required
ExpectedBucketOwner (string)
s3/delete_bucket_websiteThis operation is not supported for directory buckets. 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. ByBucket (string) required
ExpectedBucketOwner (string)
s3/delete_objectRemoves an object from a bucket. The behavior depends on the bucket's versioning state: If bucket versioning is not enabled, the operation permanently deletes the object. If bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object. To permanently delete an object in a versioned bucket, you must include the object’s versionId in the request. For more information about versioning-enabled buckets, see Deleting object versions from a versioBucket (string) required
Key (string) required
MFA (string)
VersionId (string)
RequestPayer (string)
BypassGovernanceRetention (boolean)
ExpectedBucketOwner (string)
IfMatch (string)
IfMatchLastModifiedTime (string)
IfMatchSize (integer)
s3/delete_objectsThis operation 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 operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead. The request can contain a list of up to 1,000 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-enablBucket (string) required
Delete: {
. Objects (array)
. Quiet (boolean)
} (object) required
MFA (string)
RequestPayer (string)
BypassGovernanceRetention (boolean)
ExpectedBucketOwner (string)
ChecksumAlgorithm (string)
s3/delete_object_taggingThis operation is not supported for directory buckets. 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 DeleteObjectTagging: PBucket (string) required
Key (string) required
VersionId (string)
ExpectedBucketOwner (string)
s3/delete_public_access_blockThis operation is not supported for directory buckets. Removes the PublicAccessBlock configuration for an Amazon S3 bucket. This operation removes the bucket-level configuration only. The effective public access behavior will still be governed by account-level settings which may inherit from organization-level policies. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource OperationBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_abacReturns the attribute-based access control ABAC property of the general purpose bucket. If ABAC is enabled on your bucket, you can use tags on the bucket for access control. For more information, see Enabling ABAC in general purpose buckets.Bucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_accelerate_configurationThis operation is not supported for directory buckets. 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. TBucket (string) required
ExpectedBucketOwner (string)
RequestPayer (string)
s3/get_bucket_aclThis operation is not supported for directory buckets. 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 the 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. When you use this API operation with an access point, provide the alias of the access point in place of tBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_analytics_configurationThis operation is not supported for directory buckets. 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 ManagBucket (string) required
Id (string) required
ExpectedBucketOwner (string)
s3/get_bucket_corsThis operation is not supported for directory buckets. 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. When you use this API operation with an access point, provide the alias of the access point in place of the bucket name. When you use this API operation with an Object Lambda access pointBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_encryptionReturns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys SSE-S3. This operation also returns the BucketKeyEnabled and BlockedEncryptionTypes statuses. General purpose buckets - For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide. Directory buckets - For directory buckets, there are onBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_intelligent_tiering_configurationThis operation is not supported for directory buckets. 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 accBucket (string) required
Id (string) required
ExpectedBucketOwner (string)
s3/get_bucket_inventory_configurationThis operation is not supported for directory buckets. Returns an S3 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 ResourceBucket (string) required
Id (string) required
ExpectedBucketOwner (string)
s3/get_bucket_lifecycle_configurationReturns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management. Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API, which is compatible with the new functionality. The previous version of the API supported filtering based only on an object key nBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_locationUsing the GetBucketLocation operation is no longer a best practice. To return the Region that a bucket resides in, we recommend that you use the HeadBucket operation instead. For backward compatibility, Amazon S3 continues to support the GetBucketLocation operation. 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. In a bucket's home Region, calls to the GetBucketBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_loggingThis operation is not supported for directory buckets. Returns the logging status of a bucket and the permissions users have to view and modify that status. The following operations are related to GetBucketLogging: CreateBucket PutBucketLogging You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.Bucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_metadata_configurationRetrieves the S3 Metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. You can use the V2 GetBucketMetadataConfiguration API operation with V1 or V2 metadata configurations. However, if you try to use the V1 GetBucketMetadataTableConfiguration API operation with V2 configurations, you will receive an HTTP 405 Method Not Allowed error. Permissions To use this operation, you must have the s3:GetBuckeBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_metadata_table_configurationWe recommend that you retrieve your S3 Metadata configurations by using the V2 GetBucketMetadataTableConfiguration API operation. We no longer recommend using the V1 GetBucketMetadataTableConfiguration API operation. If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table. Retrieves the V1 S3 Metadata cBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_metrics_configurationThis operation is not supported for directory buckets. 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 OperationsBucket (string) required
Id (string) required
ExpectedBucketOwner (string)
s3/get_bucket_notification_configurationThis operation is not supported for directory buckets. 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. When you use this API operationBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_ownership_controlsThis operation is not supported for directory buckets. 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. A bucket doesn't have OwnershipControls settings in the following cases: The bucket was created before the BucketOwnerEnforced ownership setting was introduced and you've never explicitly applied this value You've manuaBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_policyReturns the policy of a specified bucket. Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For mBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_policy_statusThis operation is not supported for directory buckets. 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 AmazonBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_replicationThis operation is not supported for directory buckets. 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 permissionsBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_request_paymentThis operation is not supported for directory buckets. 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 You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.Bucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_taggingThis operation is not supported for directory buckets. Returns the tag set associated with the general purpose bucket. if ABAC is not enabled for the bucket. When you enable ABAC for a general purpose bucket, you can no longer use this operation for that bucket and must use ListTagsForResource instead. 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. GetBucketTagginBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_versioningThis operation is not supported for directory buckets. 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 You must URL encodeBucket (string) required
ExpectedBucketOwner (string)
s3/get_bucket_websiteThis operation is not supported for directory buckets. 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 configuratiBucket (string) required
ExpectedBucketOwner (string)
s3/get_objectRetrieves an object from Amazon S3. In the GetObject request, specify the full key name for the object. General purpose buckets - Both the virtual-hosted-style requests and the path-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the object key name 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,Bucket (string) required
IfMatch (string)
IfModifiedSince (string)
IfNoneMatch (string)
IfUnmodifiedSince (string)
Key (string) required
Range (string)
ResponseCacheControl (string)
ResponseContentDisposition (string)
ResponseContentEncoding (string)
ResponseContentLanguage (string)
ResponseContentType (string)
ResponseExpires (string)
VersionId (string)
SSECustomerAlgorithm (string)
SSECustomerKey (string)
SSECustomerKeyMD5 (string)
RequestPayer (string)
PartNumber (integer)
ExpectedBucketOwner (string)
ChecksumMode (string)
s3/get_object_aclThis operation is not supported for directory buckets. 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 functionality is not supported for Amazon S3 on Outposts. By default, GET returns ACL information about the current version of an object. To return ACL information about a differenBucket (string) required
Key (string) required
VersionId (string)
RequestPayer (string)
ExpectedBucketOwner (string)
s3/get_object_attributesRetrieves all of the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata. GetObjectAttributes combines the functionality of HeadObject and ListParts. All of the data returned with both of those individual calls can be returned with a single call to GetObjectAttributes. Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hoBucket (string) required
Key (string) required
VersionId (string)
MaxParts (integer)
PartNumberMarker (string)
SSECustomerAlgorithm (string)
SSECustomerKey (string)
SSECustomerKeyMD5 (string)
RequestPayer (string)
ExpectedBucketOwner (string)
ObjectAttributes (array) required
s3/get_object_legal_holdThis operation is not supported for directory buckets. Gets an object's current legal hold status. For more information, see Locking Objects. This functionality is not supported for Amazon S3 on Outposts. The following action is related to GetObjectLegalHold: GetObjectAttributes You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.Bucket (string) required
Key (string) required
VersionId (string)
RequestPayer (string)
ExpectedBucketOwner (string)
s3/get_object_lock_configurationThis operation is not supported for directory buckets. 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 You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces aBucket (string) required
ExpectedBucketOwner (string)
s3/get_object_retentionThis operation is not supported for directory buckets. Retrieves an object's retention settings. For more information, see Locking Objects. This functionality is not supported for Amazon S3 on Outposts. The following action is related to GetObjectRetention: GetObjectAttributes You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.Bucket (string) required
Key (string) required
VersionId (string)
RequestPayer (string)
ExpectedBucketOwner (string)
s3/get_object_taggingThis operation is not supported for directory buckets. 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 paramBucket (string) required
Key (string) required
VersionId (string)
ExpectedBucketOwner (string)
RequestPayer (string)
s3/get_object_torrentThis operation is not supported for directory buckets. Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. 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 functionality is not supported for Amazon S3 on Outposts. The following action is related to GetObjectTorrent:Bucket (string) required
Key (string) required
RequestPayer (string)
ExpectedBucketOwner (string)
s3/get_public_access_blockThis operation is not supported for directory buckets. Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. This operation returns the bucket-level configuration only. To understand the effective public access behavior, you must also consider account-level settings which may inherit from organization-level policies. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in aBucket (string) required
ExpectedBucketOwner (string)
s3/head_bucketYou can use this operation to determine if a bucket exists and if you have permission to access it. The action returns a 200 OK HTTP status code if the bucket exists and you have permission to access it. You can make a HeadBucket call on any bucket name to any Region in the partition, and regardless of the permissions on the bucket, you will receive a response header with the correct bucket location so that you can then make a proper, signed request to the appropriate Regional endpoint. If the bBucket (string) required
ExpectedBucketOwner (string)
s3/head_objectThe HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata. A HEAD request has the same options as a GET operation 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 code, such as 400 Bad Request, 403 Forbidden, 404 Not Found, 405 Method Not Allowed, 412 PreconditionBucket (string) required
IfMatch (string)
IfModifiedSince (string)
IfNoneMatch (string)
IfUnmodifiedSince (string)
Key (string) required
Range (string)
ResponseCacheControl (string)
ResponseContentDisposition (string)
ResponseContentEncoding (string)
ResponseContentLanguage (string)
ResponseContentType (string)
ResponseExpires (string)
VersionId (string)
SSECustomerAlgorithm (string)
SSECustomerKey (string)
SSECustomerKeyMD5 (string)
RequestPayer (string)
PartNumber (integer)
ExpectedBucketOwner (string)
ChecksumMode (string)
s3/list_bucket_analytics_configurationsThis operation is not supported for directory buckets. 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 valueBucket (string) required
ContinuationToken (string)
ExpectedBucketOwner (string)
s3/list_bucket_intelligent_tiering_configurationsThis operation is not supported for directory buckets. 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 acBucket (string) required
ContinuationToken (string)
ExpectedBucketOwner (string)
s3/list_bucket_inventory_configurationsThis operation is not supported for directory buckets. Returns a list of S3 Inventory configurations for the bucket. You can have up to 1,000 inventory 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 NeBucket (string) required
ContinuationToken (string)
ExpectedBucketOwner (string)
s3/list_bucket_metrics_configurationsThis operation is not supported for directory buckets. 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 seBucket (string) required
ContinuationToken (string)
ExpectedBucketOwner (string)
s3/list_bucketsThis operation is not supported for directory buckets. Returns a list of all buckets owned by the authenticated sender of the request. To grant IAM permission to use this operation, you must add the s3:ListAllMyBuckets policy action. For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets. We strongly recommend using only paginated ListBuckets requests. Unpaginated ListBuckets requests are only supported for Amazon Web Services accounts set to the dMaxBuckets (integer)
ContinuationToken (string)
Prefix (string)
BucketRegion (string)
s3/list_directory_bucketsReturns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide. Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more informaContinuationToken (string)
MaxDirectoryBuckets (integer)
s3/list_multipart_uploadsThis operation lists in-progress multipart uploads in a bucket. An in-progress multipart upload is a multipart upload that has been initiated by the CreateMultipartUpload request, but has not yet been completed or aborted. Directory buckets - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed. To delete these in-progress multipart uploads, use the ListMultipartUploads operation to list the iBucket (string) required
Delimiter (string)
EncodingType (string)
KeyMarker (string)
MaxUploads (integer)
Prefix (string)
UploadIdMarker (string)
ExpectedBucketOwner (string)
RequestPayer (string)
s3/list_objectsThis operation is not supported for directory buckets. 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 bacBucket (string) required
Delimiter (string)
EncodingType (string)
Marker (string)
MaxKeys (integer)
Prefix (string)
RequestPayer (string)
ExpectedBucketOwner (string)
OptionalObjectAttributes (array)
s3/list_objects_v2Returns 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. For more information about listing objects, see Listing object keys programmatically in the Amazon S3 User Guide. To get a list of your buckets, see ListBuckets.Bucket (string) required
Delimiter (string)
EncodingType (string)
MaxKeys (integer)
Prefix (string)
ContinuationToken (string)
FetchOwner (boolean)
StartAfter (string)
RequestPayer (string)
ExpectedBucketOwner (string)
OptionalObjectAttributes (array)
s3/list_object_versionsThis operation is not supported for directory buckets. 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 permission 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 handBucket (string) required
Delimiter (string)
EncodingType (string)
KeyMarker (string)
MaxKeys (integer)
Prefix (string)
VersionIdMarker (string)
ExpectedBucketOwner (string)
RequestPayer (string)
OptionalObjectAttributes (array)
s3/list_partsLists the parts that have been uploaded for a specific multipart upload. To use this operation, you must provide the upload ID in the request. You obtain this uploadID by sending the initiate multipart upload request through CreateMultipartUpload. The ListParts request returns a maximum of 1,000 uploaded parts. The limit of 1,000 parts is also the default value. You can restrict the number of parts in a response by specifying the max-parts request parameter. If your multipart upload consists ofBucket (string) required
Key (string) required
MaxParts (integer)
PartNumberMarker (string)
UploadId (string) required
RequestPayer (string)
ExpectedBucketOwner (string)
SSECustomerAlgorithm (string)
SSECustomerKey (string)
SSECustomerKeyMD5 (string)
s3/put_bucket_abacSets the attribute-based access control ABAC property of the general purpose bucket. You must have s3:PutBucketABAC permission to perform this action. When you enable ABAC, you can use tags for access control on your buckets. Additionally, when ABAC is enabled, you must use the TagResource and UntagResource actions to manage tags on your buckets. You can nolonger use the PutBucketTagging and DeleteBucketTagging actions to tag your bucket. For more information, see Enabling ABAC in general purposBucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
ExpectedBucketOwner (string)
AbacStatus: {
. Status (string)
} (object) required
s3/put_bucket_accelerate_configurationThis operation is not supported for directory buckets. 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 RelateBucket (string) required
AccelerateConfiguration: {
. Status (string)
} (object) required
ExpectedBucketOwner (string)
ChecksumAlgorithm (string)
s3/put_bucket_aclEnd of support notice: As of October 1, 2025, Amazon S3 has discontinued support for Email Grantee Access Control Lists ACLs. If you attempt to use an Email Grantee ACL in a request after October 1, 2025, the request will receive an HTTP 405 Method Not Allowed error. This change affects 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, and South America São Paulo.ACL (string)
AccessControlPolicy: {
. Grants (array)
. Owner (object)
} (object)
Bucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
GrantFullControl (string)
GrantRead (string)
GrantReadACP (string)
GrantWrite (string)
GrantWriteACP (string)
ExpectedBucketOwner (string)
s3/put_bucket_analytics_configurationThis operation is not supported for directory buckets. 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 bBucket (string) required
Id (string) required
AnalyticsConfiguration: {
. Id (string)
. Filter
. StorageClassAnalysis (object)
} (object) required
ExpectedBucketOwner (string)
s3/put_bucket_corsThis operation is not supported for directory buckets. 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 accesBucket (string) required
CORSConfiguration: {
. CORSRules (array)
} (object) required
ContentMD5 (string)
ChecksumAlgorithm (string)
ExpectedBucketOwner (string)
s3/put_bucket_encryptionThis operation configures default encryption and Amazon S3 Bucket Keys for an existing bucket. You can also block encryption types using this operation. Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones,Bucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
ServerSideEncryptionConfiguration: {
. Rules (array)
} (object) required
ExpectedBucketOwner (string)
s3/put_bucket_intelligent_tiering_configurationThis operation is not supported for directory buckets. 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 throughpBucket (string) required
Id (string) required
ExpectedBucketOwner (string)
IntelligentTieringConfiguration: {
. Id (string)
. Filter (object)
. Status (string)
. Tierings (array)
} (object) required
s3/put_bucket_inventory_configurationThis operation is not supported for directory buckets. This implementation of the PUT action adds an S3 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 cBucket (string) required
Id (string) required
InventoryConfiguration: {
. Destination (object)
. IsEnabled (boolean)
. Filter (object)
. Id (string)
. IncludedObjectVersions (string)
. OptionalFields (array)
. Schedule (object)
} (object) required
ExpectedBucketOwner (string)
s3/put_bucket_lifecycle_configurationCreates 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,Bucket (string) required
ChecksumAlgorithm (string)
LifecycleConfiguration: {
. Rules (array)
} (object)
ExpectedBucketOwner (string)
TransitionDefaultMinimumObjectSize (string)
s3/put_bucket_loggingEnd of support notice: As of October 1, 2025, Amazon S3 has discontinued support for Email Grantee Access Control Lists ACLs. If you attempt to use an Email Grantee ACL in a request after October 1, 2025, the request will receive an HTTP 405 Method Not Allowed error. This change affects 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, and South America São Paulo.Bucket (string) required
BucketLoggingStatus: {
. LoggingEnabled (object)
} (object) required
ContentMD5 (string)
ChecksumAlgorithm (string)
ExpectedBucketOwner (string)
s3/put_bucket_metrics_configurationThis operation is not supported for directory buckets. 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.Bucket (string) required
Id (string) required
MetricsConfiguration: {
. Id (string)
. Filter
} (object) required
ExpectedBucketOwner (string)
s3/put_bucket_notification_configurationThis operation is not supported for directory buckets. 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 defaulBucket (string) required
NotificationConfiguration: {
. TopicConfigurations (array)
. QueueConfigurations (array)
. LambdaFunctionConfigurations (array)
. EventBridgeConfiguration (object)
} (object) required
ExpectedBucketOwner (string)
SkipDestinationValidation (boolean)
s3/put_bucket_ownership_controlsThis operation is not supported for directory buckets. 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 You muBucket (string) required
ContentMD5 (string)
ExpectedBucketOwner (string)
OwnershipControls: {
. Rules (array)
} (object) required
ChecksumAlgorithm (string)
s3/put_bucket_policyApplies an Amazon S3 bucket policy to an Amazon S3 bucket. Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3Bucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
ConfirmRemoveSelfBucketAccess (boolean)
Policy (string) required
ExpectedBucketOwner (string)
s3/put_bucket_replicationThis operation is not supported for directory buckets. 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. You canBucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
ReplicationConfiguration: {
. Role (string)
. Rules (array)
} (object) required
Token (string)
ExpectedBucketOwner (string)
s3/put_bucket_request_paymentThis operation is not supported for directory buckets. 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 You must URL encode any signedBucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
RequestPaymentConfiguration: {
. Payer (string)
} (object) required
ExpectedBucketOwner (string)
s3/put_bucket_taggingThis operation is not supported for directory buckets. Sets the tags for a general purpose bucket if attribute based access control ABAC is not enabled for the bucket. When you enable ABAC for a general purpose bucket, you can no longer use this operation for that bucket and must use the TagResource or UntagResource operations instead. 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 kBucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
Tagging: {
. TagSet (array)
} (object) required
ExpectedBucketOwner (string)
s3/put_bucket_versioningThis operation is not supported for directory buckets. When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. While this change is propagating, you might encounter intermittent HTTP 404 NoSuchKey errors for requests to objects created or updated after enabling versioning. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations PUT or DELETE on objects in the bucket. Sets thBucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
MFA (string)
VersioningConfiguration: {
. MFADelete (string)
. Status (string)
} (object) required
ExpectedBucketOwner (string)
s3/put_bucket_websiteThis operation is not supported for directory buckets. 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 websiBucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
WebsiteConfiguration: {
. ErrorDocument (object)
. IndexDocument (object)
. RedirectAllRequestsTo (object)
. RoutingRules (array)
} (object) required
ExpectedBucketOwner (string)
s3/put_objectEnd of support notice: As of October 1, 2025, Amazon S3 has discontinued support for Email Grantee Access Control Lists ACLs. If you attempt to use an Email Grantee ACL in a request after October 1, 2025, the request will receive an HTTP 405 Method Not Allowed error. This change affects 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, and South America São Paulo.ACL (string)
Body (string)
Bucket (string) required
CacheControl (string)
ContentDisposition (string)
ContentEncoding (string)
ContentLanguage (string)
ContentLength (integer)
ContentMD5 (string)
ContentType (string)
ChecksumAlgorithm (string)
ChecksumCRC32 (string)
ChecksumCRC32C (string)
ChecksumCRC64NVME (string)
ChecksumSHA1 (string)
ChecksumSHA256 (string)
Expires (string)
IfMatch (string)
IfNoneMatch (string)
GrantFullControl (string)
GrantRead (string)
GrantReadACP (string)
GrantWriteACP (string)
Key (string) required
WriteOffsetBytes (integer)
Metadata (object)
ServerSideEncryption (string)
StorageClass (string)
WebsiteRedirectLocation (string)
SSECustomerAlgorithm (string)
SSECustomerKey (string)
SSECustomerKeyMD5 (string)
SSEKMSKeyId (string)
SSEKMSEncryptionContext (string)
BucketKeyEnabled (boolean)
RequestPayer (string)
Tagging (string)
ObjectLockMode (string)
ObjectLockRetainUntilDate (string)
ObjectLockLegalHoldStatus (string)
ExpectedBucketOwner (string)
s3/put_object_aclEnd of support notice: As of October 1, 2025, Amazon S3 has discontinued support for Email Grantee Access Control Lists ACLs. If you attempt to use an Email Grantee ACL in a request after October 1, 2025, the request will receive an HTTP 405 Method Not Allowed error. This change affects 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, and South America São Paulo.ACL (string)
AccessControlPolicy: {
. Grants (array)
. Owner (object)
} (object)
Bucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
GrantFullControl (string)
GrantRead (string)
GrantReadACP (string)
GrantWrite (string)
GrantWriteACP (string)
Key (string) required
RequestPayer (string)
VersionId (string)
ExpectedBucketOwner (string)
s3/put_object_legal_holdThis operation is not supported for directory buckets. Applies a legal hold configuration to the specified object. For more information, see Locking Objects. This functionality is not supported for Amazon S3 on Outposts. You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.Bucket (string) required
Key (string) required
LegalHold: {
. Status (string)
} (object)
RequestPayer (string)
VersionId (string)
ContentMD5 (string)
ChecksumAlgorithm (string)
ExpectedBucketOwner (string)
s3/put_object_lock_configurationThis operation is not supported for directory buckets. 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 enablBucket (string) required
ObjectLockConfiguration: {
. ObjectLockEnabled (string)
. Rule (object)
} (object)
RequestPayer (string)
Token (string)
ContentMD5 (string)
ChecksumAlgorithm (string)
ExpectedBucketOwner (string)
s3/put_object_retentionThis operation is not supported for directory buckets. 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 functionality is not supported for Amazon S3 on Outposts. You must URL encode any signed header values that contaiBucket (string) required
Key (string) required
Retention: {
. Mode (string)
. RetainUntilDate (string)
} (object)
RequestPayer (string)
VersionId (string)
BypassGovernanceRetention (boolean)
ContentMD5 (string)
ChecksumAlgorithm (string)
ExpectedBucketOwner (string)
s3/put_object_taggingThis operation is not supported for directory buckets. Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. For more information, see Object Tagging. 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 ResBucket (string) required
Key (string) required
VersionId (string)
ContentMD5 (string)
ChecksumAlgorithm (string)
Tagging: {
. TagSet (array)
} (object) required
ExpectedBucketOwner (string)
RequestPayer (string)
s3/put_public_access_blockThis operation is not supported for directory buckets. 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 objecBucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
PublicAccessBlockConfiguration: {
. BlockPublicAcls (boolean)
. IgnorePublicAcls (boolean)
. BlockPublicPolicy (boolean)
. RestrictPublicBuckets (boolean)
} (object) required
ExpectedBucketOwner (string)
s3/rename_objectRenames an existing object in a directory bucket that uses the S3 Express One Zone storage class. You can use RenameObject by specifying an existing object’s name as the source and the new name of the object as the destination within the same directory bucket. RenameObject is only supported for objects stored in the S3 Express One Zone storage class. To prevent overwriting an object, you can use the If-None-Match conditional header. If-None-Match - Renames the object only if an object with the sBucket (string) required
Key (string) required
RenameSource (string) required
DestinationIfMatch (string)
DestinationIfNoneMatch (string)
DestinationIfModifiedSince (string)
DestinationIfUnmodifiedSince (string)
SourceIfMatch (string)
SourceIfNoneMatch (string)
SourceIfModifiedSince (string)
SourceIfUnmodifiedSince (string)
ClientToken (string)
s3/restore_objectThis operation is not supported for directory buckets. Restores an archived copy of an object back into Amazon S3 This functionality is not supported for Amazon S3 on Outposts. This action performs the following types of requests: restore an archive - Restore an archived object 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 GuideBucket (string) required
Key (string) required
VersionId (string)
RestoreRequest: {
. Days (integer)
. GlacierJobParameters (object)
. Type (string)
. Tier (string)
. Description (string)
. SelectParameters (object)
. OutputLocation (object)
} (object)
RequestPayer (string)
ChecksumAlgorithm (string)
ExpectedBucketOwner (string)
s3/select_object_contentThis operation is not supported for directory buckets. 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 rBucket (string) required
Key (string) required
SSECustomerAlgorithm (string)
SSECustomerKey (string)
SSECustomerKeyMD5 (string)
Expression (string) required
ExpressionType (string) required
RequestProgress: {
. Enabled (boolean)
} (object)
InputSerialization: {
. CSV (object)
. CompressionType (string)
. JSON (object)
. Parquet (object)
} (object) required
OutputSerialization: {
. CSV (object)
. JSON (object)
} (object) required
ScanRange: {
. Start (integer)
. End (integer)
} (object)
ExpectedBucketOwner (string)
s3/update_bucket_metadata_inventory_table_configurationEnables or disables a live inventory table for an S3 Metadata configuration on a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. Permissions To use this operation, you must have the following permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. If you want to encrypt your inventory table with server-side encryption with Key Management Service KMS keysBucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
InventoryTableConfiguration: {
. ConfigurationState (string)
. EncryptionConfiguration (object)
} (object) required
ExpectedBucketOwner (string)
s3/update_bucket_metadata_journal_table_configurationEnables or disables journal table record expiration for an S3 Metadata configuration on a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. Permissions To use this operation, you must have the s3:UpdateBucketMetadataJournalTableConfiguration permission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. The following operations are related to UpdateBucketMetadataJoBucket (string) required
ContentMD5 (string)
ChecksumAlgorithm (string)
JournalTableConfiguration: {
. RecordExpiration (object)
} (object) required
ExpectedBucketOwner (string)
s3/update_object_encryptionThis operation is not supported for directory buckets or Amazon S3 on Outposts buckets. Updates the server-side encryption type of an existing encrypted object in a general purpose bucket. You can use the UpdateObjectEncryption operation to change encrypted objects from server-side encryption with Amazon S3 managed keys SSE-S3 to server-side encryption with Key Management Service KMS keys SSE-KMS, or to apply S3 Bucket Keys. You can also use the UpdateObjectEncryption operation to change the cusBucket (string) required
Key (string) required
VersionId (string)
ObjectEncryption (undefined) required
RequestPayer (string)
ExpectedBucketOwner (string)
ContentMD5 (string)
ChecksumAlgorithm (string)
s3/upload_partUploads a part in a multipart upload. In this operation, you provide new data as a part of an object 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 identifieBody (string)
Bucket (string) required
ContentLength (integer)
ContentMD5 (string)
ChecksumAlgorithm (string)
ChecksumCRC32 (string)
ChecksumCRC32C (string)
ChecksumCRC64NVME (string)
ChecksumSHA1 (string)
ChecksumSHA256 (string)
Key (string) required
PartNumber (integer) required
UploadId (string) required
SSECustomerAlgorithm (string)
SSECustomerKey (string)
SSECustomerKeyMD5 (string)
RequestPayer (string)
ExpectedBucketOwner (string)
s3/upload_part_copyUploads a part by copying data from an existing object as data source. To specify the data source, you add the request header x-amz-copy-source in your request. To specify a byte range, you add 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 copying data from an existing object as part data, you might use the UploadPart acBucket (string) required
CopySource (string) required
CopySourceIfMatch (string)
CopySourceIfModifiedSince (string)
CopySourceIfNoneMatch (string)
CopySourceIfUnmodifiedSince (string)
CopySourceRange (string)
Key (string) required
PartNumber (integer) required
UploadId (string) required
SSECustomerAlgorithm (string)
SSECustomerKey (string)
SSECustomerKeyMD5 (string)
CopySourceSSECustomerAlgorithm (string)
CopySourceSSECustomerKey (string)
CopySourceSSECustomerKeyMD5 (string)
RequestPayer (string)
ExpectedBucketOwner (string)
ExpectedSourceBucketOwner (string)
s3/write_get_object_responseThis operation is not supported for directory buckets. 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 WriteGRequestRoute (string) required
RequestToken (string) required
Body (string)
StatusCode (integer)
ErrorCode (string)
ErrorMessage (string)
AcceptRanges (string)
CacheControl (string)
ContentDisposition (string)
ContentEncoding (string)
ContentLanguage (string)
ContentLength (integer)
ContentRange (string)
ContentType (string)
ChecksumCRC32 (string)
ChecksumCRC32C (string)
ChecksumCRC64NVME (string)
ChecksumSHA1 (string)
ChecksumSHA256 (string)
DeleteMarker (boolean)
ETag (string)
Expires (string)
Expiration (string)
LastModified (string)
MissingMeta (integer)
Metadata (object)
ObjectLockMode (string)
ObjectLockLegalHoldStatus (string)
ObjectLockRetainUntilDate (string)
PartsCount (integer)
ReplicationStatus (string)
RequestCharged (string)
Restore (string)
ServerSideEncryption (string)
SSECustomerAlgorithm (string)
SSEKMSKeyId (string)
SSECustomerKeyMD5 (string)
StorageClass (string)
TagCount (integer)
VersionId (string)
BucketKeyEnabled (boolean)
s3outposts/create_endpointCreates 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 ListEndpointsOutpostId (string) required
SubnetId (string) required
SecurityGroupId (string) required
AccessType (string)
CustomerOwnedIpv4Pool (string)
s3outposts/delete_endpointDeletes an endpoint. It can take up to 5 minutes for this action to finish. Related actions include: CreateEndpoint ListEndpointsEndpointId (string) required
OutpostId (string) required
s3outposts/list_endpointsLists endpoints associated with the specified Outpost. Related actions include: CreateEndpoint DeleteEndpointNextToken (string)
MaxResults (integer)
s3outposts/list_outposts_with_s3Lists the Outposts with S3 on Outposts capacity for your Amazon Web Services account. Includes S3 on Outposts that you have access to as the Outposts owner, or as a shared user from Resource Access Manager RAM.NextToken (string)
MaxResults (integer)
s3outposts/list_shared_endpointsLists all endpoints associated with an Outpost that has been shared by Amazon Web Services Resource Access Manager RAM. Related actions include: CreateEndpoint DeleteEndpointNextToken (string)
MaxResults (integer)
OutpostId (string) required
s3tables/list_tags_for_resourceLists all of the tags applied to a specified Amazon S3 Tables resource. Each tag is a label consisting of a key and value pair. Tags can help you organize, track costs for, and control access to resources. For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources. Permissions For tables and table buckets, you must have the s3tables:ListTagsForResource permission to use this operation.resourceArn (string) required
s3tables/tag_resourceApplies one or more user-defined tags to an Amazon S3 Tables resource or updates existing tags. Each tag is a label consisting of a key and value pair. Tags can help you organize, track costs for, and control access to your resources. You can add up to 50 tags for each S3 resource. For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources. Permissions For tables and table buckets, you must have the s3tables:TagResource permission to use this operation.resourceArn (string) required
tags (object) required
s3tables/untag_resourceRemoves the specified user-defined tags from an Amazon S3 Tables resource. You can pass one or more tag keys. For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources. Permissions For tables and table buckets, you must have the s3tables:UntagResource permission to use this operation.resourceArn (string) required
tagKeys (array) required
s3tables/create_namespaceCreates a namespace. A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see Create a namespace in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:CreateNamespace permission to use this operation.tableBucketARN (string) required
namespace (array) required
s3tables/delete_namespaceDeletes a namespace. For more information, see Delete a namespace in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:DeleteNamespace permission to use this operation.tableBucketARN (string) required
namespace (string) required
s3tables/get_namespaceGets details about a namespace. For more information, see Table namespaces in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetNamespace permission to use this operation.tableBucketARN (string) required
namespace (string) required
s3tables/list_namespacesLists the namespaces within a table bucket. For more information, see Table namespaces in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:ListNamespaces permission to use this operation.tableBucketARN (string) required
prefix (string)
continuationToken (string)
maxNamespaces (integer)
s3tables/delete_table_bucket_encryptionDeletes the encryption configuration for a table bucket. Permissions You must have the s3tables:DeleteTableBucketEncryption permission to use this operation.tableBucketARN (string) required
s3tables/get_table_bucket_encryptionGets the encryption configuration for a table bucket. Permissions You must have the s3tables:GetTableBucketEncryption permission to use this operation.tableBucketARN (string) required
s3tables/put_table_bucket_encryptionSets the encryption configuration for a table bucket. Permissions You must have the s3tables:PutTableBucketEncryption permission to use this operation. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption in the Amazon Simple Storage Service User Guide.tableBucketARN (string) required
encryptionConfiguration: {
. sseAlgorithm (string)
. kmsKeyArn (string)
} (object) required
s3tables/delete_table_bucket_policyDeletes a table bucket policy. For more information, see Deleting a table bucket policy in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:DeleteTableBucketPolicy permission to use this operation.tableBucketARN (string) required
s3tables/get_table_bucket_policyGets details about a table bucket policy. For more information, see Viewing a table bucket policy in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTableBucketPolicy permission to use this operation.tableBucketARN (string) required
s3tables/put_table_bucket_policyCreates a new table bucket policy or replaces an existing table bucket policy for a table bucket. For more information, see Adding a table bucket policy in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:PutTableBucketPolicy permission to use this operation.tableBucketARN (string) required
resourcePolicy (string) required
s3tables/delete_table_bucket_replicationDeletes the replication configuration for a table bucket. After deletion, new table updates will no longer be replicated to destination buckets, though existing replicated tables will remain in destination buckets. Permissions You must have the s3tables:DeleteTableBucketReplication permission to use this operation.tableBucketARN (string) required
versionToken (string)
s3tables/get_table_bucket_replicationRetrieves the replication configuration for a table bucket.This operation returns the IAM role, versionToken, and replication rules that define how tables in this bucket are replicated to other buckets. Permissions You must have the s3tables:GetTableBucketReplication permission to use this operation.tableBucketARN (string) required
s3tables/put_table_bucket_replicationCreates or updates the replication configuration for a table bucket. This operation defines how tables in the source bucket are replicated to destination buckets. Replication helps ensure data availability and disaster recovery across regions or accounts. Permissions You must have the s3tables:PutTableBucketReplication permission to use this operation. The IAM role specified in the configuration must have permissions to read from the source bucket and write permissions to all destination bucketstableBucketARN (string) required
versionToken (string)
configuration: {
. role (string)
. rules (array)
} (object) required
s3tables/create_table_bucketCreates a table bucket. For more information, see Creating a table bucket in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:CreateTableBucket permission to use this operation. If you use this operation with the optional encryptionConfiguration parameter you must have the s3tables:PutTableBucketEncryption permission. If you use this operation with the storageClassConfiguration request parameter, you must have the s3tables:PutTableBucketStorageClass permissionname (string) required
encryptionConfiguration: {
. sseAlgorithm (string)
. kmsKeyArn (string)
} (object)
storageClassConfiguration: {
. storageClass (string)
} (object)
tags (object)
s3tables/delete_table_bucketDeletes a table bucket. For more information, see Deleting a table bucket in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:DeleteTableBucket permission to use this operation.tableBucketARN (string) required
s3tables/delete_table_bucket_metrics_configurationDeletes the metrics configuration for a table bucket. Permissions You must have the s3tables:DeleteTableBucketMetricsConfiguration permission to use this operation.tableBucketARN (string) required
s3tables/get_table_bucketGets details on a table bucket. For more information, see Viewing details about an Amazon S3 table bucket in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTableBucket permission to use this operation.tableBucketARN (string) required
s3tables/get_table_bucket_maintenance_configurationGets details about a maintenance configuration for a given table bucket. For more information, see Amazon S3 table bucket maintenance in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTableBucketMaintenanceConfiguration permission to use this operation.tableBucketARN (string) required
s3tables/get_table_bucket_metrics_configurationGets the metrics configuration for a table bucket. Permissions You must have the s3tables:GetTableBucketMetricsConfiguration permission to use this operation.tableBucketARN (string) required
s3tables/get_table_bucket_storage_classRetrieves the storage class configuration for a specific table. This allows you to view the storage class settings that apply to an individual table, which may differ from the table bucket's default configuration. Permissions You must have the s3tables:GetTableBucketStorageClass permission to use this operation.tableBucketARN (string) required
s3tables/list_table_bucketsLists table buckets for your account. For more information, see S3 Table buckets in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:ListTableBuckets permission to use this operation.prefix (string)
continuationToken (string)
maxBuckets (integer)
type (string)
s3tables/put_table_bucket_maintenance_configurationCreates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket. For more information, see Amazon S3 table bucket maintenance in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:PutTableBucketMaintenanceConfiguration permission to use this operation.tableBucketARN (string) required
type (string) required
value: {
. status (string)
. settings
} (object) required
s3tables/put_table_bucket_metrics_configurationSets the metrics configuration for a table bucket. Permissions You must have the s3tables:PutTableBucketMetricsConfiguration permission to use this operation.tableBucketARN (string) required
s3tables/put_table_bucket_storage_classSets or updates the storage class configuration for a table bucket. This configuration serves as the default storage class for all new tables created in the bucket, allowing you to optimize storage costs at the bucket level. Permissions You must have the s3tables:PutTableBucketStorageClass permission to use this operation.tableBucketARN (string) required
storageClassConfiguration: {
. storageClass (string)
} (object) required
s3tables/get_table_encryptionGets the encryption configuration for a table. Permissions You must have the s3tables:GetTableEncryption permission to use this operation.tableBucketARN (string) required
namespace (string) required
name (string) required
s3tables/delete_table_policyDeletes a table policy. For more information, see Deleting a table policy in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:DeleteTablePolicy permission to use this operation.tableBucketARN (string) required
namespace (string) required
name (string) required
s3tables/get_table_policyGets details about a table policy. For more information, see Viewing a table policy in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTablePolicy permission to use this operation.tableBucketARN (string) required
namespace (string) required
name (string) required
s3tables/put_table_policyCreates a new table policy or replaces an existing table policy for a table. For more information, see Adding a table policy in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:PutTablePolicy permission to use this operation.tableBucketARN (string) required
namespace (string) required
name (string) required
resourcePolicy (string) required
s3tables/delete_table_replicationDeletes the replication configuration for a specific table. After deletion, new updates to this table will no longer be replicated to destination tables, though existing replicated copies will remain in destination buckets. Permissions You must have the s3tables:DeleteTableReplication permission to use this operation.tableArn (string) required
versionToken (string) required
s3tables/get_table_replicationRetrieves the replication configuration for a specific table. Permissions You must have the s3tables:GetTableReplication permission to use this operation.tableArn (string) required
s3tables/get_table_replication_statusRetrieves the replication status for a table, including the status of replication to each destination. This operation provides visibility into replication health and progress. Permissions You must have the s3tables:GetTableReplicationStatus permission to use this operation.tableArn (string) required
s3tables/put_table_replicationCreates or updates the replication configuration for a specific table. This operation allows you to define table-level replication independently of bucket-level replication, providing granular control over which tables are replicated and where. Permissions You must have the s3tables:PutTableReplication permission to use this operation. The IAM role specified in the configuration must have permissions to read from the source table and write to all destination tables. You must also have the followtableArn (string) required
versionToken (string)
configuration: {
. role (string)
. rules (array)
} (object) required
s3tables/create_tableCreates a new table associated with the given namespace in a table bucket. For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:CreateTable permission to use this operation. If you use this operation with the optional metadata request parameter you must have the s3tables:PutTableData permission. If you use this operation with the optional encryptionConfiguration request parameter you must have the s3tables:PtableBucketARN (string) required
namespace (string) required
name (string) required
format (string) required
metadata (undefined)
encryptionConfiguration: {
. sseAlgorithm (string)
. kmsKeyArn (string)
} (object)
storageClassConfiguration: {
. storageClass (string)
} (object)
tags (object)
s3tables/delete_tableDeletes a table. For more information, see Deleting an Amazon S3 table in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:DeleteTable permission to use this operation.tableBucketARN (string) required
namespace (string) required
name (string) required
versionToken (string)
s3tables/get_tableGets details about a table. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTable permission to use this operation.tableBucketARN (string)
namespace (string)
name (string)
tableArn (string)
s3tables/get_table_maintenance_configurationGets details about the maintenance configuration of a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTableMaintenanceConfiguration permission to use this operation. You must have the s3tables:GetTableData permission to use set the compaction strategy to sort or zorder.tableBucketARN (string) required
namespace (string) required
name (string) required
s3tables/get_table_maintenance_job_statusGets the status of a maintenance job for a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTableMaintenanceJobStatus permission to use this operation.tableBucketARN (string) required
namespace (string) required
name (string) required
s3tables/get_table_metadata_locationGets the location of the table metadata. Permissions You must have the s3tables:GetTableMetadataLocation permission to use this operation.tableBucketARN (string) required
namespace (string) required
name (string) required
s3tables/get_table_record_expiration_configurationRetrieves the expiration configuration settings for records in a table, and the status of the configuration. If the status of the configuration is enabled, records expire and are automatically removed from the table after the specified number of days. Permissions You must have the s3tables:GetTableRecordExpirationConfiguration permission to use this operation.tableArn (string) required
s3tables/get_table_record_expiration_job_statusRetrieves the status, metrics, and details of the latest record expiration job for a table. This includes when the job ran, and whether it succeeded or failed. If the job ran successfully, this also includes statistics about the records that were removed. Permissions You must have the s3tables:GetTableRecordExpirationJobStatus permission to use this operation.tableArn (string) required
s3tables/get_table_storage_classRetrieves the storage class configuration for a specific table. This allows you to view the storage class settings that apply to an individual table, which may differ from the table bucket's default configuration. Permissions You must have the s3tables:GetTableStorageClass permission to use this operation.tableBucketARN (string) required
namespace (string) required
name (string) required
s3tables/list_tablesList tables in the given table bucket. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:ListTables permission to use this operation.tableBucketARN (string) required
namespace (string)
prefix (string)
continuationToken (string)
maxTables (integer)
s3tables/put_table_maintenance_configurationCreates a new maintenance configuration or replaces an existing maintenance configuration for a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:PutTableMaintenanceConfiguration permission to use this operation.tableBucketARN (string) required
namespace (string) required
name (string) required
type (string) required
value: {
. status (string)
. settings
} (object) required
s3tables/put_table_record_expiration_configurationCreates or updates the expiration configuration settings for records in a table, including the status of the configuration. If you enable record expiration for a table, records expire and are automatically removed from the table after the number of days that you specify. Permissions You must have the s3tables:PutTableRecordExpirationConfiguration permission to use this operation.tableArn (string) required
value: {
. status (string)
. settings (object)
} (object) required
s3tables/rename_tableRenames a table or a namespace. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:RenameTable permission to use this operation.tableBucketARN (string) required
namespace (string) required
name (string) required
newNamespaceName (string)
newName (string)
versionToken (string)
s3tables/update_table_metadata_locationUpdates the metadata location for a table. The metadata location of a table must be an S3 URI that begins with the table's warehouse location. The metadata location for an Apache Iceberg table must end with .metadata.json, or if the metadata file is Gzip-compressed, .metadata.json.gz. Permissions You must have the s3tables:UpdateTableMetadataLocation permission to use this operation.tableBucketARN (string) required
namespace (string) required
name (string) required
versionToken (string) required
metadataLocation (string) required
s3vectors/list_tags_for_resourceLists all of the tags applied to a specified Amazon S3 Vectors resource. Each tag is a label consisting of a key and value pair. Tags can help you organize, track costs for, and control access to resources. For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources. Permissions For vector buckets and vector indexes, you must have the s3vectors:ListTagsForResource permission to use this operation.resourceArn (string) required
s3vectors/tag_resourceApplies one or more user-defined tags to an Amazon S3 Vectors resource or updates existing tags. Each tag is a label consisting of a key and value pair. Tags can help you organize, track costs for, and control access to your resources. You can add up to 50 tags for each resource. For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources. Permissions For vector buckets and vector indexes, you must have the s3vectors:TagResource permission to use this operation.resourceArn (string) required
tags (object) required
s3vectors/untag_resourceRemoves the specified user-defined tags from an Amazon S3 Vectors resource. You can pass one or more tag keys. For a list of S3 resources that support tagging, see Managing tags for Amazon S3 resources. Permissions For vector buckets and vector indexes, you must have the s3vectors:UntagResource permission to use this operation.resourceArn (string) required
tagKeys (array) required
s3vectors/create_vector_bucketCreates a vector bucket in the Amazon Web Services Region that you want your bucket to be in. Permissions You must have the s3vectors:CreateVectorBucket permission to use this operation. You must have the s3vectors:TagResource permission in addition to s3vectors:CreateVectorBucket permission to create a vector bucket with tags.vectorBucketName (string) required
encryptionConfiguration: {
. sseType (string)
. kmsKeyArn (string)
} (object)
tags (object)
s3vectors/delete_vector_bucketDeletes a vector bucket. All vector indexes in the vector bucket must be deleted before the vector bucket can be deleted. To perform this operation, you must use either the vector bucket name or the vector bucket Amazon Resource Name ARN. Permissions You must have the s3vectors:DeleteVectorBucket permission to use this operation.vectorBucketName (string)
vectorBucketArn (string)
s3vectors/delete_vector_bucket_policyDeletes a vector bucket policy. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name ARN. Permissions You must have the s3vectors:DeleteVectorBucketPolicy permission to use this operation.vectorBucketName (string)
vectorBucketArn (string)
s3vectors/get_vector_bucketReturns vector bucket attributes. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name ARN. Permissions You must have the s3vectors:GetVectorBucket permission to use this operation.vectorBucketName (string)
vectorBucketArn (string)
s3vectors/get_vector_bucket_policyGets details about a vector bucket policy. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name ARN. Permissions You must have the s3vectors:GetVectorBucketPolicy permission to use this operation.vectorBucketName (string)
vectorBucketArn (string)
s3vectors/list_vector_bucketsReturns a list of all the vector buckets that are owned by the authenticated sender of the request. Permissions You must have the s3vectors:ListVectorBuckets permission to use this operation.maxResults (integer)
nextToken (string)
prefix (string)
s3vectors/put_vector_bucket_policyCreates a bucket policy for a vector bucket. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name ARN. Permissions You must have the s3vectors:PutVectorBucketPolicy permission to use this operation.vectorBucketName (string)
vectorBucketArn (string)
policy (string) required
s3vectors/create_indexCreates a vector index within a vector bucket. To specify the vector bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name ARN. Permissions You must have the s3vectors:CreateIndex permission to use this operation. You must have the s3vectors:TagResource permission in addition to s3vectors:CreateIndex permission to create a vector index with tags.vectorBucketName (string)
vectorBucketArn (string)
indexName (string) required
dataType (string) required
dimension (integer) required
distanceMetric (string) required
metadataConfiguration: {
. nonFilterableMetadataKeys (array)
} (object)
encryptionConfiguration: {
. sseType (string)
. kmsKeyArn (string)
} (object)
tags (object)
s3vectors/delete_indexDeletes a vector index. To specify the vector index, you can either use both the vector bucket name and vector index name, or use the vector index Amazon Resource Name ARN. Permissions You must have the s3vectors:DeleteIndex permission to use this operation.vectorBucketName (string)
indexName (string)
indexArn (string)
s3vectors/get_indexReturns vector index attributes. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name ARN. Permissions You must have the s3vectors:GetIndex permission to use this operation.vectorBucketName (string)
indexName (string)
indexArn (string)
s3vectors/list_indexesReturns a list of all the vector indexes within the specified vector bucket. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name ARN. Permissions You must have the s3vectors:ListIndexes permission to use this operation.vectorBucketName (string)
vectorBucketArn (string)
maxResults (integer)
nextToken (string)
prefix (string)
s3vectors/delete_vectorsDeletes one or more vectors in a vector index. To specify the vector index, you can either use both the vector bucket name and vector index name, or use the vector index Amazon Resource Name ARN. Permissions You must have the s3vectors:DeleteVectors permission to use this operation.vectorBucketName (string)
indexName (string)
indexArn (string)
keys (array) required
s3vectors/get_vectorsReturns vector attributes. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name ARN. Permissions You must have the s3vectors:GetVectors permission to use this operation.vectorBucketName (string)
indexName (string)
indexArn (string)
keys (array) required
returnData (boolean)
returnMetadata (boolean)
s3vectors/list_vectorsList vectors in the specified vector index. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name ARN. ListVectors operations proceed sequentially; however, for faster performance on a large number of vectors in a vector index, applications can request a parallel ListVectors operation by providing the segmentCount and segmentIndex parameters. Permissions You must have the s3vectors:ListVectors permissiovectorBucketName (string)
indexName (string)
indexArn (string)
maxResults (integer)
nextToken (string)
segmentCount (integer)
segmentIndex (integer)
returnData (boolean)
returnMetadata (boolean)
s3vectors/put_vectorsAdds one or more vectors to a vector index. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name ARN. For more information about limits, see Limitations and restrictions in the Amazon S3 User Guide. When inserting vector data into your vector index, you must provide the vector data as float32 32-bit floating point values. If you pass higher-precision values to an Amazon Web Services SDK, S3 Vectors convectorBucketName (string)
indexName (string)
indexArn (string)
vectors (array) required
s3vectors/query_vectorsPerforms an approximate nearest neighbor search query in a vector index using a query vector. By default, it returns the keys of approximate nearest neighbors. You can optionally include the computed distance between the query vector and each vector in the response, the vector data, and metadata of each vector in the response. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name ARN. Permissions You muvectorBucketName (string)
indexName (string)
indexArn (string)
topK (integer) required
queryVector (undefined) required
filter (undefined)
returnMetadata (boolean)
returnDistance (boolean)
sagemaker_a2i_runtime/delete_human_loopDeletes the specified human loop for a flow definition. If the human loop was deleted, this operation will return a ResourceNotFoundException.HumanLoopName (string) required
sagemaker_a2i_runtime/describe_human_loopReturns information about the specified human loop. If the human loop was deleted, this operation will return a ResourceNotFoundException error.HumanLoopName (string) required
sagemaker_a2i_runtime/list_human_loopsReturns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.CreationTimeAfter (string)
CreationTimeBefore (string)
FlowDefinitionArn (string) required
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker_a2i_runtime/start_human_loopStarts a human loop, provided that at least one activation condition is met.HumanLoopName (string) required
FlowDefinitionArn (string) required
HumanLoopInput: {
. InputContent (string)
} (object) required
DataAttributes: {
. ContentClassifiers (array)
} (object)
sagemaker_a2i_runtime/stop_human_loopStops the specified human loop.HumanLoopName (string) required
sagemaker_edge/get_deploymentsUse to get the active deployments from a device.DeviceName (string) required
DeviceFleetName (string) required
sagemaker_edge/get_device_registrationUse to check if a device is registered with SageMaker Edge Manager.DeviceName (string) required
DeviceFleetName (string) required
sagemaker_edge/send_heartbeatUse to get the current status of devices registered on SageMaker Edge Manager.AgentMetrics (array)
Models (array)
AgentVersion (string) required
DeviceName (string) required
DeviceFleetName (string) required
DeploymentResult: {
. DeploymentName (string)
. DeploymentStatus (string)
. DeploymentStatusMessage (string)
. DeploymentStartTime (string)
. DeploymentEndTime (string)
. DeploymentModels (array)
} (object)
sagemaker_featurestore_runtime/batch_get_recordRetrieves a batch of Records from a FeatureGroup.Identifiers (array) required
ExpirationTimeResponse (string)
sagemaker_featurestore_runtime/delete_recordDeletes a Record from a FeatureGroup in the OnlineStore. Feature Store supports both SoftDelete and HardDelete. For SoftDelete default, feature columns are set to null and the record is no longer retrievable by GetRecord or BatchGetRecord. For HardDelete, the complete Record is removed from the OnlineStore. In both cases, Feature Store appends the deleted record marker to the OfflineStore. The deleted record marker is a record with the same RecordIdentifer as the original, but with is_deleted vaFeatureGroupName (string) required
RecordIdentifierValueAsString (string) required
EventTime (string) required
TargetStores (array)
DeletionMode (string)
sagemaker_featurestore_runtime/get_recordUse 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.FeatureGroupName (string) required
RecordIdentifierValueAsString (string) required
FeatureNames (array)
ExpirationTimeResponse (string)
sagemaker_featurestore_runtime/put_recordThe PutRecord API is used to ingest a list of Records into your feature group. If a new record’s EventTime is greater, the new record is written to both the OnlineStore and OfflineStore. Otherwise, the record is a historic record and it is written only to the OfflineStore. You can specify the ingestion to be applied to the OnlineStore, OfflineStore, or both by using the TargetStores request parameter. You can set the ingested record to expire at a given time to live TTL duration after the recordFeatureGroupName (string) required
Record (array) required
TargetStores (array)
TtlDuration: {
. Unit (string)
. Value (integer)
} (object)
sagemaker_geospatial/list_tags_for_resourceLists the tags attached to the resource.ResourceArn (string) required
sagemaker_geospatial/tag_resourceThe resource you want to tag.ResourceArn (string) required
Tags (object) required
sagemaker_geospatial/untag_resourceThe resource you want to untag.ResourceArn (string) required
TagKeys (array) required
sagemaker_geospatial/export_earth_observation_jobUse this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.Arn (string) required
ClientToken (string)
ExecutionRoleArn (string) required
OutputConfig: {
. S3Data (object)
} (object) required
ExportSourceImages (boolean)
sagemaker_geospatial/get_tileGets a web mercator tile for the given Earth Observation job.x (integer) required
y (integer) required
z (integer) required
ImageAssets (array) required
Target (string) required
Arn (string) required
ImageMask (boolean)
OutputFormat (string)
TimeRangeFilter (string)
PropertyFilters (string)
OutputDataType (string)
ExecutionRoleArn (string)
sagemaker_geospatial/stop_earth_observation_jobUse this operation to stop an existing earth observation job.Arn (string) required
sagemaker_geospatial/start_earth_observation_jobUse this operation to create an Earth observation job.Name (string) required
ClientToken (string)
KmsKeyId (string)
InputConfig: {
. PreviousEarthObservationJobArn (string)
. RasterDataCollectionQuery (object)
} (object) required
JobConfig (undefined) required
ExecutionRoleArn (string) required
Tags (object)
sagemaker_geospatial/get_earth_observation_jobGet the details for a previously initiated Earth Observation job.Arn (string) required
sagemaker_geospatial/delete_earth_observation_jobUse this operation to delete an Earth Observation job.Arn (string) required
sagemaker_geospatial/list_earth_observation_jobsUse this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.StatusEquals (string)
SortOrder (string)
SortBy (string)
NextToken (string)
MaxResults (integer)
sagemaker_geospatial/search_raster_data_collectionAllows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.Arn (string) required
RasterDataCollectionQuery: {
. TimeRangeFilter (object)
. AreaOfInterest
. PropertyFilters (object)
. BandFilter (array)
} (object) required
NextToken (string)
sagemaker_geospatial/get_raster_data_collectionUse this operation to get details of a specific raster data collection.Arn (string) required
sagemaker_geospatial/list_raster_data_collectionsUse this operation to get raster data collections.NextToken (string)
MaxResults (integer)
sagemaker_geospatial/export_vector_enrichment_jobUse this operation to copy results of a Vector Enrichment job to an Amazon S3 location.Arn (string) required
ClientToken (string)
ExecutionRoleArn (string) required
OutputConfig: {
. S3Data (object)
} (object) required
sagemaker_geospatial/stop_vector_enrichment_jobStops the Vector Enrichment job for a given job ARN.Arn (string) required
sagemaker_geospatial/start_vector_enrichment_jobCreates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.Name (string) required
ClientToken (string)
KmsKeyId (string)
InputConfig: {
. DocumentType (string)
. DataSourceConfig
} (object) required
JobConfig (undefined) required
ExecutionRoleArn (string) required
Tags (object)
sagemaker_geospatial/get_vector_enrichment_jobRetrieves details of a Vector Enrichment Job for a given job Amazon Resource Name ARN.Arn (string) required
sagemaker_geospatial/delete_vector_enrichment_jobUse this operation to delete a Vector Enrichment job.Arn (string) required
sagemaker_geospatial/list_vector_enrichment_jobsRetrieves a list of vector enrichment jobs.StatusEquals (string)
SortOrder (string)
SortBy (string)
NextToken (string)
MaxResults (integer)
sagemaker_metrics/batch_get_metricsUsed to retrieve training metrics from SageMaker.MetricQueries (array) required
sagemaker_metrics/batch_put_metricsUsed to ingest training metrics into SageMaker. These metrics can be visualized in SageMaker Studio.TrialComponentName (string) required
MetricData (array) required
sagemaker_runtime_http2/invoke_endpoint_with_bidirectional_streamInvokes a model endpoint with bidirectional streaming capabilities. This operation establishes a persistent connection that allows you to send multiple requests and receive streaming responses from the model in real-time. Bidirectional streaming is useful for interactive applications such as chatbots, real-time translation, or any scenario where you need to maintain a conversation-like interaction with the model. The connection remains open, allowing you to send additional input and receive respEndpointName (string) required
Body (undefined) required
TargetVariant (string)
ModelInvocationPath (string)
ModelQueryString (string)
sagemaker_runtime/invoke_endpointAfter you deploy a model into production using Amazon SageMaker AI 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 AI, see How It Works. Amazon SageMaker AI strips all POST headers except those supported by the API. Amazon SageMaker AI might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax. Calls to InvokeEndpoint areEndpointName (string) required
Body (string) required
ContentType (string)
Accept (string)
CustomAttributes (string)
TargetModel (string)
TargetVariant (string)
TargetContainerHostname (string)
InferenceId (string)
EnableExplanations (string)
InferenceComponentName (string)
SessionId (string)
sagemaker_runtime/invoke_endpoint_asyncAfter you deploy a model into production using Amazon SageMaker AI 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 you receive a response from this API. The response from this API will not contain the result of the inference request but contain inforEndpointName (string) required
ContentType (string)
Accept (string)
CustomAttributes (string)
InferenceId (string)
InputLocation (string) required
RequestTTLSeconds (integer)
InvocationTimeoutSeconds (integer)
sagemaker_runtime/invoke_endpoint_with_response_streamInvokes a model at the specified endpoint to return the inference response as a stream. The inference stream provides the response payload incrementally as a series of parts. Before you can get an inference stream, you must have access to a model that's deployed using Amazon SageMaker AI hosting services, and the container for that model must support inference streaming. For more information that can help you use this API, see the following sections in the Amazon SageMaker AI Developer Guide: FoEndpointName (string) required
Body (string) required
ContentType (string)
Accept (string)
CustomAttributes (string)
TargetVariant (string)
TargetContainerHostname (string)
InferenceId (string)
InferenceComponentName (string)
SessionId (string)
sagemaker/add_associationCreates 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.SourceArn (string) required
DestinationArn (string) required
AssociationType (string)
sagemaker/add_tagsAdds 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 calResourceArn (string) required
Tags (array) required
sagemaker/associate_trial_componentAssociates 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.TrialComponentName (string) required
TrialName (string) required
sagemaker/attach_cluster_node_volumeAttaches your Amazon Elastic Block Store Amazon EBS volume to a node in your EKS orchestrated HyperPod cluster. This API works with the Amazon Elastic Block Store Amazon EBS Container Storage Interface CSI driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters.ClusterArn (string) required
NodeId (string) required
VolumeId (string) required
sagemaker/batch_add_cluster_nodesAdds nodes to a HyperPod cluster by incrementing the target count for one or more instance groups. This operation returns a unique NodeLogicalId for each node being added, which can be used to track the provisioning status of the node. This API provides a safer alternative to UpdateCluster for scaling operations by avoiding unintended configuration changes. This API is only supported for clusters using Continuous as the NodeProvisioningMode.ClusterName (string) required
ClientToken (string)
NodesToAdd (array) required
sagemaker/batch_delete_cluster_nodesDeletes specific nodes within a SageMaker HyperPod cluster. BatchDeleteClusterNodes accepts a cluster name and a list of node IDs. To safeguard your work, back up your data to Amazon S3 or an FSx for Lustre file system before invoking the API on a worker node group. This will help prevent any potential data loss from the instance root volume. For more information about backup, see Use the backup script provided by SageMaker HyperPod. If you want to invoke this API on an existing cluster, you'llClusterName (string) required
NodeIds (array)
NodeLogicalIds (array)
sagemaker/batch_describe_model_packageThis action batch describes a list of versioned model packagesModelPackageArnList (array) required
sagemaker/batch_reboot_cluster_nodesReboots specific nodes within a SageMaker HyperPod cluster using a soft recovery mechanism. BatchRebootClusterNodes performs a graceful reboot of the specified nodes by calling the Amazon Elastic Compute Cloud RebootInstances API, which attempts to cleanly shut down the operating system before restarting the instance. This operation is useful for recovering from transient issues or applying certain configuration changes that require a restart. Rebooting a node may cause temporary service interruClusterName (string) required
NodeIds (array)
NodeLogicalIds (array)
sagemaker/batch_replace_cluster_nodesReplaces specific nodes within a SageMaker HyperPod cluster with new hardware. BatchReplaceClusterNodes terminates the specified instances and provisions new replacement instances with the same configuration but fresh hardware. The Amazon Machine Image AMI and instance configuration remain the same. This operation is useful for recovering from hardware failures or persistent issues that cannot be resolved through a reboot. Data Loss Warning: Replacing nodes destroys all instance volumes, includiClusterName (string) required
NodeIds (array)
NodeLogicalIds (array)
sagemaker/create_actionCreates 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.ActionName (string) required
Source: {
. SourceUri (string)
. SourceType (string)
. SourceId (string)
} (object) required
ActionType (string) required
Description (string)
Status (string)
Properties (object)
MetadataProperties: {
. CommitId (string)
. Repository (string)
. GeneratedBy (string)
. ProjectId (string)
} (object)
Tags (array)
sagemaker/create_algorithmCreate a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.AlgorithmName (string) required
AlgorithmDescription (string)
TrainingSpecification: {
. TrainingImage (string)
. TrainingImageDigest (string)
. SupportedHyperParameters (array)
. SupportedTrainingInstanceTypes (array)
. SupportsDistributedTraining (boolean)
. MetricDefinitions (array)
. TrainingChannels (array)
. SupportedTuningJobObjectiveMetrics (array)
. AdditionalS3DataSource (object)
} (object) required
InferenceSpecification: {
. Containers (array)
. SupportedTransformInstanceTypes (array)
. SupportedRealtimeInferenceInstanceTypes (array)
. SupportedContentTypes (array)
. SupportedResponseMIMETypes (array)
} (object)
ValidationSpecification: {
. ValidationRole (string)
. ValidationProfiles (array)
} (object)
CertifyForMarketplace (boolean)
Tags (array)
sagemaker/create_appCreates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker AI upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.DomainId (string) required
UserProfileName (string)
SpaceName (string)
AppType (string) required
AppName (string) required
Tags (array)
ResourceSpec: {
. SageMakerImageArn (string)
. SageMakerImageVersionArn (string)
. SageMakerImageVersionAlias (string)
. InstanceType (string)
. LifecycleConfigArn (string)
} (object)
RecoveryMode (boolean)
sagemaker/create_app_image_configCreates a configuration for running a SageMaker AI image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.AppImageConfigName (string) required
Tags (array)
KernelGatewayImageConfig: {
. KernelSpecs (array)
. FileSystemConfig (object)
} (object)
JupyterLabAppImageConfig: {
. FileSystemConfig (object)
. ContainerConfig (object)
} (object)
CodeEditorAppImageConfig: {
. FileSystemConfig (object)
. ContainerConfig (object)
} (object)
sagemaker/create_artifactCreates 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.ArtifactName (string)
Source: {
. SourceUri (string)
. SourceTypes (array)
} (object) required
ArtifactType (string) required
Properties (object)
MetadataProperties: {
. CommitId (string)
. Repository (string)
. GeneratedBy (string)
. ProjectId (string)
} (object)
Tags (array)
sagemaker/create_auto_mljobCreates an Autopilot job also referred to as Autopilot experiment or AutoML job. An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoMLAutoMLJobName (string) required
InputDataConfig (array) required
OutputDataConfig: {
. KmsKeyId (string)
. S3OutputPath (string)
} (object) required
ProblemType (string)
AutoMLJobObjective: {
. MetricName (string)
} (object)
AutoMLJobConfig: {
. CompletionCriteria (object)
. SecurityConfig (object)
. CandidateGenerationConfig (object)
. DataSplitConfig (object)
. Mode (string)
} (object)
RoleArn (string) required
GenerateCandidateDefinitionsOnly (boolean)
Tags (array)
ModelDeployConfig: {
. AutoGenerateEndpointName (boolean)
. EndpointName (string)
} (object)
sagemaker/create_auto_mljob_v2Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2. An AutoML job in SageMaker AI is a fully automated process that allows you to build machine learning models with minimal effort and machine learning expertise. When initiating an AutoML job, you provide your data and optionally specify parameters tailored to your use case. SageMaker AI then automates the entire model development lifecycle, including data preprocessing, model training, tuning, and evaluation. AutoAutoMLJobName (string) required
AutoMLJobInputDataConfig (array) required
OutputDataConfig: {
. KmsKeyId (string)
. S3OutputPath (string)
} (object) required
AutoMLProblemTypeConfig (undefined) required
RoleArn (string) required
Tags (array)
SecurityConfig: {
. VolumeKmsKeyId (string)
. EnableInterContainerTrafficEncryption (boolean)
. VpcConfig (object)
} (object)
AutoMLJobObjective: {
. MetricName (string)
} (object)
ModelDeployConfig: {
. AutoGenerateEndpointName (boolean)
. EndpointName (string)
} (object)
DataSplitConfig: {
. ValidationFraction (number)
} (object)
AutoMLComputeConfig: {
. EmrServerlessComputeConfig (object)
} (object)
sagemaker/create_clusterCreates an Amazon SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models LLMs and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide.ClusterName (string) required
InstanceGroups (array)
RestrictedInstanceGroups (array)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
Tags (array)
Orchestrator: {
. Eks (object)
. Slurm (object)
} (object)
NodeRecovery (string)
TieredStorageConfig: {
. Mode (string)
. InstanceMemoryAllocationPercentage (integer)
} (object)
NodeProvisioningMode (string)
ClusterRole (string)
AutoScaling: {
. Mode (string)
. AutoScalerType (string)
} (object)
sagemaker/create_cluster_scheduler_configCreate cluster policy configuration. This policy is used for task prioritization and fair-share allocation of idle compute. This helps prioritize critical workloads and distributes idle compute across entities.Name (string) required
ClusterArn (string) required
SchedulerConfig: {
. PriorityClasses (array)
. FairShare (string)
. IdleResourceSharing (string)
} (object) required
Description (string)
Tags (array)
sagemaker/create_code_repositoryCreates a Git repository as a resource in your SageMaker AI 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 AI 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 otCodeRepositoryName (string) required
GitConfig: {
. RepositoryUrl (string)
. Branch (string)
. SecretArn (string)
} (object) required
Tags (array)
sagemaker/create_compilation_jobStarts a model compilation job. After the model has been compiled, Amazon SageMaker AI 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 AI 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:CompilationJobName (string) required
RoleArn (string) required
ModelPackageVersionArn (string)
InputConfig: {
. S3Uri (string)
. DataInputConfig (string)
. Framework (string)
. FrameworkVersion (string)
} (object)
OutputConfig: {
. S3OutputLocation (string)
. TargetDevice (string)
. TargetPlatform (object)
. CompilerOptions (string)
. KmsKeyId (string)
} (object) required
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
StoppingCondition: {
. MaxRuntimeInSeconds (integer)
. MaxWaitTimeInSeconds (integer)
. MaxPendingTimeInSeconds (integer)
} (object) required
Tags (array)
sagemaker/create_compute_quotaCreate compute allocation definition. This defines how compute is allocated, shared, and borrowed for specified entities. Specifically, how to lend and borrow idle compute and assign a fair-share weight to the specified entities.Name (string) required
Description (string)
ClusterArn (string) required
ComputeQuotaConfig: {
. ComputeQuotaResources (array)
. ResourceSharingConfig (object)
. PreemptTeamTasks (string)
} (object) required
ComputeQuotaTarget: {
. TeamName (string)
. FairShareWeight (integer)
} (object) required
ActivationState (string)
Tags (array)
sagemaker/create_contextCreates 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.ContextName (string) required
Source: {
. SourceUri (string)
. SourceType (string)
. SourceId (string)
} (object) required
ContextType (string) required
Description (string)
Properties (object)
Tags (array)
sagemaker/create_data_quality_job_definitionCreates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.JobDefinitionName (string) required
DataQualityBaselineConfig: {
. BaseliningJobName (string)
. ConstraintsResource (object)
. StatisticsResource (object)
} (object)
DataQualityAppSpecification: {
. ImageUri (string)
. ContainerEntrypoint (array)
. ContainerArguments (array)
. RecordPreprocessorSourceUri (string)
. PostAnalyticsProcessorSourceUri (string)
. Environment (object)
} (object) required
DataQualityJobInput: {
. EndpointInput (object)
. BatchTransformInput (object)
} (object) required
DataQualityJobOutputConfig: {
. MonitoringOutputs (array)
. KmsKeyId (string)
} (object) required
JobResources: {
. ClusterConfig (object)
} (object) required
NetworkConfig: {
. EnableInterContainerTrafficEncryption (boolean)
. EnableNetworkIsolation (boolean)
. VpcConfig (object)
} (object)
RoleArn (string) required
StoppingCondition: {
. MaxRuntimeInSeconds (integer)
} (object)
Tags (array)
sagemaker/create_device_fleetCreates a device fleet.DeviceFleetName (string) required
RoleArn (string)
Description (string)
OutputConfig: {
. S3OutputLocation (string)
. KmsKeyId (string)
. PresetDeploymentType (string)
. PresetDeploymentConfig (string)
} (object) required
Tags (array)
EnableIotRoleAlias (boolean)
sagemaker/create_domainCreates a Domain. A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud VPC configurations. 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 repoDomainName (string) required
AuthMode (string) required
DefaultUserSettings: {
. ExecutionRole (string)
. SecurityGroups (array)
. SharingSettings (object)
. JupyterServerAppSettings (object)
. KernelGatewayAppSettings (object)
. TensorBoardAppSettings (object)
. RStudioServerProAppSettings (object)
. RSessionAppSettings (object)
. CanvasAppSettings (object)
. CodeEditorAppSettings (object)
. JupyterLabAppSettings (object)
. SpaceStorageSettings (object)
. DefaultLandingUri (string)
. StudioWebPortal (string)
. CustomPosixUserConfig (object)
. CustomFileSystemConfigs (array)
. StudioWebPortalSettings (object)
. AutoMountHomeEFS (string)
} (object) required
DomainSettings: {
. SecurityGroupIds (array)
. RStudioServerProDomainSettings (object)
. ExecutionRoleIdentityConfig (string)
. TrustedIdentityPropagationSettings (object)
. DockerSettings (object)
. AmazonQSettings (object)
. UnifiedStudioSettings (object)
. IpAddressType (string)
} (object)
SubnetIds (array)
VpcId (string)
Tags (array)
AppNetworkAccessType (string)
HomeEfsFileSystemKmsKeyId (string)
KmsKeyId (string)
AppSecurityGroupManagement (string)
TagPropagation (string)
DefaultSpaceSettings: {
. ExecutionRole (string)
. SecurityGroups (array)
. JupyterServerAppSettings (object)
. KernelGatewayAppSettings (object)
. JupyterLabAppSettings (object)
. SpaceStorageSettings (object)
. CustomPosixUserConfig (object)
. CustomFileSystemConfigs (array)
} (object)
sagemaker/create_edge_deployment_planCreates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.EdgeDeploymentPlanName (string) required
ModelConfigs (array) required
DeviceFleetName (string) required
Stages (array)
Tags (array)
sagemaker/create_edge_deployment_stageCreates a new stage in an existing edge deployment plan.EdgeDeploymentPlanName (string) required
Stages (array) required
sagemaker/create_edge_packaging_jobStarts 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.EdgePackagingJobName (string) required
CompilationJobName (string) required
ModelName (string) required
ModelVersion (string) required
RoleArn (string) required
OutputConfig: {
. S3OutputLocation (string)
. KmsKeyId (string)
. PresetDeploymentType (string)
. PresetDeploymentConfig (string)
} (object) required
ResourceKey (string)
Tags (array)
sagemaker/create_endpointCreates 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. 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 createEndpointName (string) required
EndpointConfigName (string) required
DeploymentConfig: {
. BlueGreenUpdatePolicy (object)
. RollingUpdatePolicy (object)
. AutoRollbackConfiguration (object)
} (object)
Tags (array)
sagemaker/create_endpoint_configCreates 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 alsEndpointConfigName (string) required
ProductionVariants (array) required
DataCaptureConfig: {
. EnableCapture (boolean)
. InitialSamplingPercentage (integer)
. DestinationS3Uri (string)
. KmsKeyId (string)
. CaptureOptions (array)
. CaptureContentTypeHeader (object)
} (object)
Tags (array)
KmsKeyId (string)
AsyncInferenceConfig: {
. ClientConfig (object)
. OutputConfig (object)
} (object)
ExplainerConfig: {
. ClarifyExplainerConfig (object)
} (object)
ShadowProductionVariants (array)
ExecutionRoleArn (string)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
EnableNetworkIsolation (boolean)
MetricsConfig: {
. EnableEnhancedMetrics (boolean)
. MetricPublishFrequencyInSeconds (integer)
} (object)
sagemaker/create_experimentCreates a 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. In the Studio UI, trials are referred to as run groups and trial components are referred to as runs. 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 orExperimentName (string) required
DisplayName (string)
Description (string)
Tags (array)
sagemaker/create_feature_groupCreate 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. Note that it can takeFeatureGroupName (string) required
RecordIdentifierFeatureName (string) required
EventTimeFeatureName (string) required
FeatureDefinitions (array) required
OnlineStoreConfig: {
. SecurityConfig (object)
. EnableOnlineStore (boolean)
. TtlDuration (object)
. StorageType (string)
} (object)
OfflineStoreConfig: {
. S3StorageConfig (object)
. DisableGlueTableCreation (boolean)
. DataCatalogConfig (object)
. TableFormat (string)
} (object)
ThroughputConfig: {
. ThroughputMode (string)
. ProvisionedReadCapacityUnits (integer)
. ProvisionedWriteCapacityUnits (integer)
} (object)
RoleArn (string)
Description (string)
Tags (array)
sagemaker/create_flow_definitionCreates a flow definition.FlowDefinitionName (string) required
HumanLoopRequestSource: {
. AwsManagedHumanLoopRequestSource (string)
} (object)
HumanLoopActivationConfig: {
. HumanLoopActivationConditionsConfig (object)
} (object)
HumanLoopConfig: {
. WorkteamArn (string)
. HumanTaskUiArn (string)
. TaskTitle (string)
. TaskDescription (string)
. TaskCount (integer)
. TaskAvailabilityLifetimeInSeconds (integer)
. TaskTimeLimitInSeconds (integer)
. TaskKeywords (array)
. PublicWorkforceTaskPrice (object)
} (object)
OutputConfig: {
. S3OutputPath (string)
. KmsKeyId (string)
} (object) required
RoleArn (string) required
Tags (array)
sagemaker/create_hubCreate a hub.HubName (string) required
HubDescription (string) required
HubDisplayName (string)
HubSearchKeywords (array)
S3StorageConfig: {
. S3OutputPath (string)
} (object)
Tags (array)
sagemaker/create_hub_content_presigned_urlsCreates presigned URLs for accessing hub content artifacts. This operation generates time-limited, secure URLs that allow direct download of model artifacts and associated files from Amazon SageMaker hub content, including gated models that require end-user license agreement acceptance.HubName (string) required
HubContentType (string) required
HubContentName (string) required
HubContentVersion (string)
AccessConfig: {
. AcceptEula (boolean)
. ExpectedS3Url (string)
} (object)
MaxResults (integer)
NextToken (string)
sagemaker/create_hub_content_referenceCreate a hub content reference in order to add a model in the JumpStart public hub to a private hub.HubName (string) required
SageMakerPublicHubContentArn (string) required
HubContentName (string)
MinVersion (string)
Tags (array)
sagemaker/create_human_task_uiDefines 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.HumanTaskUiName (string) required
UiTemplate: {
. Content (string)
} (object) required
Tags (array)
sagemaker/create_hyper_parameter_tuning_jobStarts 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. A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each traHyperParameterTuningJobName (string) required
HyperParameterTuningJobConfig: {
. Strategy (string)
. StrategyConfig (object)
. HyperParameterTuningJobObjective (object)
. ResourceLimits (object)
. ParameterRanges (object)
. TrainingJobEarlyStoppingType (string)
. TuningJobCompletionCriteria (object)
. RandomSeed (integer)
} (object) required
TrainingJobDefinition: {
. DefinitionName (string)
. TuningObjective (object)
. HyperParameterRanges (object)
. StaticHyperParameters (object)
. AlgorithmSpecification (object)
. RoleArn (string)
. InputDataConfig (array)
. VpcConfig (object)
. OutputDataConfig (object)
. ResourceConfig (object)
. HyperParameterTuningResourceConfig (object)
. StoppingCondition (object)
. EnableNetworkIsolation (boolean)
. EnableInterContainerTrafficEncryption (boolean)
. EnableManagedSpotTraining (boolean)
. CheckpointConfig (object)
. RetryStrategy (object)
. Environment (object)
} (object)
TrainingJobDefinitions (array)
WarmStartConfig: {
. ParentHyperParameterTuningJobs (array)
. WarmStartType (string)
} (object)
Tags (array)
Autotune: {
. Mode (string)
} (object)
sagemaker/create_imageCreates a custom SageMaker AI image. A SageMaker AI image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker AI image.Description (string)
DisplayName (string)
ImageName (string) required
RoleArn (string) required
Tags (array)
sagemaker/create_image_versionCreates a version of the SageMaker AI image specified by ImageName. The version represents the Amazon ECR container image specified by BaseImage.BaseImage (string) required
ClientToken (string) required
ImageName (string) required
Aliases (array)
VendorGuidance (string)
JobType (string)
MLFramework (string)
ProgrammingLang (string)
Processor (string)
Horovod (boolean)
ReleaseNotes (string)
sagemaker/create_inference_componentCreates an inference component, which is a SageMaker AI hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and theInferenceComponentName (string) required
EndpointName (string) required
VariantName (string)
Specification: {
. ModelName (string)
. Container (object)
. StartupParameters (object)
. ComputeResourceRequirements (object)
. BaseInferenceComponentName (string)
. DataCacheConfig (object)
} (object) required
RuntimeConfig: {
. CopyCount (integer)
} (object)
Tags (array)
sagemaker/create_inference_experimentCreates an inference experiment using the configurations specified in the request. Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests. Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration. While the experiment is in progress or after it has concluded, you can view meName (string) required
Type (string) required
Schedule: {
. StartTime (string)
. EndTime (string)
} (object)
Description (string)
RoleArn (string) required
EndpointName (string) required
ModelVariants (array) required
DataStorageConfig: {
. Destination (string)
. KmsKey (string)
. ContentType (object)
} (object)
ShadowModeConfig: {
. SourceModelVariantName (string)
. ShadowModelVariants (array)
} (object) required
KmsKey (string)
Tags (array)
sagemaker/create_inference_recommendations_jobStarts a recommendation job. You can create either an instance recommendation or load test job.JobName (string) required
JobType (string) required
RoleArn (string) required
InputConfig: {
. ModelPackageVersionArn (string)
. ModelName (string)
. JobDurationInSeconds (integer)
. TrafficPattern (object)
. ResourceLimit (object)
. EndpointConfigurations (array)
. VolumeKmsKeyId (string)
. ContainerConfig (object)
. Endpoints (array)
. VpcConfig (object)
} (object) required
JobDescription (string)
StoppingConditions: {
. MaxInvocations (integer)
. ModelLatencyThresholds (array)
. FlatInvocations (string)
} (object)
OutputConfig: {
. KmsKeyId (string)
. CompiledOutputConfig (object)
} (object)
Tags (array)
sagemaker/create_labeling_jobCreates 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.LabelingJobName (string) required
LabelAttributeName (string) required
InputConfig: {
. DataSource (object)
. DataAttributes (object)
} (object) required
OutputConfig: {
. S3OutputPath (string)
. KmsKeyId (string)
. SnsTopicArn (string)
} (object) required
RoleArn (string) required
LabelCategoryConfigS3Uri (string)
StoppingConditions: {
. MaxHumanLabeledObjectCount (integer)
. MaxPercentageOfInputDatasetLabeled (integer)
} (object)
LabelingJobAlgorithmsConfig: {
. LabelingJobAlgorithmSpecificationArn (string)
. InitialActiveLearningModelArn (string)
. LabelingJobResourceConfig (object)
} (object)
HumanTaskConfig: {
. WorkteamArn (string)
. UiConfig (object)
. PreHumanTaskLambdaArn (string)
. TaskKeywords (array)
. TaskTitle (string)
. TaskDescription (string)
. NumberOfHumanWorkersPerDataObject (integer)
. TaskTimeLimitInSeconds (integer)
. TaskAvailabilityLifetimeInSeconds (integer)
. MaxConcurrentTaskCount (integer)
. AnnotationConsolidationConfig (object)
. PublicWorkforceTaskPrice (object)
} (object) required
Tags (array)
sagemaker/create_mlflow_appCreates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store.Name (string) required
ArtifactStoreUri (string) required
RoleArn (string) required
ModelRegistrationMode (string)
WeeklyMaintenanceWindowStart (string)
AccountDefaultStatus (string)
DefaultDomainIdList (array)
Tags (array)
sagemaker/create_mlflow_tracking_serverCreates an MLflow Tracking Server using a general purpose Amazon S3 bucket as the artifact store. For more information, see Create an MLflow Tracking Server.TrackingServerName (string) required
ArtifactStoreUri (string) required
TrackingServerSize (string)
MlflowVersion (string)
RoleArn (string) required
AutomaticModelRegistration (boolean)
WeeklyMaintenanceWindowStart (string)
Tags (array)
sagemaker/create_modelCreates 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 CreateEndpModelName (string) required
PrimaryContainer: {
. ContainerHostname (string)
. Image (string)
. ImageConfig (object)
. Mode (string)
. ModelDataUrl (string)
. ModelDataSource (object)
. AdditionalModelDataSources (array)
. Environment (object)
. ModelPackageName (string)
. InferenceSpecificationName (string)
. MultiModelConfig (object)
} (object)
Containers (array)
InferenceExecutionConfig: {
. Mode (string)
} (object)
ExecutionRoleArn (string)
Tags (array)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
EnableNetworkIsolation (boolean)
sagemaker/create_model_bias_job_definitionCreates the definition for a model bias job.JobDefinitionName (string) required
ModelBiasBaselineConfig: {
. BaseliningJobName (string)
. ConstraintsResource (object)
} (object)
ModelBiasAppSpecification: {
. ImageUri (string)
. ConfigUri (string)
. Environment (object)
} (object) required
ModelBiasJobInput: {
. EndpointInput (object)
. BatchTransformInput (object)
. GroundTruthS3Input (object)
} (object) required
ModelBiasJobOutputConfig: {
. MonitoringOutputs (array)
. KmsKeyId (string)
} (object) required
JobResources: {
. ClusterConfig (object)
} (object) required
NetworkConfig: {
. EnableInterContainerTrafficEncryption (boolean)
. EnableNetworkIsolation (boolean)
. VpcConfig (object)
} (object)
RoleArn (string) required
StoppingCondition: {
. MaxRuntimeInSeconds (integer)
} (object)
Tags (array)
sagemaker/create_model_cardCreates an Amazon SageMaker Model Card. For information about how to use model cards, see Amazon SageMaker Model Card.ModelCardName (string) required
SecurityConfig: {
. KmsKeyId (string)
} (object)
Content (string) required
ModelCardStatus (string) required
Tags (array)
sagemaker/create_model_card_export_jobCreates an Amazon SageMaker Model Card export job.ModelCardName (string) required
ModelCardVersion (integer)
ModelCardExportJobName (string) required
OutputConfig: {
. S3OutputPath (string)
} (object) required
sagemaker/create_model_explainability_job_definitionCreates the definition for a model explainability job.JobDefinitionName (string) required
ModelExplainabilityBaselineConfig: {
. BaseliningJobName (string)
. ConstraintsResource (object)
} (object)
ModelExplainabilityAppSpecification: {
. ImageUri (string)
. ConfigUri (string)
. Environment (object)
} (object) required
ModelExplainabilityJobInput: {
. EndpointInput (object)
. BatchTransformInput (object)
} (object) required
ModelExplainabilityJobOutputConfig: {
. MonitoringOutputs (array)
. KmsKeyId (string)
} (object) required
JobResources: {
. ClusterConfig (object)
} (object) required
NetworkConfig: {
. EnableInterContainerTrafficEncryption (boolean)
. EnableNetworkIsolation (boolean)
. VpcConfig (object)
} (object)
RoleArn (string) required
StoppingCondition: {
. MaxRuntimeInSeconds (integer)
} (object)
Tags (array)
sagemaker/create_model_packageCreates 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 algorithmModelPackageName (string)
ModelPackageGroupName (string)
ModelPackageDescription (string)
ModelPackageRegistrationType (string)
InferenceSpecification: {
. Containers (array)
. SupportedTransformInstanceTypes (array)
. SupportedRealtimeInferenceInstanceTypes (array)
. SupportedContentTypes (array)
. SupportedResponseMIMETypes (array)
} (object)
ValidationSpecification: {
. ValidationRole (string)
. ValidationProfiles (array)
} (object)
SourceAlgorithmSpecification: {
. SourceAlgorithms (array)
} (object)
CertifyForMarketplace (boolean)
Tags (array)
ModelApprovalStatus (string)
MetadataProperties: {
. CommitId (string)
. Repository (string)
. GeneratedBy (string)
. ProjectId (string)
} (object)
ModelMetrics: {
. ModelQuality (object)
. ModelDataQuality (object)
. Bias (object)
. Explainability (object)
} (object)
ClientToken (string)
Domain (string)
Task (string)
SamplePayloadUrl (string)
CustomerMetadataProperties (object)
DriftCheckBaselines: {
. Bias (object)
. Explainability (object)
. ModelQuality (object)
. ModelDataQuality (object)
} (object)
AdditionalInferenceSpecifications (array)
SkipModelValidation (string)
SourceUri (string)
SecurityConfig: {
. KmsKeyId (string)
} (object)
ModelCard: {
. ModelCardContent (string)
. ModelCardStatus (string)
} (object)
ModelLifeCycle: {
. Stage (string)
. StageStatus (string)
. StageDescription (string)
} (object)
sagemaker/create_model_package_groupCreates a model group. A model group contains a group of model versions.ModelPackageGroupName (string) required
ModelPackageGroupDescription (string)
Tags (array)
sagemaker/create_model_quality_job_definitionCreates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker AI Model Monitor.JobDefinitionName (string) required
ModelQualityBaselineConfig: {
. BaseliningJobName (string)
. ConstraintsResource (object)
} (object)
ModelQualityAppSpecification: {
. ImageUri (string)
. ContainerEntrypoint (array)
. ContainerArguments (array)
. RecordPreprocessorSourceUri (string)
. PostAnalyticsProcessorSourceUri (string)
. ProblemType (string)
. Environment (object)
} (object) required
ModelQualityJobInput: {
. EndpointInput (object)
. BatchTransformInput (object)
. GroundTruthS3Input (object)
} (object) required
ModelQualityJobOutputConfig: {
. MonitoringOutputs (array)
. KmsKeyId (string)
} (object) required
JobResources: {
. ClusterConfig (object)
} (object) required
NetworkConfig: {
. EnableInterContainerTrafficEncryption (boolean)
. EnableNetworkIsolation (boolean)
. VpcConfig (object)
} (object)
RoleArn (string) required
StoppingCondition: {
. MaxRuntimeInSeconds (integer)
} (object)
Tags (array)
sagemaker/create_monitoring_scheduleCreates a schedule that regularly starts Amazon SageMaker AI Processing Jobs to monitor the data captured for an Amazon SageMaker AI Endpoint.MonitoringScheduleName (string) required
MonitoringScheduleConfig: {
. ScheduleConfig (object)
. MonitoringJobDefinition (object)
. MonitoringJobDefinitionName (string)
. MonitoringType (string)
} (object) required
Tags (array)
sagemaker/create_notebook_instanceCreates an SageMaker AI 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 AI 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 AI also provides a set of example notebooks. Each notebook demonstrates howNotebookInstanceName (string) required
InstanceType (string) required
SubnetId (string)
SecurityGroupIds (array)
IpAddressType (string)
RoleArn (string) required
KmsKeyId (string)
Tags (array)
LifecycleConfigName (string)
DirectInternetAccess (string)
VolumeSizeInGB (integer)
AcceleratorTypes (array)
DefaultCodeRepository (string)
AdditionalCodeRepositories (array)
RootAccess (string)
PlatformIdentifier (string)
InstanceMetadataServiceConfiguration: {
. MinimumInstanceMetadataServiceVersion (string)
} (object)
sagemaker/create_notebook_instance_lifecycle_configCreates 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 Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances inNotebookInstanceLifecycleConfigName (string) required
OnCreate (array)
OnStart (array)
Tags (array)
sagemaker/create_optimization_jobCreates a job that optimizes a model for inference performance. To create the job, you provide the location of a source model, and you provide the settings for the optimization techniques that you want the job to apply. When the job completes successfully, SageMaker uploads the new optimized model to the output destination that you specify. For more information about how to use this action, and about the supported optimization techniques, see Optimize model inference with Amazon SageMaker.OptimizationJobName (string) required
RoleArn (string) required
ModelSource: {
. S3 (object)
. SageMakerModel (object)
} (object) required
DeploymentInstanceType (string) required
MaxInstanceCount (integer)
OptimizationEnvironment (object)
OptimizationConfigs (array) required
OutputConfig: {
. KmsKeyId (string)
. S3OutputLocation (string)
. SageMakerModel (object)
} (object) required
StoppingCondition: {
. MaxRuntimeInSeconds (integer)
. MaxWaitTimeInSeconds (integer)
. MaxPendingTimeInSeconds (integer)
} (object) required
Tags (array)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
sagemaker/create_partner_appCreates an Amazon SageMaker Partner AI App.Name (string) required
Type (string) required
ExecutionRoleArn (string) required
KmsKeyId (string)
MaintenanceConfig: {
. MaintenanceWindowStart (string)
} (object)
Tier (string) required
ApplicationConfig: {
. AdminUsers (array)
. Arguments (object)
. AssignedGroupPatterns (array)
. RoleGroupAssignments (array)
} (object)
AuthType (string) required
EnableIamSessionBasedIdentity (boolean)
EnableAutoMinorVersionUpgrade (boolean)
ClientToken (string)
Tags (array)
sagemaker/create_partner_app_presigned_urlCreates a presigned URL to access an Amazon SageMaker Partner AI App.Arn (string) required
ExpiresInSeconds (integer)
SessionExpirationDurationInSeconds (integer)
sagemaker/create_pipelineCreates a pipeline using a JSON pipeline definition.PipelineName (string) required
PipelineDisplayName (string)
PipelineDefinition (string)
PipelineDefinitionS3Location: {
. Bucket (string)
. ObjectKey (string)
. VersionId (string)
} (object)
PipelineDescription (string)
ClientRequestToken (string) required
RoleArn (string) required
Tags (array)
ParallelismConfiguration: {
. MaxParallelExecutionSteps (integer)
} (object)
sagemaker/create_presigned_domain_urlCreates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System 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 thisDomainId (string) required
UserProfileName (string) required
SessionExpirationDurationInSeconds (integer)
ExpiresInSeconds (integer)
SpaceName (string)
LandingUri (string)
sagemaker/create_presigned_mlflow_app_urlReturns a presigned URL that you can use to connect to the MLflow UI attached to your MLflow App. For more information, see Launch the MLflow UI using a presigned URL.Arn (string) required
ExpiresInSeconds (integer)
SessionExpirationDurationInSeconds (integer)
sagemaker/create_presigned_mlflow_tracking_server_urlReturns a presigned URL that you can use to connect to the MLflow UI attached to your tracking server. For more information, see Launch the MLflow UI using a presigned URL.TrackingServerName (string) required
ExpiresInSeconds (integer)
SessionExpirationDurationInSeconds (integer)
sagemaker/create_presigned_notebook_instance_urlReturns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker AI console, when you choose Open next to a notebook instance, SageMaker AI 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 acNotebookInstanceName (string) required
SessionExpirationDurationInSeconds (integer)
sagemaker/create_processing_jobCreates a processing job.ProcessingInputs (array)
ProcessingOutputConfig: {
. Outputs (array)
. KmsKeyId (string)
} (object)
ProcessingJobName (string) required
ProcessingResources: {
. ClusterConfig (object)
} (object) required
StoppingCondition: {
. MaxRuntimeInSeconds (integer)
} (object)
AppSpecification: {
. ImageUri (string)
. ContainerEntrypoint (array)
. ContainerArguments (array)
} (object) required
Environment (object)
NetworkConfig: {
. EnableInterContainerTrafficEncryption (boolean)
. EnableNetworkIsolation (boolean)
. VpcConfig (object)
} (object)
RoleArn (string) required
Tags (array)
ExperimentConfig: {
. ExperimentName (string)
. TrialName (string)
. TrialComponentDisplayName (string)
. RunName (string)
} (object)
sagemaker/create_projectCreates 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.ProjectName (string) required
ProjectDescription (string)
ServiceCatalogProvisioningDetails: {
. ProductId (string)
. ProvisioningArtifactId (string)
. PathId (string)
. ProvisioningParameters (array)
} (object)
Tags (array)
TemplateProviders (array)
sagemaker/create_spaceCreates a private space or a space used for real time collaboration in a domain.DomainId (string) required
SpaceName (string) required
Tags (array)
SpaceSettings: {
. JupyterServerAppSettings (object)
. KernelGatewayAppSettings (object)
. CodeEditorAppSettings (object)
. JupyterLabAppSettings (object)
. AppType (string)
. SpaceStorageSettings (object)
. SpaceManagedResources (string)
. CustomFileSystems (array)
. RemoteAccess (string)
} (object)
OwnershipSettings: {
. OwnerUserProfileName (string)
} (object)
SpaceSharingSettings: {
. SharingType (string)
} (object)
SpaceDisplayName (string)
sagemaker/create_studio_lifecycle_configCreates a new Amazon SageMaker AI Studio Lifecycle Configuration.StudioLifecycleConfigName (string) required
StudioLifecycleConfigContent (string) required
StudioLifecycleConfigAppType (string) required
Tags (array)
sagemaker/create_training_jobStarts 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 theTrainingJobName (string) required
HyperParameters (object)
AlgorithmSpecification: {
. TrainingImage (string)
. AlgorithmName (string)
. TrainingInputMode (string)
. MetricDefinitions (array)
. EnableSageMakerMetricsTimeSeries (boolean)
. ContainerEntrypoint (array)
. ContainerArguments (array)
. TrainingImageConfig (object)
} (object)
RoleArn (string) required
InputDataConfig (array)
OutputDataConfig: {
. KmsKeyId (string)
. S3OutputPath (string)
. CompressionType (string)
} (object) required
ResourceConfig: {
. InstanceType (string)
. InstanceCount (integer)
. VolumeSizeInGB (integer)
. VolumeKmsKeyId (string)
. KeepAlivePeriodInSeconds (integer)
. InstanceGroups (array)
. TrainingPlanArn (string)
. InstancePlacementConfig (object)
} (object)
VpcConfig: {
. SecurityGroupIds (array)
. Subnets (array)
} (object)
StoppingCondition: {
. MaxRuntimeInSeconds (integer)
. MaxWaitTimeInSeconds (integer)
. MaxPendingTimeInSeconds (integer)
} (object)
Tags (array)
EnableNetworkIsolation (boolean)
EnableInterContainerTrafficEncryption (boolean)
EnableManagedSpotTraining (boolean)
CheckpointConfig: {
. S3Uri (string)
. LocalPath (string)
} (object)
DebugHookConfig: {
. LocalPath (string)
. S3OutputPath (string)
. HookParameters (object)
. CollectionConfigurations (array)
} (object)
DebugRuleConfigurations (array)
TensorBoardOutputConfig: {
. LocalPath (string)
. S3OutputPath (string)
} (object)
ExperimentConfig: {
. ExperimentName (string)
. TrialName (string)
. TrialComponentDisplayName (string)
. RunName (string)
} (object)
ProfilerConfig: {
. S3OutputPath (string)
. ProfilingIntervalInMilliseconds (integer)
. ProfilingParameters (object)
. DisableProfiler (boolean)
} (object)
ProfilerRuleConfigurations (array)
Environment (object)
RetryStrategy: {
. MaximumRetryAttempts (integer)
} (object)
RemoteDebugConfig: {
. EnableRemoteDebug (boolean)
} (object)
InfraCheckConfig: {
. EnableInfraCheck (boolean)
} (object)
SessionChainingConfig: {
. EnableSessionTagChaining (boolean)
} (object)
ServerlessJobConfig: {
. BaseModelArn (string)
. AcceptEula (boolean)
. JobType (string)
. CustomizationTechnique (string)
. Peft (string)
. EvaluationType (string)
. EvaluatorArn (string)
} (object)
MlflowConfig: {
. MlflowResourceArn (string)
. MlflowExperimentName (string)
. MlflowRunName (string)
} (object)
ModelPackageConfig: {
. ModelPackageGroupArn (string)
. SourceModelPackageArn (string)
} (object)
sagemaker/create_training_planCreates a new training plan in SageMaker to reserve compute capacity. Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU capacity for large-scale AI model training. It provides a way to secure predictable access to computational resources within specific timelines and budgets, without the need to manage underlying infrastructure. How it works Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperTrainingPlanName (string) required
TrainingPlanOfferingId (string) required
SpareInstanceCountPerUltraServer (integer)
Tags (array)
sagemaker/create_transform_jobStarts 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 uTransformJobName (string) required
ModelName (string) required
MaxConcurrentTransforms (integer)
ModelClientConfig: {
. InvocationsTimeoutInSeconds (integer)
. InvocationsMaxRetries (integer)
} (object)
MaxPayloadInMB (integer)
BatchStrategy (string)
Environment (object)
TransformInput: {
. DataSource (object)
. ContentType (string)
. CompressionType (string)
. SplitType (string)
} (object) required
TransformOutput: {
. S3OutputPath (string)
. Accept (string)
. AssembleWith (string)
. KmsKeyId (string)
} (object) required
DataCaptureConfig: {
. DestinationS3Uri (string)
. KmsKeyId (string)
. GenerateInferenceId (boolean)
} (object)
TransformResources: {
. InstanceType (string)
. InstanceCount (integer)
. VolumeKmsKeyId (string)
. TransformAmiVersion (string)
} (object) required
DataProcessing: {
. InputFilter (string)
. OutputFilter (string)
. JoinSource (string)
} (object)
Tags (array)
ExperimentConfig: {
. ExperimentName (string)
. TrialName (string)
. TrialComponentDisplayName (string)
. RunName (string)
} (object)
sagemaker/create_trialCreates 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 tTrialName (string) required
DisplayName (string)
ExperimentName (string) required
MetadataProperties: {
. CommitId (string)
. Repository (string)
. GeneratedBy (string)
. ProjectId (string)
} (object)
Tags (array)
sagemaker/create_trial_componentCreates 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 ATrialComponentName (string) required
DisplayName (string)
Status: {
. PrimaryStatus (string)
. Message (string)
} (object)
StartTime (string)
EndTime (string)
Parameters (object)
InputArtifacts (object)
OutputArtifacts (object)
MetadataProperties: {
. CommitId (string)
. Repository (string)
. GeneratedBy (string)
. ProjectId (string)
} (object)
Tags (array)
sagemaker/create_user_profileCreates 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 a domain. 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 ADomainId (string) required
UserProfileName (string) required
SingleSignOnUserIdentifier (string)
SingleSignOnUserValue (string)
Tags (array)
UserSettings: {
. ExecutionRole (string)
. SecurityGroups (array)
. SharingSettings (object)
. JupyterServerAppSettings (object)
. KernelGatewayAppSettings (object)
. TensorBoardAppSettings (object)
. RStudioServerProAppSettings (object)
. RSessionAppSettings (object)
. CanvasAppSettings (object)
. CodeEditorAppSettings (object)
. JupyterLabAppSettings (object)
. SpaceStorageSettings (object)
. DefaultLandingUri (string)
. StudioWebPortal (string)
. CustomPosixUserConfig (object)
. CustomFileSystemConfigs (array)
. StudioWebPortalSettings (object)
. AutoMountHomeEFS (string)
} (object)
sagemaker/create_workforceUse 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 DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce. To creCognitoConfig: {
. UserPool (string)
. ClientId (string)
} (object)
OidcConfig: {
. ClientId (string)
. ClientSecret (string)
. Issuer (string)
. AuthorizationEndpoint (string)
. TokenEndpoint (string)
. UserInfoEndpoint (string)
. LogoutEndpoint (string)
. JwksUri (string)
. Scope (string)
. AuthenticationRequestExtraParams (object)
} (object)
SourceIpConfig: {
. Cidrs (array)
} (object)
WorkforceName (string) required
Tags (array)
WorkforceVpcConfig: {
. VpcId (string)
. SecurityGroupIds (array)
. Subnets (array)
} (object)
IpAddressType (string)
sagemaker/create_workteamCreates 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.WorkteamName (string) required
WorkforceName (string)
MemberDefinitions (array) required
Description (string) required
NotificationConfiguration: {
. NotificationTopicArn (string)
} (object)
WorkerAccessConfiguration: {
. S3Presign (object)
} (object)
Tags (array)
sagemaker/delete_actionDeletes an action.ActionName (string) required
sagemaker/delete_algorithmRemoves the specified algorithm from your account.AlgorithmName (string) required
sagemaker/delete_appUsed to stop and delete an app.DomainId (string) required
UserProfileName (string)
SpaceName (string)
AppType (string) required
AppName (string) required
sagemaker/delete_app_image_configDeletes an AppImageConfig.AppImageConfigName (string) required
sagemaker/delete_artifactDeletes an artifact. Either ArtifactArn or Source must be specified.ArtifactArn (string)
Source: {
. SourceUri (string)
. SourceTypes (array)
} (object)
sagemaker/delete_associationDeletes an association.SourceArn (string) required
DestinationArn (string) required
sagemaker/delete_clusterDelete a SageMaker HyperPod cluster.ClusterName (string) required
sagemaker/delete_cluster_scheduler_configDeletes the cluster policy of the cluster.ClusterSchedulerConfigId (string) required
sagemaker/delete_code_repositoryDeletes the specified Git repository from your account.CodeRepositoryName (string) required
sagemaker/delete_compilation_jobDeletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker AI. It doesn't delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role. You can delete a compilation job only if its current status is COMPLETED, FAILED, or STOPPED. If the job status is STARTING or INPROGRESS, stop the job, and then delete it after its status becomesCompilationJobName (string) required
sagemaker/delete_compute_quotaDeletes the compute allocation from the cluster.ComputeQuotaId (string) required
sagemaker/delete_contextDeletes an context.ContextName (string) required
sagemaker/delete_data_quality_job_definitionDeletes a data quality monitoring job definition.JobDefinitionName (string) required
sagemaker/delete_device_fleetDeletes a fleet.DeviceFleetName (string) required
sagemaker/delete_domainUsed 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.DomainId (string) required
RetentionPolicy: {
. HomeEfsFileSystem (string)
} (object)
sagemaker/delete_edge_deployment_planDeletes an edge deployment plan if and only if all the stages in the plan are inactive or there are no stages in the plan.EdgeDeploymentPlanName (string) required
sagemaker/delete_edge_deployment_stageDelete a stage in an edge deployment plan if and only if the stage is inactive.EdgeDeploymentPlanName (string) required
StageName (string) required
sagemaker/delete_endpointDeletes 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 fEndpointName (string) required
sagemaker/delete_endpoint_configDeletes 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. TheEndpointConfigName (string) required
sagemaker/delete_experimentDeletes 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.ExperimentName (string) required
sagemaker/delete_feature_groupDelete 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. Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the InMemory StorageType.FeatureGroupName (string) required
sagemaker/delete_flow_definitionDeletes the specified flow definition.FlowDefinitionName (string) required
sagemaker/delete_hubDelete a hub.HubName (string) required
sagemaker/delete_hub_contentDelete the contents of a hub.HubName (string) required
HubContentType (string) required
HubContentName (string) required
HubContentVersion (string) required
sagemaker/delete_hub_content_referenceDelete a hub content reference in order to remove a model from a private hub.HubName (string) required
HubContentType (string) required
HubContentName (string) required
sagemaker/delete_human_task_uiUse 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 ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.HumanTaskUiName (string) required
sagemaker/delete_hyper_parameter_tuning_jobDeletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob API deletes only the tuning job entry that was created in SageMaker when you called the CreateHyperParameterTuningJob API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model.HyperParameterTuningJobName (string) required
sagemaker/delete_imageDeletes a SageMaker AI image and all versions of the image. The container images aren't deleted.ImageName (string) required
sagemaker/delete_image_versionDeletes a version of a SageMaker AI image. The container image the version represents isn't deleted.ImageName (string) required
Version (integer)
Alias (string)
sagemaker/delete_inference_componentDeletes an inference component.InferenceComponentName (string) required
sagemaker/delete_inference_experimentDeletes an inference experiment. This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.Name (string) required
sagemaker/delete_mlflow_appDeletes an MLflow App.Arn (string) required
sagemaker/delete_mlflow_tracking_serverDeletes an MLflow Tracking Server. For more information, see Clean up MLflow resources.TrackingServerName (string) required
sagemaker/delete_modelDeletes 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.ModelName (string) required
sagemaker/delete_model_bias_job_definitionDeletes an Amazon SageMaker AI model bias job definition.JobDefinitionName (string) required
sagemaker/delete_model_cardDeletes an Amazon SageMaker Model Card.ModelCardName (string) required
sagemaker/delete_model_explainability_job_definitionDeletes an Amazon SageMaker AI model explainability job definition.JobDefinitionName (string) required
sagemaker/delete_model_packageDeletes 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.ModelPackageName (string) required
sagemaker/delete_model_package_groupDeletes the specified model group.ModelPackageGroupName (string) required
sagemaker/delete_model_package_group_policyDeletes a model group resource policy.ModelPackageGroupName (string) required
sagemaker/delete_model_quality_job_definitionDeletes the secified model quality monitoring job definition.JobDefinitionName (string) required
sagemaker/delete_monitoring_scheduleDeletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.MonitoringScheduleName (string) required
sagemaker/delete_notebook_instanceDeletes an SageMaker AI 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 AI removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.NotebookInstanceName (string) required
sagemaker/delete_notebook_instance_lifecycle_configDeletes a notebook instance lifecycle configuration.NotebookInstanceLifecycleConfigName (string) required
sagemaker/delete_optimization_jobDeletes an optimization job.OptimizationJobName (string) required
sagemaker/delete_partner_appDeletes a SageMaker Partner AI App.Arn (string) required
ClientToken (string)
sagemaker/delete_pipelineDeletes 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.PipelineName (string) required
ClientRequestToken (string) required
sagemaker/delete_processing_jobDeletes a processing job. After Amazon SageMaker deletes a processing job, all of the metadata for the processing job is lost. You can delete only processing jobs that are in a terminal state Stopped, Failed, or Completed. You cannot delete a job that is in the InProgress or Stopping state. After deleting the job, you can reuse its name to create another processing job.ProcessingJobName (string) required
sagemaker/delete_projectDelete the specified project.ProjectName (string) required
sagemaker/delete_spaceUsed to delete a space.DomainId (string) required
SpaceName (string) required
sagemaker/delete_studio_lifecycle_configDeletes the Amazon SageMaker AI 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.StudioLifecycleConfigName (string) required
sagemaker/delete_tagsDeletes 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 Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.ResourceArn (string) required
TagKeys (array) required
sagemaker/delete_training_jobDeletes a training job. After SageMaker deletes a training job, all of the metadata for the training job is lost. You can delete only training jobs that are in a terminal state Stopped, Failed, or Completed and don't retain an Available managed warm pool. You cannot delete a job that is in the InProgress or Stopping state. After deleting the job, you can reuse its name to create another training job.TrainingJobName (string) required
sagemaker/delete_trialDeletes 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.TrialName (string) required
sagemaker/delete_trial_componentDeletes 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.TrialComponentName (string) required
sagemaker/delete_user_profileDeletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.DomainId (string) required
UserProfileName (string) required
sagemaker/delete_workforceUse 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 CreateWorkforce to create a new workforce. If a private workforce contains one or more work teams, you must use the DeleteWorkteam 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 receive aWorkforceName (string) required
sagemaker/delete_workteamDeletes an existing work team. This operation can't be undone.WorkteamName (string) required
sagemaker/deregister_devicesDeregisters the specified devices. After you deregister a device, you will need to re-register the devices.DeviceFleetName (string) required
DeviceNames (array) required
sagemaker/describe_actionDescribes an action.ActionName (string) required
sagemaker/describe_algorithmReturns a description of the specified algorithm that is in your account.AlgorithmName (string) required
sagemaker/describe_appDescribes the app.DomainId (string) required
UserProfileName (string)
SpaceName (string)
AppType (string) required
AppName (string) required
sagemaker/describe_app_image_configDescribes an AppImageConfig.AppImageConfigName (string) required
sagemaker/describe_artifactDescribes an artifact.ArtifactArn (string) required
sagemaker/describe_auto_mljobReturns information about an AutoML job created by calling CreateAutoMLJob. AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by DescribeAutoMLJob.AutoMLJobName (string) required
sagemaker/describe_auto_mljob_v2Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.AutoMLJobName (string) required
sagemaker/describe_clusterRetrieves information of a SageMaker HyperPod cluster.ClusterName (string) required
sagemaker/describe_cluster_eventRetrieves detailed information about a specific event for a given HyperPod cluster. This functionality is only supported when the NodeProvisioningMode is set to Continuous.EventId (string) required
ClusterName (string) required
sagemaker/describe_cluster_nodeRetrieves information of a node also called a instance interchangeably of a SageMaker HyperPod cluster.ClusterName (string) required
NodeId (string)
NodeLogicalId (string)
sagemaker/describe_cluster_scheduler_configDescription of the cluster policy. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.ClusterSchedulerConfigId (string) required
ClusterSchedulerConfigVersion (integer)
sagemaker/describe_code_repositoryGets details about the specified Git repository.CodeRepositoryName (string) required
sagemaker/describe_compilation_jobReturns information about a model compilation job. To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.CompilationJobName (string) required
sagemaker/describe_compute_quotaDescription of the compute allocation definition.ComputeQuotaId (string) required
ComputeQuotaVersion (integer)
sagemaker/describe_contextDescribes a context.ContextName (string) required
sagemaker/describe_data_quality_job_definitionGets the details of a data quality monitoring job definition.JobDefinitionName (string) required
sagemaker/describe_deviceDescribes the device.NextToken (string)
DeviceName (string) required
DeviceFleetName (string) required
sagemaker/describe_device_fleetA description of the fleet the device belongs to.DeviceFleetName (string) required
sagemaker/describe_domainThe description of the domain.DomainId (string) required
sagemaker/describe_edge_deployment_planDescribes an edge deployment plan with deployment status per stage.EdgeDeploymentPlanName (string) required
NextToken (string)
MaxResults (integer)
sagemaker/describe_edge_packaging_jobA description of edge packaging jobs.EdgePackagingJobName (string) required
sagemaker/describe_endpointReturns the description of an endpoint.EndpointName (string) required
sagemaker/describe_endpoint_configReturns the description of an endpoint configuration created using the CreateEndpointConfig API.EndpointConfigName (string) required
sagemaker/describe_experimentProvides a list of an experiment's properties.ExperimentName (string) required
sagemaker/describe_feature_groupUse this operation to describe a FeatureGroup. The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup, and more.FeatureGroupName (string) required
NextToken (string)
sagemaker/describe_feature_metadataShows the metadata for a feature within a feature group.FeatureGroupName (string) required
FeatureName (string) required
sagemaker/describe_flow_definitionReturns information about the specified flow definition.FlowDefinitionName (string) required
sagemaker/describe_hubDescribes a hub.HubName (string) required
sagemaker/describe_hub_contentDescribe the content of a hub.HubName (string) required
HubContentType (string) required
HubContentName (string) required
HubContentVersion (string)
sagemaker/describe_human_task_uiReturns information about the requested human task user interface worker task template.HumanTaskUiName (string) required
sagemaker/describe_hyper_parameter_tuning_jobReturns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name ARN, job status of your tuning job and more.HyperParameterTuningJobName (string) required
sagemaker/describe_imageDescribes a SageMaker AI image.ImageName (string) required
sagemaker/describe_image_versionDescribes a version of a SageMaker AI image.ImageName (string) required
Version (integer)
Alias (string)
sagemaker/describe_inference_componentReturns information about an inference component.InferenceComponentName (string) required
sagemaker/describe_inference_experimentReturns details about an inference experiment.Name (string) required
sagemaker/describe_inference_recommendations_jobProvides the results of the Inference Recommender job. One or more recommendation jobs are returned.JobName (string) required
sagemaker/describe_labeling_jobGets information about a labeling job.LabelingJobName (string) required
sagemaker/describe_lineage_groupProvides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking in the Amazon SageMaker Developer Guide.LineageGroupName (string) required
sagemaker/describe_mlflow_appReturns information about an MLflow App.Arn (string) required
sagemaker/describe_mlflow_tracking_serverReturns information about an MLflow Tracking Server.TrackingServerName (string) required
sagemaker/describe_modelDescribes a model that you created using the CreateModel API.ModelName (string) required
sagemaker/describe_model_bias_job_definitionReturns a description of a model bias job definition.JobDefinitionName (string) required
sagemaker/describe_model_cardDescribes the content, creation time, and security configuration of an Amazon SageMaker Model Card.ModelCardName (string) required
ModelCardVersion (integer)
sagemaker/describe_model_card_export_jobDescribes an Amazon SageMaker Model Card export job.ModelCardExportJobArn (string) required
sagemaker/describe_model_explainability_job_definitionReturns a description of a model explainability job definition.JobDefinitionName (string) required
sagemaker/describe_model_packageReturns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace. If you provided a KMS Key ID when you created your model package, you will see the KMS Decrypt API call in your CloudTrail logs when you use this API. To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.ModelPackageName (string) required
sagemaker/describe_model_package_groupGets a description for the specified model group.ModelPackageGroupName (string) required
sagemaker/describe_model_quality_job_definitionReturns a description of a model quality job definition.JobDefinitionName (string) required
sagemaker/describe_monitoring_scheduleDescribes the schedule for a monitoring job.MonitoringScheduleName (string) required
sagemaker/describe_notebook_instanceReturns information about a notebook instance.NotebookInstanceName (string) required
sagemaker/describe_notebook_instance_lifecycle_configReturns a description of a notebook instance lifecycle configuration. For information about notebook instance lifestyle configurations, see Step 2.1: Optional Customize a Notebook Instance.NotebookInstanceLifecycleConfigName (string) required
sagemaker/describe_optimization_jobProvides the properties of the specified optimization job.OptimizationJobName (string) required
sagemaker/describe_partner_appGets information about a SageMaker Partner AI App.Arn (string) required
IncludeAvailableUpgrade (boolean)
sagemaker/describe_pipelineDescribes the details of a pipeline.PipelineName (string) required
PipelineVersionId (integer)
sagemaker/describe_pipeline_definition_for_executionDescribes the details of an execution's pipeline definition.PipelineExecutionArn (string) required
sagemaker/describe_pipeline_executionDescribes the details of a pipeline execution.PipelineExecutionArn (string) required
sagemaker/describe_processing_jobReturns a description of a processing job.ProcessingJobName (string) required
sagemaker/describe_projectDescribes the details of a project.ProjectName (string) required
sagemaker/describe_reserved_capacityRetrieves details about a reserved capacity.ReservedCapacityArn (string) required
sagemaker/describe_spaceDescribes the space.DomainId (string) required
SpaceName (string) required
sagemaker/describe_studio_lifecycle_configDescribes the Amazon SageMaker AI Studio Lifecycle Configuration.StudioLifecycleConfigName (string) required
sagemaker/describe_subscribed_workteamGets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.WorkteamArn (string) required
sagemaker/describe_training_jobReturns 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.TrainingJobName (string) required
sagemaker/describe_training_planRetrieves detailed information about a specific training plan.TrainingPlanName (string) required
sagemaker/describe_transform_jobReturns information about a transform job.TransformJobName (string) required
sagemaker/describe_trialProvides a list of a trial's properties.TrialName (string) required
sagemaker/describe_trial_componentProvides a list of a trials component's properties.TrialComponentName (string) required
sagemaker/describe_user_profileDescribes a user profile. For more information, see CreateUserProfile.DomainId (string) required
UserProfileName (string) required
sagemaker/describe_workforceLists 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.WorkforceName (string) required
sagemaker/describe_workteamGets information about a specific work team. You can see information such as the creation date, the last updated date, membership information, and the work team's Amazon Resource Name ARN.WorkteamName (string) required
sagemaker/detach_cluster_node_volumeDetaches your Amazon Elastic Block Store Amazon EBS volume from a node in your EKS orchestrated SageMaker HyperPod cluster. This API works with the Amazon Elastic Block Store Amazon EBS Container Storage Interface CSI driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters.ClusterArn (string) required
NodeId (string) required
VolumeId (string) required
sagemaker/disable_sagemaker_servicecatalog_portfolioDisables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.No parameters
sagemaker/disassociate_trial_componentDisassociates 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.TrialCTrialComponentName (string) required
TrialName (string) required
sagemaker/enable_sagemaker_servicecatalog_portfolioEnables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.No parameters
sagemaker/get_device_fleet_reportDescribes a fleet.DeviceFleetName (string) required
sagemaker/get_lineage_group_policyThe resource policy for the lineage group.LineageGroupName (string) required
sagemaker/get_model_package_group_policyGets 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..ModelPackageGroupName (string) required
sagemaker/get_sagemaker_servicecatalog_portfolio_statusGets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.No parameters
sagemaker/get_scaling_configuration_recommendationStarts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.InferenceRecommendationsJobName (string) required
RecommendationId (string)
EndpointName (string)
TargetCpuUtilizationPerCore (integer)
ScalingPolicyObjective: {
. MinInvocationsPerMinute (integer)
. MaxInvocationsPerMinute (integer)
} (object)
sagemaker/get_search_suggestionsAn auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.Resource (string) required
SuggestionQuery: {
. PropertyNameQuery (object)
} (object)
sagemaker/import_hub_contentImport hub content.HubContentName (string) required
HubContentVersion (string)
HubContentType (string) required
DocumentSchemaVersion (string) required
HubName (string) required
HubContentDisplayName (string)
HubContentDescription (string)
HubContentMarkdown (string)
HubContentDocument (string) required
SupportStatus (string)
HubContentSearchKeywords (array)
Tags (array)
sagemaker/list_actionsLists the actions in your account and their properties.SourceUri (string)
ActionType (string)
CreatedAfter (string)
CreatedBefore (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_algorithmsLists the machine learning algorithms that have been created.CreationTimeAfter (string)
CreationTimeBefore (string)
MaxResults (integer)
NameContains (string)
NextToken (string)
SortBy (string)
SortOrder (string)
sagemaker/list_aliasesLists the aliases of a specified image or image version.ImageName (string) required
Alias (string)
Version (integer)
MaxResults (integer)
NextToken (string)
sagemaker/list_app_image_configsLists 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.MaxResults (integer)
NextToken (string)
NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
ModifiedTimeBefore (string)
ModifiedTimeAfter (string)
SortBy (string)
SortOrder (string)
sagemaker/list_appsLists apps.NextToken (string)
MaxResults (integer)
SortOrder (string)
SortBy (string)
DomainIdEquals (string)
UserProfileNameEquals (string)
SpaceNameEquals (string)
sagemaker/list_artifactsLists the artifacts in your account and their properties.SourceUri (string)
ArtifactType (string)
CreatedAfter (string)
CreatedBefore (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_associationsLists the associations in your account and their properties.SourceArn (string)
DestinationArn (string)
SourceType (string)
DestinationType (string)
AssociationType (string)
CreatedAfter (string)
CreatedBefore (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_auto_mljobsRequest a list of jobs.CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
NameContains (string)
StatusEquals (string)
SortOrder (string)
SortBy (string)
MaxResults (integer)
NextToken (string)
sagemaker/list_candidates_for_auto_mljobList the candidates created for the job.AutoMLJobName (string) required
StatusEquals (string)
CandidateNameEquals (string)
SortOrder (string)
SortBy (string)
MaxResults (integer)
NextToken (string)
sagemaker/list_cluster_eventsRetrieves a list of event summaries for a specified HyperPod cluster. The operation supports filtering, sorting, and pagination of results. This functionality is only supported when the NodeProvisioningMode is set to Continuous.ClusterName (string) required
InstanceGroupName (string)
NodeId (string)
EventTimeAfter (string)
EventTimeBefore (string)
SortBy (string)
SortOrder (string)
ResourceType (string)
MaxResults (integer)
NextToken (string)
sagemaker/list_cluster_nodesRetrieves the list of instances also called nodes interchangeably in a SageMaker HyperPod cluster.ClusterName (string) required
CreationTimeAfter (string)
CreationTimeBefore (string)
InstanceGroupNameContains (string)
MaxResults (integer)
NextToken (string)
SortBy (string)
SortOrder (string)
IncludeNodeLogicalIds (boolean)
sagemaker/list_clustersRetrieves the list of SageMaker HyperPod clusters.CreationTimeAfter (string)
CreationTimeBefore (string)
MaxResults (integer)
NameContains (string)
NextToken (string)
SortBy (string)
SortOrder (string)
TrainingPlanArn (string)
sagemaker/list_cluster_scheduler_configsList the cluster policy configurations.CreatedAfter (string)
CreatedBefore (string)
NameContains (string)
ClusterArn (string)
Status (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_code_repositoriesGets a list of the Git repositories in your account.CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
MaxResults (integer)
NameContains (string)
NextToken (string)
SortBy (string)
SortOrder (string)
sagemaker/list_compilation_jobsLists 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.NextToken (string)
MaxResults (integer)
CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
NameContains (string)
StatusEquals (string)
SortBy (string)
SortOrder (string)
sagemaker/list_compute_quotasList the resource allocation definitions.CreatedAfter (string)
CreatedBefore (string)
NameContains (string)
Status (string)
ClusterArn (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_contextsLists the contexts in your account and their properties.SourceUri (string)
ContextType (string)
CreatedAfter (string)
CreatedBefore (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_data_quality_job_definitionsLists the data quality job definitions in your account.EndpointName (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
sagemaker/list_device_fleetsReturns a list of devices in the fleet.NextToken (string)
MaxResults (integer)
CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
NameContains (string)
SortBy (string)
SortOrder (string)
sagemaker/list_devicesA list of devices.NextToken (string)
MaxResults (integer)
LatestHeartbeatAfter (string)
ModelName (string)
DeviceFleetName (string)
sagemaker/list_domainsLists the domains.NextToken (string)
MaxResults (integer)
sagemaker/list_edge_deployment_plansLists all edge deployment plans.NextToken (string)
MaxResults (integer)
CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
NameContains (string)
DeviceFleetNameContains (string)
SortBy (string)
SortOrder (string)
sagemaker/list_edge_packaging_jobsReturns a list of edge packaging jobs.NextToken (string)
MaxResults (integer)
CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
NameContains (string)
ModelNameContains (string)
StatusEquals (string)
SortBy (string)
SortOrder (string)
sagemaker/list_endpoint_configsLists endpoint configurations.SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
sagemaker/list_endpointsLists endpoints.SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
LastModifiedTimeBefore (string)
LastModifiedTimeAfter (string)
StatusEquals (string)
sagemaker/list_experimentsLists 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.CreatedAfter (string)
CreatedBefore (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_feature_groupsList FeatureGroups based on given filter and order.NameContains (string)
FeatureGroupStatusEquals (string)
OfflineStoreStatusEquals (string)
CreationTimeAfter (string)
CreationTimeBefore (string)
SortOrder (string)
SortBy (string)
MaxResults (integer)
NextToken (string)
sagemaker/list_flow_definitionsReturns information about the flow definitions in your account.CreationTimeAfter (string)
CreationTimeBefore (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_hub_contentsList the contents of a hub.HubName (string) required
HubContentType (string) required
NameContains (string)
MaxSchemaVersion (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
SortBy (string)
SortOrder (string)
MaxResults (integer)
NextToken (string)
sagemaker/list_hub_content_versionsList hub content versions.HubName (string) required
HubContentType (string) required
HubContentName (string) required
MinVersion (string)
MaxSchemaVersion (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
SortBy (string)
SortOrder (string)
MaxResults (integer)
NextToken (string)
sagemaker/list_hubsList all existing hubs.NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
LastModifiedTimeBefore (string)
LastModifiedTimeAfter (string)
SortBy (string)
SortOrder (string)
MaxResults (integer)
NextToken (string)
sagemaker/list_human_task_uisReturns information about the human task user interfaces in your account.CreationTimeAfter (string)
CreationTimeBefore (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_hyper_parameter_tuning_jobsGets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.NextToken (string)
MaxResults (integer)
SortBy (string)
SortOrder (string)
NameContains (string)
CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
StatusEquals (string)
sagemaker/list_imagesLists 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.CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
MaxResults (integer)
NameContains (string)
NextToken (string)
SortBy (string)
SortOrder (string)
sagemaker/list_image_versionsLists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.CreationTimeAfter (string)
CreationTimeBefore (string)
ImageName (string) required
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
MaxResults (integer)
NextToken (string)
SortBy (string)
SortOrder (string)
sagemaker/list_inference_componentsLists the inference components in your account and their properties.SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
LastModifiedTimeBefore (string)
LastModifiedTimeAfter (string)
StatusEquals (string)
EndpointNameEquals (string)
VariantNameEquals (string)
sagemaker/list_inference_experimentsReturns the list of all inference experiments.NameContains (string)
Type (string)
StatusEquals (string)
CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_inference_recommendations_jobsLists recommendation jobs that satisfy various filters.CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
NameContains (string)
StatusEquals (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
ModelNameEquals (string)
ModelPackageVersionArnEquals (string)
sagemaker/list_inference_recommendations_job_stepsReturns a list of the subtasks for an Inference Recommender job. The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.JobName (string) required
Status (string)
StepType (string)
MaxResults (integer)
NextToken (string)
sagemaker/list_labeling_jobsGets a list of labeling jobs.CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
MaxResults (integer)
NextToken (string)
NameContains (string)
SortBy (string)
SortOrder (string)
StatusEquals (string)
sagemaker/list_labeling_jobs_for_workteamGets a list of labeling jobs assigned to a specified work team.WorkteamArn (string) required
MaxResults (integer)
NextToken (string)
CreationTimeAfter (string)
CreationTimeBefore (string)
JobReferenceCodeContains (string)
SortBy (string)
SortOrder (string)
sagemaker/list_lineage_groupsA 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.CreatedAfter (string)
CreatedBefore (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_mlflow_appsLists all MLflow AppsCreatedAfter (string)
CreatedBefore (string)
Status (string)
MlflowVersion (string)
DefaultForDomainId (string)
AccountDefaultStatus (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_mlflow_tracking_serversLists all MLflow Tracking Servers.CreatedAfter (string)
CreatedBefore (string)
TrackingServerStatus (string)
MlflowVersion (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_model_bias_job_definitionsLists model bias jobs definitions that satisfy various filters.EndpointName (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
sagemaker/list_model_card_export_jobsList the export jobs for the Amazon SageMaker Model Card.ModelCardName (string) required
ModelCardVersion (integer)
CreationTimeAfter (string)
CreationTimeBefore (string)
ModelCardExportJobNameContains (string)
StatusEquals (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_model_cardsList existing model cards.CreationTimeAfter (string)
CreationTimeBefore (string)
MaxResults (integer)
NameContains (string)
ModelCardStatus (string)
NextToken (string)
SortBy (string)
SortOrder (string)
sagemaker/list_model_card_versionsList existing versions of an Amazon SageMaker Model Card.CreationTimeAfter (string)
CreationTimeBefore (string)
MaxResults (integer)
ModelCardName (string) required
ModelCardStatus (string)
NextToken (string)
SortBy (string)
SortOrder (string)
sagemaker/list_model_explainability_job_definitionsLists model explainability job definitions that satisfy various filters.EndpointName (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
sagemaker/list_model_metadataLists the domain, framework, task, and model name of standard machine learning models found in common model zoos.SearchExpression: {
. Filters (array)
} (object)
NextToken (string)
MaxResults (integer)
sagemaker/list_model_package_groupsGets a list of the model groups in your Amazon Web Services account.CreationTimeAfter (string)
CreationTimeBefore (string)
MaxResults (integer)
NameContains (string)
NextToken (string)
SortBy (string)
SortOrder (string)
CrossAccountFilterOption (string)
sagemaker/list_model_packagesLists the model packages that have been created.CreationTimeAfter (string)
CreationTimeBefore (string)
MaxResults (integer)
NameContains (string)
ModelApprovalStatus (string)
ModelPackageGroupName (string)
ModelPackageType (string)
NextToken (string)
SortBy (string)
SortOrder (string)
sagemaker/list_model_quality_job_definitionsGets a list of model quality monitoring job definitions in your account.EndpointName (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
sagemaker/list_modelsLists models created with the CreateModel API.SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
sagemaker/list_monitoring_alert_historyGets a list of past alerts in a model monitoring schedule.MonitoringScheduleName (string)
MonitoringAlertName (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
CreationTimeBefore (string)
CreationTimeAfter (string)
StatusEquals (string)
sagemaker/list_monitoring_alertsGets the alerts for a single monitoring schedule.MonitoringScheduleName (string) required
NextToken (string)
MaxResults (integer)
sagemaker/list_monitoring_executionsReturns list of all monitoring job executions.MonitoringScheduleName (string)
EndpointName (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
ScheduledTimeBefore (string)
ScheduledTimeAfter (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
LastModifiedTimeBefore (string)
LastModifiedTimeAfter (string)
StatusEquals (string)
MonitoringJobDefinitionName (string)
MonitoringTypeEquals (string)
sagemaker/list_monitoring_schedulesReturns list of all monitoring schedules.EndpointName (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
LastModifiedTimeBefore (string)
LastModifiedTimeAfter (string)
StatusEquals (string)
MonitoringJobDefinitionName (string)
MonitoringTypeEquals (string)
sagemaker/list_notebook_instance_lifecycle_configsLists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.NextToken (string)
MaxResults (integer)
SortBy (string)
SortOrder (string)
NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
LastModifiedTimeBefore (string)
LastModifiedTimeAfter (string)
sagemaker/list_notebook_instancesReturns a list of the SageMaker AI notebook instances in the requester's account in an Amazon Web Services Region.NextToken (string)
MaxResults (integer)
SortBy (string)
SortOrder (string)
NameContains (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
LastModifiedTimeBefore (string)
LastModifiedTimeAfter (string)
StatusEquals (string)
NotebookInstanceLifecycleConfigNameContains (string)
DefaultCodeRepositoryContains (string)
AdditionalCodeRepositoryEquals (string)
sagemaker/list_optimization_jobsLists the optimization jobs in your account and their properties.NextToken (string)
MaxResults (integer)
CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
OptimizationContains (string)
NameContains (string)
StatusEquals (string)
SortBy (string)
SortOrder (string)
sagemaker/list_partner_appsLists all of the SageMaker Partner AI Apps in an account.MaxResults (integer)
NextToken (string)
sagemaker/list_pipeline_executionsGets a list of the pipeline executions.PipelineName (string) required
CreatedAfter (string)
CreatedBefore (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_pipeline_execution_stepsGets a list of PipeLineExecutionStep objects.PipelineExecutionArn (string)
NextToken (string)
MaxResults (integer)
SortOrder (string)
sagemaker/list_pipeline_parameters_for_executionGets a list of parameters for a pipeline execution.PipelineExecutionArn (string) required
NextToken (string)
MaxResults (integer)
sagemaker/list_pipelinesGets a list of pipelines.PipelineNamePrefix (string)
CreatedAfter (string)
CreatedBefore (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_pipeline_versionsGets a list of all versions of the pipeline.PipelineName (string) required
CreatedAfter (string)
CreatedBefore (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_processing_jobsLists processing jobs that satisfy various filters.CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
NameContains (string)
StatusEquals (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_projectsGets a list of the projects in an Amazon Web Services account.CreationTimeAfter (string)
CreationTimeBefore (string)
MaxResults (integer)
NameContains (string)
NextToken (string)
SortBy (string)
SortOrder (string)
sagemaker/list_resource_catalogsLists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalogs viewable is 1000.NameContains (string)
CreationTimeAfter (string)
CreationTimeBefore (string)
SortOrder (string)
SortBy (string)
MaxResults (integer)
NextToken (string)
sagemaker/list_spacesLists spaces.NextToken (string)
MaxResults (integer)
SortOrder (string)
SortBy (string)
DomainIdEquals (string)
SpaceNameContains (string)
sagemaker/list_stage_devicesLists devices allocated to the stage, containing detailed device information and deployment status.NextToken (string)
MaxResults (integer)
EdgeDeploymentPlanName (string) required
ExcludeDevicesDeployedInOtherStage (boolean)
StageName (string) required
sagemaker/list_studio_lifecycle_configsLists the Amazon SageMaker AI Studio Lifecycle Configurations in your Amazon Web Services Account.MaxResults (integer)
NextToken (string)
NameContains (string)
AppTypeEquals (string)
CreationTimeBefore (string)
CreationTimeAfter (string)
ModifiedTimeBefore (string)
ModifiedTimeAfter (string)
SortBy (string)
SortOrder (string)
sagemaker/list_subscribed_workteamsGets 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.NameContains (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_tagsReturns the tags for the specified SageMaker resource.ResourceArn (string) required
NextToken (string)
MaxResults (integer)
sagemaker/list_training_jobsLists 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 accorNextToken (string)
MaxResults (integer)
CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
NameContains (string)
StatusEquals (string)
SortBy (string)
SortOrder (string)
WarmPoolStatusEquals (string)
TrainingPlanArnEquals (string)
sagemaker/list_training_jobs_for_hyper_parameter_tuning_jobGets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.HyperParameterTuningJobName (string) required
NextToken (string)
MaxResults (integer)
StatusEquals (string)
SortBy (string)
SortOrder (string)
sagemaker/list_training_plansRetrieves a list of training plans for the current account.NextToken (string)
MaxResults (integer)
StartTimeAfter (string)
StartTimeBefore (string)
SortBy (string)
SortOrder (string)
Filters (array)
sagemaker/list_transform_jobsLists transform jobs.CreationTimeAfter (string)
CreationTimeBefore (string)
LastModifiedTimeAfter (string)
LastModifiedTimeBefore (string)
NameContains (string)
StatusEquals (string)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_trial_componentsLists 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 TrialNameExperimentName (string)
TrialName (string)
SourceArn (string)
CreatedAfter (string)
CreatedBefore (string)
SortBy (string)
SortOrder (string)
MaxResults (integer)
NextToken (string)
sagemaker/list_trialsLists 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.ExperimentName (string)
TrialComponentName (string)
CreatedAfter (string)
CreatedBefore (string)
SortBy (string)
SortOrder (string)
MaxResults (integer)
NextToken (string)
sagemaker/list_ultra_servers_by_reserved_capacityLists all UltraServers that are part of a specified reserved capacity.ReservedCapacityArn (string) required
MaxResults (integer)
NextToken (string)
sagemaker/list_user_profilesLists user profiles.NextToken (string)
MaxResults (integer)
SortOrder (string)
SortBy (string)
DomainIdEquals (string)
UserProfileNameContains (string)
sagemaker/list_workforcesUse 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.SortBy (string)
SortOrder (string)
NameContains (string)
NextToken (string)
MaxResults (integer)
sagemaker/list_workteamsGets 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.SortBy (string)
SortOrder (string)
NameContains (string)
NextToken (string)
MaxResults (integer)
sagemaker/put_model_package_group_policyAdds 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..ModelPackageGroupName (string) required
ResourcePolicy (string) required
sagemaker/query_lineageUse this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.StartArns (array)
Direction (string)
IncludeEdges (boolean)
Filters: {
. Types (array)
. LineageTypes (array)
. CreatedBefore (string)
. CreatedAfter (string)
. ModifiedBefore (string)
. ModifiedAfter (string)
. Properties (object)
} (object)
MaxDepth (integer)
MaxResults (integer)
NextToken (string)
sagemaker/register_devicesRegister devices.DeviceFleetName (string) required
Devices (array) required
Tags (array)
sagemaker/render_ui_templateRenders the UI template so that you can preview the worker's experience.UiTemplate: {
. Content (string)
} (object)
Task: {
. Input (string)
} (object) required
RoleArn (string) required
HumanTaskUiArn (string)
sagemaker/retry_pipeline_executionRetry the execution of the pipeline.PipelineExecutionArn (string) required
ClientRequestToken (string) required
ParallelismConfiguration: {
. MaxParallelExecutionSteps (integer)
} (object)
sagemaker/searchFinds 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. The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.Resource (string) required
SearchExpression: {
. Filters (array)
. NestedFilters (array)
. SubExpressions (array)
. Operator (string)
} (object)
SortBy (string)
SortOrder (string)
NextToken (string)
MaxResults (integer)
CrossAccountFilterOption (string)
VisibilityConditions (array)
sagemaker/search_training_plan_offeringsSearches for available training plan offerings based on specified criteria. Users search for available plan offerings based on their requirements e.g., instance type, count, start time, duration. And then, they create a plan that best matches their needs using the ID of the plan offering they want to use. For more information about how to reserve GPU capacity for your SageMaker training jobs or SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see CreateTrainingPlan .InstanceType (string)
InstanceCount (integer)
UltraServerType (string)
UltraServerCount (integer)
StartTimeAfter (string)
EndTimeBefore (string)
DurationHours (integer)
TargetResources (array)
sagemaker/send_pipeline_execution_step_failureNotifies 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.CallbackToken (string) required
FailureReason (string)
ClientRequestToken (string)
sagemaker/send_pipeline_execution_step_successNotifies 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.CallbackToken (string) required
OutputParameters (array)
ClientRequestToken (string)
sagemaker/start_edge_deployment_stageStarts a stage in an edge deployment plan.EdgeDeploymentPlanName (string) required
StageName (string) required
sagemaker/start_inference_experimentStarts an inference experiment.Name (string) required
sagemaker/start_mlflow_tracking_serverProgrammatically start an MLflow Tracking Server.TrackingServerName (string) required
sagemaker/start_monitoring_scheduleStarts a previously stopped monitoring schedule. By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.MonitoringScheduleName (string) required
sagemaker/start_notebook_instanceLaunches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker AI sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.NotebookInstanceName (string) required
sagemaker/start_pipeline_executionStarts a pipeline execution.PipelineName (string) required
PipelineExecutionDisplayName (string)
PipelineParameters (array)
PipelineExecutionDescription (string)
ClientRequestToken (string) required
ParallelismConfiguration: {
. MaxParallelExecutionSteps (integer)
} (object)
SelectiveExecutionConfig: {
. SourcePipelineExecutionArn (string)
. SelectedSteps (array)
} (object)
PipelineVersionId (integer)
MlflowExperimentName (string)
sagemaker/start_sessionInitiates a remote connection session between a local integrated development environments IDEs and a remote SageMaker space.ResourceIdentifier (string) required
sagemaker/stop_auto_mljobA method for forcing a running job to shut down.AutoMLJobName (string) required
sagemaker/stop_compilation_jobStops a model compilation job. To stop a job, Amazon SageMaker AI 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 AI changes the CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped.CompilationJobName (string) required
sagemaker/stop_edge_deployment_stageStops a stage in an edge deployment plan.EdgeDeploymentPlanName (string) required
StageName (string) required
sagemaker/stop_edge_packaging_jobRequest to stop an edge packaging job.EdgePackagingJobName (string) required
sagemaker/stop_hyper_parameter_tuning_jobStops 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.HyperParameterTuningJobName (string) required
sagemaker/stop_inference_experimentStops an inference experiment.Name (string) required
ModelVariantActions (object) required
DesiredModelVariants (array)
DesiredState (string)
Reason (string)
sagemaker/stop_inference_recommendations_jobStops an Inference Recommender job.JobName (string) required
sagemaker/stop_labeling_jobStops 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.LabelingJobName (string) required
sagemaker/stop_mlflow_tracking_serverProgrammatically stop an MLflow Tracking Server.TrackingServerName (string) required
sagemaker/stop_monitoring_scheduleStops a previously started monitoring schedule.MonitoringScheduleName (string) required
sagemaker/stop_notebook_instanceTerminates the ML compute instance. Before terminating the instance, SageMaker AI disconnects the ML storage volume from it. SageMaker AI preserves the ML storage volume. SageMaker AI 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 stNotebookInstanceName (string) required
sagemaker/stop_optimization_jobEnds a running inference optimization job.OptimizationJobName (string) required
sagemaker/stop_pipeline_executionStops 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 thePipelineExecutionArn (string) required
ClientRequestToken (string) required
sagemaker/stop_processing_jobStops a processing job.ProcessingJobName (string) required
sagemaker/stop_training_jobStops 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.TrainingJobName (string) required
sagemaker/stop_transform_jobStops 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.TransformJobName (string) required
sagemaker/update_actionUpdates an action.ActionName (string) required
Description (string)
Status (string)
Properties (object)
PropertiesToRemove (array)
sagemaker/update_app_image_configUpdates the properties of an AppImageConfig.AppImageConfigName (string) required
KernelGatewayImageConfig: {
. KernelSpecs (array)
. FileSystemConfig (object)
} (object)
JupyterLabAppImageConfig: {
. FileSystemConfig (object)
. ContainerConfig (object)
} (object)
CodeEditorAppImageConfig: {
. FileSystemConfig (object)
. ContainerConfig (object)
} (object)
sagemaker/update_artifactUpdates an artifact.ArtifactArn (string) required
ArtifactName (string)
Properties (object)
PropertiesToRemove (array)
sagemaker/update_clusterUpdates a SageMaker HyperPod cluster.ClusterName (string) required
InstanceGroups (array)
RestrictedInstanceGroups (array)
TieredStorageConfig: {
. Mode (string)
. InstanceMemoryAllocationPercentage (integer)
} (object)
NodeRecovery (string)
InstanceGroupsToDelete (array)
NodeProvisioningMode (string)
ClusterRole (string)
AutoScaling: {
. Mode (string)
. AutoScalerType (string)
} (object)
Orchestrator: {
. Eks (object)
. Slurm (object)
} (object)
sagemaker/update_cluster_scheduler_configUpdate the cluster policy configuration.ClusterSchedulerConfigId (string) required
TargetVersion (integer) required
SchedulerConfig: {
. PriorityClasses (array)
. FairShare (string)
. IdleResourceSharing (string)
} (object)
Description (string)
sagemaker/update_cluster_softwareUpdates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster. The UpgradeClusterSoftware API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads.ClusterName (string) required
InstanceGroups (array)
DeploymentConfig: {
. RollingUpdatePolicy (object)
. WaitIntervalInSeconds (integer)
. AutoRollbackConfiguration (array)
} (object)
ImageId (string)
sagemaker/update_code_repositoryUpdates the specified Git repository with the specified values.CodeRepositoryName (string) required
GitConfig: {
. SecretArn (string)
} (object)
sagemaker/update_compute_quotaUpdate the compute allocation definition.ComputeQuotaId (string) required
TargetVersion (integer) required
ComputeQuotaConfig: {
. ComputeQuotaResources (array)
. ResourceSharingConfig (object)
. PreemptTeamTasks (string)
} (object)
ComputeQuotaTarget: {
. TeamName (string)
. FairShareWeight (integer)
} (object)
ActivationState (string)
Description (string)
sagemaker/update_contextUpdates a context.ContextName (string) required
Description (string)
Properties (object)
PropertiesToRemove (array)
sagemaker/update_device_fleetUpdates a fleet of devices.DeviceFleetName (string) required
RoleArn (string)
Description (string)
OutputConfig: {
. S3OutputLocation (string)
. KmsKeyId (string)
. PresetDeploymentType (string)
. PresetDeploymentConfig (string)
} (object) required
EnableIotRoleAlias (boolean)
sagemaker/update_devicesUpdates one or more devices in a fleet.DeviceFleetName (string) required
Devices (array) required
sagemaker/update_domainUpdates the default settings for new user profiles in the domain.DomainId (string) required
DefaultUserSettings: {
. ExecutionRole (string)
. SecurityGroups (array)
. SharingSettings (object)
. JupyterServerAppSettings (object)
. KernelGatewayAppSettings (object)
. TensorBoardAppSettings (object)
. RStudioServerProAppSettings (object)
. RSessionAppSettings (object)
. CanvasAppSettings (object)
. CodeEditorAppSettings (object)
. JupyterLabAppSettings (object)
. SpaceStorageSettings (object)
. DefaultLandingUri (string)
. StudioWebPortal (string)
. CustomPosixUserConfig (object)
. CustomFileSystemConfigs (array)
. StudioWebPortalSettings (object)
. AutoMountHomeEFS (string)
} (object)
DomainSettingsForUpdate: {
. RStudioServerProDomainSettingsForUpdate (object)
. ExecutionRoleIdentityConfig (string)
. SecurityGroupIds (array)
. TrustedIdentityPropagationSettings (object)
. DockerSettings (object)
. AmazonQSettings (object)
. UnifiedStudioSettings (object)
. IpAddressType (string)
} (object)
AppSecurityGroupManagement (string)
DefaultSpaceSettings: {
. ExecutionRole (string)
. SecurityGroups (array)
. JupyterServerAppSettings (object)
. KernelGatewayAppSettings (object)
. JupyterLabAppSettings (object)
. SpaceStorageSettings (object)
. CustomPosixUserConfig (object)
. CustomFileSystemConfigs (array)
} (object)
SubnetIds (array)
AppNetworkAccessType (string)
TagPropagation (string)
VpcId (string)
sagemaker/update_endpointDeploys the EndpointConfig specified in the request to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint configuration and then deletes the old instances using the previous EndpointConfig there is no availability loss. For more information about how to control the update and traffic shifting process, see Update models in production. When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, iEndpointName (string) required
EndpointConfigName (string) required
RetainAllVariantProperties (boolean)
ExcludeRetainedVariantProperties (array)
DeploymentConfig: {
. BlueGreenUpdatePolicy (object)
. RollingUpdatePolicy (object)
. AutoRollbackConfiguration (object)
} (object)
RetainDeploymentConfig (boolean)
sagemaker/update_endpoint_weights_and_capacitiesUpdates 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.EndpointName (string) required
DesiredWeightsAndCapacities (array) required
sagemaker/update_experimentAdds, updates, or removes the description of an experiment. Updates the display name of an experiment.ExperimentName (string) required
DisplayName (string)
Description (string)
sagemaker/update_feature_groupUpdates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the UpdateFeatureGroup API. You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group. You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all recoFeatureGroupName (string) required
FeatureAdditions (array)
OnlineStoreConfig: {
. TtlDuration (object)
} (object)
ThroughputConfig: {
. ThroughputMode (string)
. ProvisionedReadCapacityUnits (integer)
. ProvisionedWriteCapacityUnits (integer)
} (object)
sagemaker/update_feature_metadataUpdates the description and parameters of the feature group.FeatureGroupName (string) required
FeatureName (string) required
Description (string)
ParameterAdditions (array)
ParameterRemovals (array)
sagemaker/update_hubUpdate a hub.HubName (string) required
HubDescription (string)
HubDisplayName (string)
HubSearchKeywords (array)
sagemaker/update_hub_contentUpdates SageMaker hub content either a Model or Notebook resource. You can update the metadata that describes the resource. In addition to the required request fields, specify at least one of the following fields to update: HubContentDescription HubContentDisplayName HubContentMarkdown HubContentSearchKeywords SupportStatus For more information about hubs, see Private curated hubs for foundation model access control in JumpStart. If you want to update a ModelReference resource in your hub, use tHubName (string) required
HubContentName (string) required
HubContentType (string) required
HubContentVersion (string) required
HubContentDisplayName (string)
HubContentDescription (string)
HubContentMarkdown (string)
HubContentSearchKeywords (array)
SupportStatus (string)
sagemaker/update_hub_content_referenceUpdates the contents of a SageMaker hub for a ModelReference resource. A ModelReference allows you to access public SageMaker JumpStart models from within your private hub. When using this API, you can update the MinVersion field for additional flexibility in the model version. You shouldn't update any additional fields when using this API, because the metadata in your private hub should match the public JumpStart model's metadata. If you want to update a Model or Notebook resource in your hub,HubName (string) required
HubContentName (string) required
HubContentType (string) required
MinVersion (string)
sagemaker/update_imageUpdates the properties of a SageMaker AI image. To change the image's tags, use the AddTags and DeleteTags APIs.DeleteProperties (array)
Description (string)
DisplayName (string)
ImageName (string) required
RoleArn (string)
sagemaker/update_image_versionUpdates the properties of a SageMaker AI image version.ImageName (string) required
Alias (string)
Version (integer)
AliasesToAdd (array)
AliasesToDelete (array)
VendorGuidance (string)
JobType (string)
MLFramework (string)
ProgrammingLang (string)
Processor (string)
Horovod (boolean)
ReleaseNotes (string)
sagemaker/update_inference_componentUpdates an inference component.InferenceComponentName (string) required
Specification: {
. ModelName (string)
. Container (object)
. StartupParameters (object)
. ComputeResourceRequirements (object)
. BaseInferenceComponentName (string)
. DataCacheConfig (object)
} (object)
RuntimeConfig: {
. CopyCount (integer)
} (object)
DeploymentConfig: {
. RollingUpdatePolicy (object)
. AutoRollbackConfiguration (object)
} (object)
sagemaker/update_inference_component_runtime_configRuntime settings for a model that is deployed with an inference component.InferenceComponentName (string) required
DesiredRuntimeConfig: {
. CopyCount (integer)
} (object) required
sagemaker/update_inference_experimentUpdates an inference experiment that you created. The status of the inference experiment has to be either Created, Running. For more information on the status of an inference experiment, see DescribeInferenceExperiment.Name (string) required
Schedule: {
. StartTime (string)
. EndTime (string)
} (object)
Description (string)
ModelVariants (array)
DataStorageConfig: {
. Destination (string)
. KmsKey (string)
. ContentType (object)
} (object)
ShadowModeConfig: {
. SourceModelVariantName (string)
. ShadowModelVariants (array)
} (object)
sagemaker/update_mlflow_appUpdates an MLflow App.Arn (string) required
Name (string)
ArtifactStoreUri (string)
ModelRegistrationMode (string)
WeeklyMaintenanceWindowStart (string)
DefaultDomainIdList (array)
AccountDefaultStatus (string)
sagemaker/update_mlflow_tracking_serverUpdates properties of an existing MLflow Tracking Server.TrackingServerName (string) required
ArtifactStoreUri (string)
TrackingServerSize (string)
AutomaticModelRegistration (boolean)
WeeklyMaintenanceWindowStart (string)
sagemaker/update_model_cardUpdate an Amazon SageMaker Model Card. You cannot update both model card content and model card status in a single call.ModelCardName (string) required
Content (string)
ModelCardStatus (string)
sagemaker/update_model_packageUpdates a versioned model.ModelPackageArn (string) required
ModelApprovalStatus (string)
ModelPackageRegistrationType (string)
ApprovalDescription (string)
CustomerMetadataProperties (object)
CustomerMetadataPropertiesToRemove (array)
AdditionalInferenceSpecificationsToAdd (array)
InferenceSpecification: {
. Containers (array)
. SupportedTransformInstanceTypes (array)
. SupportedRealtimeInferenceInstanceTypes (array)
. SupportedContentTypes (array)
. SupportedResponseMIMETypes (array)
} (object)
SourceUri (string)
ModelCard: {
. ModelCardContent (string)
. ModelCardStatus (string)
} (object)
ModelLifeCycle: {
. Stage (string)
. StageStatus (string)
. StageDescription (string)
} (object)
ClientToken (string)
sagemaker/update_monitoring_alertUpdate the parameters of a model monitor alert.MonitoringScheduleName (string) required
MonitoringAlertName (string) required
DatapointsToAlert (integer) required
EvaluationPeriod (integer) required
sagemaker/update_monitoring_scheduleUpdates a previously created schedule.MonitoringScheduleName (string) required
MonitoringScheduleConfig: {
. ScheduleConfig (object)
. MonitoringJobDefinition (object)
. MonitoringJobDefinitionName (string)
. MonitoringType (string)
} (object) required
sagemaker/update_notebook_instanceUpdates 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. This API can attach lifecycle configurations to notebook instances. Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Principals with this permission and access to lifecycle configurations can execute code with the execution role's credeNotebookInstanceName (string) required
InstanceType (string)
IpAddressType (string)
PlatformIdentifier (string)
RoleArn (string)
LifecycleConfigName (string)
DisassociateLifecycleConfig (boolean)
VolumeSizeInGB (integer)
DefaultCodeRepository (string)
AdditionalCodeRepositories (array)
AcceleratorTypes (array)
DisassociateAcceleratorTypes (boolean)
DisassociateDefaultCodeRepository (boolean)
DisassociateAdditionalCodeRepositories (boolean)
RootAccess (string)
InstanceMetadataServiceConfiguration: {
. MinimumInstanceMetadataServiceVersion (string)
} (object)
sagemaker/update_notebook_instance_lifecycle_configUpdates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API. Updates to lifecycle configurations affect all notebook instances using that configuration upon their next start. Lifecycle configuration scripts execute with root access and the notebook instance's IAM execution role privileges. Grant this permission only to trusted principals. See Customize a Notebook Instance Using a Lifecycle Configuration Script for security best practices.NotebookInstanceLifecycleConfigName (string) required
OnCreate (array)
OnStart (array)
sagemaker/update_partner_appUpdates all of the SageMaker Partner AI Apps in an account.Arn (string) required
MaintenanceConfig: {
. MaintenanceWindowStart (string)
} (object)
Tier (string)
ApplicationConfig: {
. AdminUsers (array)
. Arguments (object)
. AssignedGroupPatterns (array)
. RoleGroupAssignments (array)
} (object)
EnableIamSessionBasedIdentity (boolean)
EnableAutoMinorVersionUpgrade (boolean)
AppVersion (string)
ClientToken (string)
Tags (array)
sagemaker/update_pipelineUpdates a pipeline.PipelineName (string) required
PipelineDisplayName (string)
PipelineDefinition (string)
PipelineDefinitionS3Location: {
. Bucket (string)
. ObjectKey (string)
. VersionId (string)
} (object)
PipelineDescription (string)
RoleArn (string)
ParallelismConfiguration: {
. MaxParallelExecutionSteps (integer)
} (object)
sagemaker/update_pipeline_executionUpdates a pipeline execution.PipelineExecutionArn (string) required
PipelineExecutionDescription (string)
PipelineExecutionDisplayName (string)
ParallelismConfiguration: {
. MaxParallelExecutionSteps (integer)
} (object)
sagemaker/update_pipeline_versionUpdates a pipeline version.PipelineArn (string) required
PipelineVersionId (integer) required
PipelineVersionDisplayName (string)
PipelineVersionDescription (string)
sagemaker/update_projectUpdates 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.ProjectName (string) required
ProjectDescription (string)
ServiceCatalogProvisioningUpdateDetails: {
. ProvisioningArtifactId (string)
. ProvisioningParameters (array)
} (object)
Tags (array)
TemplateProvidersToUpdate (array)
sagemaker/update_spaceUpdates the settings of a space. You can't edit the app type of a space in the SpaceSettings.DomainId (string) required
SpaceName (string) required
SpaceSettings: {
. JupyterServerAppSettings (object)
. KernelGatewayAppSettings (object)
. CodeEditorAppSettings (object)
. JupyterLabAppSettings (object)
. AppType (string)
. SpaceStorageSettings (object)
. SpaceManagedResources (string)
. CustomFileSystems (array)
. RemoteAccess (string)
} (object)
SpaceDisplayName (string)
sagemaker/update_training_jobUpdate a model training job to request a new Debugger profiling configuration or to change warm pool retention length.TrainingJobName (string) required
ProfilerConfig: {
. S3OutputPath (string)
. ProfilingIntervalInMilliseconds (integer)
. ProfilingParameters (object)
. DisableProfiler (boolean)
} (object)
ProfilerRuleConfigurations (array)
ResourceConfig: {
. KeepAlivePeriodInSeconds (integer)
} (object)
RemoteDebugConfig: {
. EnableRemoteDebug (boolean)
} (object)
sagemaker/update_trialUpdates the display name of a trial.TrialName (string) required
DisplayName (string)
sagemaker/update_trial_componentUpdates one or more properties of a trial component.TrialComponentName (string) required
DisplayName (string)
Status: {
. PrimaryStatus (string)
. Message (string)
} (object)
StartTime (string)
EndTime (string)
Parameters (object)
ParametersToRemove (array)
InputArtifacts (object)
InputArtifactsToRemove (array)
OutputArtifacts (object)
OutputArtifactsToRemove (array)
sagemaker/update_user_profileUpdates a user profile.DomainId (string) required
UserProfileName (string) required
UserSettings: {
. ExecutionRole (string)
. SecurityGroups (array)
. SharingSettings (object)
. JupyterServerAppSettings (object)
. KernelGatewayAppSettings (object)
. TensorBoardAppSettings (object)
. RStudioServerProAppSettings (object)
. RSessionAppSettings (object)
. CanvasAppSettings (object)
. CodeEditorAppSettings (object)
. JupyterLabAppSettings (object)
. SpaceStorageSettings (object)
. DefaultLandingUri (string)
. StudioWebPortal (string)
. CustomPosixUserConfig (object)
. CustomFileSystemConfigs (array)
. StudioWebPortalSettings (object)
. AutoMountHomeEFS (string)
} (object)
sagemaker/update_workforceUse 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 speciWorkforceName (string) required
SourceIpConfig: {
. Cidrs (array)
} (object)
OidcConfig: {
. ClientId (string)
. ClientSecret (string)
. Issuer (string)
. AuthorizationEndpoint (string)
. TokenEndpoint (string)
. UserInfoEndpoint (string)
. LogoutEndpoint (string)
. JwksUri (string)
. Scope (string)
. AuthenticationRequestExtraParams (object)
} (object)
WorkforceVpcConfig: {
. VpcId (string)
. SecurityGroupIds (array)
. Subnets (array)
} (object)
IpAddressType (string)
sagemaker/update_workteamUpdates an existing work team with new member definitions or description.WorkteamName (string) required
MemberDefinitions (array)
Description (string)
NotificationConfiguration: {
. NotificationTopicArn (string)
} (object)
WorkerAccessConfiguration: {
. S3Presign (object)
} (object)
savingsplans/create_savings_planCreates a Savings Plan.savingsPlanOfferingId (string) required
commitment (string) required
upfrontPaymentAmount (string)
purchaseTime (string)
clientToken (string)
tags (object)
savingsplans/delete_queued_savings_planDeletes the queued purchase for the specified Savings Plan.savingsPlanId (string) required
savingsplans/describe_savings_plan_ratesDescribes the rates for a specific, existing Savings Plan.savingsPlanId (string) required
filters (array)
nextToken (string)
maxResults (integer)
savingsplans/describe_savings_plansDescribes the specified Savings Plans.savingsPlanArns (array)
savingsPlanIds (array)
nextToken (string)
maxResults (integer)
states (array)
filters (array)
savingsplans/describe_savings_plans_offering_ratesDescribes the offering rates for Savings Plans you might want to purchase.savingsPlanOfferingIds (array)
savingsPlanPaymentOptions (array)
savingsPlanTypes (array)
products (array)
serviceCodes (array)
usageTypes (array)
operations (array)
filters (array)
nextToken (string)
maxResults (integer)
savingsplans/describe_savings_plans_offeringsDescribes the offerings for the specified Savings Plans.offeringIds (array)
paymentOptions (array)
productType (string)
planTypes (array)
durations (array)
currencies (array)
descriptions (array)
serviceCodes (array)
usageTypes (array)
operations (array)
filters (array)
nextToken (string)
maxResults (integer)
savingsplans/list_tags_for_resourceLists the tags for the specified resource.resourceArn (string) required
savingsplans/return_savings_planReturns the specified Savings Plan.savingsPlanId (string) required
clientToken (string)
savingsplans/tag_resourceAdds the specified tags to the specified resource.resourceArn (string) required
tags (object) required
savingsplans/untag_resourceRemoves the specified tags from the specified resource.resourceArn (string) required
tagKeys (array) required
scheduler/list_tags_for_resourceLists the tags associated with the Scheduler resource.ResourceArn (string) required
scheduler/tag_resourceAssigns one or more tags key-value pairs to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.ResourceArn (string) required
Tags (array) required
scheduler/untag_resourceRemoves one or more tags from the specified EventBridge Scheduler schedule group.ResourceArn (string) required
TagKeys (array) required
scheduler/get_scheduleRetrieves the specified schedule.Name (string) required
GroupName (string)
scheduler/update_scheduleUpdates the specified schedule. When you call UpdateSchedule, EventBridge Scheduler uses all values, including empty values, specified in the request and overrides the existing schedule. This is by design. This means that if you do not set an optional field in your request, that field will be set to its system-default value after the update. Before calling this operation, we recommend that you call the GetSchedule API operation and make a note of all optional parameters for your UpdateSchedule cName (string) required
GroupName (string)
ScheduleExpression (string) required
StartDate (string)
EndDate (string)
Description (string)
ScheduleExpressionTimezone (string)
State (string)
KmsKeyArn (string)
Target: {
. Arn (string)
. RoleArn (string)
. DeadLetterConfig (object)
. RetryPolicy (object)
. Input (string)
. EcsParameters (object)
. EventBridgeParameters (object)
. KinesisParameters (object)
. SageMakerPipelineParameters (object)
. SqsParameters (object)
} (object) required
FlexibleTimeWindow: {
. Mode (string)
. MaximumWindowInMinutes (integer)
} (object) required
ClientToken (string)
ActionAfterCompletion (string)
scheduler/delete_scheduleDeletes the specified schedule.Name (string) required
GroupName (string)
ClientToken (string)
scheduler/list_schedulesReturns a paginated list of your EventBridge Scheduler schedules.GroupName (string)
NamePrefix (string)
State (string)
NextToken (string)
MaxResults (integer)
scheduler/create_scheduleCreates the specified schedule.Name (string) required
GroupName (string)
ScheduleExpression (string) required
StartDate (string)
EndDate (string)
Description (string)
ScheduleExpressionTimezone (string)
State (string)
KmsKeyArn (string)
Target: {
. Arn (string)
. RoleArn (string)
. DeadLetterConfig (object)
. RetryPolicy (object)
. Input (string)
. EcsParameters (object)
. EventBridgeParameters (object)
. KinesisParameters (object)
. SageMakerPipelineParameters (object)
. SqsParameters (object)
} (object) required
FlexibleTimeWindow: {
. Mode (string)
. MaximumWindowInMinutes (integer)
} (object) required
ClientToken (string)
ActionAfterCompletion (string)
scheduler/get_schedule_groupRetrieves the specified schedule group.Name (string) required
scheduler/delete_schedule_groupDeletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group. When you delete a group, it remains in a DELETING state until all of its associated schedules are deleted. Schedules associated with the group that are set to run while the schedule group is in the process of being deleted might continue to invoke their targets until the schedule group and its associated schedules are deleted. This operation is eventuName (string) required
ClientToken (string)
scheduler/list_schedule_groupsReturns a paginated list of your schedule groups.NamePrefix (string)
NextToken (string)
MaxResults (integer)
scheduler/create_schedule_groupCreates the specified schedule group.Name (string) required
Tags (array)
ClientToken (string)
schemas/create_discovererCreates a discoverer.Description (string)
SourceArn (string) required
CrossAccount (boolean)
Tags (object)
schemas/create_registryCreates a registry.Description (string)
RegistryName (string) required
Tags (object)
schemas/create_schemaCreates a schema definition. Inactive schemas will be deleted after two years.Content (string) required
Description (string)
RegistryName (string) required
SchemaName (string) required
Tags (object)
Type (string) required
schemas/delete_discovererDeletes a discoverer.DiscovererId (string) required
schemas/delete_registryDeletes a Registry.RegistryName (string) required
schemas/delete_resource_policyDelete the resource-based policy attached to the specified registry.RegistryName (string)
schemas/delete_schemaDelete a schema definition.RegistryName (string) required
SchemaName (string) required
schemas/delete_schema_versionDelete the schema version definitionRegistryName (string) required
SchemaName (string) required
SchemaVersion (string) required
schemas/describe_code_bindingDescribe the code binding URI.Language (string) required
RegistryName (string) required
SchemaName (string) required
SchemaVersion (string)
schemas/describe_discovererDescribes the discoverer.DiscovererId (string) required
schemas/describe_registryDescribes the registry.RegistryName (string) required
schemas/describe_schemaRetrieve the schema definition.RegistryName (string) required
SchemaName (string) required
SchemaVersion (string)
schemas/export_schemaNo description availableRegistryName (string) required
SchemaName (string) required
SchemaVersion (string)
Type (string) required
schemas/get_code_binding_sourceGet the code binding source URI.Language (string) required
RegistryName (string) required
SchemaName (string) required
SchemaVersion (string)
schemas/get_discovered_schemaGet the discovered schema that was generated based on sampled events.Events (array) required
Type (string) required
schemas/get_resource_policyRetrieves the resource-based policy attached to a given registry.RegistryName (string)
schemas/list_discoverersList the discoverers.DiscovererIdPrefix (string)
Limit (integer)
NextToken (string)
SourceArnPrefix (string)
schemas/list_registriesList the registries.Limit (integer)
NextToken (string)
RegistryNamePrefix (string)
Scope (string)
schemas/list_schemasList the schemas.Limit (integer)
NextToken (string)
RegistryName (string) required
SchemaNamePrefix (string)
schemas/list_schema_versionsProvides a list of the schema versions and related information.Limit (integer)
NextToken (string)
RegistryName (string) required
SchemaName (string) required
schemas/list_tags_for_resourceGet tags for resource.ResourceArn (string) required
schemas/put_code_bindingPut code binding URILanguage (string) required
RegistryName (string) required
SchemaName (string) required
SchemaVersion (string)
schemas/put_resource_policyThe name of the policy.Policy (string) required
RegistryName (string)
RevisionId (string)
schemas/search_schemasSearch the schemasKeywords (string) required
Limit (integer)
NextToken (string)
RegistryName (string) required
schemas/start_discovererStarts the discovererDiscovererId (string) required
schemas/stop_discovererStops the discovererDiscovererId (string) required
schemas/tag_resourceAdd tags to a resource.ResourceArn (string) required
Tags (object) required
schemas/untag_resourceRemoves tags from a resource.ResourceArn (string) required
TagKeys (array) required
schemas/update_discovererUpdates the discovererDescription (string)
DiscovererId (string) required
CrossAccount (boolean)
schemas/update_registryUpdates a registry.Description (string)
RegistryName (string) required
schemas/update_schemaUpdates the schema definition Inactive schemas will be deleted after two years.ClientTokenId (string)
Content (string)
Description (string)
RegistryName (string) required
SchemaName (string) required
Type (string)
secrets_manager/batch_get_secret_valueRetrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue. To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as AccessDeniedException while attempting to retrieve any of the secrets, you can see the errors in Errors in the response. Secrets Manager generates CloudTrail GetSecretValue log entries for each seSecretIdList (array)
Filters (array)
MaxResults (integer)
NextToken (string)
secrets_manager/cancel_rotate_secretTurns 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 labeSecretId (string) required
secrets_manager/create_secretCreates 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 secrets that use managed rotatiName (string) required
ClientRequestToken (string)
Description (string)
KmsKeyId (string)
SecretBinary (string)
SecretString (string)
Tags (array)
AddReplicaRegions (array)
ForceOverwriteReplicaSecret (boolean)
Type (string)
secrets_manager/delete_resource_policyDeletes 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 AuthenticatSecretId (string) required
secrets_manager/delete_secretDeletes 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 ReSecretId (string) required
RecoveryWindowInDays (integer)
ForceDeleteWithoutRecovery (boolean)
secrets_manager/describe_secretRetrieves 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 SecretsSecretId (string) required
secrets_manager/get_random_passwordGenerates 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. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: !' $% and '+,-./:;?@^_|~ Secrets Manager generates a CloudTrail log entry when you call this action. Required permissions: secretsmanager:GetRandomPassword. For more information, see IAM policy actions for SePasswordLength (integer)
ExcludeCharacters (string)
ExcludeNumbers (boolean)
ExcludePunctuation (boolean)
ExcludeUppercase (boolean)
ExcludeLowercase (boolean)
IncludeSpace (boolean)
RequireEachIncludedType (boolean)
secrets_manager/get_resource_policyRetrieves 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. ForSecretId (string) required
secrets_manager/get_secret_valueRetrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content. To retrieve the values for a group of secrets, call BatchGetSecretValue. 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.SecretId (string) required
VersionId (string)
VersionStage (string)
secrets_manager/list_secretsLists 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. All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling DescribeSecret. To list the versions of a secret, use ListSecretVersionIds. To retrieve the valueIncludePlannedDeletion (boolean)
MaxResults (integer)
NextToken (string)
Filters (array)
SortOrder (string)
SortBy (string)
secrets_manager/list_secret_version_idsLists 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: secretsmanSecretId (string) required
MaxResults (integer)
NextToken (string)
IncludeDeprecated (boolean)
secrets_manager/put_resource_policyAttaches 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 withSecretId (string) required
ResourcePolicy (string) required
BlockPublicPolicy (boolean)
secrets_manager/put_secret_valueCreates a new version of your secret by creating a new encrypted value and attaching it to the secret. version can contain a new SecretString value or a new SecretBinary value. Do not call 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 keeps 100 of the most recent versions, but it keeps all secret versions created in the last 24 hours. If you call PutSecretValue more thaSecretId (string) required
ClientRequestToken (string)
SecretBinary (string)
SecretString (string)
VersionStages (array)
RotationToken (string)
secrets_manager/remove_regions_from_replicationFor 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 andSecretId (string) required
RemoveReplicaRegions (array) required
secrets_manager/replicate_secret_to_regionsReplicates 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. If the primary secret is encrypted with a KMS key other than aws/secretsmanager, you also need kms:Decrypt permission to the key. To eSecretId (string) required
AddReplicaRegions (array) required
ForceOverwriteReplicaSecret (boolean)
secrets_manager/restore_secretCancels 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 ASecretId (string) required
secrets_manager/rotate_secretConfigures and starts the asynchronous process of rotating the secret. For information about rotation, see Rotate secrets in the Secrets Manager User Guide. 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. When rotation is successful, the AWSPENDING staging label might be attached to the sSecretId (string) required
ClientRequestToken (string)
RotationLambdaARN (string)
RotationRules: {
. AutomaticallyAfterDays (integer)
. Duration (string)
. ScheduleExpression (string)
} (object)
ExternalSecretRotationMetadata (array)
ExternalSecretRotationRoleArn (string)
RotateImmediately (boolean)
secrets_manager/stop_replication_to_replicaRemoves 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:SecretId (string) required
secrets_manager/tag_resourceAttaches 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. For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference guide. If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation wouSecretId (string) required
Tags (array) required
secrets_manager/untag_resourceRemoves 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 caSecretId (string) required
TagKeys (array) required
secrets_manager/update_secretModifies 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. To change a secret so that it is managed by another service, you need to recreate the secret in that service. See Secrets Manager secrets managed by other Amazon Web Services services. We recommend you avoid calling UpdateSecret at a sustained rate of more than once every 10 minutes. WheSecretId (string) required
ClientRequestToken (string)
Description (string)
KmsKeyId (string)
SecretBinary (string)
SecretString (string)
Type (string)
secrets_manager/update_secret_version_stageModifies 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. TheSecretId (string) required
VersionStage (string) required
RemoveFromVersionId (string)
MoveToVersionId (string)
secrets_manager/validate_resource_policyValidates 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 gSecretId (string)
ResourcePolicy (string) required
security_ir/list_tags_for_resourceReturns currently configured tags on a resource.resourceArn (string) required
security_ir/tag_resourceAdds a tags to a designated resource.resourceArn (string) required
tags (object) required
security_ir/untag_resourceRemoves a tags from a designate resource.resourceArn (string) required
tagKeys (array) required
security_ir/close_caseCloses an existing case.caseId (string) required
security_ir/create_case_commentAdds a comment to an existing case.caseId (string) required
clientToken (string)
body (string) required
security_ir/get_case_attachment_download_urlReturns a Pre-Signed URL for uploading attachments into a case.caseId (string) required
attachmentId (string) required
security_ir/get_case_attachment_upload_urlUploads an attachment to a case.caseId (string) required
fileName (string) required
contentLength (integer) required
clientToken (string)
security_ir/list_case_editsViews the case history for edits made to a designated case.nextToken (string)
maxResults (integer)
caseId (string) required
security_ir/list_commentsReturns comments for a designated case.nextToken (string)
maxResults (integer)
caseId (string) required
security_ir/list_investigationsInvestigation performed by an agent for a security incident...nextToken (string)
maxResults (integer)
caseId (string) required
security_ir/send_feedbackSend feedback based on response investigation actioncaseId (string) required
resultId (string) required
usefulness (string) required
comment (string)
security_ir/update_case_commentUpdates an existing case comment.caseId (string) required
commentId (string) required
body (string) required
security_ir/update_case_statusUpdates the state transitions for a designated cases. Self-managed: the following states are available for self-managed cases. Submitted → Detection and Analysis Detection and Analysis → Containment, Eradication, and Recovery Detection and Analysis → Post-incident Activities Containment, Eradication, and Recovery → Detection and Analysis Containment, Eradication, and Recovery → Post-incident Activities Post-incident Activities → Containment, Eradication, and Recovery Post-incident Activities → DcaseId (string) required
caseStatus (string) required
security_ir/update_resolver_typeUpdates the resolver type for a case. This is a one-way action and cannot be reversed.caseId (string) required
resolverType (string) required
security_ir/create_caseCreates a new case.clientToken (string)
resolverType (string) required
title (string) required
description (string) required
engagementType (string) required
reportedIncidentStartDate (string) required
impactedAccounts (array) required
watchers (array) required
threatActorIpAddresses (array)
impactedServices (array)
impactedAwsRegions (array)
tags (object)
security_ir/get_caseReturns the attributes of a case.caseId (string) required
security_ir/update_caseUpdates an existing case.caseId (string) required
title (string)
description (string)
reportedIncidentStartDate (string)
actualIncidentStartDate (string)
engagementType (string)
watchersToAdd (array)
watchersToDelete (array)
threatActorIpAddressesToAdd (array)
threatActorIpAddressesToDelete (array)
impactedServicesToAdd (array)
impactedServicesToDelete (array)
impactedAwsRegionsToAdd (array)
impactedAwsRegionsToDelete (array)
impactedAccountsToAdd (array)
impactedAccountsToDelete (array)
caseMetadata (array)
security_ir/list_casesLists all cases the requester has access to.nextToken (string)
maxResults (integer)
security_ir/batch_get_member_account_detailsProvides information on whether the supplied account IDs are associated with a membership. AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be 123123123 which is nine digits, and with zero-prepend would be 000123123123. Not zero-prepending to 12 digits could result in errors.membershipId (string) required
accountIds (array) required
security_ir/cancel_membershipCancels an existing membership.membershipId (string) required
security_ir/create_membershipCreates a new membership.clientToken (string)
membershipName (string) required
incidentResponseTeam (array) required
optInFeatures (array)
tags (object)
coverEntireOrganization (boolean)
security_ir/get_membershipReturns the attributes of a membership.membershipId (string) required
security_ir/update_membershipUpdates membership configuration.membershipId (string) required
membershipName (string)
incidentResponseTeam (array)
optInFeatures (array)
membershipAccountsConfigurationsUpdate: {
. coverEntireOrganization (boolean)
. organizationalUnitsToAdd (array)
. organizationalUnitsToRemove (array)
} (object)
undoMembershipCancellation (boolean)
security_ir/list_membershipsReturns the memberships that the calling principal can access.nextToken (string)
maxResults (integer)
securityhub/accept_administrator_invitationWe recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide. 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 invitaAdministratorId (string) required
InvitationId (string) required
securityhub/accept_invitationThis 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 invitMasterId (string) required
InvitationId (string) required
securityhub/batch_delete_automation_rulesDeletes one or more automation rules.AutomationRulesArns (array) required
securityhub/batch_disable_standardsDisables the standards specified by the provided StandardsSubscriptionArns. For more information, see Security Standards section of the Security Hub User Guide.StandardsSubscriptionArns (array) required
securityhub/batch_enable_standardsEnables 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.StandardsSubscriptionRequests (array) required
securityhub/batch_get_automation_rulesRetrieves a list of details for automation rules based on rule Amazon Resource Names ARNs.AutomationRulesArns (array) required
securityhub/batch_get_configuration_policy_associationsReturns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root. Only the Security Hub delegated administrator can invoke this operation from the home Region. A configuration can refer to a configuration policy or to a self-managed configuration.ConfigurationPolicyAssociationIdentifiers (array) required
securityhub/batch_get_security_controlsProvides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.SecurityControlIds (array) required
securityhub/batch_get_standards_control_associationsFor a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard. Calls to this operation return a RESOURCE_NOT_FOUND_EXCEPTION error when the standard subscription for the association has a NOT_READY_FOR_UPDATES value for StandardsControlsUpdatable.StandardsControlAssociationIds (array) required
securityhub/batch_import_findingsImports 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 BatchImporFindings (array) required
securityhub/batch_update_automation_rulesUpdates one or more automation rules based on rule Amazon Resource Names ARNs and input parameters.UpdateAutomationRulesRequestItems (array) required
securityhub/batch_update_findingsUsed by Security Hub customers to update information about their investigation into one or more findings. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. A member account can update findings only for their own account. Administrator and member accounts can use this operation to update the following fields and objects for one or more findings: Confidence Criticality Note RelatedFindings Severity TypesFindingIdentifiers (array) required
Note: {
. Text (string)
. UpdatedBy (string)
} (object)
Severity: {
. Normalized (integer)
. Product (number)
. Label (string)
} (object)
VerificationState (string)
Confidence (integer)
Criticality (integer)
Types (array)
UserDefinedFields (object)
Workflow: {
. Status (string)
} (object)
RelatedFindings (array)
securityhub/batch_update_findings_v2Used by customers to update information about their investigation into a finding. Requested by delegated administrator accounts or member accounts. Delegated administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account. BatchUpdateFindings and BatchUpdateFindingV2 both use securityhub:BatchUpdateFindings in the Action element of an IAM policy statement. You must have permission to perform the securityhub:BatchUpdateMetadataUids (array)
FindingIdentifiers (array)
Comment (string)
SeverityId (integer)
StatusId (integer)
securityhub/batch_update_standards_control_associationsFor a batch of security controls and standards, this operation updates the enablement status of a control in a standard.StandardsControlAssociationUpdates (array) required
securityhub/create_action_targetCreates 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.Name (string) required
Description (string) required
Id (string) required
securityhub/create_aggregator_v2Enables aggregation across Amazon Web Services Regions.RegionLinkingMode (string) required
LinkedRegions (array)
Tags (object)
ClientToken (string)
securityhub/create_automation_ruleCreates an automation rule based on input parameters.Tags (object)
RuleStatus (string)
RuleOrder (integer) required
RuleName (string) required
Description (string) required
IsTerminal (boolean)
Criteria: {
. ProductArn (array)
. AwsAccountId (array)
. Id (array)
. GeneratorId (array)
. Type (array)
. FirstObservedAt (array)
. LastObservedAt (array)
. CreatedAt (array)
. UpdatedAt (array)
. Confidence (array)
. Criticality (array)
. Title (array)
. Description (array)
. SourceUrl (array)
. ProductName (array)
. CompanyName (array)
. SeverityLabel (array)
. ResourceType (array)
. ResourceId (array)
. ResourcePartition (array)
. ResourceRegion (array)
. ResourceTags (array)
. ResourceDetailsOther (array)
. ComplianceStatus (array)
. ComplianceSecurityControlId (array)
. ComplianceAssociatedStandardsId (array)
. VerificationState (array)
. WorkflowStatus (array)
. RecordState (array)
. RelatedFindingsProductArn (array)
. RelatedFindingsId (array)
. NoteText (array)
. NoteUpdatedAt (array)
. NoteUpdatedBy (array)
. UserDefinedFields (array)
. ResourceApplicationArn (array)
. ResourceApplicationName (array)
. AwsAccountName (array)
} (object) required
Actions (array) required
securityhub/create_automation_rule_v2Creates a V2 automation rule.RuleName (string) required
RuleStatus (string)
Description (string) required
RuleOrder (number) required
Criteria (undefined) required
Actions (array) required
Tags (object)
ClientToken (string)
securityhub/create_configuration_policyCreates a configuration policy with the defined configuration. Only the Security Hub delegated administrator can invoke this operation from the home Region.Name (string) required
Description (string)
ConfigurationPolicy (undefined) required
Tags (object)
securityhub/create_connector_v2Grants permission to create a connectorV2 based on input parameters.Name (string) required
Description (string)
Provider (undefined) required
KmsKeyArn (string)
Tags (object)
ClientToken (string)
securityhub/create_finding_aggregatorThe aggregation Region is now called the home Region. Used to enable cross-Region aggregation. This operation can be invoked from the home Region only. For information about how cross-Region aggregation works, see Understanding cross-Region aggregation in Security Hub in the Security Hub User Guide.RegionLinkingMode (string) required
Regions (array)
securityhub/create_insightCreates 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.Name (string) required
Filters: {
. ProductArn (array)
. AwsAccountId (array)
. Id (array)
. GeneratorId (array)
. Region (array)
. Type (array)
. FirstObservedAt (array)
. LastObservedAt (array)
. CreatedAt (array)
. UpdatedAt (array)
. SeverityProduct (array)
. SeverityNormalized (array)
. SeverityLabel (array)
. Confidence (array)
. Criticality (array)
. Title (array)
. Description (array)
. RecommendationText (array)
. SourceUrl (array)
. ProductFields (array)
. ProductName (array)
. CompanyName (array)
. UserDefinedFields (array)
. MalwareName (array)
. MalwareType (array)
. MalwarePath (array)
. MalwareState (array)
. NetworkDirection (array)
. NetworkProtocol (array)
. NetworkSourceIpV4 (array)
. NetworkSourceIpV6 (array)
. NetworkSourcePort (array)
. NetworkSourceDomain (array)
. NetworkSourceMac (array)
. NetworkDestinationIpV4 (array)
. NetworkDestinationIpV6 (array)
. NetworkDestinationPort (array)
. NetworkDestinationDomain (array)
. ProcessName (array)
. ProcessPath (array)
. ProcessPid (array)
. ProcessParentPid (array)
. ProcessLaunchedAt (array)
. ProcessTerminatedAt (array)
. ThreatIntelIndicatorType (array)
. ThreatIntelIndicatorValue (array)
. ThreatIntelIndicatorCategory (array)
. ThreatIntelIndicatorLastObservedAt (array)
. ThreatIntelIndicatorSource (array)
. ThreatIntelIndicatorSourceUrl (array)
. ResourceType (array)
. ResourceId (array)
. ResourcePartition (array)
. ResourceRegion (array)
. ResourceTags (array)
. ResourceAwsEc2InstanceType (array)
. ResourceAwsEc2InstanceImageId (array)
. ResourceAwsEc2InstanceIpV4Addresses (array)
. ResourceAwsEc2InstanceIpV6Addresses (array)
. ResourceAwsEc2InstanceKeyName (array)
. ResourceAwsEc2InstanceIamInstanceProfileArn (array)
. ResourceAwsEc2InstanceVpcId (array)
. ResourceAwsEc2InstanceSubnetId (array)
. ResourceAwsEc2InstanceLaunchedAt (array)
. ResourceAwsS3BucketOwnerId (array)
. ResourceAwsS3BucketOwnerName (array)
. ResourceAwsIamAccessKeyUserName (array)
. ResourceAwsIamAccessKeyPrincipalName (array)
. ResourceAwsIamAccessKeyStatus (array)
. ResourceAwsIamAccessKeyCreatedAt (array)
. ResourceAwsIamUserUserName (array)
. ResourceContainerName (array)
. ResourceContainerImageId (array)
. ResourceContainerImageName (array)
. ResourceContainerLaunchedAt (array)
. ResourceDetailsOther (array)
. ComplianceStatus (array)
. VerificationState (array)
. WorkflowState (array)
. WorkflowStatus (array)
. RecordState (array)
. RelatedFindingsProductArn (array)
. RelatedFindingsId (array)
. NoteText (array)
. NoteUpdatedAt (array)
. NoteUpdatedBy (array)
. Keyword (array)
. FindingProviderFieldsConfidence (array)
. FindingProviderFieldsCriticality (array)
. FindingProviderFieldsRelatedFindingsId (array)
. FindingProviderFieldsRelatedFindingsProductArn (array)
. FindingProviderFieldsSeverityLabel (array)
. FindingProviderFieldsSeverityOriginal (array)
. FindingProviderFieldsTypes (array)
. Sample (array)
. ComplianceSecurityControlId (array)
. ComplianceAssociatedStandardsId (array)
. VulnerabilitiesExploitAvailable (array)
. VulnerabilitiesFixAvailable (array)
. ComplianceSecurityControlParametersName (array)
. ComplianceSecurityControlParametersValue (array)
. AwsAccountName (array)
. ResourceApplicationName (array)
. ResourceApplicationArn (array)
} (object) required
GroupByAttribute (string) required
securityhub/create_membersCreates 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 autAccountDetails (array) required
securityhub/create_ticket_v2Grants permission to create a ticket in the chosen ITSM based on finding information for the provided finding metadata UID.ConnectorId (string) required
FindingMetadataUid (string) required
ClientToken (string)
Mode (string)
securityhub/decline_invitationsWe recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide. Declines invitations to become a Security Hub member account. A prospective member account uses this operation to decline an invitation to become a member. Only member accounts that aren't part of an Amazon Web Services organization should use this operation. OrganizatioAccountIds (array) required
securityhub/delete_action_targetDeletes 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.ActionTargetArn (string) required
securityhub/delete_aggregator_v2Deletes the Aggregator V2.AggregatorV2Arn (string) required
securityhub/delete_automation_rule_v2Deletes a V2 automation rule.Identifier (string) required
securityhub/delete_configuration_policyDeletes a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region. For the deletion to succeed, you must first disassociate a configuration policy from target accounts, organizational units, or the root by invoking the StartConfigurationPolicyDisassociation operation.Identifier (string) required
securityhub/delete_connector_v2Grants permission to delete a connectorV2.ConnectorId (string) required
securityhub/delete_finding_aggregatorThe aggregation Region is now called the home Region. Deletes a finding aggregator. When you delete the finding aggregator, you stop cross-Region aggregation. Finding replication stops occurring from the linked Regions to the home Region. When you stop cross-Region aggregation, findings that were already replicated and sent to the home Region are still visible from the home Region. However, new findings and finding updates are no longer replicated and sent to the home Region.FindingAggregatorArn (string) required
securityhub/delete_insightDeletes the insight specified by the InsightArn.InsightArn (string) required
securityhub/delete_invitationsWe recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide. Deletes invitations to become a Security Hub member account. A Security Hub administrator account can use this operation to delete invitations sent to one or more prospective member accounts. This operation is only used to delete invitations that are sent to prospectiveAccountIds (array) required
securityhub/delete_membersDeletes the specified member accounts from Security Hub. You can invoke this API only to delete accounts that became members through invitation. You can't invoke this API to delete accounts that belong to an Organizations organization.AccountIds (array) required
securityhub/describe_action_targetsReturns a list of the custom action targets in Security Hub in your account.ActionTargetArns (array)
NextToken (string)
MaxResults (integer)
securityhub/describe_hubReturns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.HubArn (string)
securityhub/describe_organization_configurationReturns information about the way your organization is configured in Security Hub. Only the Security Hub administrator account can invoke this operation.No parameters
securityhub/describe_productsReturns 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 don't provide an integration ARN, then the results include all of the available product integrations.NextToken (string)
MaxResults (integer)
ProductArn (string)
securityhub/describe_products_v2Gets information about the product integration.NextToken (string)
MaxResults (integer)
securityhub/describe_security_hub_v2Returns details about the service resource in your account.No parameters
securityhub/describe_standardsReturns a list of the available standards in Security Hub. For each standard, the results include the standard ARN, the name, and a description.NextToken (string)
MaxResults (integer)
securityhub/describe_standards_controlsReturns 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. This operation returns an empty list for standard subscriptions where StandardsControlsUpdatable has value NOT_READY_FOR_UPDATES.StandardsSubscriptionArn (string) required
NextToken (string)
MaxResults (integer)
securityhub/disable_import_findings_for_productDisables 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.ProductSubscriptionArn (string) required
securityhub/disable_organization_admin_accountDisables a Security Hub administrator account. Can only be called by the organization management account.AdminAccountId (string) required
Feature (string)
securityhub/disable_security_hubDisables Security Hub in your account only in the current Amazon Web Services Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub. You can't disable Security Hub in an account that is currently the Security Hub administrator. 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 disabNo parameters
securityhub/disable_security_hub_v2Disable the service for the current Amazon Web Services Region or specified Amazon Web Services Region.No parameters
securityhub/disassociate_from_administrator_accountDisassociates 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.No parameters
securityhub/disassociate_from_master_accountThis 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 DNo parameters
securityhub/disassociate_membersDisassociates 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.AccountIds (array) required
securityhub/enable_import_findings_for_productEnables 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.ProductArn (string) required
securityhub/enable_organization_admin_accountDesignates the Security Hub administrator account for an organization. Can only be called by the organization management account.AdminAccountId (string) required
Feature (string)
securityhub/enable_security_hubEnables 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: Center for Internet Security CIS Amazon Web Services Foundations Benchmark v1.2.0 Amazon Web Services FoundationalTags (object)
EnableDefaultStandards (boolean)
ControlFindingGenerator (string)
securityhub/enable_security_hub_v2Enables the service in account for the current Amazon Web Services Region or specified Amazon Web Services Region.Tags (object)
securityhub/get_administrator_accountProvides 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.No parameters
securityhub/get_aggregator_v2Returns the configuration of the specified Aggregator V2.AggregatorV2Arn (string) required
securityhub/get_automation_rule_v2Returns an automation rule for the V2 service.Identifier (string) required
securityhub/get_configuration_policyProvides information about a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.Identifier (string) required
securityhub/get_configuration_policy_associationReturns the association between a configuration and a target account, organizational unit, or the root. The configuration can be a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.Target (undefined) required
securityhub/get_connector_v2Grants permission to retrieve details for a connectorV2 based on connector id.ConnectorId (string) required
securityhub/get_enabled_standardsReturns a list of the standards that are currently enabled.StandardsSubscriptionArns (array)
NextToken (string)
MaxResults (integer)
securityhub/get_finding_aggregatorThe aggregation Region is now called the home Region. Returns the current configuration in the calling account for cross-Region aggregation. A finding aggregator is a resource that establishes the home Region and any linked Regions.FindingAggregatorArn (string) required
securityhub/get_finding_historyReturns the history of a Security Hub finding. The history includes changes made to any fields in the Amazon Web Services Security Finding Format ASFF except top-level timestamp fields, such as the CreatedAt and UpdatedAt fields. This operation might return fewer results than the maximum number of results MaxResults specified in a request, even when more results are available. If this occurs, the response includes a NextToken value, which you should use to retrieve the next set of results in theFindingIdentifier: {
. Id (string)
. ProductArn (string)
} (object) required
StartTime (string)
EndTime (string)
NextToken (string)
MaxResults (integer)
securityhub/get_findingsReturns a list of findings that match the specified criteria. If cross-Region aggregation is enabled, then when you call GetFindings from the home Region, the results include all of the matching findings from both the home Region and linked Regions.Filters: {
. ProductArn (array)
. AwsAccountId (array)
. Id (array)
. GeneratorId (array)
. Region (array)
. Type (array)
. FirstObservedAt (array)
. LastObservedAt (array)
. CreatedAt (array)
. UpdatedAt (array)
. SeverityProduct (array)
. SeverityNormalized (array)
. SeverityLabel (array)
. Confidence (array)
. Criticality (array)
. Title (array)
. Description (array)
. RecommendationText (array)
. SourceUrl (array)
. ProductFields (array)
. ProductName (array)
. CompanyName (array)
. UserDefinedFields (array)
. MalwareName (array)
. MalwareType (array)
. MalwarePath (array)
. MalwareState (array)
. NetworkDirection (array)
. NetworkProtocol (array)
. NetworkSourceIpV4 (array)
. NetworkSourceIpV6 (array)
. NetworkSourcePort (array)
. NetworkSourceDomain (array)
. NetworkSourceMac (array)
. NetworkDestinationIpV4 (array)
. NetworkDestinationIpV6 (array)
. NetworkDestinationPort (array)
. NetworkDestinationDomain (array)
. ProcessName (array)
. ProcessPath (array)
. ProcessPid (array)
. ProcessParentPid (array)
. ProcessLaunchedAt (array)
. ProcessTerminatedAt (array)
. ThreatIntelIndicatorType (array)
. ThreatIntelIndicatorValue (array)
. ThreatIntelIndicatorCategory (array)
. ThreatIntelIndicatorLastObservedAt (array)
. ThreatIntelIndicatorSource (array)
. ThreatIntelIndicatorSourceUrl (array)
. ResourceType (array)
. ResourceId (array)
. ResourcePartition (array)
. ResourceRegion (array)
. ResourceTags (array)
. ResourceAwsEc2InstanceType (array)
. ResourceAwsEc2InstanceImageId (array)
. ResourceAwsEc2InstanceIpV4Addresses (array)
. ResourceAwsEc2InstanceIpV6Addresses (array)
. ResourceAwsEc2InstanceKeyName (array)
. ResourceAwsEc2InstanceIamInstanceProfileArn (array)
. ResourceAwsEc2InstanceVpcId (array)
. ResourceAwsEc2InstanceSubnetId (array)
. ResourceAwsEc2InstanceLaunchedAt (array)
. ResourceAwsS3BucketOwnerId (array)
. ResourceAwsS3BucketOwnerName (array)
. ResourceAwsIamAccessKeyUserName (array)
. ResourceAwsIamAccessKeyPrincipalName (array)
. ResourceAwsIamAccessKeyStatus (array)
. ResourceAwsIamAccessKeyCreatedAt (array)
. ResourceAwsIamUserUserName (array)
. ResourceContainerName (array)
. ResourceContainerImageId (array)
. ResourceContainerImageName (array)
. ResourceContainerLaunchedAt (array)
. ResourceDetailsOther (array)
. ComplianceStatus (array)
. VerificationState (array)
. WorkflowState (array)
. WorkflowStatus (array)
. RecordState (array)
. RelatedFindingsProductArn (array)
. RelatedFindingsId (array)
. NoteText (array)
. NoteUpdatedAt (array)
. NoteUpdatedBy (array)
. Keyword (array)
. FindingProviderFieldsConfidence (array)
. FindingProviderFieldsCriticality (array)
. FindingProviderFieldsRelatedFindingsId (array)
. FindingProviderFieldsRelatedFindingsProductArn (array)
. FindingProviderFieldsSeverityLabel (array)
. FindingProviderFieldsSeverityOriginal (array)
. FindingProviderFieldsTypes (array)
. Sample (array)
. ComplianceSecurityControlId (array)
. ComplianceAssociatedStandardsId (array)
. VulnerabilitiesExploitAvailable (array)
. VulnerabilitiesFixAvailable (array)
. ComplianceSecurityControlParametersName (array)
. ComplianceSecurityControlParametersValue (array)
. AwsAccountName (array)
. ResourceApplicationName (array)
. ResourceApplicationArn (array)
} (object)
SortCriteria (array)
NextToken (string)
MaxResults (integer)
securityhub/get_finding_statistics_v2Returns aggregated statistical data about findings. GetFindingStatisticsV2 use securityhub:GetAdhocInsightResults in the Action element of an IAM policy statement. You must have permission to perform the s action.GroupByRules (array) required
SortOrder (string)
MaxStatisticResults (integer)
securityhub/get_findings_trends_v2Returns findings trend data based on the specified criteria. This operation helps you analyze patterns and changes in findings over time.Filters: {
. CompositeFilters (array)
. CompositeOperator (string)
} (object)
StartTime (string) required
EndTime (string) required
NextToken (string)
MaxResults (integer)
securityhub/get_findings_v2Return a list of findings that match the specified criteria. GetFindings and GetFindingsV2 both use securityhub:GetFindings in the Action element of an IAM policy statement. You must have permission to perform the securityhub:GetFindings action.Filters: {
. CompositeFilters (array)
. CompositeOperator (string)
} (object)
SortCriteria (array)
NextToken (string)
MaxResults (integer)
securityhub/get_insight_resultsLists the results of the Security Hub insight specified by the insight ARN.InsightArn (string) required
securityhub/get_insightsLists and describes insights for the specified insight ARNs.InsightArns (array)
NextToken (string)
MaxResults (integer)
securityhub/get_invitations_countWe recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide. Returns the count of all Security Hub membership invitations that were sent to the calling member account, not including the currently accepted invitation.No parameters
securityhub/get_master_accountThis 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 HubNo parameters
securityhub/get_membersReturns 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.AccountIds (array) required
securityhub/get_resources_statistics_v2Retrieves statistical information about Amazon Web Services resources and their associated security findings.GroupByRules (array) required
SortOrder (string)
MaxStatisticResults (integer)
securityhub/get_resources_trends_v2Returns resource trend data based on the specified criteria. This operation helps you analyze patterns and changes in resource compliance over time.Filters: {
. CompositeFilters (array)
. CompositeOperator (string)
} (object)
StartTime (string) required
EndTime (string) required
NextToken (string)
MaxResults (integer)
securityhub/get_resources_v2Returns a list of resources.Filters: {
. CompositeFilters (array)
. CompositeOperator (string)
} (object)
SortCriteria (array)
NextToken (string)
MaxResults (integer)
securityhub/get_security_control_definitionRetrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details.SecurityControlId (string) required
securityhub/invite_membersWe recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide. 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 don't belong to an Amazon Web Services organization. Organization accountAccountIds (array) required
securityhub/list_aggregators_v2Retrieves a list of V2 aggregators.NextToken (string)
MaxResults (integer)
securityhub/list_automation_rulesA list of automation rules and their metadata for the calling account.NextToken (string)
MaxResults (integer)
securityhub/list_automation_rules_v2Returns a list of automation rules and metadata for the calling account.NextToken (string)
MaxResults (integer)
securityhub/list_configuration_policiesLists the configuration policies that the Security Hub delegated administrator has created for your organization. Only the delegated administrator can invoke this operation from the home Region.NextToken (string)
MaxResults (integer)
securityhub/list_configuration_policy_associationsProvides information about the associations for your configuration policies and self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.NextToken (string)
MaxResults (integer)
Filters: {
. ConfigurationPolicyId (string)
. AssociationType (string)
. AssociationStatus (string)
} (object)
securityhub/list_connectors_v2Grants permission to retrieve a list of connectorsV2 and their metadata for the calling account.NextToken (string)
MaxResults (integer)
ProviderName (string)
ConnectorStatus (string)
securityhub/list_enabled_products_for_importLists all findings-generating solutions products that you are subscribed to receive findings from in Security Hub.NextToken (string)
MaxResults (integer)
securityhub/list_finding_aggregatorsIf cross-Region aggregation is enabled, then ListFindingAggregators returns the Amazon Resource Name ARN of the finding aggregator. You can run this operation from any Amazon Web Services Region.NextToken (string)
MaxResults (integer)
securityhub/list_invitationsWe recommend using Organizations instead of Security Hub invitations to manage your member accounts. For information, see Managing Security Hub administrator and member accounts with Organizations in the Security Hub User Guide. Lists all Security Hub membership invitations that were sent to the calling account. Only accounts that are managed by invitation can use this operation. Accounts that are managed using the integration with Organizations don't receive invitations.MaxResults (integer)
NextToken (string)
securityhub/list_membersLists 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.OnlyAssociated (boolean)
MaxResults (integer)
NextToken (string)
securityhub/list_organization_admin_accountsLists the Security Hub administrator accounts. Can only be called by the organization management account.MaxResults (integer)
NextToken (string)
Feature (string)
securityhub/list_security_control_definitionsLists all of the security controls that apply to a specified standard.StandardsArn (string)
NextToken (string)
MaxResults (integer)
securityhub/list_standards_control_associationsSpecifies whether a control is currently enabled or disabled in each enabled standard in the calling account. This operation omits standards control associations for standard subscriptions where StandardsControlsUpdatable has value NOT_READY_FOR_UPDATES.SecurityControlId (string) required
NextToken (string)
MaxResults (integer)
securityhub/list_tags_for_resourceReturns a list of tags associated with a resource.ResourceArn (string) required
securityhub/register_connector_v2Grants permission to complete the authorization based on input parameters.AuthCode (string) required
AuthState (string) required
securityhub/start_configuration_policy_associationAssociates a target account, organizational unit, or the root with a specified configuration. The target can be associated with a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.ConfigurationPolicyIdentifier (string) required
Target (undefined) required
securityhub/start_configuration_policy_disassociationDisassociates a target account, organizational unit, or the root from a specified configuration. When you disassociate a configuration from its target, the target inherits the configuration of the closest parent. If there’s no configuration to inherit, the target retains its settings but becomes a self-managed account. A target can be disassociated from a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.Target (undefined)
ConfigurationPolicyIdentifier (string) required
securityhub/tag_resourceAdds one or more tags to a resource.ResourceArn (string) required
Tags (object) required
securityhub/untag_resourceRemoves one or more tags from a resource.ResourceArn (string) required
TagKeys (array) required
securityhub/update_action_targetUpdates the name and description of a custom action target in Security Hub.ActionTargetArn (string) required
Name (string)
Description (string)
securityhub/update_aggregator_v2Udpates the configuration for the Aggregator V2.AggregatorV2Arn (string) required
RegionLinkingMode (string) required
LinkedRegions (array)
securityhub/update_automation_rule_v2Updates a V2 automation rule.Identifier (string) required
RuleStatus (string)
RuleOrder (number)
Description (string)
RuleName (string)
Criteria (undefined)
Actions (array)
securityhub/update_configuration_policyUpdates a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.Identifier (string) required
Name (string)
Description (string)
UpdatedReason (string)
ConfigurationPolicy (undefined)
securityhub/update_connector_v2Grants permission to update a connectorV2 based on its id and input parameters.ConnectorId (string) required
Description (string)
Provider (undefined)
securityhub/update_finding_aggregatorThe aggregation Region is now called the home Region. Updates cross-Region aggregation settings. You can use this operation to update the Region linking mode and the list of included or excluded Amazon Web Services Regions. However, you can't use this operation to change the home Region. You can invoke this operation from the current home Region only.FindingAggregatorArn (string) required
RegionLinkingMode (string) required
Regions (array)
securityhub/update_findingsUpdateFindings is a deprecated operation. Instead of UpdateFindings, use the BatchUpdateFindings operation. The UpdateFindings operation updates the Note and RecordState of the Security Hub aggregated findings that the filter attributes specify. Any member account that can view the finding can also see the update to the finding. Finding updates made with UpdateFindings aren't persisted if the same finding is later updated by the finding provider through the BatchImportFindings operation. In addiFilters: {
. ProductArn (array)
. AwsAccountId (array)
. Id (array)
. GeneratorId (array)
. Region (array)
. Type (array)
. FirstObservedAt (array)
. LastObservedAt (array)
. CreatedAt (array)
. UpdatedAt (array)
. SeverityProduct (array)
. SeverityNormalized (array)
. SeverityLabel (array)
. Confidence (array)
. Criticality (array)
. Title (array)
. Description (array)
. RecommendationText (array)
. SourceUrl (array)
. ProductFields (array)
. ProductName (array)
. CompanyName (array)
. UserDefinedFields (array)
. MalwareName (array)
. MalwareType (array)
. MalwarePath (array)
. MalwareState (array)
. NetworkDirection (array)
. NetworkProtocol (array)
. NetworkSourceIpV4 (array)
. NetworkSourceIpV6 (array)
. NetworkSourcePort (array)
. NetworkSourceDomain (array)
. NetworkSourceMac (array)
. NetworkDestinationIpV4 (array)
. NetworkDestinationIpV6 (array)
. NetworkDestinationPort (array)
. NetworkDestinationDomain (array)
. ProcessName (array)
. ProcessPath (array)
. ProcessPid (array)
. ProcessParentPid (array)
. ProcessLaunchedAt (array)
. ProcessTerminatedAt (array)
. ThreatIntelIndicatorType (array)
. ThreatIntelIndicatorValue (array)
. ThreatIntelIndicatorCategory (array)
. ThreatIntelIndicatorLastObservedAt (array)
. ThreatIntelIndicatorSource (array)
. ThreatIntelIndicatorSourceUrl (array)
. ResourceType (array)
. ResourceId (array)
. ResourcePartition (array)
. ResourceRegion (array)
. ResourceTags (array)
. ResourceAwsEc2InstanceType (array)
. ResourceAwsEc2InstanceImageId (array)
. ResourceAwsEc2InstanceIpV4Addresses (array)
. ResourceAwsEc2InstanceIpV6Addresses (array)
. ResourceAwsEc2InstanceKeyName (array)
. ResourceAwsEc2InstanceIamInstanceProfileArn (array)
. ResourceAwsEc2InstanceVpcId (array)
. ResourceAwsEc2InstanceSubnetId (array)
. ResourceAwsEc2InstanceLaunchedAt (array)
. ResourceAwsS3BucketOwnerId (array)
. ResourceAwsS3BucketOwnerName (array)
. ResourceAwsIamAccessKeyUserName (array)
. ResourceAwsIamAccessKeyPrincipalName (array)
. ResourceAwsIamAccessKeyStatus (array)
. ResourceAwsIamAccessKeyCreatedAt (array)
. ResourceAwsIamUserUserName (array)
. ResourceContainerName (array)
. ResourceContainerImageId (array)
. ResourceContainerImageName (array)
. ResourceContainerLaunchedAt (array)
. ResourceDetailsOther (array)
. ComplianceStatus (array)
. VerificationState (array)
. WorkflowState (array)
. WorkflowStatus (array)
. RecordState (array)
. RelatedFindingsProductArn (array)
. RelatedFindingsId (array)
. NoteText (array)
. NoteUpdatedAt (array)
. NoteUpdatedBy (array)
. Keyword (array)
. FindingProviderFieldsConfidence (array)
. FindingProviderFieldsCriticality (array)
. FindingProviderFieldsRelatedFindingsId (array)
. FindingProviderFieldsRelatedFindingsProductArn (array)
. FindingProviderFieldsSeverityLabel (array)
. FindingProviderFieldsSeverityOriginal (array)
. FindingProviderFieldsTypes (array)
. Sample (array)
. ComplianceSecurityControlId (array)
. ComplianceAssociatedStandardsId (array)
. VulnerabilitiesExploitAvailable (array)
. VulnerabilitiesFixAvailable (array)
. ComplianceSecurityControlParametersName (array)
. ComplianceSecurityControlParametersValue (array)
. AwsAccountName (array)
. ResourceApplicationName (array)
. ResourceApplicationArn (array)
} (object) required
Note: {
. Text (string)
. UpdatedBy (string)
} (object)
RecordState (string)
securityhub/update_insightUpdates the Security Hub insight identified by the specified insight ARN.InsightArn (string) required
Name (string)
Filters: {
. ProductArn (array)
. AwsAccountId (array)
. Id (array)
. GeneratorId (array)
. Region (array)
. Type (array)
. FirstObservedAt (array)
. LastObservedAt (array)
. CreatedAt (array)
. UpdatedAt (array)
. SeverityProduct (array)
. SeverityNormalized (array)
. SeverityLabel (array)
. Confidence (array)
. Criticality (array)
. Title (array)
. Description (array)
. RecommendationText (array)
. SourceUrl (array)
. ProductFields (array)
. ProductName (array)
. CompanyName (array)
. UserDefinedFields (array)
. MalwareName (array)
. MalwareType (array)
. MalwarePath (array)
. MalwareState (array)
. NetworkDirection (array)
. NetworkProtocol (array)
. NetworkSourceIpV4 (array)
. NetworkSourceIpV6 (array)
. NetworkSourcePort (array)
. NetworkSourceDomain (array)
. NetworkSourceMac (array)
. NetworkDestinationIpV4 (array)
. NetworkDestinationIpV6 (array)
. NetworkDestinationPort (array)
. NetworkDestinationDomain (array)
. ProcessName (array)
. ProcessPath (array)
. ProcessPid (array)
. ProcessParentPid (array)
. ProcessLaunchedAt (array)
. ProcessTerminatedAt (array)
. ThreatIntelIndicatorType (array)
. ThreatIntelIndicatorValue (array)
. ThreatIntelIndicatorCategory (array)
. ThreatIntelIndicatorLastObservedAt (array)
. ThreatIntelIndicatorSource (array)
. ThreatIntelIndicatorSourceUrl (array)
. ResourceType (array)
. ResourceId (array)
. ResourcePartition (array)
. ResourceRegion (array)
. ResourceTags (array)
. ResourceAwsEc2InstanceType (array)
. ResourceAwsEc2InstanceImageId (array)
. ResourceAwsEc2InstanceIpV4Addresses (array)
. ResourceAwsEc2InstanceIpV6Addresses (array)
. ResourceAwsEc2InstanceKeyName (array)
. ResourceAwsEc2InstanceIamInstanceProfileArn (array)
. ResourceAwsEc2InstanceVpcId (array)
. ResourceAwsEc2InstanceSubnetId (array)
. ResourceAwsEc2InstanceLaunchedAt (array)
. ResourceAwsS3BucketOwnerId (array)
. ResourceAwsS3BucketOwnerName (array)
. ResourceAwsIamAccessKeyUserName (array)
. ResourceAwsIamAccessKeyPrincipalName (array)
. ResourceAwsIamAccessKeyStatus (array)
. ResourceAwsIamAccessKeyCreatedAt (array)
. ResourceAwsIamUserUserName (array)
. ResourceContainerName (array)
. ResourceContainerImageId (array)
. ResourceContainerImageName (array)
. ResourceContainerLaunchedAt (array)
. ResourceDetailsOther (array)
. ComplianceStatus (array)
. VerificationState (array)
. WorkflowState (array)
. WorkflowStatus (array)
. RecordState (array)
. RelatedFindingsProductArn (array)
. RelatedFindingsId (array)
. NoteText (array)
. NoteUpdatedAt (array)
. NoteUpdatedBy (array)
. Keyword (array)
. FindingProviderFieldsConfidence (array)
. FindingProviderFieldsCriticality (array)
. FindingProviderFieldsRelatedFindingsId (array)
. FindingProviderFieldsRelatedFindingsProductArn (array)
. FindingProviderFieldsSeverityLabel (array)
. FindingProviderFieldsSeverityOriginal (array)
. FindingProviderFieldsTypes (array)
. Sample (array)
. ComplianceSecurityControlId (array)
. ComplianceAssociatedStandardsId (array)
. VulnerabilitiesExploitAvailable (array)
. VulnerabilitiesFixAvailable (array)
. ComplianceSecurityControlParametersName (array)
. ComplianceSecurityControlParametersValue (array)
. AwsAccountName (array)
. ResourceApplicationName (array)
. ResourceApplicationArn (array)
} (object)
GroupByAttribute (string)
securityhub/update_organization_configurationUpdates the configuration of your organization in Security Hub. Only the Security Hub administrator account can invoke this operation.AutoEnable (boolean) required
AutoEnableStandards (string)
OrganizationConfiguration: {
. ConfigurationType (string)
. Status (string)
. StatusMessage (string)
} (object)
securityhub/update_security_controlUpdates the properties of a security control.SecurityControlId (string) required
Parameters (object) required
LastUpdateReason (string)
securityhub/update_security_hub_configurationUpdates configuration options for Security Hub.AutoEnableControls (boolean)
ControlFindingGenerator (string)
securityhub/update_standards_controlUsed to control whether an individual security standard control is enabled or disabled. Calls to this operation return a RESOURCE_NOT_FOUND_EXCEPTION error when the standard subscription for the control has StandardsControlsUpdatable value NOT_READY_FOR_UPDATES.StandardsControlArn (string) required
ControlStatus (string)
DisabledReason (string)
securitylake/create_data_lake_exception_subscriptionCreates the specified notification subscription in Amazon Security Lake for the organization you specify. The notification subscription is created for exceptions that cannot be resolved by Security Lake automatically.subscriptionProtocol (string) required
notificationEndpoint (string) required
exceptionTimeToLive (integer)
securitylake/delete_data_lake_exception_subscriptionDeletes the specified notification subscription in Amazon Security Lake for the organization you specify.No parameters
securitylake/deregister_data_lake_delegated_administratorDeletes the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.No parameters
securitylake/get_data_lake_exception_subscriptionRetrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.No parameters
securitylake/list_data_lake_exceptionsLists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.regions (array)
maxResults (integer)
nextToken (string)
securitylake/list_tags_for_resourceRetrieves the tags keys and values that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.resourceArn (string) required
securitylake/register_data_lake_delegated_administratorDesignates the Amazon Security Lake delegated administrator account for the organization. This API can only be called by the organization management account. The organization management account cannot be the delegated administrator account.accountId (string) required
securitylake/tag_resourceAdds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region. A tag is a label that you can define and associate with Amazon Web Services resources. Each tag consists of a required tag key and an associated tag value. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor for a tagresourceArn (string) required
tags (array) required
securitylake/untag_resourceRemoves one or more tags keys and values from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.resourceArn (string) required
tagKeys (array) required
securitylake/update_data_lake_exception_subscriptionUpdates the specified notification subscription in Amazon Security Lake for the organization you specify.subscriptionProtocol (string) required
notificationEndpoint (string) required
exceptionTimeToLive (integer)
securitylake/create_aws_log_sourceAdds a natively supported Amazon Web Services service as an Amazon Security Lake source. Enables source types for member accounts in required Amazon Web Services Regions, based on the parameters you specify. You can choose any source type in any Region for either accounts that are part of a trusted organization or standalone accounts. Once you add an Amazon Web Services service as a source, Security Lake starts collecting logs and events from it. You can use this API only to enable natively suppsources (array) required
securitylake/create_custom_log_sourceAdds a third-party custom source in Amazon Security Lake, from the Amazon Web Services Region where you want to create a custom source. Security Lake can collect logs and events from third-party custom sources. After creating the appropriate IAM role to invoke Glue crawler, use this API to add a custom source name in Security Lake. This operation creates a partition in the Amazon S3 bucket for Security Lake as the target location for log files from the custom source. In addition, this operationsourceName (string) required
sourceVersion (string)
eventClasses (array)
configuration: {
. crawlerConfiguration (object)
. providerIdentity (object)
} (object) required
securitylake/create_data_lakeInitializes an Amazon Security Lake instance with the provided or default configuration. You can enable Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions. To specify particular Regions, configure these Regions using the configurations parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enableconfigurations (array) required
metaStoreManagerRoleArn (string) required
tags (array)
securitylake/create_data_lake_organization_configurationAutomatically enables Amazon Security Lake for new member accounts in your organization. Security Lake is not automatically enabled for any existing member accounts in your organization. This operation merges the new data lake organization configuration with the existing configuration for Security Lake in your organization. If you want to create a new data lake organization configuration, you must delete the existing one using DeleteDataLakeOrganizationConfiguration.autoEnableNewAccount (array)
securitylake/delete_aws_log_sourceRemoves a natively supported Amazon Web Services service as an Amazon Security Lake source. You can remove a source for one or more Regions. When you remove the source, Security Lake stops collecting data from that source in the specified Regions and accounts, and subscribers can no longer consume new data from the source. However, subscribers can still consume data that Security Lake collected from the source before removal. You can choose any source type in any Amazon Web Services Region for esources (array) required
securitylake/delete_custom_log_sourceRemoves a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.sourceName (string) required
sourceVersion (string)
securitylake/delete_data_lakeWhen you disable Amazon Security Lake from your account, Security Lake is disabled in all Amazon Web Services Regions and it stops collecting data from your sources. Also, this API automatically takes steps to remove the account from Security Lake. However, Security Lake retains all of your existing settings and the resources that it created in your Amazon Web Services account in the current Amazon Web Services Region. The DeleteDataLake operation does not delete the data that is stored in yourregions (array) required
securitylake/delete_data_lake_organization_configurationTurns off automatic enablement of Amazon Security Lake for member accounts that are added to an organization in Organizations. Only the delegated Security Lake administrator for an organization can perform this operation. If the delegated Security Lake administrator performs this operation, new member accounts won't automatically contribute data to the data lake.autoEnableNewAccount (array)
securitylake/get_data_lake_organization_configurationRetrieves the configuration that will be automatically set up for accounts added to the organization after the organization has onboarded to Amazon Security Lake. This API does not take input parameters.No parameters
securitylake/get_data_lake_sourcesRetrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled for those accounts and which sources Security Lake is collecting data from.accounts (array)
maxResults (integer)
nextToken (string)
securitylake/list_data_lakesRetrieves the Amazon Security Lake configuration object for the specified Amazon Web Services Regions. You can use this operation to determine whether Security Lake is enabled for a Region.regions (array)
securitylake/list_log_sourcesRetrieves the log sources.accounts (array)
regions (array)
sources (array)
maxResults (integer)
nextToken (string)
securitylake/update_data_lakeYou can use UpdateDataLake to specify where to store your security data, how it should be encrypted at rest and for how long. You can add a Rollup Region to consolidate data from multiple Amazon Web Services Regions, replace default encryption SSE-S3 with Customer Manged Key, or specify transition and expiration actions through storage Lifecycle management. The UpdateDataLake API works as an 'upsert' operation that performs an insert if the specified item or record does not exist, or an update iconfigurations (array) required
metaStoreManagerRoleArn (string)
securitylake/create_subscriber_notificationNotifies the subscriber when new data is written to the data lake for the sources that the subscriber consumes in Security Lake. You can create only one subscriber notification per subscriber.subscriberId (string) required
configuration (undefined) required
securitylake/delete_subscriber_notificationDeletes the specified subscription notification in Amazon Security Lake for the organization you specify.subscriberId (string) required
securitylake/update_subscriber_notificationUpdates an existing notification method for the subscription SQS or HTTPs endpoint or switches the notification subscription endpoint for a subscriber.subscriberId (string) required
configuration (undefined) required
securitylake/create_subscriberCreates a subscriber for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.subscriberIdentity: {
. principal (string)
. externalId (string)
} (object) required
subscriberName (string) required
subscriberDescription (string)
sources (array) required
accessTypes (array)
tags (array)
securitylake/get_subscriberRetrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.subscriberId (string) required
securitylake/update_subscriberUpdates an existing subscription for the given Amazon Security Lake account ID. You can update a subscriber by changing the sources that the subscriber consumes data from.subscriberId (string) required
subscriberIdentity: {
. principal (string)
. externalId (string)
} (object)
subscriberName (string)
subscriberDescription (string)
sources (array)
securitylake/delete_subscriberDeletes the subscription permission and all notification settings for accounts that are already enabled in Amazon Security Lake. When you run DeleteSubscriber, the subscriber will no longer consume data from Security Lake and the subscriber is removed. This operation deletes the subscriber and removes access to data in the current Amazon Web Services Region.subscriberId (string) required
securitylake/list_subscribersLists all subscribers for the specific Amazon Security Lake account ID. You can retrieve a list of subscriptions associated with a specific organization or Amazon Web Services account.nextToken (string)
maxResults (integer)
serverlessapplicationrepository/create_applicationCreates an application, optionally including an AWS SAM file to create the first application version in the same call.Author (string) required
Description (string) required
HomePageUrl (string)
Labels (array)
LicenseBody (string)
LicenseUrl (string)
Name (string) required
ReadmeBody (string)
ReadmeUrl (string)
SemanticVersion (string)
SourceCodeArchiveUrl (string)
SourceCodeUrl (string)
SpdxLicenseId (string)
TemplateBody (string)
TemplateUrl (string)
serverlessapplicationrepository/create_application_versionCreates an application version.ApplicationId (string) required
SemanticVersion (string) required
SourceCodeArchiveUrl (string)
SourceCodeUrl (string)
TemplateBody (string)
TemplateUrl (string)
serverlessapplicationrepository/create_cloud_formation_change_setCreates an AWS CloudFormation change set for the given application.ApplicationId (string) required
Capabilities (array)
ChangeSetName (string)
ClientToken (string)
Description (string)
NotificationArns (array)
ParameterOverrides (array)
ResourceTypes (array)
RollbackConfiguration: {
. MonitoringTimeInMinutes (integer)
. RollbackTriggers (array)
} (object)
SemanticVersion (string)
StackName (string) required
Tags (array)
TemplateId (string)
serverlessapplicationrepository/create_cloud_formation_templateCreates an AWS CloudFormation template.ApplicationId (string) required
SemanticVersion (string)
serverlessapplicationrepository/delete_applicationDeletes the specified application.ApplicationId (string) required
serverlessapplicationrepository/get_applicationGets the specified application.ApplicationId (string) required
SemanticVersion (string)
serverlessapplicationrepository/get_application_policyRetrieves the policy for the application.ApplicationId (string) required
serverlessapplicationrepository/get_cloud_formation_templateGets the specified AWS CloudFormation template.ApplicationId (string) required
TemplateId (string) required
serverlessapplicationrepository/list_application_dependenciesRetrieves the list of applications nested in the containing application.ApplicationId (string) required
MaxItems (integer)
NextToken (string)
SemanticVersion (string)
serverlessapplicationrepository/list_applicationsLists applications owned by the requester.MaxItems (integer)
NextToken (string)
serverlessapplicationrepository/list_application_versionsLists versions for the specified application.ApplicationId (string) required
MaxItems (integer)
NextToken (string)
serverlessapplicationrepository/put_application_policySets the permission policy for an application. For the list of actions supported for this operation, see Application Permissions .ApplicationId (string) required
Statements (array) required
serverlessapplicationrepository/unshare_applicationUnshares an application from an AWS Organization.This operation can be called only from the organization's master account.ApplicationId (string) required
OrganizationId (string) required
serverlessapplicationrepository/update_applicationUpdates the specified application.ApplicationId (string) required
Author (string)
Description (string)
HomePageUrl (string)
Labels (array)
ReadmeBody (string)
ReadmeUrl (string)
service_catalog_appregistry/associate_attribute_groupAssociates 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.application (string) required
attributeGroup (string) required
service_catalog_appregistry/associate_resourceAssociates a resource with an application. The resource can be specified by its ARN or name. The application can be specified by ARN, ID, or name. Minimum permissions You must have the following permissions to associate a resource using the OPTIONS parameter set to APPLY_APPLICATION_TAG. tag:GetResources tag:TagResources You must also have these additional permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess policy. For more information, see AWSServiceCatalogAppRegistryFullAccapplication (string) required
resourceType (string) required
resource (string) required
options (array)
service_catalog_appregistry/create_applicationCreates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.name (string) required
description (string)
tags (object)
clientToken (string) required
service_catalog_appregistry/create_attribute_groupCreates 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.name (string) required
description (string)
attributes (string) required
tags (object)
clientToken (string) required
service_catalog_appregistry/delete_applicationDeletes an application that is specified either by its application ID, name, or ARN. All associated attribute groups and resources must be disassociated from it before deleting an application.application (string) required
service_catalog_appregistry/delete_attribute_groupDeletes an attribute group, specified either by its attribute group ID, name, or ARN.attributeGroup (string) required
service_catalog_appregistry/disassociate_attribute_groupDisassociates 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.application (string) required
attributeGroup (string) required
service_catalog_appregistry/disassociate_resourceDisassociates a resource from application. Both the resource and the application can be specified either by ID or name. Minimum permissions You must have the following permissions to remove a resource that's been associated with an application using the APPLY_APPLICATION_TAG option for AssociateResource. tag:GetResources tag:UntagResources You must also have the following permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess policy. For more information, see AWSServiceCatalogApapplication (string) required
resourceType (string) required
resource (string) required
service_catalog_appregistry/get_applicationRetrieves metadata information about one of your applications. The application can be specified by its ARN, ID, or name which is unique within one account in one region at a given point in time. Specify by ARN or 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.application (string) required
service_catalog_appregistry/get_associated_resourceGets the resource associated with the application.application (string) required
resourceType (string) required
resource (string) required
nextToken (string)
resourceTagStatus (array)
maxResults (integer)
service_catalog_appregistry/get_attribute_groupRetrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.attributeGroup (string) required
service_catalog_appregistry/get_configurationRetrieves a TagKey configuration from an account.No parameters
service_catalog_appregistry/list_applicationsRetrieves a list of all of your applications. Results are paginated.nextToken (string)
maxResults (integer)
service_catalog_appregistry/list_associated_attribute_groupsLists all attribute groups that are associated with specified application. Results are paginated.application (string) required
nextToken (string)
maxResults (integer)
service_catalog_appregistry/list_associated_resourcesLists all of the resources that are associated with the specified application. Results are paginated. If you share an application, and a consumer account associates a tag query to the application, all of the users who can access the application can also view the tag values in all accounts that are associated with it using this API.application (string) required
nextToken (string)
maxResults (integer)
service_catalog_appregistry/list_attribute_groupsLists all attribute groups which you have access to. Results are paginated.nextToken (string)
maxResults (integer)
service_catalog_appregistry/list_attribute_groups_for_applicationLists the details of all attribute groups associated with a specific application. The results display in pages.application (string) required
nextToken (string)
maxResults (integer)
service_catalog_appregistry/list_tags_for_resourceLists all of the tags on the resource.resourceArn (string) required
service_catalog_appregistry/put_configurationAssociates a TagKey configuration to an account.configuration: {
. tagQueryConfiguration (object)
} (object) required
service_catalog_appregistry/sync_resourceSyncs 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.resourceType (string) required
resource (string) required
service_catalog_appregistry/tag_resourceAssigns 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.resourceArn (string) required
tags (object) required
service_catalog_appregistry/untag_resourceRemoves tags from a resource. This operation returns an empty response if the call was successful.resourceArn (string) required
tagKeys (array) required
service_catalog_appregistry/update_applicationUpdates an existing application with new attributes.application (string) required
name (string)
description (string)
service_catalog_appregistry/update_attribute_groupUpdates an existing attribute group with new details.attributeGroup (string) required
name (string)
description (string)
attributes (string)
service_catalog/accept_portfolio_shareAccepts an offer to share the specified portfolio.AcceptLanguage (string)
PortfolioId (string) required
PortfolioShareType (string)
service_catalog/associate_budget_with_resourceAssociates the specified budget with the specified resource.BudgetName (string) required
ResourceId (string) required
service_catalog/associate_principal_with_portfolioAssociates the specified principal ARN with the specified portfolio. If you share the portfolio with principal name sharing enabled, the PrincipalARN association is included in the share. The PortfolioID, PrincipalARN, and PrincipalType parameters are required. You can associate a maximum of 10 Principals with a portfolio using PrincipalType as IAM_PATTERN. When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with otherAcceptLanguage (string)
PortfolioId (string) required
PrincipalARN (string) required
PrincipalType (string) required
service_catalog/associate_product_with_portfolioAssociates the specified product with the specified portfolio. A delegated admin is authorized to invoke this command.AcceptLanguage (string)
ProductId (string) required
PortfolioId (string) required
SourcePortfolioId (string)
service_catalog/associate_service_action_with_provisioning_artifactAssociates a self-service action with a provisioning artifact.ProductId (string) required
ProvisioningArtifactId (string) required
ServiceActionId (string) required
AcceptLanguage (string)
IdempotencyToken (string)
service_catalog/associate_tag_option_with_resourceAssociate the specified TagOption with the specified portfolio or product.ResourceId (string) required
TagOptionId (string) required
service_catalog/batch_associate_service_action_with_provisioning_artifactAssociates multiple self-service actions with provisioning artifacts.ServiceActionAssociations (array) required
AcceptLanguage (string)
service_catalog/batch_disassociate_service_action_from_provisioning_artifactDisassociates a batch of self-service actions from the specified provisioning artifact.ServiceActionAssociations (array) required
AcceptLanguage (string)
service_catalog/copy_productCopies 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.AcceptLanguage (string)
SourceProductArn (string) required
TargetProductId (string)
TargetProductName (string)
SourceProvisioningArtifactIdentifiers (array)
CopyOptions (array)
IdempotencyToken (string) required
service_catalog/create_constraintCreates a constraint. A delegated admin is authorized to invoke this command.AcceptLanguage (string)
PortfolioId (string) required
ProductId (string) required
Parameters (string) required
Type (string) required
Description (string)
IdempotencyToken (string) required
service_catalog/create_portfolioCreates a portfolio. A delegated admin is authorized to invoke this command.AcceptLanguage (string)
DisplayName (string) required
Description (string)
ProviderName (string) required
Tags (array)
IdempotencyToken (string) required
service_catalog/create_portfolio_shareShares 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 cAcceptLanguage (string)
PortfolioId (string) required
AccountId (string)
OrganizationNode: {
. Type (string)
. Value (string)
} (object)
ShareTagOptions (boolean)
SharePrincipals (boolean)
service_catalog/create_productCreates 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.AcceptLanguage (string)
Name (string) required
Owner (string) required
Description (string)
Distributor (string)
SupportDescription (string)
SupportEmail (string)
SupportUrl (string)
ProductType (string) required
Tags (array)
ProvisioningArtifactParameters: {
. Name (string)
. Description (string)
. Info (object)
. Type (string)
. DisableTemplateValidation (boolean)
} (object)
IdempotencyToken (string) required
SourceConnection: {
. Type (string)
. ConnectionParameters (object)
} (object)
service_catalog/create_provisioned_product_planCreates 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.AcceptLanguage (string)
PlanName (string) required
PlanType (string) required
NotificationArns (array)
PathId (string)
ProductId (string) required
ProvisionedProductName (string) required
ProvisioningArtifactId (string) required
ProvisioningParameters (array)
IdempotencyToken (string) required
Tags (array)
service_catalog/create_provisioning_artifactCreates 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.AcceptLanguage (string)
ProductId (string) required
Parameters: {
. Name (string)
. Description (string)
. Info (object)
. Type (string)
. DisableTemplateValidation (boolean)
} (object) required
IdempotencyToken (string) required
service_catalog/create_service_actionCreates a self-service action.Name (string) required
DefinitionType (string) required
Definition (object) required
Description (string)
AcceptLanguage (string)
IdempotencyToken (string) required
service_catalog/create_tag_optionCreates a TagOption.Key (string) required
Value (string) required
service_catalog/delete_constraintDeletes the specified constraint. A delegated admin is authorized to invoke this command.AcceptLanguage (string)
Id (string) required
service_catalog/delete_portfolioDeletes 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.AcceptLanguage (string)
Id (string) required
service_catalog/delete_portfolio_shareStops 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.AcceptLanguage (string)
PortfolioId (string) required
AccountId (string)
OrganizationNode: {
. Type (string)
. Value (string)
} (object)
service_catalog/delete_productDeletes 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.AcceptLanguage (string)
Id (string) required
service_catalog/delete_provisioned_product_planDeletes the specified plan.AcceptLanguage (string)
PlanId (string) required
IgnoreErrors (boolean)
service_catalog/delete_provisioning_artifactDeletes 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.AcceptLanguage (string)
ProductId (string) required
ProvisioningArtifactId (string) required
service_catalog/delete_service_actionDeletes a self-service action.Id (string) required
AcceptLanguage (string)
IdempotencyToken (string)
service_catalog/delete_tag_optionDeletes the specified TagOption. You cannot delete a TagOption if it is associated with a product or portfolio.Id (string) required
service_catalog/describe_constraintGets information about the specified constraint.AcceptLanguage (string)
Id (string) required
service_catalog/describe_copy_product_statusGets the status of the specified copy product operation.AcceptLanguage (string)
CopyProductToken (string) required
service_catalog/describe_portfolioGets information about the specified portfolio. A delegated admin is authorized to invoke this command.AcceptLanguage (string)
Id (string) required
service_catalog/describe_portfolio_sharesReturns 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.PortfolioId (string) required
Type (string) required
PageToken (string)
PageSize (integer)
service_catalog/describe_portfolio_share_statusGets 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.PortfolioShareToken (string) required
service_catalog/describe_productGets information about the specified product. Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.AcceptLanguage (string)
Id (string)
Name (string)
service_catalog/describe_product_as_adminGets information about the specified product. This operation is run with administrator access.AcceptLanguage (string)
Id (string)
Name (string)
SourcePortfolioId (string)
service_catalog/describe_product_viewGets information about the specified product.AcceptLanguage (string)
Id (string) required
service_catalog/describe_provisioned_productGets information about the specified provisioned product.AcceptLanguage (string)
Id (string)
Name (string)
service_catalog/describe_provisioned_product_planGets information about the resource changes for the specified plan.AcceptLanguage (string)
PlanId (string) required
PageSize (integer)
PageToken (string)
service_catalog/describe_provisioning_artifactGets information about the specified provisioning artifact also known as a version for the specified product.AcceptLanguage (string)
ProvisioningArtifactId (string)
ProductId (string)
ProvisioningArtifactName (string)
ProductName (string)
Verbose (boolean)
IncludeProvisioningArtifactParameters (boolean)
service_catalog/describe_provisioning_parametersGets 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 TagAcceptLanguage (string)
ProductId (string)
ProductName (string)
ProvisioningArtifactId (string)
ProvisioningArtifactName (string)
PathId (string)
PathName (string)
service_catalog/describe_recordGets 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'sAcceptLanguage (string)
Id (string) required
PageToken (string)
PageSize (integer)
service_catalog/describe_service_actionDescribes a self-service action.Id (string) required
AcceptLanguage (string)
service_catalog/describe_service_action_execution_parametersFinds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.ProvisionedProductId (string) required
ServiceActionId (string) required
AcceptLanguage (string)
service_catalog/describe_tag_optionGets information about the specified TagOption.Id (string) required
service_catalog/disable_awsorganizations_accessDisable 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 noNo parameters
service_catalog/disassociate_budget_from_resourceDisassociates the specified budget from the specified resource.BudgetName (string) required
ResourceId (string) required
service_catalog/disassociate_principal_from_portfolioDisassociates a previously associated principal ARN from a specified portfolio. The PrincipalType and PrincipalARN must match the AssociatePrincipalWithPortfolio call request details. For example, to disassociate an association created with a PrincipalARN of PrincipalType IAM you must use the PrincipalType IAM when calling DisassociatePrincipalFromPortfolio. For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will nAcceptLanguage (string)
PortfolioId (string) required
PrincipalARN (string) required
PrincipalType (string)
service_catalog/disassociate_product_from_portfolioDisassociates the specified product from the specified portfolio. A delegated admin is authorized to invoke this command.AcceptLanguage (string)
ProductId (string) required
PortfolioId (string) required
service_catalog/disassociate_service_action_from_provisioning_artifactDisassociates the specified self-service action association from the specified provisioning artifact.ProductId (string) required
ProvisioningArtifactId (string) required
ServiceActionId (string) required
AcceptLanguage (string)
IdempotencyToken (string)
service_catalog/disassociate_tag_option_from_resourceDisassociates the specified TagOption from the specified resource.ResourceId (string) required
TagOptionId (string) required
service_catalog/enable_awsorganizations_accessEnable 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 tNo parameters
service_catalog/execute_provisioned_product_planProvisions or modifies a product based on the resource changes for the specified plan.AcceptLanguage (string)
PlanId (string) required
IdempotencyToken (string) required
service_catalog/execute_provisioned_product_service_actionExecutes a self-service action against a provisioned product.ProvisionedProductId (string) required
ServiceActionId (string) required
ExecuteToken (string) required
AcceptLanguage (string)
Parameters (object)
service_catalog/get_awsorganizations_access_statusGet 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.No parameters
service_catalog/get_provisioned_product_outputsThis 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.AcceptLanguage (string)
ProvisionedProductId (string)
ProvisionedProductName (string)
OutputKeys (array)
PageSize (integer)
PageToken (string)
service_catalog/import_as_provisioned_productRequests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported 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_ROLLBAAcceptLanguage (string)
ProductId (string) required
ProvisioningArtifactId (string) required
ProvisionedProductName (string) required
PhysicalId (string) required
IdempotencyToken (string) required
service_catalog/list_accepted_portfolio_sharesLists 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.AcceptLanguage (string)
PageToken (string)
PageSize (integer)
PortfolioShareType (string)
service_catalog/list_budgets_for_resourceLists all the budgets associated to the specified resource.AcceptLanguage (string)
ResourceId (string) required
PageSize (integer)
PageToken (string)
service_catalog/list_constraints_for_portfolioLists the constraints for the specified portfolio and product.AcceptLanguage (string)
PortfolioId (string) required
ProductId (string)
PageSize (integer)
PageToken (string)
service_catalog/list_launch_pathsLists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal. When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see Granting users access in the Service Catalog User Guide.AcceptLanguage (string)
ProductId (string) required
PageSize (integer)
PageToken (string)
service_catalog/list_organization_portfolio_accessLists 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.AcceptLanguage (string)
PortfolioId (string) required
OrganizationNodeType (string) required
PageToken (string)
PageSize (integer)
service_catalog/list_portfolio_accessLists 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.AcceptLanguage (string)
PortfolioId (string) required
OrganizationParentId (string)
PageToken (string)
PageSize (integer)
service_catalog/list_portfoliosLists all portfolios in the catalog.AcceptLanguage (string)
PageToken (string)
PageSize (integer)
service_catalog/list_portfolios_for_productLists all portfolios that the specified product is associated with.AcceptLanguage (string)
ProductId (string) required
PageToken (string)
PageSize (integer)
service_catalog/list_principals_for_portfolioLists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio.AcceptLanguage (string)
PortfolioId (string) required
PageSize (integer)
PageToken (string)
service_catalog/list_provisioned_product_plansLists the plans for the specified provisioned product or all plans to which the user has access.AcceptLanguage (string)
ProvisionProductId (string)
PageSize (integer)
PageToken (string)
AccessLevelFilter: {
. Key (string)
. Value (string)
} (object)
service_catalog/list_provisioning_artifactsLists all provisioning artifacts also known as versions for the specified product.AcceptLanguage (string)
ProductId (string) required
service_catalog/list_provisioning_artifacts_for_service_actionLists all provisioning artifacts also known as versions for the specified self-service action.ServiceActionId (string) required
PageSize (integer)
PageToken (string)
AcceptLanguage (string)
service_catalog/list_record_historyLists the specified requests or all performed requests.AcceptLanguage (string)
AccessLevelFilter: {
. Key (string)
. Value (string)
} (object)
SearchFilter: {
. Key (string)
. Value (string)
} (object)
PageSize (integer)
PageToken (string)
service_catalog/list_resources_for_tag_optionLists the resources associated with the specified TagOption.TagOptionId (string) required
ResourceType (string)
PageSize (integer)
PageToken (string)
service_catalog/list_service_actionsLists all self-service actions.AcceptLanguage (string)
PageSize (integer)
PageToken (string)
service_catalog/list_service_actions_for_provisioning_artifactReturns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.ProductId (string) required
ProvisioningArtifactId (string) required
PageSize (integer)
PageToken (string)
AcceptLanguage (string)
service_catalog/list_stack_instances_for_provisioned_productReturns 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.AcceptLanguage (string)
ProvisionedProductId (string) required
PageToken (string)
PageSize (integer)
service_catalog/list_tag_optionsLists the specified TagOptions or all TagOptions.Filters: {
. Key (string)
. Value (string)
. Active (boolean)
} (object)
PageSize (integer)
PageToken (string)
service_catalog/notify_provision_product_engine_workflow_resultNotifies the result of the provisioning engine execution.WorkflowToken (string) required
RecordId (string) required
Status (string) required
FailureReason (string)
ResourceIdentifier: {
. UniqueTag (object)
} (object)
Outputs (array)
IdempotencyToken (string) required
service_catalog/notify_terminate_provisioned_product_engine_workflow_resultNotifies the result of the terminate engine execution.WorkflowToken (string) required
RecordId (string) required
Status (string) required
FailureReason (string)
IdempotencyToken (string) required
service_catalog/notify_update_provisioned_product_engine_workflow_resultNotifies the result of the update engine execution.WorkflowToken (string) required
RecordId (string) required
Status (string) required
FailureReason (string)
Outputs (array)
IdempotencyToken (string) required
service_catalog/provision_productProvisions the specified product. A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on an CloudFormation template launches an 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's a tag conflict for that key. Don't include conflicted keys as tags, or this will cause the error 'Parameter validation failed: MiAcceptLanguage (string)
ProductId (string)
ProductName (string)
ProvisioningArtifactId (string)
ProvisioningArtifactName (string)
PathId (string)
PathName (string)
ProvisionedProductName (string) required
ProvisioningParameters (array)
ProvisioningPreferences: {
. StackSetAccounts (array)
. StackSetRegions (array)
. StackSetFailureToleranceCount (integer)
. StackSetFailureTolerancePercentage (integer)
. StackSetMaxConcurrencyCount (integer)
. StackSetMaxConcurrencyPercentage (integer)
} (object)
Tags (array)
NotificationArns (array)
ProvisionToken (string) required
service_catalog/reject_portfolio_shareRejects an offer to share the specified portfolio.AcceptLanguage (string)
PortfolioId (string) required
PortfolioShareType (string)
service_catalog/scan_provisioned_productsLists the provisioned products that are available not terminated. To use additional filtering, see SearchProvisionedProducts.AcceptLanguage (string)
AccessLevelFilter: {
. Key (string)
. Value (string)
} (object)
PageSize (integer)
PageToken (string)
service_catalog/search_productsGets information about the products to which the caller has access.AcceptLanguage (string)
Filters (object)
PageSize (integer)
SortBy (string)
SortOrder (string)
PageToken (string)
service_catalog/search_products_as_adminGets information about the products for the specified portfolio or all products.AcceptLanguage (string)
PortfolioId (string)
Filters (object)
SortBy (string)
SortOrder (string)
PageToken (string)
PageSize (integer)
ProductSource (string)
service_catalog/search_provisioned_productsGets information about the provisioned products that meet the specified criteria.AcceptLanguage (string)
AccessLevelFilter: {
. Key (string)
. Value (string)
} (object)
Filters (object)
SortBy (string)
SortOrder (string)
PageSize (integer)
PageToken (string)
service_catalog/terminate_provisioned_productTerminates 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.ProvisionedProductName (string)
ProvisionedProductId (string)
TerminateToken (string) required
IgnoreErrors (boolean)
AcceptLanguage (string)
RetainPhysicalResources (boolean)
service_catalog/update_constraintUpdates the specified constraint.AcceptLanguage (string)
Id (string) required
Description (string)
Parameters (string)
service_catalog/update_portfolioUpdates the specified portfolio. You cannot update a product that was shared with you.AcceptLanguage (string)
Id (string) required
DisplayName (string)
Description (string)
ProviderName (string)
AddTags (array)
RemoveTags (array)
service_catalog/update_portfolio_shareUpdates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal 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 accouAcceptLanguage (string)
PortfolioId (string) required
AccountId (string)
OrganizationNode: {
. Type (string)
. Value (string)
} (object)
ShareTagOptions (boolean)
SharePrincipals (boolean)
service_catalog/update_productUpdates the specified product.AcceptLanguage (string)
Id (string) required
Name (string)
Owner (string)
Description (string)
Distributor (string)
SupportDescription (string)
SupportEmail (string)
SupportUrl (string)
AddTags (array)
RemoveTags (array)
SourceConnection: {
. Type (string)
. ConnectionParameters (object)
} (object)
service_catalog/update_provisioned_productRequests 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.AcceptLanguage (string)
ProvisionedProductName (string)
ProvisionedProductId (string)
ProductId (string)
ProductName (string)
ProvisioningArtifactId (string)
ProvisioningArtifactName (string)
PathId (string)
PathName (string)
ProvisioningParameters (array)
ProvisioningPreferences: {
. StackSetAccounts (array)
. StackSetRegions (array)
. StackSetFailureToleranceCount (integer)
. StackSetFailureTolerancePercentage (integer)
. StackSetMaxConcurrencyCount (integer)
. StackSetMaxConcurrencyPercentage (integer)
. StackSetOperationType (string)
} (object)
Tags (array)
UpdateToken (string) required
service_catalog/update_provisioned_product_propertiesRequests updates to the properties of the specified provisioned product.AcceptLanguage (string)
ProvisionedProductId (string) required
ProvisionedProductProperties (object) required
IdempotencyToken (string) required
service_catalog/update_provisioning_artifactUpdates 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.AcceptLanguage (string)
ProductId (string) required
ProvisioningArtifactId (string) required
Name (string)
Description (string)
Active (boolean)
Guidance (string)
service_catalog/update_service_actionUpdates a self-service action.Id (string) required
Name (string)
Definition (object)
Description (string)
AcceptLanguage (string)
service_catalog/update_tag_optionUpdates the specified TagOption.Id (string) required
Value (string)
Active (boolean)
service_quotas/associate_service_quota_templateAssociates your quota request template with your organization. When a new Amazon Web Services 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.No parameters
service_quotas/create_support_caseCreates a Support case for an existing quota increase request. This call only creates a Support case if the request has a Pending status.RequestId (string) required
service_quotas/delete_service_quota_increase_request_from_templateDeletes the quota increase request for the specified quota from your quota request template.ServiceCode (string) required
QuotaCode (string) required
AwsRegion (string) required
service_quotas/disassociate_service_quota_templateDisables your quota request template. After a template is disabled, the quota increase requests in the template are not applied to new Amazon Web Services accounts in your organization. Disabling a quota request template does not apply its quota increase requests.No parameters
service_quotas/get_association_for_service_quota_templateRetrieves the status of the association for the quota request template.No parameters
service_quotas/get_auto_management_configurationRetrieves information about your Service Quotas Automatic Management configuration. Automatic Management monitors your Service Quotas utilization and notifies you before you run out of your allocated quotas.No parameters
service_quotas/get_awsdefault_service_quotaRetrieves the default value for the specified quota. The default value does not reflect any quota increases.ServiceCode (string) required
QuotaCode (string) required
service_quotas/get_quota_utilization_reportRetrieves the quota utilization report for your Amazon Web Services account. This operation returns paginated results showing your quota usage across all Amazon Web Services services, sorted by utilization percentage in descending order highest utilization first. You must first initiate a report using the StartQuotaUtilizationReport operation. The report generation process is asynchronous and may take several seconds to complete. Poll this operation periodically to check the status and retrieveReportId (string) required
NextToken (string)
MaxResults (integer)
service_quotas/get_requested_service_quota_changeRetrieves information about the specified quota increase request.RequestId (string) required
service_quotas/get_service_quotaRetrieves the applied quota value for the specified account-level or resource-level 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.ServiceCode (string) required
QuotaCode (string) required
ContextId (string)
service_quotas/get_service_quota_increase_request_from_templateRetrieves information about the specified quota increase request in your quota request template.ServiceCode (string) required
QuotaCode (string) required
AwsRegion (string) required
service_quotas/list_awsdefault_service_quotasLists the default values for the quotas for the specified Amazon Web Services service. A default value does not reflect any quota increases.ServiceCode (string) required
NextToken (string)
MaxResults (integer)
service_quotas/list_requested_service_quota_change_historyRetrieves the quota increase requests for the specified Amazon Web Services service. Filter responses to return quota requests at either the account level, resource level, or all levels. Responses include any open or closed requests within 90 days.ServiceCode (string)
Status (string)
NextToken (string)
MaxResults (integer)
QuotaRequestedAtLevel (string)
service_quotas/list_requested_service_quota_change_history_by_quotaRetrieves the quota increase requests for the specified quota. Filter responses to return quota requests at either the account level, resource level, or all levels.ServiceCode (string) required
QuotaCode (string) required
Status (string)
NextToken (string)
MaxResults (integer)
QuotaRequestedAtLevel (string)
service_quotas/list_service_quota_increase_requests_in_templateLists the quota increase requests in the specified quota request template.ServiceCode (string)
AwsRegion (string)
NextToken (string)
MaxResults (integer)
service_quotas/list_service_quotasLists the applied quota values for the specified Amazon Web Services 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. Filter responses to return applied quota values at either the account level, resource level, or all levels.ServiceCode (string) required
NextToken (string)
MaxResults (integer)
QuotaCode (string)
QuotaAppliedAtLevel (string)
service_quotas/list_servicesLists the names and codes for the Amazon Web Services services integrated with Service Quotas.NextToken (string)
MaxResults (integer)
service_quotas/list_tags_for_resourceReturns a list of the tags assigned to the specified applied quota.ResourceARN (string) required
service_quotas/put_service_quota_increase_request_into_templateAdds a quota increase request to your quota request template.QuotaCode (string) required
ServiceCode (string) required
AwsRegion (string) required
DesiredValue (number) required
service_quotas/request_service_quota_increaseSubmits a quota increase request for the specified quota at the account or resource level.ServiceCode (string) required
QuotaCode (string) required
DesiredValue (number) required
ContextId (string)
SupportCaseAllowed (boolean)
service_quotas/start_auto_managementStarts Service Quotas Automatic Management for an Amazon Web Services account, including notification preferences and excluded quotas configurations. Automatic Management monitors your Service Quotas utilization and notifies you before you run out of your allocated quotas.OptInLevel (string) required
OptInType (string) required
NotificationArn (string)
ExclusionList (object)
service_quotas/start_quota_utilization_reportInitiates the generation of a quota utilization report for your Amazon Web Services account. This asynchronous operation analyzes your quota usage across all Amazon Web Services services and returns a unique report identifier that you can use to retrieve the results. The report generation process may take several seconds to complete, depending on the number of quotas in your account. Use the GetQuotaUtilizationReport operation to check the status and retrieve the results when the report is readyNo parameters
service_quotas/stop_auto_managementStops Service Quotas Automatic Management for an Amazon Web Services account and removes all associated configurations. Automatic Management monitors your Service Quotas utilization and notifies you before you run out of your allocated quotas.No parameters
service_quotas/tag_resourceAdds tags to the specified applied quota. You can include one or more tags to add to the quota.ResourceARN (string) required
Tags (array) required
service_quotas/untag_resourceRemoves tags from the specified applied quota. You can specify one or more tags to remove.ResourceARN (string) required
TagKeys (array) required
service_quotas/update_auto_managementUpdates your Service Quotas Automatic Management configuration, including notification preferences and excluded quotas. Automatic Management monitors your Service Quotas utilization and notifies you before you run out of your allocated quotas.OptInType (string)
NotificationArn (string)
ExclusionList (object)
servicediscovery/create_http_namespaceCreates 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 Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.Name (string) required
CreatorRequestId (string)
Description (string)
Tags (array)
servicediscovery/create_private_dns_namespaceCreates 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 creatName (string) required
CreatorRequestId (string)
Description (string)
Vpc (string) required
Tags (array)
Properties: {
. DnsProperties (object)
} (object)
servicediscovery/create_public_dns_namespaceCreates 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 Amazon WebName (string) required
CreatorRequestId (string)
Description (string)
Tags (array)
Properties: {
. DnsProperties (object)
} (object)
servicediscovery/create_serviceCreates 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 namespacName (string) required
NamespaceId (string)
CreatorRequestId (string)
Description (string)
DnsConfig: {
. NamespaceId (string)
. RoutingPolicy (string)
. DnsRecords (array)
} (object)
HealthCheckConfig: {
. Type (string)
. ResourcePath (string)
. FailureThreshold (integer)
} (object)
HealthCheckCustomConfig: {
. FailureThreshold (integer)
} (object)
Tags (array)
Type (string)
servicediscovery/delete_namespaceDeletes a namespace from the current account. If the namespace still contains one or more services, the request fails.Id (string) required
servicediscovery/delete_serviceDeletes a specified service and all associated service attributes. If the service still contains one or more registered instances, the request fails.Id (string) required
servicediscovery/delete_service_attributesDeletes specific attributes associated with a service.ServiceId (string) required
Attributes (array) required
servicediscovery/deregister_instanceDeletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.ServiceId (string) required
InstanceId (string) required
servicediscovery/discover_instancesDiscovers registered instances for a specified namespace and service. You can use DiscoverInstances to discover instances for any type of namespace. DiscoverInstances returns a randomized list of instances allowing customers to distribute traffic evenly across instances. For public and private DNS namespaces, you can also use DNS queries to discover instances.NamespaceName (string) required
ServiceName (string) required
MaxResults (integer)
QueryParameters (object)
OptionalParameters (object)
HealthStatus (string)
OwnerAccount (string)
servicediscovery/discover_instances_revisionDiscovers the increasing revision associated with an instance.NamespaceName (string) required
ServiceName (string) required
OwnerAccount (string)
servicediscovery/get_instanceGets information about a specified instance.ServiceId (string) required
InstanceId (string) required
servicediscovery/get_instances_health_statusGets 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.ServiceId (string) required
Instances (array)
MaxResults (integer)
NextToken (string)
servicediscovery/get_namespaceGets information about a namespace.Id (string) required
servicediscovery/get_operationGets information about any operation that returns an operation ID in the response, such as a CreateHttpNamespace request. To get a list of operations that match specified criteria, see ListOperations.OperationId (string) required
OwnerAccount (string)
servicediscovery/get_serviceGets the settings for a specified service.Id (string) required
servicediscovery/get_service_attributesReturns the attributes associated with a specified service.ServiceId (string) required
servicediscovery/list_instancesLists summary information about the instances that you registered by using a specified service.ServiceId (string) required
NextToken (string)
MaxResults (integer)
servicediscovery/list_namespacesLists summary information about the namespaces that were created by the current Amazon Web Services account and shared with the current Amazon Web Services account.NextToken (string)
MaxResults (integer)
Filters (array)
servicediscovery/list_operationsLists operations that match the criteria that you specify.NextToken (string)
MaxResults (integer)
Filters (array)
servicediscovery/list_servicesLists summary information for all the services that are associated with one or more namespaces.NextToken (string)
MaxResults (integer)
Filters (array)
servicediscovery/list_tags_for_resourceLists tags for the specified resource.ResourceARN (string) required
servicediscovery/register_instanceCreates 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.ServiceId (string) required
InstanceId (string) required
CreatorRequestId (string)
Attributes (object) required
servicediscovery/tag_resourceAdds one or more tags to the specified resource.ResourceARN (string) required
Tags (array) required
servicediscovery/untag_resourceRemoves one or more tags from the specified resource.ResourceARN (string) required
TagKeys (array) required
servicediscovery/update_http_namespaceUpdates an HTTP namespace.Id (string) required
UpdaterRequestId (string)
Namespace: {
. Description (string)
} (object) required
servicediscovery/update_instance_custom_health_statusSubmits 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.ServiceId (string) required
InstanceId (string) required
Status (string) required
servicediscovery/update_private_dns_namespaceUpdates a private DNS namespace.Id (string) required
UpdaterRequestId (string)
Namespace: {
. Description (string)
. Properties (object)
} (object) required
servicediscovery/update_public_dns_namespaceUpdates a public DNS namespace.Id (string) required
UpdaterRequestId (string)
Namespace: {
. Description (string)
. Properties (object)
} (object) required
servicediscovery/update_serviceSubmits 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 HealthCheId (string) required
Service: {
. Description (string)
. DnsConfig (object)
. HealthCheckConfig (object)
} (object) required
servicediscovery/update_service_attributesSubmits a request to update a specified service to add service-level attributes.ServiceId (string) required
Attributes (object) required
ses/clone_receipt_rule_setCreates 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.RuleSetName (string) required
OriginalRuleSetName (string) required
ses/create_configuration_setCreates 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.ConfigurationSet: {
. Name (string)
} (object) required
ses/create_configuration_set_event_destinationCreates 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 Amazon Web Services 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 executConfigurationSetName (string) required
EventDestination: {
. Name (string)
. Enabled (boolean)
. MatchingEventTypes (array)
. KinesisFirehoseDestination (object)
. CloudWatchDestination (object)
. SNSDestination (object)
} (object) required
ses/create_configuration_set_tracking_optionsCreates 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.ConfigurationSetName (string) required
TrackingOptions: {
. CustomRedirectDomain (string)
} (object) required
ses/create_custom_verification_email_templateCreates 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.TemplateName (string) required
FromEmailAddress (string) required
TemplateSubject (string) required
TemplateContent (string) required
SuccessRedirectionURL (string) required
FailureRedirectionURL (string) required
ses/create_receipt_filterCreates 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.Filter: {
. Name (string)
. IpFilter (object)
} (object) required
ses/create_receipt_ruleCreates 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.RuleSetName (string) required
After (string)
Rule: {
. Name (string)
. Enabled (boolean)
. TlsPolicy (string)
. Recipients (array)
. Actions (array)
. ScanEnabled (boolean)
} (object) required
ses/create_receipt_rule_setCreates 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.RuleSetName (string) required
ses/create_templateCreates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.Template: {
. TemplateName (string)
. SubjectPart (string)
. TextPart (string)
. HtmlPart (string)
} (object) required
ses/delete_configuration_setDeletes 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.ConfigurationSetName (string) required
ses/delete_configuration_set_event_destinationDeletes 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.ConfigurationSetName (string) required
EventDestinationName (string) required
ses/delete_configuration_set_tracking_optionsDeletes 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 results in emails sent using the specified configuration set to capture open and click events usingConfigurationSetName (string) required
ses/delete_custom_verification_email_templateDeletes 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.TemplateName (string) required
ses/delete_identityDeletes 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.Identity (string) required
ses/delete_identity_policyDeletes the specified sending authorization policy for the given identity an email address or a domain. This operation returns successfully even if a policy with the specified name does not exist. This operation is for the identity owner only. If you have not verified the identity, it returns 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 DeveloperIdentity (string) required
PolicyName (string) required
ses/delete_receipt_filterDeletes 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.FilterName (string) required
ses/delete_receipt_ruleDeletes 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.RuleSetName (string) required
RuleName (string) required
ses/delete_receipt_rule_setDeletes 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.RuleSetName (string) required
ses/delete_templateDeletes an email template. You can execute this operation no more than once per second.TemplateName (string) required
ses/delete_verified_email_addressDeprecated. Use the DeleteIdentity operation to delete email addresses and domains.EmailAddress (string) required
ses/describe_active_receipt_rule_setReturns 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.No parameters
ses/describe_configuration_setReturns 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.ConfigurationSetName (string) required
ConfigurationSetAttributeNames (array)
ses/describe_receipt_ruleReturns 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.RuleSetName (string) required
RuleName (string) required
ses/describe_receipt_rule_setReturns 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.RuleSetName (string) required
ses/get_account_sending_enabledReturns the email sending status of the Amazon SES account for the current Region. You can execute this operation no more than once per second.No parameters
ses/get_custom_verification_email_templateReturns 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.TemplateName (string) required
ses/get_identity_dkim_attributesReturns 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,Identities (array) required
ses/get_identity_mail_from_domain_attributesReturns 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.Identities (array) required
ses/get_identity_notification_attributesGiven 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.Identities (array) required
ses/get_identity_policiesReturns 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 operation is for the identity owner only. If you have not verified the identity, it returns 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 authorizatiIdentity (string) required
PolicyNames (array) required
ses/get_identity_verification_attributesGiven 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,Identities (array) required
ses/get_send_quotaProvides the sending limits for the Amazon SES account. You can execute this operation no more than once per second.No parameters
ses/get_send_statisticsProvides sending statistics for the current Amazon Web Services Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time. You can execute this operation no more than once per second.No parameters
ses/get_templateDisplays 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.TemplateName (string) required
ses/list_configuration_setsProvides a list of the configuration sets associated with your Amazon SES account in the current Amazon Web Services 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 returns 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 also returns NextToken. YoNextToken (string)
MaxItems (integer)
ses/list_custom_verification_email_templatesLists 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.NextToken (string)
MaxResults (integer)
ses/list_identitiesReturns a list containing all of the identities email addresses and domains for your Amazon Web Services account in the current Amazon Web Services Region, regardless of verification status. You can execute this operation no more than once per second. It's recommended that for successive pagination calls of this API, you continue to the use the same parameter/value pairs as used in the original call, e.g., if you used IdentityType=Domain in the the original call and received a NextToken in the rIdentityType (string)
NextToken (string)
MaxItems (integer)
ses/list_identity_policiesReturns a list of sending authorization policies that are attached to the given identity an email address or a domain. This operation returns only a list. To get the actual policy content, use GetIdentityPolicies. This operation is for the identity owner only. If you have not verified the identity, it returns 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 AmazIdentity (string) required
ses/list_receipt_filtersLists the IP address filters associated with your Amazon Web Services account in the current Amazon Web Services 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.No parameters
ses/list_receipt_rule_setsLists the receipt rule sets that exist under your Amazon Web Services account in the current Amazon Web Services Region. If there are additional receipt rule sets to be retrieved, you 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.NextToken (string)
ses/list_templatesLists 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.NextToken (string)
MaxItems (integer)
ses/list_verified_email_addressesDeprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account.No parameters
ses/put_configuration_set_delivery_optionsAdds or updates the delivery options for a configuration set.ConfigurationSetName (string) required
DeliveryOptions: {
. TlsPolicy (string)
} (object)
ses/put_identity_policyAdds or updates a sending authorization policy for the specified identity an email address or a domain. This operation is for the identity owner only. If you have not verified the identity, it returns 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.Identity (string) required
PolicyName (string) required
Policy (string) required
ses/reorder_receipt_rule_setReorders the receipt rules within a receipt rule set. All of the rules in the rule set must be represented in this request. That is, it is 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.RuleSetName (string) required
RuleNames (array) required
ses/send_bounceGenerates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this operation on an email up to 24 hours after you receive it. You cannot use this operation 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.OriginalMessageId (string) required
BounceSender (string) required
Explanation (string)
MessageDsn: {
. ReportingMta (string)
. ArrivalDate (string)
. ExtensionFields (array)
} (object)
BouncedRecipientInfoList (array) required
BounceSenderArn (string)
ses/send_bulk_templated_emailComposes an email message to multiple destinations. The message body is created using an email template. To send email using this operation, your call must meet the following requirements: The call must refer to an existing email template. You can create email templates using CreateTemplate. The message must be sent from a verified email address or domain. If your account is still in the Amazon SES sandbox, you may send only to verified addresses or domains, or to email addresses associated withSource (string) required
SourceArn (string)
ReplyToAddresses (array)
ReturnPath (string)
ReturnPathArn (string)
ConfigurationSetName (string)
DefaultTags (array)
Template (string) required
TemplateArn (string)
DefaultTemplateData (string) required
Destinations (array) required
ses/send_custom_verification_emailAdds 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. YEmailAddress (string) required
TemplateName (string) required
ConfigurationSetName (string)
ses/send_emailComposes an email message and immediately queues it for sending. To send email using this 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 results 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 AmaSource (string) required
Destination: {
. ToAddresses (array)
. CcAddresses (array)
. BccAddresses (array)
} (object) required
Message: {
. Subject (object)
. Body (object)
} (object) required
ReplyToAddresses (array)
ReturnPath (string)
SourceArn (string)
ReturnPathArn (string)
Tags (array)
ConfigurationSetName (string)
ses/send_raw_emailComposes an email message and immediately queues it for sending. This operation is more flexible than the SendEmail 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 need 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 followiSource (string)
Destinations (array)
RawMessage: {
. Data (string)
} (object) required
FromArn (string)
SourceArn (string)
ReturnPathArn (string)
Tags (array)
ConfigurationSetName (string)
ses/send_templated_emailComposes an email message using an email template and immediately queues it for sending. To send email using this operation, your call 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 tSource (string) required
Destination: {
. ToAddresses (array)
. CcAddresses (array)
. BccAddresses (array)
} (object) required
ReplyToAddresses (array)
ReturnPath (string)
SourceArn (string)
ReturnPathArn (string)
Tags (array)
ConfigurationSetName (string)
Template (string) required
TemplateArn (string)
TemplateData (string) required
ses/set_active_receipt_rule_setSets the specified receipt rule set as the active receipt rule set. To disable your email-receiving through Amazon SES completely, you can call this operation 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.RuleSetName (string)
ses/set_identity_dkim_enabledEnables 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 DKIIdentity (string) required
DkimEnabled (boolean) required
ses/set_identity_feedback_forwarding_enabledGiven 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 uIdentity (string) required
ForwardingEnabled (boolean) required
ses/set_identity_headers_in_notifications_enabledGiven 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.Identity (string) required
NotificationType (string) required
Enabled (boolean) required
ses/set_identity_mail_from_domainEnables 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. To ensure that your emails 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.Identity (string) required
MailFromDomain (string)
BehaviorOnMXFailure (string)
ses/set_identity_notification_topicSets 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 moreIdentity (string) required
NotificationType (string) required
SnsTopic (string)
ses/set_receipt_rule_positionSets 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.RuleSetName (string) required
RuleName (string) required
After (string)
ses/test_render_templateCreates 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.TemplateName (string) required
TemplateData (string) required
ses/update_account_sending_enabledEnables or disables email sending across your entire Amazon SES account in the current Amazon Web Services 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 Amazon Web Services 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.Enabled (boolean)
ses/update_configuration_set_event_destinationUpdates 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 destinatiConfigurationSetName (string) required
EventDestination: {
. Name (string)
. Enabled (boolean)
. MatchingEventTypes (array)
. KinesisFirehoseDestination (object)
. CloudWatchDestination (object)
. SNSDestination (object)
} (object) required
ses/update_configuration_set_reputation_metrics_enabledEnables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given Amazon Web Services 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.ConfigurationSetName (string) required
Enabled (boolean) required
ses/update_configuration_set_sending_enabledEnables or disables email sending for messages sent using a specific configuration set in a given Amazon Web Services 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.ConfigurationSetName (string) required
Enabled (boolean) required
ses/update_configuration_set_tracking_optionsModifies 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.ConfigurationSetName (string) required
TrackingOptions: {
. CustomRedirectDomain (string)
} (object) required
ses/update_custom_verification_email_templateUpdates 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.TemplateName (string) required
FromEmailAddress (string)
TemplateSubject (string)
TemplateContent (string)
SuccessRedirectionURL (string)
FailureRedirectionURL (string)
ses/update_receipt_ruleUpdates 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.RuleSetName (string) required
Rule: {
. Name (string)
. Enabled (boolean)
. TlsPolicy (string)
. Recipients (array)
. Actions (array)
. ScanEnabled (boolean)
} (object) required
ses/update_templateUpdates an email template. Email templates enable you to send personalized email to one or more destinations in a single operation. For more information, see the Amazon SES Developer Guide. You can execute this operation no more than once per second.Template: {
. TemplateName (string)
. SubjectPart (string)
. TextPart (string)
. HtmlPart (string)
} (object) required
ses/verify_domain_dkimReturns 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 thisDomain (string) required
ses/verify_domain_identityAdds a domain to the list of identities for your Amazon SES account in the current Amazon Web Services 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.Domain (string) required
ses/verify_email_addressDeprecated. Use the VerifyEmailIdentity operation to verify a new email address.EmailAddress (string) required
ses/verify_email_identityAdds 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 verification email is sent to the specified address. You can execute this operation no more than once per second.EmailAddress (string) required
sesv2/batch_get_metric_dataRetrieves batches of metric data collected based on your sending activity. You can execute this operation no more than 16 times per second, and with at most 160 queries from the batches per second cumulative.Queries (array) required
sesv2/cancel_export_jobCancels an export job.JobId (string) required
sesv2/create_configuration_setCreate 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.ConfigurationSetName (string) required
TrackingOptions: {
. CustomRedirectDomain (string)
. HttpsPolicy (string)
} (object)
DeliveryOptions: {
. TlsPolicy (string)
. SendingPoolName (string)
. MaxDeliverySeconds (integer)
} (object)
ReputationOptions: {
. ReputationMetricsEnabled (boolean)
. LastFreshStart (string)
} (object)
SendingOptions: {
. SendingEnabled (boolean)
} (object)
Tags (array)
SuppressionOptions: {
. SuppressedReasons (array)
. ValidationOptions (object)
} (object)
VdmOptions: {
. DashboardOptions (object)
. GuardianOptions (object)
} (object)
ArchivingOptions: {
. ArchiveArn (string)
} (object)
sesv2/create_configuration_set_event_destinationCreate 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 EventBridge and associate a rule to send the event to the specified target. A single configuration set can include more than one event destination.ConfigurationSetName (string) required
EventDestinationName (string) required
EventDestination: {
. Enabled (boolean)
. MatchingEventTypes (array)
. KinesisFirehoseDestination (object)
. CloudWatchDestination (object)
. SnsDestination (object)
. EventBridgeDestination (object)
. PinpointDestination (object)
} (object) required
sesv2/create_contactCreates a contact, which is an end-user who is receiving the email, and adds them to a contact list.ContactListName (string) required
EmailAddress (string) required
TopicPreferences (array)
UnsubscribeAll (boolean)
AttributesData (string)
sesv2/create_contact_listCreates a contact list.ContactListName (string) required
Topics (array)
Description (string)
Tags (array)
sesv2/create_custom_verification_email_templateCreates 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.TemplateName (string) required
FromEmailAddress (string) required
TemplateSubject (string) required
TemplateContent (string) required
Tags (array)
SuccessRedirectionURL (string) required
FailureRedirectionURL (string) required
sesv2/create_dedicated_ip_poolCreate 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.PoolName (string) required
Tags (array)
ScalingMode (string)
sesv2/create_deliverability_test_reportCreate 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 GeReportName (string)
FromEmailAddress (string) required
Content: {
. Simple (object)
. Raw (object)
. Template (object)
} (object) required
Tags (array)
sesv2/create_email_identityStarts 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 theEmailIdentity (string) required
Tags (array)
DkimSigningAttributes: {
. DomainSigningSelector (string)
. DomainSigningPrivateKey (string)
. NextSigningKeyLength (string)
. DomainSigningAttributesOrigin (string)
} (object)
ConfigurationSetName (string)
sesv2/create_email_identity_policyCreates 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.EmailIdentity (string) required
PolicyName (string) required
Policy (string) required
sesv2/create_email_templateCreates 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.TemplateName (string) required
TemplateContent: {
. Subject (string)
. Text (string)
. Html (string)
} (object) required
Tags (array)
sesv2/create_export_jobCreates an export job for a data source and destination. You can execute this operation no more than once per second.ExportDataSource: {
. MetricsDataSource (object)
. MessageInsightsDataSource (object)
} (object) required
ExportDestination: {
. DataFormat (string)
. S3Url (string)
} (object) required
sesv2/create_import_jobCreates an import job for a data destination.ImportDestination: {
. SuppressionListDestination (object)
. ContactListDestination (object)
} (object) required
ImportDataSource: {
. S3Url (string)
. DataFormat (string)
} (object) required
sesv2/create_multi_region_endpointCreates a multi-region endpoint global-endpoint. The primary region is going to be the AWS-Region where the operation is executed. The secondary region has to be provided in request's parameters. From the data flow standpoint there is no difference between primary and secondary regions - sending traffic will be split equally between the two. The primary region is the region where the resource has been created and where it can be managed.EndpointName (string) required
Details: {
. RoutesDetails (array)
} (object) required
Tags (array)
sesv2/create_tenantCreate a tenant. Tenants are logical containers that group related SES resources together. Each tenant can have its own set of resources like email identities, configuration sets, and templates, along with reputation metrics and sending status. This helps isolate and manage email sending for different customers or business units within your Amazon SES API v2 account.TenantName (string) required
Tags (array)
sesv2/create_tenant_resource_associationAssociate a resource with a tenant. Resources can be email identities, configuration sets, or email templates. When you associate a resource with a tenant, you can use that resource when sending emails on behalf of that tenant. A single resource can be associated with multiple tenants, allowing for resource sharing across different tenants while maintaining isolation in email sending operations.TenantName (string) required
ResourceArn (string) required
sesv2/delete_configuration_setDelete 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.ConfigurationSetName (string) required
sesv2/delete_configuration_set_event_destinationDelete 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 EventBridge and associate a rule to send the event to the specified target.ConfigurationSetName (string) required
EventDestinationName (string) required
sesv2/delete_contactRemoves a contact from a contact list.ContactListName (string) required
EmailAddress (string) required
sesv2/delete_contact_listDeletes a contact list and all of the contacts on that list.ContactListName (string) required
sesv2/delete_custom_verification_email_templateDeletes 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.TemplateName (string) required
sesv2/delete_dedicated_ip_poolDelete a dedicated IP pool.PoolName (string) required
sesv2/delete_email_identityDeletes an email identity. An identity can be either an email address or a domain name.EmailIdentity (string) required
sesv2/delete_email_identity_policyDeletes 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 GuEmailIdentity (string) required
PolicyName (string) required
sesv2/delete_email_templateDeletes an email template. You can execute this operation no more than once per second.TemplateName (string) required
sesv2/delete_multi_region_endpointDeletes a multi-region endpoint global-endpoint. Only multi-region endpoints global-endpoints whose primary region is the AWS-Region where operation is executed can be deleted.EndpointName (string) required
sesv2/delete_suppressed_destinationRemoves an email address from the suppression list for your account.EmailAddress (string) required
sesv2/delete_tenantDelete an existing tenant. When you delete a tenant, its associations with resources are removed, but the resources themselves are not deleted.TenantName (string) required
sesv2/delete_tenant_resource_associationDelete an association between a tenant and a resource. When you delete a tenant-resource association, the resource itself is not deleted, only its association with the specific tenant is removed. After removal, the resource will no longer be available for use with that tenant's email sending operations.TenantName (string) required
ResourceArn (string) required
sesv2/get_accountObtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.No parameters
sesv2/get_blacklist_reportsRetrieve a list of the blacklists that your dedicated IP addresses appear on.BlacklistItemNames (array) required
sesv2/get_configuration_setGet 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.ConfigurationSetName (string) required
sesv2/get_configuration_set_event_destinationsRetrieve 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 EventBridge and associate a rule to send the event to the specified target.ConfigurationSetName (string) required
sesv2/get_contactReturns a contact from a contact list.ContactListName (string) required
EmailAddress (string) required
sesv2/get_contact_listReturns contact list metadata. It does not return any information about the contacts present in the list.ContactListName (string) required
sesv2/get_custom_verification_email_templateReturns 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.TemplateName (string) required
sesv2/get_dedicated_ipGet 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.Ip (string) required
sesv2/get_dedicated_ip_poolRetrieve information about the dedicated pool.PoolName (string) required
sesv2/get_dedicated_ipsList the dedicated IP addresses that are associated with your Amazon Web Services account.PoolName (string)
NextToken (string)
PageSize (integer)
sesv2/get_deliverability_dashboard_optionsRetrieve 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 servicesNo parameters
sesv2/get_deliverability_test_reportRetrieve the results of a predictive inbox placement test.ReportId (string) required
sesv2/get_domain_deliverability_campaignRetrieve 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.CampaignId (string) required
sesv2/get_domain_statistics_reportRetrieve inbox placement and engagement rates for the domains that you use to send email.Domain (string) required
StartDate (string) required
EndDate (string) required
sesv2/get_email_address_insightsProvides validation insights about a specific email address, including syntax validation, DNS record checks, mailbox existence, and other deliverability factors.EmailAddress (string) required
sesv2/get_email_identityProvides information about a specific identity, including the identity's verification status, sending authorization policies, its DKIM authentication status, and its custom Mail-From settings.EmailIdentity (string) required
sesv2/get_email_identity_policiesReturns 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 authoriEmailIdentity (string) required
sesv2/get_email_templateDisplays 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.TemplateName (string) required
sesv2/get_export_jobProvides information about an export job.JobId (string) required
sesv2/get_import_jobProvides information about an import job.JobId (string) required
sesv2/get_message_insightsProvides information about a specific message, including the from address, the subject, the recipient address, email tags, as well as events associated with the message. You can execute this operation no more than once per second.MessageId (string) required
sesv2/get_multi_region_endpointDisplays the multi-region endpoint global-endpoint configuration. Only multi-region endpoints global-endpoints whose primary region is the AWS-Region where operation is executed can be displayed.EndpointName (string) required
sesv2/get_reputation_entityRetrieve information about a specific reputation entity, including its reputation management policy, customer-managed status, Amazon Web Services Amazon SES-managed status, and aggregate sending status. Reputation entities represent resources in your Amazon SES account that have reputation tracking and management capabilities. The reputation impact reflects the highest impact reputation finding for the entity. Reputation findings can be retrieved using the ListRecommendations operation.ReputationEntityReference (string) required
ReputationEntityType (string) required
sesv2/get_suppressed_destinationRetrieves information about a specific email address that's on the suppression list for your account.EmailAddress (string) required
sesv2/get_tenantGet information about a specific tenant, including the tenant's name, ID, ARN, creation timestamp, tags, and sending status.TenantName (string) required
sesv2/list_configuration_setsList 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.NextToken (string)
PageSize (integer)
sesv2/list_contact_listsLists all of the contact lists available. If your output includes a 'NextToken' field with a string value, this indicates there may be additional contacts on the filtered list - regardless of the number of contacts returned.PageSize (integer)
NextToken (string)
sesv2/list_contactsLists the contacts present in a specific contact list.ContactListName (string) required
Filter: {
. FilteredStatus (string)
. TopicFilter (object)
} (object)
PageSize (integer)
NextToken (string)
sesv2/list_custom_verification_email_templatesLists 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.NextToken (string)
PageSize (integer)
sesv2/list_dedicated_ip_poolsList all of the dedicated IP pools that exist in your Amazon Web Services account in the current Region.NextToken (string)
PageSize (integer)
sesv2/list_deliverability_test_reportsShow 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.NextToken (string)
PageSize (integer)
sesv2/list_domain_deliverability_campaignsRetrieve 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.StartDate (string) required
EndDate (string) required
SubscribedDomain (string) required
NextToken (string)
PageSize (integer)
sesv2/list_email_identitiesReturns 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.NextToken (string)
PageSize (integer)
sesv2/list_email_templatesLists 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.NextToken (string)
PageSize (integer)
sesv2/list_export_jobsLists all of the export jobs.NextToken (string)
PageSize (integer)
ExportSourceType (string)
JobStatus (string)
sesv2/list_import_jobsLists all of the import jobs.ImportDestinationType (string)
NextToken (string)
PageSize (integer)
sesv2/list_multi_region_endpointsList the multi-region endpoints global-endpoints. Only multi-region endpoints global-endpoints whose primary region is the AWS-Region where operation is executed will be listed.NextToken (string)
PageSize (integer)
sesv2/list_recommendationsLists the recommendations present in your Amazon SES account in the current Amazon Web Services Region. You can execute this operation no more than once per second.Filter (object)
NextToken (string)
PageSize (integer)
sesv2/list_reputation_entitiesList reputation entities in your Amazon SES account in the current Amazon Web Services Region. You can filter the results by entity type, reputation impact, sending status, or entity reference prefix. Reputation entities represent resources in your account that have reputation tracking and management capabilities. Use this operation to get an overview of all entities and their current reputation status.Filter (object)
NextToken (string)
PageSize (integer)
sesv2/list_resource_tenantsList all tenants associated with a specific resource. This operation returns a list of tenants that are associated with the specified resource. This is useful for understanding which tenants are currently using a particular resource such as an email identity, configuration set, or email template.ResourceArn (string) required
PageSize (integer)
NextToken (string)
sesv2/list_suppressed_destinationsRetrieves a list of email addresses that are on the suppression list for your account.Reasons (array)
StartDate (string)
EndDate (string)
NextToken (string)
PageSize (integer)
sesv2/list_tags_for_resourceRetrieve 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.ResourceArn (string) required
sesv2/list_tenant_resourcesList all resources associated with a specific tenant. This operation returns a list of resources email identities, configuration sets, or email templates that are associated with the specified tenant. You can optionally filter the results by resource type.TenantName (string) required
Filter (object)
PageSize (integer)
NextToken (string)
sesv2/list_tenantsList all tenants associated with your account in the current Amazon Web Services Region. This operation returns basic information about each tenant, such as tenant name, ID, ARN, and creation timestamp.NextToken (string)
PageSize (integer)
sesv2/put_account_dedicated_ip_warmup_attributesEnable or disable the automatic warm-up feature for dedicated IP addresses.AutoWarmupEnabled (boolean)
sesv2/put_account_detailsUpdate your Amazon SES account details.MailType (string) required
WebsiteURL (string) required
ContactLanguage (string)
UseCaseDescription (string)
AdditionalContactEmailAddresses (array)
ProductionAccessEnabled (boolean)
sesv2/put_account_sending_attributesEnable or disable the ability of your account to send email.SendingEnabled (boolean)
sesv2/put_account_suppression_attributesChange the settings for the account-level suppression list.SuppressedReasons (array)
ValidationAttributes: {
. ConditionThreshold (object)
} (object)
sesv2/put_account_vdm_attributesUpdate your Amazon SES account VDM attributes. You can execute this operation no more than once per second.VdmAttributes: {
. VdmEnabled (string)
. DashboardAttributes (object)
. GuardianAttributes (object)
} (object) required
sesv2/put_configuration_set_archiving_optionsAssociate the configuration set with a MailManager archive. When you send email using the SendEmail or SendBulkEmail operations the message as it will be given to the receiving SMTP server will be archived, along with the recipient information.ConfigurationSetName (string) required
ArchiveArn (string)
sesv2/put_configuration_set_delivery_optionsAssociate 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.ConfigurationSetName (string) required
TlsPolicy (string)
SendingPoolName (string)
MaxDeliverySeconds (integer)
sesv2/put_configuration_set_reputation_optionsEnable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific Amazon Web Services Region.ConfigurationSetName (string) required
ReputationMetricsEnabled (boolean)
sesv2/put_configuration_set_sending_optionsEnable or disable email sending for messages that use a particular configuration set in a specific Amazon Web Services Region.ConfigurationSetName (string) required
SendingEnabled (boolean)
sesv2/put_configuration_set_suppression_optionsSpecify the account suppression list preferences for a configuration set.ConfigurationSetName (string) required
SuppressedReasons (array)
ValidationOptions: {
. ConditionThreshold (object)
} (object)
sesv2/put_configuration_set_tracking_optionsSpecify a custom domain to use for open and click tracking elements in email that you send.ConfigurationSetName (string) required
CustomRedirectDomain (string)
HttpsPolicy (string)
sesv2/put_configuration_set_vdm_optionsSpecify VDM preferences for email that you send using the configuration set. You can execute this operation no more than once per second.ConfigurationSetName (string) required
VdmOptions: {
. DashboardOptions (object)
. GuardianOptions (object)
} (object)
sesv2/put_dedicated_ip_in_poolMove 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.Ip (string) required
DestinationPoolName (string) required
sesv2/put_dedicated_ip_pool_scaling_attributesUsed to convert a dedicated IP pool to a different scaling mode. MANAGED pools cannot be converted to STANDARD scaling mode.PoolName (string) required
ScalingMode (string) required
sesv2/put_dedicated_ip_warmup_attributesNo description availableIp (string) required
WarmupPercentage (integer) required
sesv2/put_deliverability_dashboard_optionEnable 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 featureDashboardEnabled (boolean) required
SubscribedDomains (array)
sesv2/put_email_identity_configuration_set_attributesUsed to associate a configuration set with an email identity.EmailIdentity (string) required
ConfigurationSetName (string)
sesv2/put_email_identity_dkim_attributesUsed to enable or disable DKIM authentication for an email identity.EmailIdentity (string) required
SigningEnabled (boolean)
sesv2/put_email_identity_dkim_signing_attributesUsed 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.EmailIdentity (string) required
SigningAttributesOrigin (string) required
SigningAttributes: {
. DomainSigningSelector (string)
. DomainSigningPrivateKey (string)
. NextSigningKeyLength (string)
. DomainSigningAttributesOrigin (string)
} (object)
sesv2/put_email_identity_feedback_attributesUsed 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 mechanismEmailIdentity (string) required
EmailForwardingEnabled (boolean)
sesv2/put_email_identity_mail_from_attributesUsed to enable or disable the custom Mail-From domain configuration for an email identity.EmailIdentity (string) required
MailFromDomain (string)
BehaviorOnMxFailure (string)
sesv2/put_suppressed_destinationAdds an email address to the suppression list for your account.EmailAddress (string) required
Reason (string) required
sesv2/send_bulk_emailComposes an email message to multiple destinations.FromEmailAddress (string)
FromEmailAddressIdentityArn (string)
ReplyToAddresses (array)
FeedbackForwardingEmailAddress (string)
FeedbackForwardingEmailAddressIdentityArn (string)
DefaultEmailTags (array)
DefaultContent: {
. Template (object)
} (object) required
BulkEmailEntries (array) required
ConfigurationSetName (string)
EndpointId (string)
TenantName (string)
sesv2/send_custom_verification_emailAdds 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. YEmailAddress (string) required
TemplateName (string) required
ConfigurationSetName (string)
sesv2/send_emailSends 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 attachmFromEmailAddress (string)
FromEmailAddressIdentityArn (string)
Destination: {
. ToAddresses (array)
. CcAddresses (array)
. BccAddresses (array)
} (object)
ReplyToAddresses (array)
FeedbackForwardingEmailAddress (string)
FeedbackForwardingEmailAddressIdentityArn (string)
Content: {
. Simple (object)
. Raw (object)
. Template (object)
} (object) required
EmailTags (array)
ConfigurationSetName (string)
EndpointId (string)
TenantName (string)
ListManagementOptions: {
. ContactListName (string)
. TopicName (string)
} (object)
sesv2/tag_resourceAdd 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 actsResourceArn (string) required
Tags (array) required
sesv2/test_render_email_templateCreates 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.TemplateName (string) required
TemplateData (string) required
sesv2/untag_resourceRemove one or more tags keys and values from a specified resource.ResourceArn (string) required
TagKeys (array) required
sesv2/update_configuration_set_event_destinationUpdate 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 EventBridge and associate a rule to send the event to the specified target.ConfigurationSetName (string) required
EventDestinationName (string) required
EventDestination: {
. Enabled (boolean)
. MatchingEventTypes (array)
. KinesisFirehoseDestination (object)
. CloudWatchDestination (object)
. SnsDestination (object)
. EventBridgeDestination (object)
. PinpointDestination (object)
} (object) required
sesv2/update_contactUpdates a contact's preferences for a list. You must specify all existing topic preferences in the TopicPreferences object, not just the ones that need updating; otherwise, all your existing preferences will be removed.ContactListName (string) required
EmailAddress (string) required
TopicPreferences (array)
UnsubscribeAll (boolean)
AttributesData (string)
sesv2/update_contact_listUpdates contact list metadata. This operation does a complete replacement.ContactListName (string) required
Topics (array)
Description (string)
sesv2/update_custom_verification_email_templateUpdates 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.TemplateName (string) required
FromEmailAddress (string) required
TemplateSubject (string) required
TemplateContent (string) required
SuccessRedirectionURL (string) required
FailureRedirectionURL (string) required
sesv2/update_email_identity_policyUpdates 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 GuEmailIdentity (string) required
PolicyName (string) required
Policy (string) required
sesv2/update_email_templateUpdates 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.TemplateName (string) required
TemplateContent: {
. Subject (string)
. Text (string)
. Html (string)
} (object) required
sesv2/update_reputation_entity_customer_managed_statusUpdate the customer-managed sending status for a reputation entity. This allows you to enable, disable, or reinstate sending for the entity. The customer-managed status works in conjunction with the Amazon Web Services Amazon SES-managed status to determine the overall sending capability. When you update the customer-managed status, the Amazon Web Services Amazon SES-managed status remains unchanged. If Amazon Web Services Amazon SES has disabled the entity, it will not be allowed to send regardReputationEntityType (string) required
ReputationEntityReference (string) required
SendingStatus (string) required
sesv2/update_reputation_entity_policyUpdate the reputation management policy for a reputation entity. The policy determines how the entity responds to reputation findings, such as automatically pausing sending when certain thresholds are exceeded. Reputation management policies are Amazon Web Services Amazon SES-managed predefined policies. You can select from none, standard, and strict policies.ReputationEntityType (string) required
ReputationEntityReference (string) required
ReputationEntityPolicy (string) required
sfn/create_activityCreates an activity. An activity is a task that you write in any programming language and host on any machine that has access to 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 rename (string) required
tags (array)
encryptionConfiguration: {
. kmsKeyId (string)
. kmsDataKeyReusePeriodSeconds (integer)
. type (string)
} (object)
sfn/create_state_machineCreates 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 Step Functions User Guide. If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machinname (string) required
definition (string) required
roleArn (string) required
type (string)
loggingConfiguration: {
. level (string)
. includeExecutionData (boolean)
. destinations (array)
} (object)
tags (array)
tracingConfiguration: {
. enabled (boolean)
} (object)
publish (boolean)
versionDescription (string)
encryptionConfiguration: {
. kmsKeyId (string)
. kmsDataKeyReusePeriodSeconds (integer)
. type (string)
} (object)
sfn/create_state_machine_aliasCreates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code. You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each versiondescription (string)
name (string) required
routingConfiguration (array) required
sfn/delete_activityDeletes an activity.activityArn (string) required
sfn/delete_state_machineDeletes a state machine. This is an asynchronous operation. It sets the state machine's status to DELETING and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machinestateMachineArn (string) required
sfn/delete_state_machine_aliasDeletes a state machine alias. After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references. Related operations: CreateStateMachineAlias DescribeStateMachineAlias ListStateMachineAliases UpdateStateMachineAliasstateMachineAliasArn (string) required
sfn/delete_state_machine_versionDeletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias. Deleting a state machine version won't terminate its in-progress executions. You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version. Related operations: PublishStateMachineVersion ListSstateMachineVersionArn (string) required
sfn/describe_activityDescribes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.activityArn (string) required
sfn/describe_executionProvides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name ARN if the execution was dispatched by a Map Run. If you specify a version or alias ARN when you call the StartExecutioexecutionArn (string) required
includedData (string)
sfn/describe_map_runProvides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.mapRunArn (string) required
sfn/describe_state_machineProvides information about a state machine's definition, its IAM role Amazon Resource Name ARN, and configuration. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:rstateMachineArn (string) required
includedData (string)
sfn/describe_state_machine_aliasReturns details about a state machine alias. Related operations: CreateStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias DeleteStateMachineAliasstateMachineAliasArn (string) required
sfn/describe_state_machine_for_executionProvides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name ARN in the response. The state machine returned is the state machine associated with the Map Run. 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.executionArn (string) required
includedData (string)
sfn/get_activity_taskUsed 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. This API aactivityArn (string) required
workerName (string)
sfn/get_execution_historyReturns 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.executionArn (string) required
maxResults (integer)
reverseOrder (boolean)
nextToken (string)
includeExecutionData (boolean)
sfn/list_activitiesLists 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 amaxResults (integer)
nextToken (string)
sfn/list_executionsLists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name ARN, or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all redriven executions. You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version. Results are sorted by time, with the most recent execution first. If nextToken istateMachineArn (string)
statusFilter (string)
maxResults (integer)
nextToken (string)
mapRunArn (string)
redriveFilter (string)
sfn/list_map_runsLists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.executionArn (string) required
maxResults (integer)
nextToken (string)
sfn/list_state_machine_aliasesLists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first. To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter. 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 paginatistateMachineArn (string) required
nextToken (string)
maxResults (integer)
sfn/list_state_machinesLists 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 updatmaxResults (integer)
nextToken (string)
sfn/list_state_machine_versionsLists versions for the specified state machine Amazon Resource Name ARN. The results are sorted in descending order of the version creation time. 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 erstateMachineArn (string) required
nextToken (string)
maxResults (integer)
sfn/list_tags_for_resourceList tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.resourceArn (string) required
sfn/publish_state_machine_versionCreates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias. You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action. PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate state machine versiostateMachineArn (string) required
revisionId (string)
description (string)
sfn/redrive_executionRestarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and executionexecutionArn (string) required
clientToken (string)
sfn/send_task_failureUsed by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken failed. For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role. A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs totaskToken (string) required
error (string)
cause (string)
sfn/send_task_heartbeatUsed by activity workers and Task states using the callback pattern, and optionally Task states using the job run 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 executiontaskToken (string) required
sfn/send_task_successUsed by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken completed successfully.taskToken (string) required
output (string) required
sfn/start_executionStarts a state machine execution. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualistateMachineArn (string) required
name (string)
input (string)
traceHeader (string)
sfn/start_sync_executionStarts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows. StartSyncExecution will return a 200 OK response, even if your execution fails, because the status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration. This API action isn't logged in CloudTrail.stateMachineArn (string) required
name (string)
input (string)
traceHeader (string)
includedData (string)
sfn/stop_executionStops an execution. This API action is not supported by EXPRESS state machines. For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role. A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.executionArn (string) required
error (string)
cause (string)
sfn/tag_resourceAdd a tag to a Step Functions resource. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.resourceArn (string) required
tags (array) required
sfn/test_stateAccepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following: A state's input and output processing data flow An Amazon Web Services service integration request and response An HTTP Task request and response You can call this API on only one state at a time. The states that you can test include the following: All Task types except Activity Pass Wait Choice Succeeddefinition (string) required
roleArn (string)
input (string)
inspectionLevel (string)
revealSecrets (boolean)
variables (string)
stateName (string)
mock: {
. result (string)
. errorOutput (object)
. fieldValidationMode (string)
} (object)
context (string)
stateConfiguration: {
. retrierRetryCount (integer)
. errorCausedByState (string)
. mapIterationFailureCount (integer)
. mapItemReaderData (string)
} (object)
sfn/untag_resourceRemove a tag from a Step Functions resourceresourceArn (string) required
tagKeys (array) required
sfn/update_map_runUpdates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.mapRunArn (string) required
maxConcurrency (integer)
toleratedFailurePercentage (number)
toleratedFailureCount (integer)
sfn/update_state_machineUpdates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration. 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. A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachinestateMachineArn (string) required
definition (string)
roleArn (string)
loggingConfiguration: {
. level (string)
. includeExecutionData (boolean)
. destinations (array)
} (object)
tracingConfiguration: {
. enabled (boolean)
} (object)
publish (boolean)
versionDescription (string)
encryptionConfiguration: {
. kmsKeyId (string)
. kmsDataKeyReusePeriodSeconds (integer)
. type (string)
} (object)
sfn/update_state_machine_aliasUpdates the configuration of an existing state machine alias by modifying its description or routingConfiguration. You must specify at least one of the description or routingConfiguration parameters to update a state machine alias. UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description, and routingConfiguration parameters. Requests with the same parameters return an idempotent response. This operation is eventually consisstateMachineAliasArn (string) required
description (string)
routingConfiguration (array)
sfn/validate_state_machine_definitionValidates the syntax of a state machine definition specified in Amazon States Language ASL, a JSON-based, structured language. You can validate that a state machine definition is correct without creating a state machine resource. Suggested uses for ValidateStateMachineDefinition: Integrate automated checks into your code review or Continuous Integration CI process to check state machine definitions before starting deployments. Run validation from a Git pre-commit hook to verify the definition bedefinition (string) required
type (string)
severity (string)
maxResults (integer)
shield/associate_drtlog_bucketAuthorizes 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.LogBucket (string) required
shield/associate_drtroleAuthorizes 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 AssRoleArn (string) required
shield/associate_health_checkAdds 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.ProtectionId (string) required
HealthCheckArn (string) required
shield/associate_proactive_engagement_detailsInitializes 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 initiateEmergencyContactList (array) required
shield/create_protectionEnables 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 protectName (string) required
ResourceArn (string) required
Tags (array)
shield/create_protection_groupCreates 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.ProtectionGroupId (string) required
Aggregation (string) required
Pattern (string) required
ResourceType (string)
Members (array)
Tags (array)
shield/create_subscriptionActivates 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.No parameters
shield/delete_protectionDeletes an Shield Advanced Protection.ProtectionId (string) required
shield/delete_protection_groupRemoves the specified protection group.ProtectionGroupId (string) required
shield/delete_subscriptionRemoves 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.No parameters
shield/describe_attackDescribes the details of a DDoS attack.AttackId (string) required
shield/describe_attack_statisticsProvides 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 thNo parameters
shield/describe_drtaccessReturns 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.No parameters
shield/describe_emergency_contact_settingsA 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.No parameters
shield/describe_protectionLists the details of a Protection object.ProtectionId (string)
ResourceArn (string)
shield/describe_protection_groupReturns the specification for the specified protection group.ProtectionGroupId (string) required
shield/describe_subscriptionProvides details about the Shield Advanced subscription for an account.No parameters
shield/disable_application_layer_automatic_responseDisable 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.ResourceArn (string) required
shield/disable_proactive_engagementRemoves authorization from the Shield Response Team SRT to notify contacts about escalations to the SRT and to initiate proactive customer support.No parameters
shield/disassociate_drtlog_bucketRemoves the Shield Response Team's SRT access to the specified Amazon S3 bucket containing the logs that you shared previously.LogBucket (string) required
shield/disassociate_drtroleRemoves the Shield Response Team's SRT access to your Amazon Web Services account.No parameters
shield/disassociate_health_checkRemoves 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.ProtectionId (string) required
HealthCheckArn (string) required
shield/enable_application_layer_automatic_responseEnable 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 requiResourceArn (string) required
Action: {
. Block (object)
. Count (object)
} (object) required
shield/enable_proactive_engagementAuthorizes the Shield Response Team SRT to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.No parameters
shield/get_subscription_stateReturns the SubscriptionState, either Active or Inactive.No parameters
shield/list_attacksReturns all ongoing DDoS attacks or all DDoS attacks during a specified time period.ResourceArns (array)
StartTime: {
. FromInclusive (string)
. ToExclusive (string)
} (object)
EndTime: {
. FromInclusive (string)
. ToExclusive (string)
} (object)
NextToken (string)
MaxResults (integer)
shield/list_protection_groupsRetrieves 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.NextToken (string)
MaxResults (integer)
InclusionFilters: {
. ProtectionGroupIds (array)
. Patterns (array)
. ResourceTypes (array)
. Aggregations (array)
} (object)
shield/list_protectionsRetrieves 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.NextToken (string)
MaxResults (integer)
InclusionFilters: {
. ResourceArns (array)
. ProtectionNames (array)
. ResourceTypes (array)
} (object)
shield/list_resources_in_protection_groupRetrieves the resources that are included in the protection group.ProtectionGroupId (string) required
NextToken (string)
MaxResults (integer)
shield/list_tags_for_resourceGets information about Amazon Web Services tags for a specified Amazon Resource Name ARN in Shield.ResourceARN (string) required
shield/tag_resourceAdds or updates tags for a resource in Shield.ResourceARN (string) required
Tags (array) required
shield/untag_resourceRemoves tags from a resource in Shield.ResourceARN (string) required
TagKeys (array) required
shield/update_application_layer_automatic_responseUpdates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.ResourceArn (string) required
Action: {
. Block (object)
. Count (object)
} (object) required
shield/update_emergency_contact_settingsUpdates 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.EmergencyContactList (array)
shield/update_protection_groupUpdates 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.ProtectionGroupId (string) required
Aggregation (string) required
Pattern (string) required
ResourceType (string)
Members (array)
shield/update_subscriptionUpdates 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.AutoRenew (string)
signer/add_profile_permissionAdds cross-account permissions to a signing profile.profileName (string) required
profileVersion (string)
action (string) required
principal (string) required
revisionId (string)
statementId (string) required
signer/cancel_signing_profileChanges 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. See Data Retention for more information on scheduled deletion of a canceled signing profile.profileName (string) required
signer/describe_signing_jobReturns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.jobId (string) required
signer/get_revocation_statusRetrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.signatureTimestamp (string) required
platformId (string) required
profileVersionArn (string) required
jobArn (string) required
certificateHashes (array) required
signer/get_signing_platformReturns information on a specific signing platform.platformId (string) required
signer/get_signing_profileReturns information on a specific signing profile.profileName (string) required
profileOwner (string)
signer/list_profile_permissionsLists the cross-account permissions associated with a signing profile.profileName (string) required
nextToken (string)
signer/list_signing_jobsLists 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, AWS Signer 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 Signer returns in the nextToken parameter until all of your signing jobs have been returned.status (string)
platformId (string)
requestedBy (string)
maxResults (integer)
nextToken (string)
isRevoked (boolean)
signatureExpiresBefore (string)
signatureExpiresAfter (string)
jobInvoker (string)
signer/list_signing_platformsLists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, Signer 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 Signer returns in the nextToken parameter until all of your signing jobs have been returned.category (string)
partner (string)
target (string)
maxResults (integer)
nextToken (string)
signer/list_signing_profilesLists 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, AWS Signer 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 Signer returns in the nextToken parameter until all of your signing jobs have beeincludeCanceled (boolean)
maxResults (integer)
nextToken (string)
platformId (string)
statuses (array)
signer/list_tags_for_resourceReturns a list of the tags associated with a signing profile resource.resourceArn (string) required
signer/put_signing_profileCreates a signing profile. A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.profileName (string) required
signingMaterial: {
. certificateArn (string)
} (object)
signatureValidityPeriod: {
. value (integer)
. type (string)
} (object)
platformId (string) required
overrides: {
. signingConfiguration (object)
. signingImageFormat (string)
} (object)
signingParameters (object)
tags (object)
signer/remove_profile_permissionRemoves cross-account permissions from a signing profile.profileName (string) required
revisionId (string) required
statementId (string) required
signer/revoke_signatureChanges the state of a signing job to REVOKED. This indicates that the signature is no longer valid.jobId (string) required
jobOwner (string)
reason (string) required
signer/revoke_signing_profileChanges 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. A revoked profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs. See Data Retention for more information on scheduled deletion of a revoked signing profile.profileName (string) required
profileVersion (string) required
reason (string) required
effectiveTime (string) required
signer/sign_payloadSigns a binary payload and returns a signature envelope.profileName (string) required
profileOwner (string)
payload (string) required
payloadFormat (string) required
signer/start_signing_jobInitiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation. Note the following requirements: You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the Amazon S3 Getting Started Guide. Your S3 source bucket must be version enabled. You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code. You specify the name of the source and destination bucketssource: {
. s3 (object)
} (object) required
destination: {
. s3 (object)
} (object) required
profileName (string) required
clientRequestToken (string) required
profileOwner (string)
signer/tag_resourceAdds 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.resourceArn (string) required
tags (object) required
signer/untag_resourceRemoves one or more tags from a signing profile. To remove the tags, specify a list of tag keys.resourceArn (string) required
tagKeys (array) required
signin/create_oauth2tokenCreateOAuth2Token API Path: /v1/token Request Method: POST Content-Type: application/json or application/x-www-form-urlencoded This API implements OAuth 2.0 flows for AWS Sign-In CLI clients, supporting both: 1. Authorization code redemption grant_type=authorization_code - NOT idempotent 2. Token refresh grant_type=refresh_token - Idempotent within token validity window The operation behavior is determined by the grant_type parameter in the request body: Authorization Code Flow NOT Idempotent: -tokenInput: {
. clientId (string)
. grantType (string)
. code (string)
. redirectUri (string)
. codeVerifier (string)
. refreshToken (string)
} (object) required
simspaceweaver/list_tags_for_resourceLists all tags on a SimSpace Weaver resource.ResourceArn (string) required
simspaceweaver/tag_resourceAdds tags to a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.ResourceArn (string) required
Tags (object) required
simspaceweaver/untag_resourceRemoves tags from a SimSpace Weaver resource. For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.ResourceArn (string) required
TagKeys (array) required
simspaceweaver/create_snapshotCreates a snapshot of the specified simulation. A snapshot is a file that contains simulation state data at a specific time. The state data saved in a snapshot includes entity data from the State Fabric, the simulation configuration specified in the schema, and the clock tick number. You can use the snapshot to initialize a new simulation. For more information about snapshots, see Snapshots in the SimSpace Weaver User Guide. You specify a Destination when you create a snapshot. The Destination iSimulation (string) required
Destination: {
. BucketName (string)
. ObjectKeyPrefix (string)
} (object) required
simspaceweaver/delete_appDeletes the instance of the given custom app.Simulation (string) required
Domain (string) required
App (string) required
simspaceweaver/describe_appReturns the state of the given custom app.Simulation (string) required
Domain (string) required
App (string) required
simspaceweaver/list_appsLists all custom apps or service apps for the given simulation and domain.Simulation (string) required
Domain (string)
MaxResults (integer)
NextToken (string)
simspaceweaver/start_appStarts a custom app with the configuration specified in the simulation schema.ClientToken (string)
Simulation (string) required
Domain (string) required
Name (string) required
Description (string)
LaunchOverrides: {
. LaunchCommands (array)
} (object)
simspaceweaver/start_clockStarts the simulation clock.Simulation (string) required
simspaceweaver/stop_appStops the given custom app and shuts down all of its allocated compute resources.Simulation (string) required
Domain (string) required
App (string) required
simspaceweaver/stop_clockStops the simulation clock.Simulation (string) required
simspaceweaver/start_simulationStarts a simulation with the given name. You must choose to start your simulation from a schema or from a snapshot. For more information about the schema, see the schema reference in the SimSpace Weaver User Guide. For more information about snapshots, see Snapshots in the SimSpace Weaver User Guide.ClientToken (string)
Name (string) required
Description (string)
RoleArn (string) required
SchemaS3Location: {
. BucketName (string)
. ObjectKey (string)
} (object)
MaximumDuration (string)
Tags (object)
SnapshotS3Location: {
. BucketName (string)
. ObjectKey (string)
} (object)
simspaceweaver/describe_simulationReturns the current state of the given simulation.Simulation (string) required
simspaceweaver/stop_simulationStops the given simulation. You can't restart a simulation after you stop it. If you want to restart a simulation, then you must stop it, delete it, and start a new instance of it.Simulation (string) required
simspaceweaver/delete_simulationDeletes all SimSpace Weaver resources assigned to the given simulation. Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete resources in other Amazon Web Services.Simulation (string) required
simspaceweaver/list_simulationsLists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.MaxResults (integer)
NextToken (string)
snow_device_management/list_tags_for_resourceReturns a list of tags for a managed device or task.resourceArn (string) required
snow_device_management/tag_resourceAdds or replaces tags on a device or task.resourceArn (string) required
tags (object) required
snow_device_management/untag_resourceRemoves a tag from a device or task.resourceArn (string) required
tagKeys (array) required
snow_device_management/describe_device_ec2instancesChecks 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.managedDeviceId (string) required
instanceIds (array) required
snow_device_management/list_device_resourcesReturns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.managedDeviceId (string) required
type (string)
maxResults (integer)
nextToken (string)
snow_device_management/describe_deviceChecks device-specific information, such as the device type, software version, IP addresses, and lock status.managedDeviceId (string) required
snow_device_management/list_devicesReturns 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.jobId (string)
maxResults (integer)
nextToken (string)
snow_device_management/cancel_taskSends 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.taskId (string) required
snow_device_management/create_taskInstructs one or more devices to start a task, such as unlocking or rebooting.targets (array) required
command (undefined) required
description (string)
tags (object)
clientToken (string)
snow_device_management/describe_taskChecks the metadata for a given task on a device.taskId (string) required
snow_device_management/list_tasksReturns a list of tasks that can be filtered by state.state (string)
maxResults (integer)
nextToken (string)
snow_device_management/describe_executionChecks the status of a remote task running on one or more target devices.taskId (string) required
managedDeviceId (string) required
snow_device_management/list_executionsReturns the status of tasks for one or more target devices.taskId (string) required
state (string)
maxResults (integer)
nextToken (string)
snowball/cancel_clusterCancels 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.ClusterId (string) required
snowball/cancel_jobCancels 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.JobId (string) required
snowball/create_addressCreates 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. If providing an address as a JSON file through the cli-input-json option, include the full file path. For example, --cli-input-json file://create-address.json.Address: {
. AddressId (string)
. Name (string)
. Company (string)
. Street1 (string)
. Street2 (string)
. Street3 (string)
. City (string)
. StateOrProvince (string)
. PrefectureOrDistrict (string)
. Landmark (string)
. Country (string)
. PostalCode (string)
. PhoneNumber (string)
. IsRestricted (boolean)
. Type (string)
} (object) required
snowball/create_clusterCreates 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.JobType (string) required
Resources: {
. S3Resources (array)
. LambdaResources (array)
. Ec2AmiResources (array)
} (object)
OnDeviceServiceConfiguration: {
. NFSOnDeviceService (object)
. TGWOnDeviceService (object)
. EKSOnDeviceService (object)
. S3OnDeviceService (object)
} (object)
Description (string)
AddressId (string) required
KmsKeyARN (string)
RoleARN (string)
SnowballType (string) required
ShippingOption (string) required
Notification: {
. SnsTopicARN (string)
. JobStatesToNotify (array)
. NotifyAll (boolean)
. DevicePickupSnsTopicARN (string)
} (object)
ForwardingAddressId (string)
TaxDocuments: {
. IND (object)
} (object)
RemoteManagement (string)
InitialClusterSize (integer)
ForceCreateJobs (boolean)
LongTermPricingIds (array)
SnowballCapacityPreference (string)
snowball/create_jobCreates 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 ofJobType (string)
Resources: {
. S3Resources (array)
. LambdaResources (array)
. Ec2AmiResources (array)
} (object)
OnDeviceServiceConfiguration: {
. NFSOnDeviceService (object)
. TGWOnDeviceService (object)
. EKSOnDeviceService (object)
. S3OnDeviceService (object)
} (object)
Description (string)
AddressId (string)
KmsKeyARN (string)
RoleARN (string)
SnowballCapacityPreference (string)
ShippingOption (string)
Notification: {
. SnsTopicARN (string)
. JobStatesToNotify (array)
. NotifyAll (boolean)
. DevicePickupSnsTopicARN (string)
} (object)
ClusterId (string)
SnowballType (string)
ForwardingAddressId (string)
TaxDocuments: {
. IND (object)
} (object)
DeviceConfiguration: {
. SnowconeDeviceConfiguration (object)
} (object)
RemoteManagement (string)
LongTermPricingId (string)
ImpactLevel (string)
PickupDetails: {
. Name (string)
. PhoneNumber (string)
. Email (string)
. IdentificationNumber (string)
. IdentificationExpirationDate (string)
. IdentificationIssuingOrg (string)
. DevicePickupId (string)
} (object)
snowball/create_long_term_pricingCreates 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.LongTermPricingType (string) required
IsLongTermPricingAutoRenew (boolean)
SnowballType (string) required
snowball/create_return_shipping_labelCreates a shipping label that will be used to return the Snow device to Amazon Web Services.JobId (string) required
ShippingOption (string)
snowball/describe_addressTakes an AddressId and returns specific details about that address in the form of an Address object.AddressId (string) required
snowball/describe_addressesReturns 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.MaxResults (integer)
NextToken (string)
snowball/describe_clusterReturns information about a specific cluster including shipping information, cluster status, and other important metadata.ClusterId (string) required
snowball/describe_jobReturns information about a specific job including shipping information, job status, and other important metadata.JobId (string) required
snowball/describe_return_shipping_labelInformation on the shipping label of a Snow device that is being returned to Amazon Web Services.JobId (string) required
snowball/get_job_manifestReturns 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 UnlockCJobId (string) required
snowball/get_job_unlock_codeReturns 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 asJobId (string) required
snowball/get_snowball_usageReturns 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.No parameters
snowball/get_software_updatesReturns an Amazon S3 presigned URL for an update file associated with a specified JobId.JobId (string) required
snowball/list_cluster_jobsReturns 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.ClusterId (string) required
MaxResults (integer)
NextToken (string)
snowball/list_clustersReturns 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.MaxResults (integer)
NextToken (string)
snowball/list_compatible_imagesThis action returns a list of the different Amazon EC2-compatible 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 Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial HVM images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VMMaxResults (integer)
NextToken (string)
snowball/list_jobsReturns 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.MaxResults (integer)
NextToken (string)
snowball/list_long_term_pricingLists all long-term pricing types.MaxResults (integer)
NextToken (string)
snowball/list_pickup_locationsA list of locations from which the customer can choose to pickup a device.MaxResults (integer)
NextToken (string)
snowball/list_service_versionsLists all supported versions for Snow on-device services. Returns an array of ServiceVersion object containing the supported versions for a particular service.ServiceName (string) required
DependentServices (array)
MaxResults (integer)
NextToken (string)
snowball/update_clusterWhile 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.ClusterId (string) required
RoleARN (string)
Description (string)
Resources: {
. S3Resources (array)
. LambdaResources (array)
. Ec2AmiResources (array)
} (object)
OnDeviceServiceConfiguration: {
. NFSOnDeviceService (object)
. TGWOnDeviceService (object)
. EKSOnDeviceService (object)
. S3OnDeviceService (object)
} (object)
AddressId (string)
ShippingOption (string)
Notification: {
. SnsTopicARN (string)
. JobStatesToNotify (array)
. NotifyAll (boolean)
. DevicePickupSnsTopicARN (string)
} (object)
ForwardingAddressId (string)
snowball/update_jobWhile 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.JobId (string) required
RoleARN (string)
Notification: {
. SnsTopicARN (string)
. JobStatesToNotify (array)
. NotifyAll (boolean)
. DevicePickupSnsTopicARN (string)
} (object)
Resources: {
. S3Resources (array)
. LambdaResources (array)
. Ec2AmiResources (array)
} (object)
OnDeviceServiceConfiguration: {
. NFSOnDeviceService (object)
. TGWOnDeviceService (object)
. EKSOnDeviceService (object)
. S3OnDeviceService (object)
} (object)
AddressId (string)
ShippingOption (string)
Description (string)
SnowballCapacityPreference (string)
ForwardingAddressId (string)
PickupDetails: {
. Name (string)
. PhoneNumber (string)
. Email (string)
. IdentificationNumber (string)
. IdentificationExpirationDate (string)
. IdentificationIssuingOrg (string)
. DevicePickupId (string)
} (object)
snowball/update_job_shipment_stateUpdates the state when a shipment state changes to a different state.JobId (string) required
ShipmentState (string) required
snowball/update_long_term_pricingUpdates the long-term pricing type.LongTermPricingId (string) required
ReplacementJob (string)
IsLongTermPricingAutoRenew (boolean)
sns/add_permissionAdds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions. To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.TopicArn (string) required
Label (string) required
AWSAccountId (array) required
ActionName (array) required
sns/check_if_phone_number_is_opted_outAccepts 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.phoneNumber (string) required
sns/confirm_subscriptionVerifies 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'.TopicArn (string) required
Token (string) required
AuthenticateOnUnsubscribe (string)
sns/create_platform_applicationCreates 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 APNS and APNS_SANDBOX usingName (string) required
Platform (string) required
Attributes (object) required
sns/create_platform_endpointCreates 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 tokPlatformApplicationArn (string) required
Token (string) required
CustomUserData (string)
Attributes (object)
sns/create_smssandbox_phone_numberAdds 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, yoPhoneNumber (string) required
LanguageCode (string)
sns/create_topicCreates 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.Name (string) required
Attributes (object)
Tags (array)
DataProtectionPolicy (string)
sns/delete_endpointDeletes 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.EndpointArn (string) required
sns/delete_platform_applicationDeletes 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.PlatformApplicationArn (string) required
sns/delete_smssandbox_phone_numberDeletes 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 destPhoneNumber (string) required
sns/delete_topicDeletes 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.TopicArn (string) required
sns/get_data_protection_policyRetrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.ResourceArn (string) required
sns/get_endpoint_attributesRetrieves 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.EndpointArn (string) required
sns/get_platform_application_attributesRetrieves 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.PlatformApplicationArn (string) required
sns/get_smsattributesReturns the settings for sending SMS messages from your Amazon Web Services account. These settings are set with the SetSMSAttributes action.attributes (array)
sns/get_smssandbox_account_statusRetrieves 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 messageNo parameters
sns/get_subscription_attributesReturns all of the properties of a subscription.SubscriptionArn (string) required
sns/get_topic_attributesReturns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.TopicArn (string) required
sns/list_endpoints_by_platform_applicationLists 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 cPlatformApplicationArn (string) required
NextToken (string)
sns/list_origination_numbersLists 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.NextToken (string)
MaxResults (integer)
sns/list_phone_numbers_opted_outReturns 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 willnextToken (string)
sns/list_platform_applicationsLists 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 recordsNextToken (string)
sns/list_smssandbox_phone_numbersLists 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 mesNextToken (string)
MaxResults (integer)
sns/list_subscriptionsReturns 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.NextToken (string)
sns/list_subscriptions_by_topicReturns 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.TopicArn (string) required
NextToken (string)
sns/list_tags_for_resourceList all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.ResourceArn (string) required
sns/list_topicsReturns 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.NextToken (string)
sns/opt_in_phone_numberUse 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.phoneNumber (string) required
sns/publishSends 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 PublTopicArn (string)
TargetArn (string)
PhoneNumber (string)
Message (string) required
Subject (string)
MessageStructure (string)
MessageAttributes (object)
MessageDeduplicationId (string)
MessageGroupId (string)
sns/publish_batchPublishes up to 10 messages to the specified topic in a single batch. This is a batch version of the Publish API. If you try to send more than 10 messages in a single batch request, you will receive a TooManyEntriesInBatchRequest exception. 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 five minutes. The result of publishing each message is reported individually in the responTopicArn (string) required
PublishBatchRequestEntries (array) required
sns/put_data_protection_policyAdds or updates an inline policy document that is stored in the specified Amazon SNS topic.ResourceArn (string) required
DataProtectionPolicy (string) required
sns/remove_permissionRemoves a statement from a topic's access control policy. To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.TopicArn (string) required
Label (string) required
sns/set_endpoint_attributesSets 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.EndpointArn (string) required
Attributes (object) required
sns/set_platform_application_attributesSets 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.PlatformApplicationArn (string) required
Attributes (object) required
sns/set_smsattributesUse 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.attributes (object) required
sns/set_subscription_attributesAllows a subscription owner to set an attribute of the subscription to a new value.SubscriptionArn (string) required
AttributeName (string) required
AttributeValue (string)
sns/set_topic_attributesAllows a topic owner to set an attribute of the topic to a new value. To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.TopicArn (string) required
AttributeName (string) required
AttributeValue (string)
sns/subscribeSubscribes 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 two days. This action is throttled at 100 transactions per second TPS.TopicArn (string) required
Protocol (string) required
Endpoint (string)
Attributes (object)
ReturnSubscriptionArn (boolean)
sns/tag_resourceAdd 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 accoResourceArn (string) required
Tags (array) required
sns/unsubscribeDeletes 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 throttledSubscriptionArn (string) required
sns/untag_resourceRemove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.ResourceArn (string) required
TagKeys (array) required
sns/verify_smssandbox_phone_numberVerifies 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 toPhoneNumber (string) required
OneTimePassword (string) required
socialmessaging/list_tags_for_resourceList all tags associated with a resource, such as a phone number or WABA.resourceArn (string) required
socialmessaging/tag_resourceAdds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value.resourceArn (string) required
tags (array) required
socialmessaging/untag_resourceRemoves the specified tags from a resource.resourceArn (string) required
tagKeys (array) required
socialmessaging/create_whats_app_message_templateCreates a new WhatsApp message template from a custom definition. Amazon Web Services End User Messaging Social does not store any WhatsApp message template content.templateDefinition (string) required
id (string) required
socialmessaging/create_whats_app_message_template_from_libraryCreates a new WhatsApp message template using a template from Meta's template library.metaLibraryTemplate: {
. templateName (string)
. libraryTemplateName (string)
. templateCategory (string)
. templateLanguage (string)
. libraryTemplateButtonInputs (array)
. libraryTemplateBodyInputs (object)
} (object) required
id (string) required
socialmessaging/create_whats_app_message_template_mediaUploads media for use in a WhatsApp message template.id (string) required
sourceS3File: {
. bucketName (string)
. key (string)
} (object)
socialmessaging/delete_whats_app_message_templateDeletes a WhatsApp message template.metaTemplateId (string)
deleteAllLanguages (boolean)
id (string) required
templateName (string) required
socialmessaging/get_whats_app_message_templateRetrieves a specific WhatsApp message template.metaTemplateId (string) required
id (string) required
socialmessaging/list_whats_app_message_templatesLists WhatsApp message templates for a specific WhatsApp Business Account.id (string) required
nextToken (string)
maxResults (integer)
socialmessaging/list_whats_app_template_libraryLists templates available in Meta's template library for WhatsApp messaging.nextToken (string)
maxResults (integer)
id (string) required
filters (object)
socialmessaging/put_whats_app_business_account_event_destinationsAdd an event destination to log event data from WhatsApp for a WhatsApp Business Account WABA. A WABA can only have one event destination at a time. All resources associated with the WABA use the same event destination.id (string) required
eventDestinations (array) required
socialmessaging/update_whats_app_message_templateUpdates an existing WhatsApp message template.id (string) required
metaTemplateId (string) required
parameterFormat (string)
templateCategory (string)
templateComponents (string)
ctaUrlLinkTrackingOptedOut (boolean)
socialmessaging/associate_whats_app_business_accountThis is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account.signupCallback: {
. accessToken (string)
. callbackUrl (string)
} (object)
setupFinalization: {
. associateInProgressToken (string)
. phoneNumbers (array)
. phoneNumberParent (string)
. waba (object)
} (object)
socialmessaging/get_linked_whats_app_business_accountGet the details of your linked WhatsApp Business Account.id (string) required
socialmessaging/disassociate_whats_app_business_accountDisassociate a WhatsApp Business Account WABA from your Amazon Web Services account.id (string) required
socialmessaging/list_linked_whats_app_business_accountsList all WhatsApp Business Accounts linked to your Amazon Web Services account.nextToken (string)
maxResults (integer)
socialmessaging/delete_whats_app_message_mediaDelete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too.mediaId (string) required
originationPhoneNumberId (string) required
socialmessaging/get_whats_app_message_mediaGet a media file from the WhatsApp service. On successful completion the media file is retrieved from Meta and stored in the specified Amazon S3 bucket. Use either destinationS3File or destinationS3PresignedUrl for the destination. If both are used then an InvalidParameterException is returned.mediaId (string) required
originationPhoneNumberId (string) required
metadataOnly (boolean)
destinationS3PresignedUrl: {
. url (string)
. headers (object)
} (object)
destinationS3File: {
. bucketName (string)
. key (string)
} (object)
socialmessaging/post_whats_app_message_mediaUpload a media file to the WhatsApp service. Only the specified originationPhoneNumberId has the permissions to send the media file when using SendWhatsAppMessage. You must use either sourceS3File or sourceS3PresignedUrl for the source. If both or neither are specified then an InvalidParameterException is returned.originationPhoneNumberId (string) required
sourceS3PresignedUrl: {
. url (string)
. headers (object)
} (object)
sourceS3File: {
. bucketName (string)
. key (string)
} (object)
socialmessaging/send_whats_app_messageSend a WhatsApp message. For examples of sending a message using the Amazon Web Services CLI, see Sending messages in the Amazon Web Services End User Messaging Social User Guide .originationPhoneNumberId (string) required
message (string) required
metaApiVersion (string) required
socialmessaging/get_linked_whats_app_business_account_phone_numberRetrieve the WABA account id and phone number details of a WhatsApp business account phone number.id (string) required
sqs/add_permissionAdds 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 informaQueueUrl (string) required
Label (string) required
AWSAccountIds (array) required
Actions (array) required
sqs/cancel_message_move_taskCancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet. This action is currently limited to supporting message redrive from dead-letter queues DLQs only. In this context, the source queue is the dead-letter queue DLQ, while the destination queue can be the original source queue froTaskHandle (string) required
sqs/change_message_visibilityChanges 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, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed since you received the message, and you send a ChangeMessageVisibility call with VisibilityTimeout set to 10 seconds, the 10 seconds begin toQueueUrl (string) required
ReceiptHandle (string) required
VisibilityTimeout (integer) required
sqs/change_message_visibility_batchChanges 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.QueueUrl (string) required
Entries (array) required
sqs/create_queueCreates 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 standaQueueName (string) required
Attributes (object)
tags (object)
sqs/delete_messageDeletes 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. Each time you receive a message, meaning when a consumer reQueueUrl (string) required
ReceiptHandle (string) required
sqs/delete_message_batchDeletes 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.QueueUrl (string) required
Entries (array) required
sqs/delete_queueDeletes 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 mustQueueUrl (string) required
sqs/get_queue_attributesGets attributes for the specified queue. To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.QueueUrl (string) required
AttributeNames (array)
sqs/get_queue_urlThe GetQueueUrl API returns the URL of an existing Amazon SQS queue. This is useful when you know the queue's name but need to retrieve its URL for further operations. To access a queue owned by another Amazon Web Services account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. Note that the queue owner must grant you the necessary permissions to access the queue. For more information about accessing shared queues, see the AddPermission API or Allow deveQueueName (string) required
QueueOwnerAWSAccountId (string)
sqs/list_dead_letter_source_queuesReturns 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 paramQueueUrl (string) required
NextToken (string)
MaxResults (integer)
sqs/list_message_move_tasksGets the most recent message movement tasks up to 10 under a specific source queue. This action is currently limited to supporting message redrive from dead-letter queues DLQs only. In this context, the source queue is the dead-letter queue DLQ, while the destination queue can be the original source queue from which the messages were driven to the dead-letter-queue, or a custom destination queue. Only one active message movement task is supported per queue at any given time.SourceArn (string) required
MaxResults (integer)
sqs/list_queuesReturns 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 MaxResuQueueNamePrefix (string)
NextToken (string)
MaxResults (integer)
sqs/list_queue_tagsList 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 username in the Amazon SQS Developer Guide.QueueUrl (string) required
sqs/purge_queueDeletes available messages in a queue including in-flight messages 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 whQueueUrl (string) required
sqs/receive_messageRetrieves 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. Therefore, 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 thanQueueUrl (string) required
AttributeNames (array)
MessageSystemAttributeNames (array)
MessageAttributeNames (array)
MaxNumberOfMessages (integer)
VisibilityTimeout (integer)
WaitTimeSeconds (integer)
ReceiveRequestAttemptId (string)
sqs/remove_permissionRevokes 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 username 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.QueueUrl (string) required
Label (string) required
sqs/send_messageDelivers a message to the specified queue. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters. x9 | xA | xD | x20 to xD7FF | xE000 to xFFFD | x10000 to x10FFFF If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exceQueueUrl (string) required
MessageBody (string) required
DelaySeconds (integer)
MessageAttributes (object)
MessageSystemAttributes (object)
MessageDeduplicationId (string)
MessageGroupId (string)
sqs/send_message_batchYou can use SendMessageBatch to send up to 10 messages to the specified queue by assigning either identical or different values to each message or by not assigning values at all. 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 shouldQueueUrl (string) required
Entries (array) required
sqs/set_queue_attributesSets the value of one or more queue attributes, like a policy. 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 and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of existing messages. In the future, new attributes mighQueueUrl (string) required
Attributes (object) required
sqs/start_message_move_taskStarts an asynchronous task to move messages from a specified source queue to a specified destination queue. This action is currently limited to supporting message redrive from queues that are configured as dead-letter queues DLQs of other Amazon SQS queues only. Non-SQS queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are currently not supported. In dead-letter queues redrive context, the StartMessageMoveTask the source queue is the DLQ, while the destination queue canSourceArn (string) required
DestinationArn (string)
MaxNumberOfMessagesPerSecond (integer)
sqs/tag_queueAdd 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 restrictionsQueueUrl (string) required
Tags (object) required
sqs/untag_queueRemove 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 username in the Amazon SQS Developer Guide.QueueUrl (string) required
TagKeys (array) required
ssm_contacts/accept_pageUsed to acknowledge an engagement to a contact channel during an incident.PageId (string) required
ContactChannelId (string)
AcceptType (string) required
Note (string)
AcceptCode (string) required
AcceptCodeValidation (string)
ssm_contacts/activate_contact_channelActivates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.ContactChannelId (string) required
ActivationCode (string) required
ssm_contacts/create_contactContacts 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.Alias (string) required
DisplayName (string)
Type (string) required
Plan: {
. Stages (array)
. RotationIds (array)
} (object) required
Tags (array)
IdempotencyToken (string)
ssm_contacts/create_contact_channelA contact channel is the method that Incident Manager uses to engage your contact.ContactId (string) required
Name (string) required
Type (string) required
DeliveryAddress: {
. SimpleAddress (string)
} (object) required
DeferActivation (boolean)
IdempotencyToken (string)
ssm_contacts/create_rotationCreates a rotation in an on-call schedule.Name (string) required
ContactIds (array) required
StartTime (string)
TimeZoneId (string) required
Recurrence: {
. MonthlySettings (array)
. WeeklySettings (array)
. DailySettings (array)
. NumberOfOnCalls (integer)
. ShiftCoverages (object)
. RecurrenceMultiplier (integer)
} (object) required
Tags (array)
IdempotencyToken (string)
ssm_contacts/create_rotation_overrideCreates an override for a rotation in an on-call schedule.RotationId (string) required
NewContactIds (array) required
StartTime (string) required
EndTime (string) required
IdempotencyToken (string)
ssm_contacts/deactivate_contact_channelTo no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.ContactChannelId (string) required
ssm_contacts/delete_contactTo remove a contact from Incident Manager, you can delete the contact. However, deleting a contact does not remove it from escalation plans and related response plans. Deleting an escalation plan also does not remove it from all related response plans. To modify an escalation plan, we recommend using the UpdateContact action to specify a different existing contact.ContactId (string) required
ssm_contacts/delete_contact_channelTo stop receiving engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel does not remove it from the contact's engagement plan, but the stage that includes the channel will be ignored. If you delete the only contact channel for a contact, you'll no longer be able to engage that contact during an incident.ContactChannelId (string) required
ssm_contacts/delete_rotationDeletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.RotationId (string) required
ssm_contacts/delete_rotation_overrideDeletes an existing override for an on-call rotation.RotationId (string) required
RotationOverrideId (string) required
ssm_contacts/describe_engagementIncident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.EngagementId (string) required
ssm_contacts/describe_pageLists details of the engagement to a contact channel.PageId (string) required
ssm_contacts/get_contactRetrieves information about the specified contact or escalation plan.ContactId (string) required
ssm_contacts/get_contact_channelList details about a specific contact channel.ContactChannelId (string) required
ssm_contacts/get_contact_policyRetrieves the resource policies attached to the specified contact or escalation plan.ContactArn (string) required
ssm_contacts/get_rotationRetrieves information about an on-call rotation.RotationId (string) required
ssm_contacts/get_rotation_overrideRetrieves information about an override to an on-call rotation.RotationId (string) required
RotationOverrideId (string) required
ssm_contacts/list_contact_channelsLists all contact channels for the specified contact.ContactId (string) required
NextToken (string)
MaxResults (integer)
ssm_contacts/list_contactsLists all contacts and escalation plans in Incident Manager.NextToken (string)
MaxResults (integer)
AliasPrefix (string)
Type (string)
ssm_contacts/list_engagementsLists all engagements that have happened in an incident.NextToken (string)
MaxResults (integer)
IncidentId (string)
TimeRangeValue: {
. StartTime (string)
. EndTime (string)
} (object)
ssm_contacts/list_page_receiptsLists all of the engagements to contact channels that have been acknowledged.PageId (string) required
NextToken (string)
MaxResults (integer)
ssm_contacts/list_page_resolutionsReturns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan on-call schedule contact.NextToken (string)
PageId (string) required
ssm_contacts/list_pages_by_contactLists the engagements to a contact's contact channels.ContactId (string) required
NextToken (string)
MaxResults (integer)
ssm_contacts/list_pages_by_engagementLists the engagements to contact channels that occurred by engaging a contact.EngagementId (string) required
NextToken (string)
MaxResults (integer)
ssm_contacts/list_preview_rotation_shiftsReturns a list of shifts based on rotation configuration parameters. The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.RotationStartTime (string)
StartTime (string)
EndTime (string) required
Members (array) required
TimeZoneId (string) required
Recurrence: {
. MonthlySettings (array)
. WeeklySettings (array)
. DailySettings (array)
. NumberOfOnCalls (integer)
. ShiftCoverages (object)
. RecurrenceMultiplier (integer)
} (object) required
Overrides (array)
NextToken (string)
MaxResults (integer)
ssm_contacts/list_rotation_overridesRetrieves a list of overrides currently specified for an on-call rotation.RotationId (string) required
StartTime (string) required
EndTime (string) required
NextToken (string)
MaxResults (integer)
ssm_contacts/list_rotationsRetrieves a list of on-call rotations.RotationNamePrefix (string)
NextToken (string)
MaxResults (integer)
ssm_contacts/list_rotation_shiftsReturns a list of shifts generated by an existing rotation in the system.RotationId (string) required
StartTime (string)
EndTime (string) required
NextToken (string)
MaxResults (integer)
ssm_contacts/list_tags_for_resourceLists the tags of a contact, escalation plan, rotation, or on-call schedule.ResourceARN (string) required
ssm_contacts/put_contact_policyAdds 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.ContactArn (string) required
Policy (string) required
ssm_contacts/send_activation_codeSends 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.ContactChannelId (string) required
ssm_contacts/start_engagementStarts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.ContactId (string) required
Sender (string) required
Subject (string) required
Content (string) required
PublicSubject (string)
PublicContent (string)
IncidentId (string)
IdempotencyToken (string)
ssm_contacts/stop_engagementStops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.EngagementId (string) required
Reason (string)
ssm_contacts/tag_resourceTags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.ResourceARN (string) required
Tags (array) required
ssm_contacts/untag_resourceRemoves tags from the specified resource.ResourceARN (string) required
TagKeys (array) required
ssm_contacts/update_contactUpdates the contact or escalation plan specified.ContactId (string) required
DisplayName (string)
Plan: {
. Stages (array)
. RotationIds (array)
} (object)
ssm_contacts/update_contact_channelUpdates a contact's contact channel.ContactChannelId (string) required
Name (string)
DeliveryAddress: {
. SimpleAddress (string)
} (object)
ssm_contacts/update_rotationUpdates the information specified for an on-call rotation.RotationId (string) required
ContactIds (array)
StartTime (string)
TimeZoneId (string)
Recurrence: {
. MonthlySettings (array)
. WeeklySettings (array)
. DailySettings (array)
. NumberOfOnCalls (integer)
. ShiftCoverages (object)
. RecurrenceMultiplier (integer)
} (object) required
ssm_guiconnect/get_connection_recording_preferencesReturns the preferences specified for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region.No parameters
ssm_guiconnect/delete_connection_recording_preferencesDeletes the preferences for recording RDP connections.ClientToken (string)
ssm_guiconnect/update_connection_recording_preferencesUpdates the preferences for recording RDP connections.ConnectionRecordingPreferences: {
. RecordingDestinations (object)
. KMSKeyArn (string)
} (object) required
ClientToken (string)
ssm_incidents/batch_get_incident_findingsRetrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be investigated as a potential cause of the incident.incidentRecordArn (string) required
findingIds (array) required
ssm_incidents/create_replication_setA replication set replicates and encrypts your data to the provided Regions with the provided KMS key.regions (object) required
clientToken (string)
tags (object)
ssm_incidents/create_response_planCreates 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.clientToken (string)
name (string) required
displayName (string)
incidentTemplate: {
. title (string)
. impact (integer)
. summary (string)
. dedupeString (string)
. notificationTargets (array)
. incidentTags (object)
} (object) required
chatChannel (undefined)
engagements (array)
actions (array)
tags (object)
integrations (array)
ssm_incidents/create_timeline_eventCreates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident. You can create custom timeline events to mark important events that Incident Manager can detect automatically.clientToken (string)
incidentRecordArn (string) required
eventTime (string) required
eventType (string) required
eventData (string) required
eventReferences (array)
ssm_incidents/delete_incident_recordDelete an incident record from Incident Manager.arn (string) required
ssm_incidents/delete_replication_setDeletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.arn (string) required
ssm_incidents/delete_resource_policyDeletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.resourceArn (string) required
policyId (string) required
ssm_incidents/delete_response_planDeletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.arn (string) required
ssm_incidents/delete_timeline_eventDeletes a timeline event from an incident.incidentRecordArn (string) required
eventId (string) required
ssm_incidents/get_incident_recordReturns the details for the specified incident record.arn (string) required
ssm_incidents/get_replication_setRetrieve your Incident Manager replication set.arn (string) required
ssm_incidents/get_resource_policiesRetrieves the resource policies attached to the specified response plan.resourceArn (string) required
maxResults (integer)
nextToken (string)
ssm_incidents/get_response_planRetrieves the details of the specified response plan.arn (string) required
ssm_incidents/get_timeline_eventRetrieves a timeline event based on its ID and incident record.incidentRecordArn (string) required
eventId (string) required
ssm_incidents/list_incident_findingsRetrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an CloudFormation stack creation or update or an CodeDeploy deployment that can be investigated as a potential cause of the incident.incidentRecordArn (string) required
maxResults (integer)
nextToken (string)
ssm_incidents/list_incident_recordsLists all incident records in your account. Use this command to retrieve the Amazon Resource Name ARN of the incident record you want to update.filters (array)
maxResults (integer)
nextToken (string)
ssm_incidents/list_related_itemsList all related items for an incident record.incidentRecordArn (string) required
maxResults (integer)
nextToken (string)
ssm_incidents/list_replication_setsLists details about the replication set configured in your account.maxResults (integer)
nextToken (string)
ssm_incidents/list_response_plansLists all response plans in your account.maxResults (integer)
nextToken (string)
ssm_incidents/list_tags_for_resourceLists the tags that are attached to the specified response plan or incident.resourceArn (string) required
ssm_incidents/list_timeline_eventsLists timeline events for the specified incident record.incidentRecordArn (string) required
filters (array)
sortBy (string)
sortOrder (string)
maxResults (integer)
nextToken (string)
ssm_incidents/put_resource_policyAdds 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 Cross-Region and cross-account incident management.resourceArn (string) required
policy (string) required
ssm_incidents/start_incidentUsed to start an incident from CloudWatch alarms, EventBridge events, or manually.clientToken (string)
responsePlanArn (string) required
title (string)
impact (integer)
triggerDetails: {
. source (string)
. triggerArn (string)
. timestamp (string)
. rawData (string)
} (object)
relatedItems (array)
ssm_incidents/tag_resourceAdds a tag to a response plan.resourceArn (string) required
tags (object) required
ssm_incidents/untag_resourceRemoves a tag from a resource.resourceArn (string) required
tagKeys (array) required
ssm_incidents/update_deletion_protectionUpdate deletion protection to either allow or deny deletion of the final Region in a replication set.arn (string) required
deletionProtected (boolean) required
clientToken (string)
ssm_incidents/update_incident_recordUpdate 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.clientToken (string)
arn (string) required
title (string)
summary (string)
impact (integer)
status (string)
chatChannel (undefined)
notificationTargets (array)
ssm_incidents/update_related_itemsAdd or remove related items from the related items tab of an incident record.clientToken (string)
incidentRecordArn (string) required
relatedItemsUpdate (undefined) required
ssm_incidents/update_replication_setAdd or delete Regions from your replication set.arn (string) required
actions (array) required
clientToken (string)
ssm_incidents/update_response_planUpdates the specified response plan.clientToken (string)
arn (string) required
displayName (string)
incidentTemplateTitle (string)
incidentTemplateImpact (integer)
incidentTemplateSummary (string)
incidentTemplateDedupeString (string)
incidentTemplateNotificationTargets (array)
chatChannel (undefined)
engagements (array)
actions (array)
incidentTemplateTags (object)
integrations (array)
ssm_incidents/update_timeline_eventUpdates a timeline event. You can update events of type Custom Event.clientToken (string)
incidentRecordArn (string) required
eventId (string) required
eventTime (string)
eventType (string)
eventData (string)
eventReferences (array)
ssm_quicksetup/create_configuration_managerCreates a Quick Setup configuration manager resource. This object is a collection of desired state configurations for multiple configuration definitions and summaries describing the deployments of those definitions.Name (string)
Description (string)
ConfigurationDefinitions (array) required
Tags (object)
ssm_quicksetup/delete_configuration_managerDeletes a configuration manager.ManagerArn (string) required
ssm_quicksetup/get_configurationReturns details about the specified configuration.ConfigurationId (string) required
ssm_quicksetup/get_configuration_managerReturns a configuration manager.ManagerArn (string) required
ssm_quicksetup/get_service_settingsReturns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.No parameters
ssm_quicksetup/list_configuration_managersReturns Quick Setup configuration managers.StartingToken (string)
MaxItems (integer)
Filters (array)
ssm_quicksetup/list_configurationsReturns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.StartingToken (string)
MaxItems (integer)
Filters (array)
ManagerArn (string)
ConfigurationDefinitionId (string)
ssm_quicksetup/list_quick_setup_typesReturns the available Quick Setup types.No parameters
ssm_quicksetup/list_tags_for_resourceReturns tags assigned to the resource.ResourceArn (string) required
ssm_quicksetup/tag_resourceAssigns key-value pairs of metadata to Amazon Web Services resources.ResourceArn (string) required
Tags (object) required
ssm_quicksetup/untag_resourceRemoves tags from the specified resource.ResourceArn (string) required
TagKeys (array) required
ssm_quicksetup/update_configuration_definitionUpdates a Quick Setup configuration definition.ManagerArn (string) required
Id (string) required
TypeVersion (string)
Parameters (object)
LocalDeploymentExecutionRoleName (string)
LocalDeploymentAdministrationRoleArn (string)
ssm_quicksetup/update_configuration_managerUpdates a Quick Setup configuration manager.ManagerArn (string) required
Name (string)
Description (string)
ssm_quicksetup/update_service_settingsUpdates settings configured for Quick Setup.ExplorerEnablingRoleArn (string)
ssm_sap/delete_resource_permissionRemoves permissions associated with the target database.ActionType (string)
SourceResourceArn (string)
ResourceArn (string) required
ssm_sap/deregister_applicationDeregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.ApplicationId (string) required
ssm_sap/get_applicationGets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.ApplicationId (string)
ApplicationArn (string)
AppRegistryArn (string)
ssm_sap/get_componentGets the component of an application registered with AWS Systems Manager for SAP.ApplicationId (string) required
ComponentId (string) required
ssm_sap/get_configuration_check_operationGets the details of a configuration check operation by specifying the operation ID.OperationId (string) required
ssm_sap/get_databaseGets the SAP HANA database of an application registered with AWS Systems Manager for SAP.ApplicationId (string)
ComponentId (string)
DatabaseId (string)
DatabaseArn (string)
ssm_sap/get_operationGets the details of an operation by specifying the operation ID.OperationId (string) required
ssm_sap/get_resource_permissionGets permissions associated with the target database.ActionType (string)
ResourceArn (string) required
ssm_sap/list_applicationsLists all the applications registered with AWS Systems Manager for SAP.NextToken (string)
MaxResults (integer)
Filters (array)
ssm_sap/list_componentsLists all the components registered with AWS Systems Manager for SAP.ApplicationId (string)
NextToken (string)
MaxResults (integer)
ssm_sap/list_configuration_check_definitionsLists all configuration check types supported by AWS Systems Manager for SAP.MaxResults (integer)
NextToken (string)
ssm_sap/list_configuration_check_operationsLists the configuration check operations performed by AWS Systems Manager for SAP.ApplicationId (string) required
ListMode (string)
MaxResults (integer)
NextToken (string)
Filters (array)
ssm_sap/list_databasesLists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.ApplicationId (string)
ComponentId (string)
NextToken (string)
MaxResults (integer)
ssm_sap/list_operation_eventsReturns a list of operations events. Available parameters include OperationID, as well as optional parameters MaxResults, NextToken, and Filters.OperationId (string) required
MaxResults (integer)
NextToken (string)
Filters (array)
ssm_sap/list_operationsLists the operations performed by AWS Systems Manager for SAP.ApplicationId (string) required
MaxResults (integer)
NextToken (string)
Filters (array)
ssm_sap/list_sub_check_resultsLists the sub-check results of a specified configuration check operation.OperationId (string) required
MaxResults (integer)
NextToken (string)
ssm_sap/list_sub_check_rule_resultsLists the rules of a specified sub-check belonging to a configuration check operation.SubCheckResultId (string) required
MaxResults (integer)
NextToken (string)
ssm_sap/list_tags_for_resourceLists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.resourceArn (string) required
ssm_sap/put_resource_permissionAdds permissions to the target database.ActionType (string) required
SourceResourceArn (string) required
ResourceArn (string) required
ssm_sap/register_applicationRegister an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering. The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2. AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions. Amazon EC2 instances must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.ApplicationId (string) required
ApplicationType (string) required
Instances (array) required
SapInstanceNumber (string)
Sid (string)
Tags (object)
Credentials (array)
DatabaseArn (string)
ComponentsInfo (array)
ssm_sap/start_applicationRequest is an operation which starts an application. Parameter ApplicationId is required.ApplicationId (string) required
ssm_sap/start_application_refreshRefreshes a registered application.ApplicationId (string) required
ssm_sap/start_configuration_checksInitiates configuration check operations against a specified application.ApplicationId (string) required
ConfigurationCheckIds (array)
ssm_sap/stop_applicationRequest is an operation to stop an application. Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.ApplicationId (string) required
StopConnectedEntity (string)
IncludeEc2InstanceShutdown (boolean)
ssm_sap/tag_resourceCreates tag for a resource by specifying the ARN.resourceArn (string) required
tags (object) required
ssm_sap/untag_resourceDelete the tags for a resource.resourceArn (string) required
tagKeys (array) required
ssm_sap/update_application_settingsUpdates the settings of an application registered with AWS Systems Manager for SAP.ApplicationId (string) required
CredentialsToAddOrUpdate (array)
CredentialsToRemove (array)
Backint: {
. BackintMode (string)
. EnsureNoBackupInProcess (boolean)
} (object)
DatabaseArn (string)
ssm/add_tags_to_resourceAdds 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 tResourceType (string) required
ResourceId (string) required
Tags (array) required
ssm/associate_ops_item_related_itemAssociates 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 tools in Amazon Web Services Systems Manager.OpsItemId (string) required
AssociationType (string) required
ResourceType (string) required
ResourceUri (string) required
ssm/cancel_commandAttempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.CommandId (string) required
InstanceIds (array)
ssm/cancel_maintenance_window_executionStops 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.WindowExecutionId (string) required
ssm/create_activationGenerates 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 tools. 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 Using AmazonDescription (string)
DefaultInstanceName (string)
IamRole (string) required
RegistrationLimit (integer)
ExpirationDate (string)
Tags (array)
RegistrationMetadata (array)
ssm/create_associationA 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 tool in Amazon Web SerName (string) required
DocumentVersion (string)
InstanceId (string)
Parameters (object)
Targets (array)
ScheduleExpression (string)
OutputLocation: {
. S3Location (object)
} (object)
AssociationName (string)
AutomationTargetParameterName (string)
MaxErrors (string)
MaxConcurrency (string)
ComplianceSeverity (string)
SyncCompliance (string)
ApplyOnlyAtCronInterval (boolean)
CalendarNames (array)
TargetLocations (array)
ScheduleOffset (integer)
Duration (integer)
TargetMaps (array)
Tags (array)
AlarmConfiguration: {
. IgnorePollAlarmFailure (boolean)
. Alarms (array)
} (object)
ssm/create_association_batchAssociates 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.Entries (array) required
ssm/create_documentCreates 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.Content (string) required
Requires (array)
Attachments (array)
Name (string) required
DisplayName (string)
VersionName (string)
DocumentType (string)
DocumentFormat (string)
TargetType (string)
Tags (array)
ssm/create_maintenance_windowCreates 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.Name (string) required
Description (string)
StartDate (string)
EndDate (string)
Schedule (string) required
ScheduleTimezone (string)
ScheduleOffset (integer)
Duration (integer) required
Cutoff (integer) required
AllowUnassociatedTargets (boolean) required
ClientToken (string)
Tags (array)
ssm/create_ops_itemCreates a new OpsItem. You must have permission in Identity and Access Management IAM to create a new OpsItem. For more information, see Set up 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 OpsCeDescription (string) required
OpsItemType (string)
OperationalData (object)
Notifications (array)
Priority (integer)
RelatedOpsItems (array)
Source (string) required
Title (string) required
Tags (array)
Category (string)
Severity (string)
ActualStartTime (string)
ActualEndTime (string)
PlannedStartTime (string)
PlannedEndTime (string)
AccountId (string)
ssm/create_ops_metadataIf 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.ResourceId (string) required
Metadata (object)
Tags (array)
ssm/create_patch_baselineCreates a patch baseline. For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter.OperatingSystem (string)
Name (string) required
GlobalFilters: {
. PatchFilters (array)
} (object)
ApprovalRules: {
. PatchRules (array)
} (object)
ApprovedPatches (array)
ApprovedPatchesComplianceLevel (string)
ApprovedPatchesEnableNonSecurity (boolean)
RejectedPatches (array)
RejectedPatchesAction (string)
Description (string)
Sources (array)
AvailableSecurityUpdatesComplianceStatus (string)
ClientToken (string)
Tags (array)
ssm/create_resource_data_syncA 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 Creating a resource data sync for Inventory in the Amazon Web SerSyncName (string) required
S3Destination: {
. BucketName (string)
. Prefix (string)
. SyncFormat (string)
. Region (string)
. AWSKMSKeyARN (string)
. DestinationDataSharing (object)
} (object)
SyncType (string)
SyncSource: {
. SourceType (string)
. AwsOrganizationsSource (object)
. SourceRegions (array)
. IncludeFutureRegions (boolean)
. EnableAllOpsDataSources (boolean)
} (object)
ssm/delete_activationDeletes 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.ActivationId (string) required
ssm/delete_associationDisassociates 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 configurationName (string)
InstanceId (string)
AssociationId (string)
ssm/delete_documentDeletes 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.Name (string) required
DocumentVersion (string)
VersionName (string)
Force (boolean)
ssm/delete_inventoryDelete 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.TypeName (string) required
SchemaDeleteOption (string)
DryRun (boolean)
ClientToken (string)
ssm/delete_maintenance_windowDeletes a maintenance window.WindowId (string) required
ssm/delete_ops_itemDelete an OpsItem. You must have permission in Identity and Access Management IAM to delete an OpsItem. Note the following important information about this operation. Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem. This operation uses an eventual consistency model, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response. This oOpsItemId (string) required
ssm/delete_ops_metadataDelete OpsMetadata related to an application.OpsMetadataArn (string) required
ssm/delete_parameterDelete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.Name (string) required
ssm/delete_parametersDelete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.Names (array) required
ssm/delete_patch_baselineDeletes a patch baseline.BaselineId (string) required
ssm/delete_resource_data_syncDeletes 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.SyncName (string) required
SyncType (string)
ssm/delete_resource_policyDeletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity for example, an Amazon Web Services account that can manage your Systems Manager resources. The following resources support Systems Manager resource policies. OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items OpsItems. Parameter - The resource policy is used to share a parameter with other accounts usingResourceArn (string) required
PolicyId (string) required
PolicyHash (string) required
ssm/deregister_managed_instanceRemoves the server or virtual machine from the list of registered servers. If you want to reregister an on-premises server, edge device, or VM, you must use a different Activation Code and Activation ID than used to register the machine previously. The Activation Code and Activation ID must not have already been used on the maximum number of activations specified when they were created. For more information, see Deregistering managed nodes in a hybrid and multicloud environment in the Amazon WebInstanceId (string) required
ssm/deregister_patch_baseline_for_patch_groupRemoves a patch group from a patch baseline.BaselineId (string) required
PatchGroup (string) required
ssm/deregister_target_from_maintenance_windowRemoves a target from a maintenance window.WindowId (string) required
WindowTargetId (string) required
Safe (boolean)
ssm/deregister_task_from_maintenance_windowRemoves a task from a maintenance window.WindowId (string) required
WindowTaskId (string) required
ssm/describe_activationsDescribes 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.Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_associationDescribes 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.Name (string)
InstanceId (string)
AssociationId (string)
AssociationVersion (string)
ssm/describe_association_executionsViews all executions for a specific association ID.AssociationId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_association_execution_targetsViews information about a specific execution of a specific association.AssociationId (string) required
ExecutionId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_automation_executionsProvides details about all active and terminated Automation executions.Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_automation_step_executionsInformation about all active and terminated step executions in an Automation workflow.AutomationExecutionId (string) required
Filters (array)
NextToken (string)
MaxResults (integer)
ReverseOrder (boolean)
ssm/describe_available_patchesLists all patches eligible to be included in a patch baseline. Currently, DescribeAvailablePatches supports only the Amazon Linux 1, Amazon Linux 2, and Windows Server operating systems.Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_documentDescribes the specified Amazon Web Services Systems Manager document SSM document.Name (string) required
DocumentVersion (string)
VersionName (string)
ssm/describe_document_permissionDescribes 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.Name (string) required
PermissionType (string) required
MaxResults (integer)
NextToken (string)
ssm/describe_effective_instance_associationsAll associations for the managed nodes.InstanceId (string) required
MaxResults (integer)
NextToken (string)
ssm/describe_effective_patches_for_patch_baselineRetrieves the current effective patches the patch and the approval state for the specified patch baseline. Applies to patch baselines for Windows only.BaselineId (string) required
MaxResults (integer)
NextToken (string)
ssm/describe_instance_associations_statusThe status of the associations for the managed nodes.InstanceId (string) required
MaxResults (integer)
NextToken (string)
ssm/describe_instance_informationProvides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated. If you specify one or more node IDs, the operation 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,InstanceInformationFilterList (array)
Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_instance_patchesRetrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.InstanceId (string) required
Filters (array)
NextToken (string)
MaxResults (integer)
ssm/describe_instance_patch_statesRetrieves the high-level patch state of one or more managed nodes.InstanceIds (array) required
NextToken (string)
MaxResults (integer)
ssm/describe_instance_patch_states_for_patch_groupRetrieves the high-level patch state for the managed nodes in the specified patch group.PatchGroup (string) required
Filters (array)
NextToken (string)
MaxResults (integer)
ssm/describe_instance_propertiesAn API operation used by the Systems Manager console to display information about Systems Manager managed nodes.InstancePropertyFilterList (array)
FiltersWithOperator (array)
MaxResults (integer)
NextToken (string)
ssm/describe_inventory_deletionsDescribes a specific delete inventory operation.DeletionId (string)
NextToken (string)
MaxResults (integer)
ssm/describe_maintenance_window_executionsLists 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.WindowId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_maintenance_window_execution_task_invocationsRetrieves the individual task executions one per target for a particular task run as part of a maintenance window execution.WindowExecutionId (string) required
TaskId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_maintenance_window_execution_tasksFor a given maintenance window execution, lists the tasks that were run.WindowExecutionId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_maintenance_windowsRetrieves the maintenance windows in an Amazon Web Services account.Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_maintenance_window_scheduleRetrieves information about upcoming executions of a maintenance window.WindowId (string)
Targets (array)
ResourceType (string)
Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_maintenance_windows_for_targetRetrieves information about the maintenance window targets or tasks that a managed node is associated with.Targets (array) required
ResourceType (string) required
MaxResults (integer)
NextToken (string)
ssm/describe_maintenance_window_targetsLists the targets registered with the maintenance window.WindowId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_maintenance_window_tasksLists 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.WindowId (string) required
Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_ops_itemsQuery a set of OpsItems. You must have permission in Identity and Access Management IAM to query a list of OpsItems. For more information, see Set up 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 ManagerOpsItemFilters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_parametersLists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option. 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 tFilters (array)
ParameterFilters (array)
MaxResults (integer)
NextToken (string)
Shared (boolean)
ssm/describe_patch_baselinesLists the patch baselines in your Amazon Web Services account.Filters (array)
MaxResults (integer)
NextToken (string)
ssm/describe_patch_groupsLists all patch groups that have been registered with patch baselines.MaxResults (integer)
Filters (array)
NextToken (string)
ssm/describe_patch_group_stateReturns high-level aggregated patch compliance state information for a patch group.PatchGroup (string) required
ssm/describe_patch_propertiesLists 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 | CLASSIFOperatingSystem (string) required
Property (string) required
PatchSet (string)
MaxResults (integer)
NextToken (string)
ssm/describe_sessionsRetrieves a list of all active sessions both connected and disconnected or terminated sessions from the past 30 days.State (string) required
MaxResults (integer)
NextToken (string)
Filters (array)
ssm/disassociate_ops_item_related_itemDeletes 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 tool in Amazon Web Services Systems Manager.OpsItemId (string) required
AssociationId (string) required
ssm/get_access_tokenReturns a credentials set to be used with just-in-time node access.AccessRequestId (string) required
ssm/get_automation_executionGet detailed information about a particular Automation execution.AutomationExecutionId (string) required
ssm/get_calendar_stateGets 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 statuCalendarNames (array) required
AtTime (string)
ssm/get_command_invocationReturns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command. GetCommandInvocation only gives tCommandId (string) required
InstanceId (string) required
PluginName (string)
ssm/get_connection_statusRetrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.Target (string) required
ssm/get_default_patch_baselineRetrieves 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.OperatingSystem (string)
ssm/get_deployable_patch_snapshot_for_instanceRetrieves 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 tool in Amazon Web Services Systems Manager, wiInstanceId (string) required
SnapshotId (string) required
BaselineOverride: {
. OperatingSystem (string)
. GlobalFilters (object)
. ApprovalRules (object)
. ApprovedPatches (array)
. ApprovedPatchesComplianceLevel (string)
. RejectedPatches (array)
. RejectedPatchesAction (string)
. ApprovedPatchesEnableNonSecurity (boolean)
. Sources (array)
. AvailableSecurityUpdatesComplianceStatus (string)
} (object)
UseS3DualStackEndpoint (boolean)
ssm/get_documentGets the contents of the specified Amazon Web Services Systems Manager document SSM document.Name (string) required
VersionName (string)
DocumentVersion (string)
DocumentFormat (string)
ssm/get_execution_previewInitiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.ExecutionPreviewId (string) required
ssm/get_inventoryQuery inventory information. This includes managed node status, such as Stopped or Terminated.Filters (array)
Aggregators (array)
ResultAttributes (array)
NextToken (string)
MaxResults (integer)
ssm/get_inventory_schemaReturn a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.TypeName (string)
NextToken (string)
MaxResults (integer)
Aggregator (boolean)
SubType (boolean)
ssm/get_maintenance_windowRetrieves a maintenance window.WindowId (string) required
ssm/get_maintenance_window_executionRetrieves details about a specific a maintenance window execution.WindowExecutionId (string) required
ssm/get_maintenance_window_execution_taskRetrieves the details about a specific task run as part of a maintenance window execution.WindowExecutionId (string) required
TaskId (string) required
ssm/get_maintenance_window_execution_task_invocationRetrieves information about a specific task running on a specific target.WindowExecutionId (string) required
TaskId (string) required
InvocationId (string) required
ssm/get_maintenance_window_taskRetrieves 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.WindowId (string) required
WindowTaskId (string) required
ssm/get_ops_itemGet 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 Set up 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 AOpsItemId (string) required
OpsItemArn (string)
ssm/get_ops_metadataView operational metadata related to an application in Application Manager.OpsMetadataArn (string) required
MaxResults (integer)
NextToken (string)
ssm/get_ops_summaryView 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.SyncName (string)
Filters (array)
Aggregators (array)
ResultAttributes (array)
NextToken (string)
MaxResults (integer)
ssm/get_parameterGet information about a single parameter by specifying the parameter name. Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error. To get information about more than one parameter at a time, use the GetParameters operation.Name (string) required
WithDecryption (boolean)
ssm/get_parameter_historyRetrieves the history of all changes to a parameter. Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error. 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 wName (string) required
WithDecryption (boolean)
MaxResults (integer)
NextToken (string)
ssm/get_parametersGet 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. Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.Names (array) required
WithDecryption (boolean)
ssm/get_parameters_by_pathRetrieve information about one or more parameters under a specified level in a 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 caPath (string) required
Recursive (boolean)
ParameterFilters (array)
WithDecryption (boolean)
MaxResults (integer)
NextToken (string)
ssm/get_patch_baselineRetrieves information about a patch baseline.BaselineId (string) required
ssm/get_patch_baseline_for_patch_groupRetrieves the patch baseline that should be used for the specified patch group.PatchGroup (string) required
OperatingSystem (string)
ssm/get_resource_policiesReturns an array of the Policy object.ResourceArn (string) required
NextToken (string)
MaxResults (integer)
ssm/get_service_settingServiceSetting 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. ServicesSettingId (string) required
ssm/label_parameter_versionA 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 veName (string) required
ParameterVersion (integer)
Labels (array) required
ssm/list_associationsReturns 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 tool in Amazon Web Services Systems Manager.AssociationFilterList (array)
MaxResults (integer)
NextToken (string)
ssm/list_association_versionsRetrieves all versions of an association for a specific association ID.AssociationId (string) required
MaxResults (integer)
NextToken (string)
ssm/list_command_invocationsAn 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.CommandId (string)
InstanceId (string)
MaxResults (integer)
NextToken (string)
Filters (array)
Details (boolean)
ssm/list_commandsLists the commands requested by users of the Amazon Web Services account.CommandId (string)
InstanceId (string)
MaxResults (integer)
NextToken (string)
Filters (array)
ssm/list_compliance_itemsFor 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.Filters (array)
ResourceIds (array)
ResourceTypes (array)
NextToken (string)
MaxResults (integer)
ssm/list_compliance_summariesReturns 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.Filters (array)
NextToken (string)
MaxResults (integer)
ssm/list_document_metadata_historyAmazon Web Services Systems Manager Change Manager will no longer be open to new customers starting November 7, 2025. If you would like to use Change Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services Systems Manager Change Manager availability change. Information about approval reviews for a version of a change template in Change Manager.Name (string) required
DocumentVersion (string)
Metadata (string) required
NextToken (string)
MaxResults (integer)
ssm/list_documentsReturns 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.DocumentFilterList (array)
Filters (array)
MaxResults (integer)
NextToken (string)
ssm/list_document_versionsList all versions for a document.Name (string) required
MaxResults (integer)
NextToken (string)
ssm/list_inventory_entriesA list of inventory items returned by the request.InstanceId (string) required
TypeName (string) required
Filters (array)
NextToken (string)
MaxResults (integer)
ssm/list_nodesTakes in filters and returns a list of managed nodes matching the filter criteria.SyncName (string)
Filters (array)
NextToken (string)
MaxResults (integer)
ssm/list_nodes_summaryGenerates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify.SyncName (string)
Filters (array)
Aggregators (array) required
NextToken (string)
MaxResults (integer)
ssm/list_ops_item_eventsReturns 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.Filters (array)
MaxResults (integer)
NextToken (string)
ssm/list_ops_item_related_itemsLists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.OpsItemId (string)
Filters (array)
MaxResults (integer)
NextToken (string)
ssm/list_ops_metadataAmazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.Filters (array)
MaxResults (integer)
NextToken (string)
ssm/list_resource_compliance_summariesReturns 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.Filters (array)
NextToken (string)
MaxResults (integer)
ssm/list_resource_data_syncLists 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 theSyncType (string)
NextToken (string)
MaxResults (integer)
ssm/list_tags_for_resourceReturns a list of the tags assigned to the specified resource. For information about the ID format for each supported resource type, see AddTagsToResource.ResourceType (string) required
ResourceId (string) required
ssm/modify_document_permissionShares a Amazon Web Services Systems Manager document SSM documentpublicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.Name (string) required
PermissionType (string) required
AccountIdsToAdd (array)
AccountIdsToRemove (array)
SharedDocumentVersion (string)
ssm/put_compliance_itemsRegisters 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, associatioResourceId (string) required
ResourceType (string) required
ComplianceType (string) required
ExecutionSummary: {
. ExecutionTime (string)
. ExecutionId (string)
. ExecutionType (string)
} (object) required
Items (array) required
ItemContentHash (string)
UploadType (string)
ssm/put_inventoryBulk 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.InstanceId (string) required
Items (array) required
ssm/put_parameterCreate or update a parameter in Parameter Store.Name (string) required
Description (string)
Value (string) required
Type (string)
KeyId (string)
Overwrite (boolean)
AllowedPattern (string)
Tags (array)
Tier (string)
Policies (string)
DataType (string)
ssm/put_resource_policyCreates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity for example, an Amazon Web Services account that can manage your Systems Manager resources. The following resources support Systems Manager resource policies. OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items OpsItems. Parameter - The resource policy is used to share a parameter with other accoResourceArn (string) required
Policy (string) required
PolicyId (string)
PolicyHash (string)
ssm/register_default_patch_baselineDefines 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.BaselineId (string) required
ssm/register_patch_baseline_for_patch_groupRegisters a patch baseline for a patch group.BaselineId (string) required
PatchGroup (string) required
ssm/register_target_with_maintenance_windowRegisters a target with a maintenance window.WindowId (string) required
ResourceType (string) required
Targets (array) required
OwnerInformation (string)
Name (string)
Description (string)
ClientToken (string)
ssm/register_task_with_maintenance_windowAdds a new task to a maintenance window.WindowId (string) required
Targets (array)
TaskArn (string) required
ServiceRoleArn (string)
TaskType (string) required
TaskParameters (object)
TaskInvocationParameters: {
. RunCommand (object)
. Automation (object)
. StepFunctions (object)
. Lambda (object)
} (object)
Priority (integer)
MaxConcurrency (string)
MaxErrors (string)
LoggingInfo: {
. S3BucketName (string)
. S3KeyPrefix (string)
. S3Region (string)
} (object)
Name (string)
Description (string)
ClientToken (string)
CutoffBehavior (string)
AlarmConfiguration: {
. IgnorePollAlarmFailure (boolean)
. Alarms (array)
} (object)
ssm/remove_tags_from_resourceRemoves tag keys from the specified resource.ResourceType (string) required
ResourceId (string) required
TagKeys (array) required
ssm/reset_service_settingServiceSetting 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. ServSettingId (string) required
ssm/resume_sessionReconnects 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.SessionId (string) required
ssm/send_automation_signalSends a signal to an Automation execution to change the current behavior or status of the execution.AutomationExecutionId (string) required
SignalType (string) required
Payload (object)
ssm/send_commandRuns commands on one or more managed nodes.InstanceIds (array)
Targets (array)
DocumentName (string) required
DocumentVersion (string)
DocumentHash (string)
DocumentHashType (string)
TimeoutSeconds (integer)
Comment (string)
Parameters (object)
OutputS3Region (string)
OutputS3BucketName (string)
OutputS3KeyPrefix (string)
MaxConcurrency (string)
MaxErrors (string)
ServiceRoleArn (string)
NotificationConfig: {
. NotificationArn (string)
. NotificationEvents (array)
. NotificationType (string)
} (object)
CloudWatchOutputConfig: {
. CloudWatchLogGroupName (string)
. CloudWatchOutputEnabled (boolean)
} (object)
AlarmConfiguration: {
. IgnorePollAlarmFailure (boolean)
. Alarms (array)
} (object)
ssm/start_access_requestStarts the workflow for just-in-time node access sessions.Reason (string) required
Targets (array) required
Tags (array)
ssm/start_associations_onceRuns an association immediately and only one time. This operation can be helpful when troubleshooting associations.AssociationIds (array) required
ssm/start_automation_executionInitiates execution of an Automation runbook.DocumentName (string) required
DocumentVersion (string)
Parameters (object)
ClientToken (string)
Mode (string)
TargetParameterName (string)
Targets (array)
TargetMaps (array)
MaxConcurrency (string)
MaxErrors (string)
TargetLocations (array)
Tags (array)
AlarmConfiguration: {
. IgnorePollAlarmFailure (boolean)
. Alarms (array)
} (object)
TargetLocationsURL (string)
ssm/start_change_request_executionAmazon Web Services Systems Manager Change Manager will no longer be open to new customers starting November 7, 2025. If you would like to use Change Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services Systems Manager Change Manager availability change. Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the changeScheduledTime (string)
DocumentName (string) required
DocumentVersion (string)
Parameters (object)
ChangeRequestName (string)
ClientToken (string)
AutoApprove (boolean)
Runbooks (array) required
Tags (array)
ScheduledEndTime (string)
ChangeDetails (string)
ssm/start_execution_previewInitiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources.DocumentName (string) required
DocumentVersion (string)
ExecutionInputs (undefined)
ssm/start_sessionInitiates 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 ManTarget (string) required
DocumentName (string)
Reason (string)
Parameters (object)
ssm/stop_automation_executionStop an Automation that is currently running.AutomationExecutionId (string) required
Type (string)
ssm/terminate_sessionPermanently 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.SessionId (string) required
ssm/unlabel_parameter_versionRemove a label or labels from a parameter. Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a ValidationException error.Name (string) required
ParameterVersion (integer) required
Labels (array) required
ssm/update_associationUpdates 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 tAssociationId (string) required
Parameters (object)
DocumentVersion (string)
ScheduleExpression (string)
OutputLocation: {
. S3Location (object)
} (object)
Name (string)
Targets (array)
AssociationName (string)
AssociationVersion (string)
AutomationTargetParameterName (string)
MaxErrors (string)
MaxConcurrency (string)
ComplianceSeverity (string)
SyncCompliance (string)
ApplyOnlyAtCronInterval (boolean)
CalendarNames (array)
TargetLocations (array)
ScheduleOffset (integer)
Duration (integer)
TargetMaps (array)
AlarmConfiguration: {
. IgnorePollAlarmFailure (boolean)
. Alarms (array)
} (object)
ssm/update_association_statusUpdates 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.Name (string) required
InstanceId (string) required
AssociationStatus: {
. Date (string)
. Name (string)
. Message (string)
. AdditionalInfo (string)
} (object) required
ssm/update_documentUpdates one or more values for an SSM document.Content (string) required
Attachments (array)
Name (string) required
DisplayName (string)
VersionName (string)
DocumentVersion (string)
DocumentFormat (string)
TargetType (string)
ssm/update_document_default_versionSet 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.Name (string) required
DocumentVersion (string) required
ssm/update_document_metadataAmazon Web Services Systems Manager Change Manager will no longer be open to new customers starting November 7, 2025. If you would like to use Change Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services Systems Manager Change Manager availability change. Updates information related to approval reviews for a specific version of a change template in Change Manager.Name (string) required
DocumentVersion (string)
DocumentReviews: {
. Action (string)
. Comment (array)
} (object) required
ssm/update_maintenance_windowUpdates 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 sWindowId (string) required
Name (string)
Description (string)
StartDate (string)
EndDate (string)
Schedule (string)
ScheduleTimezone (string)
ScheduleOffset (integer)
Duration (integer)
Cutoff (integer)
AllowUnassociatedTargets (boolean)
Enabled (boolean)
Replace (boolean)
ssm/update_maintenance_window_targetModifies 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.WindowId (string) required
WindowTargetId (string) required
Targets (array)
OwnerInformation (string)
Name (string)
Description (string)
Replace (boolean)
ssm/update_maintenance_window_taskModifies 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 StWindowId (string) required
WindowTaskId (string) required
Targets (array)
TaskArn (string)
ServiceRoleArn (string)
TaskParameters (object)
TaskInvocationParameters: {
. RunCommand (object)
. Automation (object)
. StepFunctions (object)
. Lambda (object)
} (object)
Priority (integer)
MaxConcurrency (string)
MaxErrors (string)
LoggingInfo: {
. S3BucketName (string)
. S3KeyPrefix (string)
. S3Region (string)
} (object)
Name (string)
Description (string)
Replace (boolean)
CutoffBehavior (string)
AlarmConfiguration: {
. IgnorePollAlarmFailure (boolean)
. Alarms (array)
} (object)
ssm/update_managed_instance_roleChanges 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.InstanceId (string) required
IamRole (string) required
ssm/update_ops_itemEdit or change an OpsItem. You must have permission in Identity and Access Management IAM to update an OpsItem. For more information, see Set up 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 OpsCDescription (string)
OperationalData (object)
OperationalDataToDelete (array)
Notifications (array)
Priority (integer)
RelatedOpsItems (array)
Status (string)
OpsItemId (string) required
Title (string)
Category (string)
Severity (string)
ActualStartTime (string)
ActualEndTime (string)
PlannedStartTime (string)
PlannedEndTime (string)
OpsItemArn (string)
ssm/update_ops_metadataAmazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.OpsMetadataArn (string) required
MetadataToUpdate (object)
KeysToDelete (array)
ssm/update_patch_baselineModifies 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.BaselineId (string) required
Name (string)
GlobalFilters: {
. PatchFilters (array)
} (object)
ApprovalRules: {
. PatchRules (array)
} (object)
ApprovedPatches (array)
ApprovedPatchesComplianceLevel (string)
ApprovedPatchesEnableNonSecurity (boolean)
RejectedPatches (array)
RejectedPatchesAction (string)
Description (string)
Sources (array)
AvailableSecurityUpdatesComplianceStatus (string)
Replace (boolean)
ssm/update_resource_data_syncUpdate 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 thSyncName (string) required
SyncType (string) required
SyncSource: {
. SourceType (string)
. AwsOrganizationsSource (object)
. SourceRegions (array)
. IncludeFutureRegions (boolean)
. EnableAllOpsDataSources (boolean)
} (object) required
ssm/update_service_settingServiceSetting 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. ServSettingId (string) required
SettingValue (string) required
sso_admin/add_regionAdds a Region to an IAM Identity Center instance. This operation initiates an asynchronous workflow to replicate the IAM Identity Center instance to the target Region. The Region status is set to ADDING at first and changes to ACTIVE when the workflow completes. To use this operation, your IAM Identity Center instance and the target Region must meet the requirements described in the IAM Identity Center User Guide. The following actions are related to AddRegion: RemoveRegion DescribeRegion ListReInstanceArn (string) required
RegionName (string) required
sso_admin/attach_customer_managed_policy_reference_to_permission_setAttaches the specified customer managed policy to the specified PermissionSet.InstanceArn (string) required
PermissionSetArn (string) required
CustomerManagedPolicyReference: {
. Name (string)
. Path (string)
} (object) required
sso_admin/attach_managed_policy_to_permission_setAttaches an Amazon Web Services 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.InstanceArn (string) required
PermissionSetArn (string) required
ManagedPolicyArn (string) required
sso_admin/create_account_assignmentAssigns access to a principal for a specified Amazon Web Services 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 IAMInstanceArn (string) required
TargetId (string) required
TargetType (string) required
PermissionSetArn (string) required
PrincipalType (string) required
PrincipalId (string) required
sso_admin/create_applicationCreates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider. This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services managed applications. To learn how to create an Amazon Web Services managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the Amazon Web Services Management Console only. See Setting up customer managed SAML 2.0 applications. For more inInstanceArn (string) required
ApplicationProviderArn (string) required
Name (string) required
Description (string)
PortalOptions: {
. SignInOptions (object)
. Visibility (string)
} (object)
Tags (array)
Status (string)
ClientToken (string)
sso_admin/create_application_assignmentGrant application access to a user or group.ApplicationArn (string) required
PrincipalId (string) required
PrincipalType (string) required
sso_admin/create_instanceCreates an instance of IAM Identity Center for a standalone Amazon Web Services account that is not managed by Organizations or a member Amazon Web Services account in an organization. You can create only one instance per account and across all Amazon Web Services Regions. The CreateInstance request is rejected if the following apply: The instance is created within the organization management account. An instance already exists in the same account.Name (string)
ClientToken (string)
Tags (array)
sso_admin/create_instance_access_control_attribute_configurationEnables 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.InstanceArn (string) required
InstanceAccessControlAttributeConfiguration: {
. AccessControlAttributes (array)
} (object) required
sso_admin/create_permission_setCreates a permission set within a specified IAM Identity Center instance. To grant users and groups access to Amazon Web Services account resources, use CreateAccountAssignment .Name (string) required
Description (string)
InstanceArn (string) required
SessionDuration (string)
RelayState (string)
Tags (array)
sso_admin/create_trusted_token_issuerCreates a connection to a trusted token issuer in an instance of IAM Identity Center. A trusted token issuer enables trusted identity propagation to be used with applications that authenticate outside of Amazon Web Services. This trusted token issuer describes an external identity provider IdP that can generate claims or assertions in the form of access tokens for a user. Applications enabled for IAM Identity Center can use these tokens for authentication.InstanceArn (string) required
Name (string) required
TrustedTokenIssuerType (string) required
TrustedTokenIssuerConfiguration (undefined) required
ClientToken (string)
Tags (array)
sso_admin/delete_account_assignmentDeletes a principal's access from a specified Amazon Web Services account using a specified permission set. After a successful response, call DescribeAccountAssignmentDeletionStatus to describe the status of an assignment deletion request.InstanceArn (string) required
TargetId (string) required
TargetType (string) required
PermissionSetArn (string) required
PrincipalType (string) required
PrincipalId (string) required
sso_admin/delete_applicationDeletes the association with the application. The connected service resource still exists.ApplicationArn (string) required
sso_admin/delete_application_assignmentRevoke application access to an application by deleting application assignments for a user or group.ApplicationArn (string) required
PrincipalId (string) required
PrincipalType (string) required
sso_admin/delete_inline_policy_from_permission_setDeletes the inline policy from a specified permission set.InstanceArn (string) required
PermissionSetArn (string) required
sso_admin/delete_instanceDeletes the instance of IAM Identity Center. Only the account that owns the instance can call this API. Neither the delegated administrator nor member account can delete the organization instance, but those roles can delete their own instance.InstanceArn (string) required
sso_admin/delete_instance_access_control_attribute_configurationDisables 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.InstanceArn (string) required
sso_admin/delete_permissions_boundary_from_permission_setDeletes the permissions boundary from a specified PermissionSet.InstanceArn (string) required
PermissionSetArn (string) required
sso_admin/delete_permission_setDeletes the specified permission set.InstanceArn (string) required
PermissionSetArn (string) required
sso_admin/delete_trusted_token_issuerDeletes a trusted token issuer configuration from an instance of IAM Identity Center. Deleting this trusted token issuer configuration will cause users to lose access to any applications that are configured to use the trusted token issuer.TrustedTokenIssuerArn (string) required
sso_admin/describe_account_assignment_creation_statusDescribes the status of the assignment creation request.InstanceArn (string) required
AccountAssignmentCreationRequestId (string) required
sso_admin/describe_account_assignment_deletion_statusDescribes the status of the assignment deletion request.InstanceArn (string) required
AccountAssignmentDeletionRequestId (string) required
sso_admin/describe_applicationRetrieves the details of an application associated with an instance of IAM Identity Center.ApplicationArn (string) required
sso_admin/describe_application_assignmentRetrieves a direct assignment of a user or group to an application. If the user doesn’t have a direct assignment to the application, the user may still have access to the application through a group. Therefore, don’t use this API to test access to an application for a user. Instead use ListApplicationAssignmentsForPrincipal.ApplicationArn (string) required
PrincipalId (string) required
PrincipalType (string) required
sso_admin/describe_application_providerRetrieves details about a provider that can be used to connect an Amazon Web Services managed application or customer managed application to IAM Identity Center.ApplicationProviderArn (string) required
sso_admin/describe_instanceReturns the details of an instance of IAM Identity Center. The status can be one of the following: CREATE_IN_PROGRESS - The instance is in the process of being created. When the instance is ready for use, DescribeInstance returns the status of ACTIVE. While the instance is in the CREATE_IN_PROGRESS state, you can call only DescribeInstance and DeleteInstance operations. DELETE_IN_PROGRESS - The instance is being deleted. Returns AccessDeniedException after the delete operation completes. ACTIVEInstanceArn (string) required
sso_admin/describe_instance_access_control_attribute_configurationReturns 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.InstanceArn (string) required
sso_admin/describe_permission_setGets the details of the permission set.InstanceArn (string) required
PermissionSetArn (string) required
sso_admin/describe_permission_set_provisioning_statusDescribes the status for the given permission set provisioning request.InstanceArn (string) required
ProvisionPermissionSetRequestId (string) required
sso_admin/describe_regionRetrieves details about a specific Region enabled in an IAM Identity Center instance. Details include the Region name, current status ACTIVE, ADDING, or REMOVING, the date when the Region was added, and whether it is the primary Region. The request must be made from one of the enabled Regions of the IAM Identity Center instance. The following actions are related to DescribeRegion: AddRegion RemoveRegion ListRegionsInstanceArn (string) required
RegionName (string) required
sso_admin/describe_trusted_token_issuerRetrieves details about a trusted token issuer configuration stored in an instance of IAM Identity Center. Details include the name of the trusted token issuer, the issuer URL, and the path of the source attribute and the destination attribute for a trusted token issuer configuration.TrustedTokenIssuerArn (string) required
sso_admin/detach_customer_managed_policy_reference_from_permission_setDetaches the specified customer managed policy from the specified PermissionSet.InstanceArn (string) required
PermissionSetArn (string) required
CustomerManagedPolicyReference: {
. Name (string)
. Path (string)
} (object) required
sso_admin/detach_managed_policy_from_permission_setDetaches the attached Amazon Web Services managed policy ARN from the specified permission set.InstanceArn (string) required
PermissionSetArn (string) required
ManagedPolicyArn (string) required
sso_admin/get_application_assignment_configurationRetrieves the configuration of PutApplicationAssignmentConfiguration.ApplicationArn (string) required
sso_admin/get_application_session_configurationRetrieves the session configuration for an application in IAM Identity Center. The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.ApplicationArn (string) required
sso_admin/get_inline_policy_for_permission_setObtains the inline policy assigned to the permission set.InstanceArn (string) required
PermissionSetArn (string) required
sso_admin/get_permissions_boundary_for_permission_setObtains the permissions boundary for a specified PermissionSet.InstanceArn (string) required
PermissionSetArn (string) required
sso_admin/list_account_assignment_creation_statusLists the status of the Amazon Web Services account assignment creation requests for a specified IAM Identity Center instance.InstanceArn (string) required
MaxResults (integer)
NextToken (string)
Filter: {
. Status (string)
} (object)
sso_admin/list_account_assignment_deletion_statusLists the status of the Amazon Web Services account assignment deletion requests for a specified IAM Identity Center instance.InstanceArn (string) required
MaxResults (integer)
NextToken (string)
Filter: {
. Status (string)
} (object)
sso_admin/list_account_assignmentsLists the assignee of the specified Amazon Web Services account with the specified permission set.InstanceArn (string) required
AccountId (string) required
PermissionSetArn (string) required
MaxResults (integer)
NextToken (string)
sso_admin/list_account_assignments_for_principalRetrieves a list of the IAM Identity Center associated Amazon Web Services accounts that the principal has access to. This action must be called from the management account containing your organization instance of IAM Identity Center. This action is not valid for account instances of IAM Identity Center.InstanceArn (string) required
PrincipalId (string) required
PrincipalType (string) required
Filter: {
. AccountId (string)
} (object)
NextToken (string)
MaxResults (integer)
sso_admin/list_accounts_for_provisioned_permission_setLists all the Amazon Web Services accounts where the specified permission set is provisioned.InstanceArn (string) required
PermissionSetArn (string) required
ProvisioningStatus (string)
MaxResults (integer)
NextToken (string)
sso_admin/list_application_assignmentsLists Amazon Web Services account users that are assigned to an application.ApplicationArn (string) required
MaxResults (integer)
NextToken (string)
sso_admin/list_application_assignments_for_principalLists the applications to which a specified principal is assigned. You must provide a filter when calling this action from a member account against your organization instance of IAM Identity Center. A filter is not required when called from the management account against an organization instance of IAM Identity Center, or from a member account against an account instance of IAM Identity Center in the same account.InstanceArn (string) required
PrincipalId (string) required
PrincipalType (string) required
Filter: {
. ApplicationArn (string)
} (object)
NextToken (string)
MaxResults (integer)
sso_admin/list_application_providersLists the application providers configured in the IAM Identity Center identity store.MaxResults (integer)
NextToken (string)
sso_admin/list_applicationsLists all applications associated with the instance of IAM Identity Center. When listing applications for an organization instance in the management account, member accounts must use the applicationAccount parameter to filter the list to only applications created from that account. When listing applications for an account instance in the same member account, a filter is not required.InstanceArn (string) required
MaxResults (integer)
NextToken (string)
Filter: {
. ApplicationAccount (string)
. ApplicationProvider (string)
} (object)
sso_admin/list_customer_managed_policy_references_in_permission_setLists all customer managed policies attached to a specified PermissionSet.InstanceArn (string) required
PermissionSetArn (string) required
MaxResults (integer)
NextToken (string)
sso_admin/list_instancesLists the details of the organization and account instances of IAM Identity Center that were created in or visible to the account calling this API.MaxResults (integer)
NextToken (string)
sso_admin/list_managed_policies_in_permission_setLists the Amazon Web Services managed policy that is attached to a specified permission set.InstanceArn (string) required
PermissionSetArn (string) required
MaxResults (integer)
NextToken (string)
sso_admin/list_permission_set_provisioning_statusLists the status of the permission set provisioning requests for a specified IAM Identity Center instance.InstanceArn (string) required
MaxResults (integer)
NextToken (string)
Filter: {
. Status (string)
} (object)
sso_admin/list_permission_setsLists the PermissionSets in an IAM Identity Center instance.InstanceArn (string) required
NextToken (string)
MaxResults (integer)
sso_admin/list_permission_sets_provisioned_to_accountLists all the permission sets that are provisioned to a specified Amazon Web Services account.InstanceArn (string) required
AccountId (string) required
ProvisioningStatus (string)
MaxResults (integer)
NextToken (string)
sso_admin/list_regionsLists all enabled Regions of an IAM Identity Center instance, including those that are being added or removed. This operation returns Regions with ACTIVE, ADDING, or REMOVING status. The following actions are related to ListRegions: AddRegion RemoveRegion DescribeRegionInstanceArn (string) required
MaxResults (integer)
NextToken (string)
sso_admin/list_tags_for_resourceLists the tags that are attached to a specified resource.InstanceArn (string)
ResourceArn (string) required
NextToken (string)
sso_admin/list_trusted_token_issuersLists all the trusted token issuers configured in an instance of IAM Identity Center.InstanceArn (string) required
MaxResults (integer)
NextToken (string)
sso_admin/provision_permission_setThe process by which a specified permission set is provisioned to the specified target.InstanceArn (string) required
PermissionSetArn (string) required
TargetId (string)
TargetType (string) required
sso_admin/put_application_assignment_configurationConfigure how users gain access to an application. If AssignmentsRequired is true default value, users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application. If an assignment is created using CreateApplicationAssignment., the user retains access if AssignmentsRequired is set to true.ApplicationArn (string) required
AssignmentRequired (boolean) required
sso_admin/put_application_session_configurationUpdates the session configuration for an application in IAM Identity Center. The session configuration determines how users can access an application. This includes whether user background sessions are enabled. User background sessions allow users to start a job on a supported Amazon Web Services managed application without having to remain signed in to an active session while the job runs.ApplicationArn (string) required
UserBackgroundSessionApplicationStatus (string)
sso_admin/put_inline_policy_to_permission_setAttaches 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.InstanceArn (string) required
PermissionSetArn (string) required
InlinePolicy (string) required
sso_admin/put_permissions_boundary_to_permission_setAttaches an Amazon Web Services managed or customer managed policy to the specified PermissionSet as a permissions boundary.InstanceArn (string) required
PermissionSetArn (string) required
PermissionsBoundary: {
. CustomerManagedPolicyReference (object)
. ManagedPolicyArn (string)
} (object) required
sso_admin/remove_regionRemoves an additional Region from an IAM Identity Center instance. This operation initiates an asynchronous workflow to clean up IAM Identity Center resources in the specified additional Region. The Region status is set to REMOVING and the Region record is deleted when the workflow completes. The request must be made from the primary Region. The target Region cannot be the primary Region, and no other add or remove Region workflows can be in progress. The following actions are related to RemoveRInstanceArn (string) required
RegionName (string) required
sso_admin/tag_resourceAssociates a set of tags with a specified resource.InstanceArn (string)
ResourceArn (string) required
Tags (array) required
sso_admin/untag_resourceDisassociates a set of tags from a specified resource.InstanceArn (string)
ResourceArn (string) required
TagKeys (array) required
sso_admin/update_applicationUpdates application properties.ApplicationArn (string) required
Name (string)
Description (string)
Status (string)
PortalOptions: {
. SignInOptions (object)
} (object)
sso_admin/update_instanceUpdate the details for the instance of IAM Identity Center that is owned by the Amazon Web Services account.Name (string)
InstanceArn (string) required
EncryptionConfiguration: {
. KeyType (string)
. KmsKeyArn (string)
} (object)
sso_admin/update_instance_access_control_attribute_configurationUpdates 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 CenInstanceArn (string) required
InstanceAccessControlAttributeConfiguration: {
. AccessControlAttributes (array)
} (object) required
sso_admin/update_permission_setUpdates an existing permission set.InstanceArn (string) required
PermissionSetArn (string) required
Description (string)
SessionDuration (string)
RelayState (string)
sso_admin/update_trusted_token_issuerUpdates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration. Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.TrustedTokenIssuerArn (string) required
Name (string)
TrustedTokenIssuerConfiguration (undefined)
sso_admin/get_application_access_scopeRetrieves the authorized targets for an IAM Identity Center access scope for an application.ApplicationArn (string) required
Scope (string) required
sso_admin/delete_application_access_scopeDeletes an IAM Identity Center access scope from an application.ApplicationArn (string) required
Scope (string) required
sso_admin/list_application_access_scopesLists the access scopes and authorized targets associated with an application.ApplicationArn (string) required
MaxResults (integer)
NextToken (string)
sso_admin/put_application_access_scopeAdds or updates the list of authorized targets for an IAM Identity Center access scope for an application.Scope (string) required
AuthorizedTargets (array)
ApplicationArn (string) required
sso_admin/get_application_authentication_methodRetrieves details about an authentication method used by an application.ApplicationArn (string) required
AuthenticationMethodType (string) required
sso_admin/delete_application_authentication_methodDeletes an authentication method from an application.ApplicationArn (string) required
AuthenticationMethodType (string) required
sso_admin/list_application_authentication_methodsLists all of the authentication methods supported by the specified application.ApplicationArn (string) required
NextToken (string)
sso_admin/put_application_authentication_methodAdds or updates an authentication method for an application.ApplicationArn (string) required
AuthenticationMethodType (string) required
AuthenticationMethod (undefined) required
sso_admin/get_application_grantRetrieves details about an application grant.ApplicationArn (string) required
GrantType (string) required
sso_admin/delete_application_grantDeletes a grant from an application.ApplicationArn (string) required
GrantType (string) required
sso_admin/list_application_grantsList the grants associated with an application.ApplicationArn (string) required
NextToken (string)
sso_admin/put_application_grantCreates a configuration for an application to use grants. Conceptually grants are authorization to request actions related to tokens. This configuration will be used when parties are requesting and receiving tokens during the trusted identity propagation process. For more information on the IAM Identity Center supported grant workflows, see SAML 2.0 and OAuth 2.0. A grant is created between your applications and Identity Center instance which enables an application to use specified mechanisms toApplicationArn (string) required
GrantType (string) required
Grant (undefined) required
sso_oidc/create_tokenCreates and returns access and refresh tokens for clients that are authenticated using client secrets. The access token can be used to fetch short-lived credentials for the assigned AWS accounts or to access application APIs using bearer authentication.clientId (string) required
clientSecret (string) required
grantType (string) required
deviceCode (string)
code (string)
refreshToken (string)
scope (array)
redirectUri (string)
codeVerifier (string)
sso_oidc/create_token_with_iamCreates and returns access and refresh tokens for authorized client applications that are authenticated using any IAM entity, such as a service role or user. These tokens might contain defined scopes that specify permissions such as read:profile or write:data. Through downscoping, you can use the scopes parameter to request tokens with reduced permissions compared to the original client application's permissions or, if applicable, the refresh token's scopes. The access token can be used to fetchclientId (string) required
grantType (string) required
code (string)
refreshToken (string)
assertion (string)
scope (array)
redirectUri (string)
subjectToken (string)
subjectTokenType (string)
requestedTokenType (string)
codeVerifier (string)
sso_oidc/register_clientRegisters a public client with IAM Identity Center. This allows clients to perform authorization using the authorization code grant with Proof Key for Code Exchange PKCE or the device code grant.clientName (string) required
clientType (string) required
scopes (array)
redirectUris (array)
grantTypes (array)
issuerUrl (string)
entitledApplicationArn (string)
sso_oidc/start_device_authorizationInitiates device authorization by requesting a pair of verification codes from the authorization service.clientId (string) required
clientSecret (string) required
startUrl (string) required
sso/get_role_credentialsReturns the STS short-term credentials for a given role name that is assigned to the user.roleName (string) required
accountId (string) required
accessToken (string) required
sso/list_account_rolesLists all roles that are assigned to the user for a given AWS account.nextToken (string)
maxResults (integer)
accessToken (string) required
accountId (string) required
sso/list_accountsLists 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.nextToken (string)
maxResults (integer)
accessToken (string) required
sso/logoutRemoves 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 behaaccessToken (string) required
storage_gateway/activate_gatewayActivates 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 actActivationKey (string) required
GatewayName (string) required
GatewayTimezone (string) required
GatewayRegion (string) required
GatewayType (string)
TapeDriveType (string)
MediumChangerType (string)
Tags (array)
storage_gateway/add_cacheConfigures 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.GatewayARN (string) required
DiskIds (array) required
storage_gateway/add_tags_to_resourceAdds 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 resResourceARN (string) required
Tags (array) required
storage_gateway/add_upload_bufferConfigures 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.GatewayARN (string) required
DiskIds (array) required
storage_gateway/add_working_storageConfigures 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, aGatewayARN (string) required
DiskIds (array) required
storage_gateway/assign_tape_poolAssigns 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.TapeARN (string) required
PoolId (string) required
BypassGovernanceRetention (boolean)
storage_gateway/associate_file_systemAssociate 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.UserName (string) required
Password (string) required
ClientToken (string) required
GatewayARN (string) required
LocationARN (string) required
Tags (array)
AuditDestinationARN (string)
CacheAttributes: {
. CacheStaleTimeoutInSeconds (integer)
} (object)
EndpointNetworkConfiguration: {
. IpAddresses (array)
} (object)
storage_gateway/attach_volumeConnects 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.GatewayARN (string) required
TargetName (string)
VolumeARN (string) required
NetworkInterfaceId (string) required
DiskId (string)
storage_gateway/cancel_archivalCancels 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.GatewayARN (string) required
TapeARN (string) required
storage_gateway/cancel_cache_reportCancels generation of a specified cache report. You can use this operation to manually cancel an IN-PROGRESS report for any reason. This action changes the report status from IN-PROGRESS to CANCELLED. You can only cancel in-progress reports. If the the report you attempt to cancel is in FAILED, ERROR, or COMPLETED state, the cancel operation returns an error.CacheReportARN (string) required
storage_gateway/cancel_retrievalCancels 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.GatewayARN (string) required
TapeARN (string) required
storage_gateway/create_cachedi_scsivolumeCreates 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 retuGatewayARN (string) required
VolumeSizeInBytes (integer) required
SnapshotId (string)
TargetName (string) required
SourceVolumeARN (string)
NetworkInterfaceId (string) required
ClientToken (string) required
KMSEncrypted (boolean)
KMSKey (string)
Tags (array)
storage_gateway/create_nfsfile_shareCreates 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 youClientToken (string) required
NFSFileShareDefaults: {
. FileMode (string)
. DirectoryMode (string)
. GroupId (integer)
. OwnerId (integer)
} (object)
GatewayARN (string) required
EncryptionType (string)
KMSEncrypted (boolean)
KMSKey (string)
Role (string) required
LocationARN (string) required
DefaultStorageClass (string)
ObjectACL (string)
ClientList (array)
Squash (string)
ReadOnly (boolean)
GuessMIMETypeEnabled (boolean)
RequesterPays (boolean)
Tags (array)
FileShareName (string)
CacheAttributes: {
. CacheStaleTimeoutInSeconds (integer)
} (object)
NotificationPolicy (string)
VPCEndpointDNSName (string)
BucketRegion (string)
AuditDestinationARN (string)
storage_gateway/create_smbfile_shareCreates 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 RegioClientToken (string) required
GatewayARN (string) required
EncryptionType (string)
KMSEncrypted (boolean)
KMSKey (string)
Role (string) required
LocationARN (string) required
DefaultStorageClass (string)
ObjectACL (string)
ReadOnly (boolean)
GuessMIMETypeEnabled (boolean)
RequesterPays (boolean)
SMBACLEnabled (boolean)
AccessBasedEnumeration (boolean)
AdminUserList (array)
ValidUserList (array)
InvalidUserList (array)
AuditDestinationARN (string)
Authentication (string)
CaseSensitivity (string)
Tags (array)
FileShareName (string)
CacheAttributes: {
. CacheStaleTimeoutInSeconds (integer)
} (object)
NotificationPolicy (string)
VPCEndpointDNSName (string)
BucketRegion (string)
OplocksEnabled (boolean)
storage_gateway/create_snapshotInitiates 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 requeVolumeARN (string) required
SnapshotDescription (string) required
Tags (array)
storage_gateway/create_snapshot_from_volume_recovery_pointInitiates 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 providVolumeARN (string) required
SnapshotDescription (string) required
Tags (array)
storage_gateway/create_storedi_scsivolumeCreates 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. IGatewayARN (string) required
DiskId (string) required
SnapshotId (string)
PreserveExistingData (boolean) required
TargetName (string) required
NetworkInterfaceId (string) required
KMSEncrypted (boolean)
KMSKey (string)
Tags (array)
storage_gateway/create_tape_poolCreates 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.PoolName (string) required
StorageClass (string) required
RetentionLockType (string)
RetentionLockTimeInDays (integer)
Tags (array)
storage_gateway/create_tapesCreates 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.GatewayARN (string) required
TapeSizeInBytes (integer) required
ClientToken (string) required
NumTapesToCreate (integer) required
TapeBarcodePrefix (string) required
KMSEncrypted (boolean)
KMSKey (string)
PoolId (string)
Worm (boolean)
Tags (array)
storage_gateway/create_tape_with_barcodeCreates 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.GatewayARN (string) required
TapeSizeInBytes (integer) required
TapeBarcode (string) required
KMSEncrypted (boolean)
KMSKey (string)
PoolId (string)
Worm (boolean)
Tags (array)
storage_gateway/delete_automatic_tape_creation_policyDeletes 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.GatewayARN (string) required
storage_gateway/delete_bandwidth_rate_limitDeletes 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.GatewayARN (string) required
BandwidthType (string) required
storage_gateway/delete_cache_reportDeletes the specified cache report and any associated tags from the Storage Gateway database. You can only delete completed reports. If the status of the report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You can use CancelCacheReport to cancel an IN-PROGRESS report. DeleteCacheReport does not delete the report object from your Amazon S3 bucket.CacheReportARN (string) required
storage_gateway/delete_chap_credentialsDeletes Challenge-Handshake Authentication Protocol CHAP credentials for a specified iSCSI target and initiator pair. This operation is supported in volume and tape gateway types.TargetARN (string) required
InitiatorName (string) required
storage_gateway/delete_file_shareDeletes a file share from an S3 File Gateway. This operation is only supported for S3 File Gateways.FileShareARN (string) required
ForceDelete (boolean)
storage_gateway/delete_gatewayDeletes 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 enviroGatewayARN (string) required
storage_gateway/delete_snapshot_scheduleDeletes 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 DesVolumeARN (string) required
storage_gateway/delete_tapeDeletes the specified virtual tape. This operation is only supported in the tape gateway type.GatewayARN (string) required
TapeARN (string) required
BypassGovernanceRetention (boolean)
storage_gateway/delete_tape_archiveDeletes the specified virtual tape from the virtual tape shelf VTS. This operation is only supported in the tape gateway type.TapeARN (string) required
BypassGovernanceRetention (boolean)
storage_gateway/delete_tape_poolDelete 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.PoolARN (string) required
storage_gateway/delete_volumeDeletes 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 sureVolumeARN (string) required
storage_gateway/describe_availability_monitor_testReturns 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.GatewayARN (string) required
storage_gateway/describe_bandwidth_rate_limitReturns 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 ARNGatewayARN (string) required
storage_gateway/describe_bandwidth_rate_limit_scheduleReturns 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 bandwiGatewayARN (string) required
storage_gateway/describe_cacheReturns 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.GatewayARN (string) required
storage_gateway/describe_cachedi_scsivolumesReturns 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.VolumeARNs (array) required
storage_gateway/describe_cache_reportReturns information about the specified cache report, including completion status and generation progress.CacheReportARN (string) required
storage_gateway/describe_chap_credentialsReturns 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.TargetARN (string) required
storage_gateway/describe_file_system_associationsGets the file system association information. This operation is only supported for FSx File Gateways.FileSystemAssociationARNList (array) required
storage_gateway/describe_gateway_informationReturns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name ARN of the gateway in your request.GatewayARN (string) required
storage_gateway/describe_maintenance_start_timeReturns your gateway's maintenance window schedule information, with values for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply. Time values returned are for the gateway's time zone.GatewayARN (string) required
storage_gateway/describe_nfsfile_sharesGets 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.FileShareARNList (array) required
storage_gateway/describe_smbfile_sharesGets 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.FileShareARNList (array) required
storage_gateway/describe_smbsettingsGets a description of a Server Message Block SMB file share settings from a file gateway. This operation is only supported for file gateways.GatewayARN (string) required
storage_gateway/describe_snapshot_scheduleDescribes 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.VolumeARN (string) required
storage_gateway/describe_storedi_scsivolumesReturns 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.VolumeARNs (array) required
storage_gateway/describe_tape_archivesReturns 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.TapeARNs (array)
Marker (string)
Limit (integer)
storage_gateway/describe_tape_recovery_pointsReturns 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.GatewayARN (string) required
Marker (string)
Limit (integer)
storage_gateway/describe_tapesReturns a description of virtual tapes that correspond to the specified Amazon Resource Names ARNs. If TapeARN is not specified, returns a description of the virtual tapes associated with the specified gateway. This operation is only supported for the tape gateway type. The operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit field in the body to limit the number of tapes in the response. If the number of tapes returnGatewayARN (string) required
TapeARNs (array)
Marker (string)
Limit (integer)
storage_gateway/describe_upload_bufferReturns 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.GatewayARN (string) required
storage_gateway/describe_vtldevicesReturns 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.GatewayARN (string) required
VTLDeviceARNs (array)
Marker (string)
Limit (integer)
storage_gateway/describe_working_storageReturns 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 storGatewayARN (string) required
storage_gateway/detach_volumeDisconnects 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.VolumeARN (string) required
ForceDetach (boolean)
storage_gateway/disable_gatewayDisables 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.GatewayARN (string) required
storage_gateway/disassociate_file_systemDisassociates 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.FileSystemAssociationARN (string) required
ForceDelete (boolean)
storage_gateway/evict_files_failing_uploadStarts a process that cleans the specified file share's cache of file entries that are failing upload to Amazon S3. This API operation reports success if the request is received with valid arguments, and there are no other cache clean operations currently in-progress for the specified file share. After a successful request, the cache clean operation occurs asynchronously and reports progress using CloudWatch logs and notifications. If ForceRemove is set to True, the cache clean operation will deFileShareARN (string) required
ForceRemove (boolean)
storage_gateway/join_domainAdds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol. Joining a domain creates an Active Directory computer account in the default organizational unit, using the gateway's Gateway ID as the account name for example, SGW-1234ADE. If your Active Directory environment requires that you pre-stage accounts to facilitate the join domain process, you will need to create this account ahead of time. To create the gateway'GatewayARN (string) required
DomainName (string) required
OrganizationalUnit (string)
DomainControllers (array)
TimeoutInSeconds (integer)
UserName (string) required
Password (string) required
storage_gateway/list_automatic_tape_creation_policiesLists 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.GatewayARN (string)
storage_gateway/list_cache_reportsReturns a list of existing cache reports for all file shares associated with your Amazon Web Services account. This list includes all information provided by the DescribeCacheReport action, such as report name, status, completion progress, start time, end time, filters, and tags.Marker (string)
storage_gateway/list_file_sharesGets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling Amazon Web Services account. This operation is only supported for S3 File Gateways.GatewayARN (string)
Limit (integer)
Marker (string)
storage_gateway/list_file_system_associationsGets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for FSx File Gateways.GatewayARN (string)
Limit (integer)
Marker (string)
storage_gateway/list_gatewaysLists 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 responseMarker (string)
Limit (integer)
storage_gateway/list_local_disksReturns 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 disGatewayARN (string) required
storage_gateway/list_tags_for_resourceLists the tags that have been added to the specified resource. This operation is supported in storage gateways of all types.ResourceARN (string) required
Marker (string)
Limit (integer)
storage_gateway/list_tape_poolsLists 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 sPoolARNs (array)
Marker (string)
Limit (integer)
storage_gateway/list_tapesLists 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 tapesTapeARNs (array)
Marker (string)
Limit (integer)
storage_gateway/list_volume_initiatorsLists 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.VolumeARN (string) required
storage_gateway/list_volume_recovery_pointsLists 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.GatewayARN (string) required
storage_gateway/list_volumesLists 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 truGatewayARN (string)
Marker (string)
Limit (integer)
storage_gateway/notify_when_uploadedSends you notification through Amazon EventBridge when all files written to your file share have been uploaded to Amazon S3. Storage Gateway can send a notification through Amazon EventBridge 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 EventBridge. You can configFileShareARN (string) required
storage_gateway/refresh_cacheRefreshes 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 subscriFileShareARN (string) required
FolderList (array)
Recursive (boolean)
storage_gateway/remove_tags_from_resourceRemoves one or more tags from the specified resource. This operation is supported in storage gateways of all types.ResourceARN (string) required
TagKeys (array) required
storage_gateway/reset_cacheResets 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 voluGatewayARN (string) required
storage_gateway/retrieve_tape_archiveRetrieves 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 retrieveTapeARN (string) required
GatewayARN (string) required
storage_gateway/retrieve_tape_recovery_pointRetrieves 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 retTapeARN (string) required
GatewayARN (string) required
storage_gateway/set_local_console_passwordSets 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.GatewayARN (string) required
LocalConsolePassword (string) required
storage_gateway/set_smbguest_passwordSets 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 GatewaysGatewayARN (string) required
Password (string) required
storage_gateway/shutdown_gatewayShuts down a Tape Gateway or Volume Gateway. To specify which gateway to shut down, use the Amazon Resource Name ARN of the gateway in the body of your request. This API action cannot be used to shut down S3 File Gateway or FSx File Gateway. 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 conditiGatewayARN (string) required
storage_gateway/start_availability_monitor_testStart 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.GatewayARN (string) required
storage_gateway/start_cache_reportStarts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share. You can use this report to identify and resolve issues if you have files failing upload from your gateway to Amazon S3. The report is a CSV file containing a list of files which match the set of filter parameters you specify in the request. The Files Failing Upload flag is reset every 24 hours and during gateway reboot. If this report captures the files after the reset, but before thFileShareARN (string) required
Role (string) required
LocationARN (string) required
BucketRegion (string) required
VPCEndpointDNSName (string)
InclusionFilters (array)
ExclusionFilters (array)
ClientToken (string) required
Tags (array)
storage_gateway/start_gatewayStarts 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 morGatewayARN (string) required
storage_gateway/update_automatic_tape_creation_policyUpdates 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.AutomaticTapeCreationRules (array) required
GatewayARN (string) required
storage_gateway/update_bandwidth_rate_limitUpdates 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 gatGatewayARN (string) required
AverageUploadRateLimitInBitsPerSec (integer)
AverageDownloadRateLimitInBitsPerSec (integer)
storage_gateway/update_bandwidth_rate_limit_scheduleUpdates 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 for volume, tape, and S3 file gateways. S3 file gateways support bandwidth rate limits for upload only. FSx file gateways do not support bandwidth rate limits.GatewayARN (string) required
BandwidthRateLimitIntervals (array) required
storage_gateway/update_chap_credentialsUpdates 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.TargetARN (string) required
SecretToAuthenticateInitiator (string) required
InitiatorName (string) required
SecretToAuthenticateTarget (string)
storage_gateway/update_file_system_associationUpdates a file system association. This operation is only supported in the FSx File Gateways.FileSystemAssociationARN (string) required
UserName (string)
Password (string)
AuditDestinationARN (string)
CacheAttributes: {
. CacheStaleTimeoutInSeconds (integer)
} (object)
storage_gateway/update_gateway_informationUpdates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size. 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.GatewayARN (string) required
GatewayName (string)
GatewayTimezone (string)
CloudWatchLogGroupARN (string)
GatewayCapacity (string)
storage_gateway/update_gateway_software_nowUpdates 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' timeoGatewayARN (string) required
storage_gateway/update_maintenance_start_timeUpdates a gateway's maintenance window schedule, with settings for monthly or weekly cadence, specific day and time to begin maintenance, and which types of updates to apply. Time configuration uses the gateway's time zone. You can pass values for a complete maintenance schedule, or update policy, or both. Previous values will persist for whichever setting you choose not to modify. If an incomplete or invalid maintenance schedule is passed, the entire request will be rejected with an error and nGatewayARN (string) required
HourOfDay (integer)
MinuteOfHour (integer)
DayOfWeek (integer)
DayOfMonth (integer)
SoftwareUpdatePreferences: {
. AutomaticUpdatePolicy (string)
} (object)
storage_gateway/update_nfsfile_shareUpdates 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 shareFileShareARN (string) required
EncryptionType (string)
KMSEncrypted (boolean)
KMSKey (string)
NFSFileShareDefaults: {
. FileMode (string)
. DirectoryMode (string)
. GroupId (integer)
. OwnerId (integer)
} (object)
DefaultStorageClass (string)
ObjectACL (string)
ClientList (array)
Squash (string)
ReadOnly (boolean)
GuessMIMETypeEnabled (boolean)
RequesterPays (boolean)
FileShareName (string)
CacheAttributes: {
. CacheStaleTimeoutInSeconds (integer)
} (object)
NotificationPolicy (string)
AuditDestinationARN (string)
storage_gateway/update_smbfile_shareUpdates 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 ServiFileShareARN (string) required
EncryptionType (string)
KMSEncrypted (boolean)
KMSKey (string)
DefaultStorageClass (string)
ObjectACL (string)
ReadOnly (boolean)
GuessMIMETypeEnabled (boolean)
RequesterPays (boolean)
SMBACLEnabled (boolean)
AccessBasedEnumeration (boolean)
AdminUserList (array)
ValidUserList (array)
InvalidUserList (array)
AuditDestinationARN (string)
CaseSensitivity (string)
FileShareName (string)
CacheAttributes: {
. CacheStaleTimeoutInSeconds (integer)
} (object)
NotificationPolicy (string)
OplocksEnabled (boolean)
storage_gateway/update_smbfile_share_visibilityControls 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.GatewayARN (string) required
FileSharesVisible (boolean) required
storage_gateway/update_smblocal_groupsUpdates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.GatewayARN (string) required
SMBLocalGroups: {
. GatewayAdmins (array)
} (object) required
storage_gateway/update_smbsecurity_strategyUpdates the SMB security strategy level for an Amazon S3 file gateway. This action is only supported for Amazon S3 file gateways. For information about configuring this setting using the Amazon Web Services console, see Setting a security level for your gateway in the Amazon S3 File Gateway User Guide. A higher security strategy level can affect performance of the gateway.GatewayARN (string) required
SMBSecurityStrategy (string) required
storage_gateway/update_snapshot_scheduleUpdates 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 snapshotVolumeARN (string) required
StartAt (integer) required
RecurrenceInHours (integer) required
Description (string)
Tags (array)
storage_gateway/update_vtldevice_typeUpdates 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.VTLDeviceARN (string) required
DeviceType (string) required
sts/assume_roleReturns a set of temporary security credentials that you can use to access Amazon Web Services resources. 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 Compare STS credentials in the IAM User Guide. Permissions The temporaryRoleArn (string) required
RoleSessionName (string) required
PolicyArns (array)
Policy (string)
DurationSeconds (integer)
Tags (array)
TransitiveTagKeys (array)
ExternalId (string)
SerialNumber (string)
TokenCode (string)
SourceIdentity (string)
ProvidedContexts (array)
sts/assume_role_with_samlReturns 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 Compare STS credentials in the IAM User GuRoleArn (string) required
PrincipalArn (string) required
SAMLAssertion (string) required
PolicyArns (array)
Policy (string)
DurationSeconds (integer)
sts/assume_role_with_web_identityReturns 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 AmazonRoleArn (string) required
RoleSessionName (string) required
WebIdentityToken (string) required
ProviderId (string)
PolicyArns (array)
Policy (string)
DurationSeconds (integer)
sts/assume_rootReturns a set of short term credentials you can use to perform privileged tasks on a member account in your organization. You must use credentials from an Organizations management account or a delegated administrator account for IAM to call AssumeRoot. You cannot use root user credentials to make this call. Before you can launch a privileged session, you must have centralized root access in your organization. For steps to enable this feature, see Centralize root access for member accounts in theTargetPrincipal (string) required
TaskPolicyArn: {
. arn (string)
} (object) required
DurationSeconds (integer)
sts/decode_authorization_messageDecodes 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 oEncodedMessage (string) required
sts/get_access_key_infoReturns 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 loAccessKeyId (string) required
sts/get_caller_identityReturns 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 attaches a policy to your identity 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 access is denied. To view an example response, see I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice in theNo parameters
sts/get_delegated_access_tokenExchanges a trade-in token for temporary Amazon Web Services credentials with the permissions associated with the assumed principal. This operation allows you to obtain credentials for a specific principal based on a trade-in token, enabling delegation of access to Amazon Web Services resources.TradeInToken (string) required
sts/get_federation_tokenReturns a set of temporary security credentials consisting of an access key ID, a secret access key, and a security token for a 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 safeguarded, usually in a server-bName (string) required
Policy (string)
PolicyArns (array)
DurationSeconds (integer)
Tags (array)
sts/get_session_tokenReturns 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 must call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials thatDurationSeconds (integer)
SerialNumber (string)
TokenCode (string)
sts/get_web_identity_tokenReturns a signed JSON Web Token JWT that represents the calling Amazon Web Services identity. The returned JWT can be used to authenticate with external services that support OIDC discovery. The token is signed by Amazon Web Services STS and can be publicly verified using the verification keys published at the issuer's JWKS endpoint.Audience (array) required
DurationSeconds (integer)
SigningAlgorithm (string) required
Tags (array)
supplychain/get_data_integration_eventEnables you to programmatically view an Amazon Web Services Supply Chain Data Integration Event. Developers can view the eventType, eventGroupId, eventTimestamp, datasetTarget, datasetLoadExecution.instanceId (string) required
eventId (string) required
supplychain/get_data_integration_flow_executionGet the flow execution.instanceId (string) required
flowName (string) required
executionId (string) required
supplychain/list_data_integration_eventsEnables you to programmatically list all data integration events for the provided Amazon Web Services Supply Chain instance.instanceId (string) required
eventType (string)
nextToken (string)
maxResults (integer)
supplychain/list_data_integration_flow_executionsList flow executions.instanceId (string) required
flowName (string) required
nextToken (string)
maxResults (integer)
supplychain/list_tags_for_resourceList all the tags for an Amazon Web ServicesSupply Chain resource. You can list all the tags added to a resource. By listing the tags, developers can view the tag level information on a resource and perform actions such as, deleting a resource associated with a particular tag.resourceArn (string) required
supplychain/send_data_integration_eventSend the data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake.instanceId (string) required
eventType (string) required
data (string) required
eventGroupId (string) required
eventTimestamp (string)
clientToken (string)
datasetTarget: {
. datasetIdentifier (string)
. operationType (string)
} (object)
supplychain/tag_resourceYou can create tags during or after creating a resource such as instance, data flow, or dataset in AWS Supply chain. During the data ingestion process, you can add tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets. You can use these tags to identify a group of resources or a single resource used by the developer.resourceArn (string) required
tags (object) required
supplychain/untag_resourceYou can delete tags for an Amazon Web Services Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain. During the data ingestion process, you can delete tags such as dev, test, or prod to data flows created during the data ingestion process in the AWS Supply Chain datasets.resourceArn (string) required
tagKeys (array) required
supplychain/create_bill_of_materials_import_jobCreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials BOM entity. For information on the product_bom entity, see the AWS Supply Chain User Guide. The CSV file must be located in an Amazon S3 location accessible to AWS Supply Chain. It is recommended to use the same Amazon S3 bucket created during your AWS Supply Chain instance creation.instanceId (string) required
s3uri (string) required
clientToken (string)
supplychain/get_bill_of_materials_import_jobGet status and details of a BillOfMaterialsImportJob.instanceId (string) required
jobId (string) required
supplychain/get_data_integration_flowEnables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.instanceId (string) required
name (string) required
supplychain/update_data_integration_flowEnables you to programmatically update an existing data pipeline to ingest data from the source systems such as, Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset product, inbound_order or a temporary dataset along with the data transformation query provided with the API.instanceId (string) required
name (string) required
sources (array)
transformation: {
. transformationType (string)
. sqlTransformation (object)
} (object)
target: {
. targetType (string)
. s3Target (object)
. datasetTarget (object)
} (object)
supplychain/delete_data_integration_flowEnable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.instanceId (string) required
name (string) required
supplychain/list_data_integration_flowsEnables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.instanceId (string) required
nextToken (string)
maxResults (integer)
supplychain/create_data_integration_flowEnables you to programmatically create a data pipeline to ingest data from source systems such as Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset product, inbound_order or a temporary dataset along with the data transformation query provided with the API.instanceId (string) required
name (string) required
sources (array) required
transformation: {
. transformationType (string)
. sqlTransformation (object)
} (object) required
target: {
. targetType (string)
. s3Target (object)
. datasetTarget (object)
} (object) required
tags (object)
supplychain/get_data_lake_datasetEnables you to programmatically view an Amazon Web Services Supply Chain data lake dataset. Developers can view the data lake dataset information such as namespace, schema, and so on for a given instance ID, namespace, and dataset name.instanceId (string) required
namespace (string) required
name (string) required
supplychain/update_data_lake_datasetEnables you to programmatically update an Amazon Web Services Supply Chain data lake dataset. Developers can update the description of a data lake dataset for a given instance ID, namespace, and dataset name.instanceId (string) required
namespace (string) required
name (string) required
description (string)
supplychain/delete_data_lake_datasetEnables you to programmatically delete an Amazon Web Services Supply Chain data lake dataset. Developers can delete the existing datasets for a given instance ID, namespace, and instance name.instanceId (string) required
namespace (string) required
name (string) required
supplychain/list_data_lake_datasetsEnables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets. Developers can view the datasets and the corresponding information such as namespace, schema, and so on for a given instance ID and namespace.instanceId (string) required
namespace (string) required
nextToken (string)
maxResults (integer)
supplychain/create_data_lake_datasetEnables you to programmatically create an Amazon Web Services Supply Chain data lake dataset. Developers can create the datasets using their pre-defined or custom schema for a given instance ID, namespace, and dataset name.instanceId (string) required
namespace (string) required
name (string) required
schema: {
. name (string)
. fields (array)
. primaryKeys (array)
} (object)
description (string)
partitionSpec: {
. fields (array)
} (object)
tags (object)
supplychain/get_data_lake_namespaceEnables you to programmatically view an Amazon Web Services Supply Chain data lake namespace. Developers can view the data lake namespace information such as description for a given instance ID and namespace name.instanceId (string) required
name (string) required
supplychain/update_data_lake_namespaceEnables you to programmatically update an Amazon Web Services Supply Chain data lake namespace. Developers can update the description of a data lake namespace for a given instance ID and namespace name.instanceId (string) required
name (string) required
description (string)
supplychain/delete_data_lake_namespaceEnables you to programmatically delete an Amazon Web Services Supply Chain data lake namespace and its underling datasets. Developers can delete the existing namespaces for a given instance ID and namespace name.instanceId (string) required
name (string) required
supplychain/list_data_lake_namespacesEnables you to programmatically view the list of Amazon Web Services Supply Chain data lake namespaces. Developers can view the namespaces and the corresponding information such as description for a given instance ID. Note that this API only return custom namespaces, instance pre-defined namespaces are not included.instanceId (string) required
nextToken (string)
maxResults (integer)
supplychain/create_data_lake_namespaceEnables you to programmatically create an Amazon Web Services Supply Chain data lake namespace. Developers can create the namespaces for a given instance ID.instanceId (string) required
name (string) required
description (string)
tags (object)
supplychain/create_instanceEnables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys and relevant information associated with the API without using the Amazon Web Services console. This is an asynchronous operation. Upon receiving a CreateInstance request, Amazon Web Services Supply Chain immediately returns the instance resource, instance ID, and the initializing state while simultaneously creating all required Amazon Web Services resources for an instance creation. You caninstanceName (string)
instanceDescription (string)
kmsKeyArn (string)
webAppDnsDomain (string)
tags (object)
clientToken (string)
supplychain/get_instanceEnables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.instanceId (string) required
supplychain/update_instanceEnables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.instanceId (string) required
instanceName (string)
instanceDescription (string)
supplychain/delete_instanceEnables you to programmatically delete an Amazon Web Services Supply Chain instance by deleting the KMS keys and relevant information associated with the API without using the Amazon Web Services console. This is an asynchronous operation. Upon receiving a DeleteInstance request, Amazon Web Services Supply Chain immediately returns a response with the instance resource, delete state while cleaning up all Amazon Web Services resources created during the instance creation process. You can use theinstanceId (string) required
supplychain/list_instancesList all Amazon Web Services Supply Chain instances for a specific account. Enables you to programmatically list all Amazon Web Services Supply Chain instances based on their account ID, instance name, and state of the instance active or delete.nextToken (string)
maxResults (integer)
instanceNameFilter (array)
instanceStateFilter (array)
support_app/create_slack_channel_configurationCreates 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 aboutteamId (string) required
channelId (string) required
channelName (string)
notifyOnCreateOrReopenCase (boolean)
notifyOnAddCorrespondenceToCase (boolean)
notifyOnResolveCase (boolean)
notifyOnCaseSeverity (string) required
channelRoleArn (string) required
support_app/delete_account_aliasDeletes 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.No parameters
support_app/delete_slack_channel_configurationDeletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.teamId (string) required
channelId (string) required
support_app/delete_slack_workspace_configurationDeletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace.teamId (string) required
support_app/get_account_aliasRetrieves 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.No parameters
support_app/list_slack_channel_configurationsLists the Slack channel configurations for an Amazon Web Services account.nextToken (string)
support_app/list_slack_workspace_configurationsLists the Slack workspace configurations for an Amazon Web Services account.nextToken (string)
support_app/put_account_aliasCreates 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.accountAlias (string) required
support_app/register_slack_workspace_for_organizationRegisters a Slack workspace for your Amazon Web Services account. To call this API, your account must be part of an organization in Organizations. If you're the management account and you want to register Slack workspaces for your organization, you must complete the following tasks: Sign in to the Amazon Web Services Support Center and authorize the Slack workspaces where you want your organization to have access to. See Authorize a Slack workspace in the Amazon Web Services Support User Guide.teamId (string) required
support_app/update_slack_channel_configurationUpdates the configuration for a Slack channel, such as case update notifications.teamId (string) required
channelId (string) required
channelName (string)
notifyOnCreateOrReopenCase (boolean)
notifyOnAddCorrespondenceToCase (boolean)
notifyOnResolveCase (boolean)
notifyOnCaseSeverity (string)
channelRoleArn (string)
support/add_attachments_to_setAdds one or more attachments to an attachment set. An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-RaattachmentSetId (string)
attachments (array) required
support/add_communication_to_caseAdds 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 frocaseId (string)
communicationBody (string) required
ccEmailAddresses (array)
attachmentSetId (string)
support/create_caseCreates 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 returnssubject (string) required
serviceCode (string)
severityCode (string)
categoryCode (string)
communicationBody (string) required
ccEmailAddresses (array)
language (string)
issueType (string)
attachmentSetId (string)
support/describe_attachmentReturns 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 yattachmentId (string) required
support/describe_casesReturns 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 dacaseIdList (array)
displayId (string)
afterTime (string)
beforeTime (string)
includeResolvedCases (boolean)
nextToken (string)
maxResults (integer)
language (string)
includeCommunications (boolean)
support/describe_communicationsReturns 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 tocaseId (string) required
beforeTime (string)
afterTime (string)
nextToken (string)
maxResults (integer)
support/describe_create_case_optionsReturns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the language categoryCode, issueType and serviceCode used to retrieve the CreateCaseOptions. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionReqissueType (string) required
serviceCode (string) required
language (string) required
categoryCode (string) required
support/describe_servicesReturns 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 returserviceCodeList (array)
language (string)
support/describe_severity_levelsReturns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error messagelanguage (string)
support/describe_supported_languagesReturns a list of supported languages for a specified categoryCode, issueType and serviceCode. The returned supported languages will include a ISO 639-1 code for the language, and the language display name. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredExceptionissueType (string) required
serviceCode (string) required
categoryCode (string) required
support/describe_trusted_advisor_check_refresh_statusesReturns 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 thecheckIds (array) required
support/describe_trusted_advisor_check_resultReturns 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_availacheckId (string) required
language (string)
support/describe_trusted_advisor_checksReturns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that doesn't have a Busilanguage (string) required
support/describe_trusted_advisor_check_summariesReturns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. The response contains an array of TrustedAdvisorCheckSummary objects. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise SupporcheckIds (array) required
support/refresh_trusted_advisor_checkRefreshes 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 youcheckId (string) required
support/resolve_caseResolves a support case. This operation takes a caseId and returns the initial and final state of the case. You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services SucaseId (string)
swf/count_closed_workflow_executionsReturns 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 tdomain (string) required
startTimeFilter: {
. oldestDate (string)
. latestDate (string)
} (object)
closeTimeFilter: {
. oldestDate (string)
. latestDate (string)
} (object)
executionFilter: {
. workflowId (string)
} (object)
typeFilter: {
. name (string)
. version (string)
} (object)
tagFilter: {
. tag (string)
} (object)
closeStatusFilter: {
. status (string)
} (object)
swf/count_open_workflow_executionsReturns 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 thidomain (string) required
startTimeFilter: {
. oldestDate (string)
. latestDate (string)
} (object) required
typeFilter: {
. name (string)
. version (string)
} (object)
tagFilter: {
. tag (string)
} (object)
executionFilter: {
. workflowId (string)
} (object)
swf/count_pending_activity_tasksReturns 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 thisdomain (string) required
taskList: {
. name (string)
} (object) required
swf/count_pending_decision_tasksReturns 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 thisdomain (string) required
taskList: {
. name (string)
} (object) required
swf/delete_activity_typeDeletes the specified activity type. Note: Prior to deletion, activity types must first be deprecated. After an activity type has been deleted, you cannot schedule new activities of that type. Activities that started before the type was deleted will continue to run. 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 ordomain (string) required
activityType: {
. name (string)
. version (string)
} (object) required
swf/delete_workflow_typeDeletes the specified workflow type. Note: Prior to deletion, workflow types must first be deprecated. After a workflow type has been deleted, you cannot create new executions of that type. Executions that started before the type was deleted will continue to run. 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 dendomain (string) required
workflowType: {
. name (string)
. version (string)
} (object) required
swf/deprecate_activity_typeDeprecates 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. 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. Constraidomain (string) required
activityType: {
. name (string)
. version (string)
} (object) required
swf/deprecate_domainDeprecates 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 channame (string) required
swf/deprecate_workflow_typeDeprecates 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 resdomain (string) required
workflowType: {
. name (string)
. version (string)
} (object) required
swf/describe_activity_typeReturns 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 Conditiodomain (string) required
activityType: {
. name (string)
. version (string)
} (object) required
swf/describe_domainReturns 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 pname (string) required
swf/describe_workflow_executionReturns 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 cadomain (string) required
execution: {
. workflowId (string)
. runId (string)
} (object) required
swf/describe_workflow_typeReturns 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 parameterdomain (string) required
workflowType: {
. name (string)
. version (string)
} (object) required
swf/get_workflow_execution_historyReturns 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 actdomain (string) required
execution: {
. workflowId (string)
. runId (string)
} (object) required
nextPageToken (string)
maximumPageSize (integer)
reverseOrder (boolean)
swf/list_activity_typesReturns 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 elementdomain (string) required
name (string)
registrationStatus (string) required
nextPageToken (string)
maximumPageSize (integer)
reverseOrder (boolean)
swf/list_closed_workflow_executionsReturns 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 Resourcedomain (string) required
startTimeFilter: {
. oldestDate (string)
. latestDate (string)
} (object)
closeTimeFilter: {
. oldestDate (string)
. latestDate (string)
} (object)
executionFilter: {
. workflowId (string)
} (object)
closeStatusFilter: {
. status (string)
} (object)
typeFilter: {
. name (string)
. version (string)
} (object)
tagFilter: {
. tag (string)
} (object)
nextPageToken (string)
maximumPageSize (integer)
reverseOrder (boolean)
swf/list_domainsReturns 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 actionextPageToken (string)
registrationStatus (string) required
maximumPageSize (integer)
reverseOrder (boolean)
swf/list_open_workflow_executionsReturns 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 edomain (string) required
startTimeFilter: {
. oldestDate (string)
. latestDate (string)
} (object) required
typeFilter: {
. name (string)
. version (string)
} (object)
tagFilter: {
. tag (string)
} (object)
nextPageToken (string)
maximumPageSize (integer)
reverseOrder (boolean)
executionFilter: {
. workflowId (string)
} (object)
swf/list_tags_for_resourceList tags for a given domain.resourceArn (string) required
swf/list_workflow_typesReturns 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 parametersdomain (string) required
name (string)
registrationStatus (string) required
nextPageToken (string)
maximumPageSize (integer)
reverseOrder (boolean)
swf/poll_for_activity_taskUsed 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 tadomain (string) required
taskList: {
. name (string)
} (object) required
identity (string)
swf/poll_for_decision_taskUsed 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 decdomain (string) required
taskList: {
. name (string)
} (object) required
identity (string)
nextPageToken (string)
maximumPageSize (integer)
reverseOrder (boolean)
startAtPreviousStartedEvent (boolean)
swf/record_activity_task_heartbeatUsed 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 istaskToken (string) required
details (string)
swf/register_activity_typeRegisters 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. Usedomain (string) required
name (string) required
version (string) required
description (string)
defaultTaskStartToCloseTimeout (string)
defaultTaskHeartbeatTimeout (string)
defaultTaskList: {
. name (string)
} (object)
defaultTaskPriority (string)
defaultTaskScheduleToStartTimeout (string)
defaultTaskScheduleToCloseTimeout (string)
swf/register_domainRegisters 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, oname (string) required
description (string)
workflowExecutionRetentionPeriodInDays (string) required
tags (array)
swf/register_workflow_typeRegisters 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 elemendomain (string) required
name (string) required
version (string) required
description (string)
defaultTaskStartToCloseTimeout (string)
defaultExecutionStartToCloseTimeout (string)
defaultTaskList: {
. name (string)
} (object)
defaultTaskPriority (string)
defaultChildPolicy (string)
defaultLambdaRole (string)
swf/request_cancel_workflow_executionRecords 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 workflowdomain (string) required
workflowId (string) required
runId (string)
swf/respond_activity_task_canceledUsed 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 istaskToken (string) required
details (string)
swf/respond_activity_task_completedUsed 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. AtaskToken (string) required
result (string)
swf/respond_activity_task_failedUsed 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, RespondActivityTtaskToken (string) required
reason (string)
details (string)
swf/respond_decision_task_completedUsed 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 intaskToken (string) required
decisions (array)
executionContext (string)
taskList: {
. name (string)
} (object)
taskListScheduleToStartTimeout (string)
swf/signal_workflow_executionRecords 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 methodomain (string) required
workflowId (string) required
runId (string)
signalName (string) required
input (string)
swf/start_workflow_executionStarts 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 elemedomain (string) required
workflowId (string) required
workflowType: {
. name (string)
. version (string)
} (object) required
taskList: {
. name (string)
} (object)
taskPriority (string)
input (string)
executionStartToCloseTimeout (string)
tagList (array)
taskStartToCloseTimeout (string)
childPolicy (string)
lambdaRole (string)
swf/tag_resourceAdd a tag to a Amazon SWF domain. Amazon SWF supports a maximum of 50 tags per resource.resourceArn (string) required
tags (array) required
swf/terminate_workflow_executionRecords 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 ofdomain (string) required
workflowId (string) required
runId (string)
reason (string)
details (string)
childPolicy (string)
swf/undeprecate_activity_typeUndeprecates 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 allowdomain (string) required
activityType: {
. name (string)
. version (string)
} (object) required
swf/undeprecate_domainUndeprecates 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 elementname (string) required
swf/undeprecate_workflow_typeUndeprecates 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 ddomain (string) required
workflowType: {
. name (string)
. version (string)
} (object) required
swf/untag_resourceRemove a tag from a Amazon SWF domain.resourceArn (string) required
tagKeys (array) required
synthetics/associate_resourceAssociates 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.GroupIdentifier (string) required
ResourceArn (string) required
synthetics/create_canaryCreates 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 cName (string) required
Code: {
. S3Bucket (string)
. S3Key (string)
. S3Version (string)
. ZipFile (string)
. Handler (string)
. BlueprintTypes (array)
. Dependencies (array)
} (object) required
ArtifactS3Location (string) required
ExecutionRoleArn (string) required
Schedule: {
. Expression (string)
. DurationInSeconds (integer)
. RetryConfig (object)
} (object) required
RunConfig: {
. TimeoutInSeconds (integer)
. MemoryInMB (integer)
. ActiveTracing (boolean)
. EnvironmentVariables (object)
. EphemeralStorage (integer)
} (object)
SuccessRetentionPeriodInDays (integer)
FailureRetentionPeriodInDays (integer)
RuntimeVersion (string) required
VpcConfig: {
. SubnetIds (array)
. SecurityGroupIds (array)
. Ipv6AllowedForDualStack (boolean)
} (object)
ResourcesToReplicateTags (array)
ProvisionedResourceCleanup (string)
BrowserConfigs (array)
Tags (object)
ArtifactConfig: {
. S3Encryption (object)
} (object)
synthetics/create_groupCreates 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 wasName (string) required
Tags (object)
synthetics/delete_canaryPermanently deletes the specified canary. If the canary's ProvisionedResourceCleanup field is set to AUTOMATIC or you specify DeleteLambda in this operation as 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, you should also delete the following: The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-Alarm-firName (string) required
DeleteLambda (boolean)
synthetics/delete_groupDeletes 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.GroupIdentifier (string) required
synthetics/describe_canariesThis 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 parameterNextToken (string)
MaxResults (integer)
Names (array)
synthetics/describe_canaries_last_runUse 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 yoNextToken (string)
MaxResults (integer)
Names (array)
BrowserType (string)
synthetics/describe_runtime_versionsReturns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions.NextToken (string)
MaxResults (integer)
synthetics/disassociate_resourceRemoves a canary from a group. You must run this operation in the Region where the canary exists.GroupIdentifier (string) required
ResourceArn (string) required
synthetics/get_canaryRetrieves 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.Name (string) required
DryRunId (string)
synthetics/get_canary_runsRetrieves a list of runs for a specified canary.Name (string) required
NextToken (string)
MaxResults (integer)
DryRunId (string)
RunType (string)
synthetics/get_groupReturns information about one group. Groups are a global resource, so you can use this operation from any Region.GroupIdentifier (string) required
synthetics/list_associated_groupsReturns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.NextToken (string)
MaxResults (integer)
ResourceArn (string) required
synthetics/list_group_resourcesThis operation returns a list of the ARNs of the canaries that are associated with the specified group.NextToken (string)
MaxResults (integer)
GroupIdentifier (string) required
synthetics/list_groupsReturns a list of all groups in the account, displaying their names, unique IDs, and ARNs. The groups from all Regions are returned.NextToken (string)
MaxResults (integer)
synthetics/list_tags_for_resourceDisplays the tags associated with a canary or group.ResourceArn (string) required
synthetics/start_canaryUse 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.Name (string) required
synthetics/start_canary_dry_runUse this operation to start a dry run for a canary that has already been createdName (string) required
Code: {
. S3Bucket (string)
. S3Key (string)
. S3Version (string)
. ZipFile (string)
. Handler (string)
. BlueprintTypes (array)
. Dependencies (array)
} (object)
RuntimeVersion (string)
RunConfig: {
. TimeoutInSeconds (integer)
. MemoryInMB (integer)
. ActiveTracing (boolean)
. EnvironmentVariables (object)
. EphemeralStorage (integer)
} (object)
VpcConfig: {
. SubnetIds (array)
. SecurityGroupIds (array)
. Ipv6AllowedForDualStack (boolean)
} (object)
ExecutionRoleArn (string)
SuccessRetentionPeriodInDays (integer)
FailureRetentionPeriodInDays (integer)
VisualReference: {
. BaseScreenshots (array)
. BaseCanaryRunId (string)
. BrowserType (string)
} (object)
ArtifactS3Location (string)
ArtifactConfig: {
. S3Encryption (object)
} (object)
ProvisionedResourceCleanup (string)
BrowserConfigs (array)
VisualReferences (array)
synthetics/stop_canaryStops 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.Name (string) required
synthetics/tag_resourceAssigns 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 reResourceArn (string) required
Tags (object) required
synthetics/untag_resourceRemoves one or more tags from the specified resource.ResourceArn (string) required
TagKeys (array) required
synthetics/update_canaryUpdates the configuration of a canary that has already been created. For multibrowser canaries, you can add or remove browsers by updating the browserConfig list in the update call. For example: To add Firefox to a canary that currently uses Chrome, specify browserConfigs as CHROME, FIREFOX To remove Firefox and keep only Chrome, specify browserConfigs as CHROME You can't use this operation to update the tags of an existing canary. To change the tags of an existing canary, use TagResource. WhenName (string) required
Code: {
. S3Bucket (string)
. S3Key (string)
. S3Version (string)
. ZipFile (string)
. Handler (string)
. BlueprintTypes (array)
. Dependencies (array)
} (object)
ExecutionRoleArn (string)
RuntimeVersion (string)
Schedule: {
. Expression (string)
. DurationInSeconds (integer)
. RetryConfig (object)
} (object)
RunConfig: {
. TimeoutInSeconds (integer)
. MemoryInMB (integer)
. ActiveTracing (boolean)
. EnvironmentVariables (object)
. EphemeralStorage (integer)
} (object)
SuccessRetentionPeriodInDays (integer)
FailureRetentionPeriodInDays (integer)
VpcConfig: {
. SubnetIds (array)
. SecurityGroupIds (array)
. Ipv6AllowedForDualStack (boolean)
} (object)
VisualReference: {
. BaseScreenshots (array)
. BaseCanaryRunId (string)
. BrowserType (string)
} (object)
ArtifactS3Location (string)
ArtifactConfig: {
. S3Encryption (object)
} (object)
ProvisionedResourceCleanup (string)
DryRunId (string)
VisualReferences (array)
BrowserConfigs (array)
taxsettings/batch_delete_tax_registrationDeletes tax registration for multiple accounts in batch. This can be used to delete tax registrations for up to five accounts in one batch. This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.accountIds (array) required
taxsettings/batch_get_tax_exemptionsGet the active tax exemptions for a given list of accounts. The IAM action is tax:GetExemptions.accountIds (array) required
taxsettings/batch_put_tax_registrationAdds or updates tax registration for multiple accounts in batch. This can be used to add or update tax registrations for up to five accounts in one batch. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first. To call this API operation for specific countries, see the following country-specific requirements. Bangladesh You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Brazil YouaccountIds (array) required
taxRegistrationEntry: {
. registrationId (string)
. registrationType (string)
. legalName (string)
. legalAddress (object)
. sector (string)
. additionalTaxInformation (object)
. verificationDetails (object)
. certifiedEmailId (string)
} (object) required
taxsettings/delete_supplemental_tax_registrationDeletes a supplemental tax registration for a single account.authorityId (string) required
taxsettings/delete_tax_registrationDeletes tax registration for a single account. This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.accountId (string)
taxsettings/get_tax_exemption_typesGet supported tax exemption types. The IAM action is tax:GetExemptions.No parameters
taxsettings/get_tax_inheritanceThe get account tax inheritance status.No parameters
taxsettings/get_tax_registrationRetrieves tax registration for a single account.accountId (string)
taxsettings/get_tax_registration_documentDownloads your tax documents to the Amazon S3 bucket that you specify in your request.destinationS3Location: {
. bucket (string)
. prefix (string)
} (object)
taxDocumentMetadata: {
. taxDocumentAccessToken (string)
. taxDocumentName (string)
} (object) required
taxsettings/list_supplemental_tax_registrationsRetrieves supplemental tax registrations for a single account.maxResults (integer)
nextToken (string)
taxsettings/list_tax_exemptionsRetrieves the tax exemption of accounts listed in a consolidated billing family. The IAM action is tax:GetExemptions.maxResults (integer)
nextToken (string)
taxsettings/list_tax_registrationsRetrieves the tax registration of accounts listed in a consolidated billing family. This can be used to retrieve up to 100 accounts' tax registrations in one call default 50.maxResults (integer)
nextToken (string)
taxsettings/put_supplemental_tax_registrationStores supplemental tax registration for a single account.taxRegistrationEntry: {
. registrationId (string)
. registrationType (string)
. legalName (string)
. address (object)
} (object) required
taxsettings/put_tax_exemptionAdds the tax exemption for a single account or all accounts listed in a consolidated billing family. The IAM action is tax:UpdateExemptions.accountIds (array) required
authority: {
. country (string)
. state (string)
} (object) required
exemptionType (string) required
exemptionCertificate: {
. documentName (string)
. documentFile (string)
} (object) required
taxsettings/put_tax_inheritanceThe updated tax inheritance status.heritageStatus (string)
taxsettings/put_tax_registrationAdds or updates tax registration for a single account. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first. To call this API operation for specific countries, see the following country-specific requirements. Bangladesh You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object. Brazil You must complete the tax registration process in the Payment preferences page in the Billing and Cost MaccountId (string)
taxRegistrationEntry: {
. registrationId (string)
. registrationType (string)
. legalName (string)
. legalAddress (object)
. sector (string)
. additionalTaxInformation (object)
. verificationDetails (object)
. certifiedEmailId (string)
} (object) required
textract/analyze_documentAnalyzes 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 obDocument: {
. Bytes (string)
. S3Object (object)
} (object) required
FeatureTypes (array) required
HumanLoopConfig: {
. HumanLoopName (string)
. FlowDefinitionArn (string)
. DataAttributes (object)
} (object)
QueriesConfig: {
. Queries (array)
} (object)
AdaptersConfig: {
. Adapters (array)
} (object)
textract/analyze_expenseAnalyzeExpense 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.Document: {
. Bytes (string)
. S3Object (object)
} (object) required
textract/analyze_idAnalyzes 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.DocumentPages (array) required
textract/create_adapterCreates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.AdapterName (string) required
ClientRequestToken (string)
Description (string)
FeatureTypes (array) required
AutoUpdate (string)
Tags (object)
textract/create_adapter_versionCreates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, an optional ClientRequestToken, and optional tags.AdapterId (string) required
ClientRequestToken (string)
DatasetConfig: {
. ManifestS3Object (object)
} (object) required
KMSKeyId (string)
OutputConfig: {
. S3Bucket (string)
. S3Prefix (string)
} (object) required
Tags (object)
textract/delete_adapterDeletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.AdapterId (string) required
textract/delete_adapter_versionDeletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.AdapterId (string) required
AdapterVersion (string) required
textract/detect_document_textDetects 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 in one of the following image formats: JPEG, PNG, PDF, or TIFF. 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 wDocument: {
. Bytes (string)
. S3Object (object)
} (object) required
textract/get_adapterGets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.AdapterId (string) required
textract/get_adapter_versionGets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.AdapterId (string) required
AdapterVersion (string) required
textract/get_document_analysisGets 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 vaJobId (string) required
MaxResults (integer)
NextToken (string)
textract/get_document_text_detectionGets 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 StartDocumentTeJobId (string) required
MaxResults (integer)
NextToken (string)
textract/get_expense_analysisGets 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 muJobId (string) required
MaxResults (integer)
NextToken (string)
textract/get_lending_analysisGets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document. You start asynchronous text analysis by calling StartLendingAnalysis, 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 StartLendingAnalysis. To get the results of the text analysis operation, first check that the statJobId (string) required
MaxResults (integer)
NextToken (string)
textract/get_lending_analysis_summaryGets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about documents grouped together by a common document type. Information like detected signatures, page numbers, and split documents is returned with respect to the type of grouped document. You start asynchronous text analysis by calling StartLendingAnalysis, which returns a job identifier JobId. When the text analysis operation finishes, AmazonJobId (string) required
textract/list_adaptersLists all adapters that match the specified filtration criteria.AfterCreationTime (string)
BeforeCreationTime (string)
MaxResults (integer)
NextToken (string)
textract/list_adapter_versionsList all version of an adapter that meet the specified filtration criteria.AdapterId (string)
AfterCreationTime (string)
BeforeCreationTime (string)
MaxResults (integer)
NextToken (string)
textract/list_tags_for_resourceLists all tags for an Amazon Textract resource.ResourceARN (string) required
textract/start_document_analysisStarts 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 iDocumentLocation: {
. S3Object (object)
} (object) required
FeatureTypes (array) required
ClientRequestToken (string)
JobTag (string)
NotificationChannel: {
. SNSTopicArn (string)
. RoleArn (string)
} (object)
OutputConfig: {
. S3Bucket (string)
. S3Prefix (string)
} (object)
KMSKeyId (string)
QueriesConfig: {
. Queries (array)
} (object)
AdaptersConfig: {
. Adapters (array)
} (object)
textract/start_document_text_detectionStarts 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. StartDocumentTextDetection returns a job identifier JobId that you use to get the results of the operation. When text detection iDocumentLocation: {
. S3Object (object)
} (object) required
ClientRequestToken (string)
JobTag (string)
NotificationChannel: {
. SNSTopicArn (string)
. RoleArn (string)
} (object)
OutputConfig: {
. S3Bucket (string)
. S3Prefix (string)
} (object)
KMSKeyId (string)
textract/start_expense_analysisStarts 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 theDocumentLocation: {
. S3Object (object)
} (object) required
ClientRequestToken (string)
JobTag (string)
NotificationChannel: {
. SNSTopicArn (string)
. RoleArn (string)
} (object)
OutputConfig: {
. S3Bucket (string)
. S3Prefix (string)
} (object)
KMSKeyId (string)
textract/start_lending_analysisStarts the classification and analysis of an input document. StartLendingAnalysis initiates the classification and analysis of a packet of lending documents. StartLendingAnalysis operates on a document file located in an Amazon S3 bucket. StartLendingAnalysis can analyze text in documents that are in one of the following formats: JPEG, PNG, TIFF, PDF. Use DocumentLocation to specify the bucket name and the file name of the document. StartLendingAnalysis returns a job identifier JobId that you usDocumentLocation: {
. S3Object (object)
} (object) required
ClientRequestToken (string)
JobTag (string)
NotificationChannel: {
. SNSTopicArn (string)
. RoleArn (string)
} (object)
OutputConfig: {
. S3Bucket (string)
. S3Prefix (string)
} (object)
KMSKeyId (string)
textract/tag_resourceAdds one or more tags to the specified resource.ResourceARN (string) required
Tags (object) required
textract/untag_resourceRemoves any tags with the specified keys from the specified resource.ResourceARN (string) required
TagKeys (array) required
textract/update_adapterUpdate the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.AdapterId (string) required
Description (string)
AdapterName (string)
AutoUpdate (string)
timestream_influxdb/list_tags_for_resourceA list of tags applied to the resource.resourceArn (string) required
timestream_influxdb/tag_resourceTags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.resourceArn (string) required
tags (object) required
timestream_influxdb/untag_resourceRemoves the tag from the specified resource.resourceArn (string) required
tagKeys (array) required
timestream_influxdb/list_db_instances_for_clusterReturns a list of Timestream for InfluxDB clusters.dbClusterId (string) required
nextToken (string)
maxResults (integer)
timestream_influxdb/reboot_db_clusterReboots a Timestream for InfluxDB cluster.dbClusterId (string) required
instanceIds (array)
timestream_influxdb/create_db_clusterCreates a new Timestream for InfluxDB cluster.name (string) required
username (string)
password (string)
organization (string)
bucket (string)
port (integer)
dbParameterGroupIdentifier (string)
dbInstanceType (string) required
dbStorageType (string)
allocatedStorage (integer)
networkType (string)
publiclyAccessible (boolean)
vpcSubnetIds (array) required
vpcSecurityGroupIds (array) required
deploymentType (string)
failoverMode (string)
logDeliveryConfiguration: {
. s3Configuration (object)
} (object)
tags (object)
timestream_influxdb/get_db_clusterRetrieves information about a Timestream for InfluxDB cluster.dbClusterId (string) required
timestream_influxdb/update_db_clusterUpdates a Timestream for InfluxDB cluster.dbClusterId (string) required
logDeliveryConfiguration: {
. s3Configuration (object)
} (object)
dbParameterGroupIdentifier (string)
port (integer)
dbInstanceType (string)
failoverMode (string)
timestream_influxdb/delete_db_clusterDeletes a Timestream for InfluxDB cluster.dbClusterId (string) required
timestream_influxdb/list_db_clustersReturns a list of Timestream for InfluxDB DB clusters.nextToken (string)
maxResults (integer)
timestream_influxdb/reboot_db_instanceReboots a Timestream for InfluxDB instance.identifier (string) required
timestream_influxdb/create_db_instanceCreates a new Timestream for InfluxDB DB instance.name (string) required
username (string)
password (string) required
organization (string)
bucket (string)
dbInstanceType (string) required
vpcSubnetIds (array) required
vpcSecurityGroupIds (array) required
publiclyAccessible (boolean)
dbStorageType (string)
allocatedStorage (integer) required
dbParameterGroupIdentifier (string)
deploymentType (string)
logDeliveryConfiguration: {
. s3Configuration (object)
} (object)
tags (object)
port (integer)
networkType (string)
timestream_influxdb/get_db_instanceReturns a Timestream for InfluxDB DB instance.identifier (string) required
timestream_influxdb/update_db_instanceUpdates a Timestream for InfluxDB DB instance.identifier (string) required
logDeliveryConfiguration: {
. s3Configuration (object)
} (object)
dbParameterGroupIdentifier (string)
port (integer)
dbInstanceType (string)
deploymentType (string)
dbStorageType (string)
allocatedStorage (integer)
timestream_influxdb/delete_db_instanceDeletes a Timestream for InfluxDB DB instance.identifier (string) required
timestream_influxdb/list_db_instancesReturns a list of Timestream for InfluxDB DB instances.nextToken (string)
maxResults (integer)
timestream_influxdb/create_db_parameter_groupCreates a new Timestream for InfluxDB DB parameter group to associate with DB instances.name (string) required
description (string)
parameters (undefined)
tags (object)
timestream_influxdb/get_db_parameter_groupReturns a Timestream for InfluxDB DB parameter group.identifier (string) required
timestream_influxdb/list_db_parameter_groupsReturns a list of Timestream for InfluxDB DB parameter groups.nextToken (string)
maxResults (integer)
timestream_query/cancel_queryCancels 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.QueryId (string) required
timestream_query/create_scheduled_queryCreate 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.Name (string) required
QueryString (string) required
ScheduleConfiguration: {
. ScheduleExpression (string)
} (object) required
NotificationConfiguration: {
. SnsConfiguration (object)
} (object) required
TargetConfiguration: {
. TimestreamConfiguration (object)
} (object)
ClientToken (string)
ScheduledQueryExecutionRoleArn (string) required
Tags (array)
KmsKeyId (string)
ErrorReportConfiguration: {
. S3Configuration (object)
} (object) required
timestream_query/delete_scheduled_queryDeletes a given scheduled query. This is an irreversible operation.ScheduledQueryArn (string) required
timestream_query/describe_account_settingsDescribes the settings for your account that include the query pricing model and the configured maximum TCUs the service can use for your query workload. You're charged only for the duration of compute units used for your workloads.No parameters
timestream_query/describe_endpointsDescribeEndpoints 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 haveNo parameters
timestream_query/describe_scheduled_queryProvides detailed information about a scheduled query.ScheduledQueryArn (string) required
timestream_query/execute_scheduled_queryYou can use this API to run a scheduled query manually. If you enabled QueryInsights, this API also returns insights and metrics related to the query that you executed as part of an Amazon SNS notification. QueryInsights helps with performance tuning of your query. For more information about QueryInsights, see Using query insights to optimize queries in Amazon Timestream.ScheduledQueryArn (string) required
InvocationTime (string) required
ClientToken (string)
QueryInsights: {
. Mode (string)
} (object)
timestream_query/list_scheduled_queriesGets a list of all scheduled queries in the caller's Amazon account and Region. ListScheduledQueries is eventually consistent.MaxResults (integer)
NextToken (string)
timestream_query/list_tags_for_resourceList all tags on a Timestream query resource.ResourceARN (string) required
MaxResults (integer)
NextToken (string)
timestream_query/prepare_queryA 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 ValidateOnly set to true.QueryString (string) required
ValidateOnly (boolean)
timestream_query/queryQuery is a synchronous operation that enables you to run a query against your Amazon Timestream data. If you enabled QueryInsights, this API also returns insights and metrics related to the query that you executed. QueryInsights helps with performance tuning of your query. For more information about QueryInsights, see Using query insights to optimize queries in Amazon Timestream. The maximum number of Query API requests you're allowed to make with QueryInsights enabled is 1 query per second QPS.QueryString (string) required
ClientToken (string)
NextToken (string)
MaxRows (integer)
QueryInsights: {
. Mode (string)
} (object)
timestream_query/tag_resourceAssociate 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.ResourceARN (string) required
Tags (array) required
timestream_query/untag_resourceRemoves the association of tags from a Timestream query resource.ResourceARN (string) required
TagKeys (array) required
timestream_query/update_account_settingsTransitions your account to use TCUs for query pricing and modifies the maximum query compute units that you've configured. If you reduce the value of MaxQueryTCU to a desired configuration, the new value can take up to 24 hours to be effective. After you've transitioned your account to use TCUs for query pricing, you can't transition to using bytes scanned for query pricing.MaxQueryTCU (integer)
QueryPricingModel (string)
QueryCompute: {
. ComputeMode (string)
. ProvisionedCapacity (object)
} (object)
timestream_query/update_scheduled_queryUpdate a scheduled query.ScheduledQueryArn (string) required
State (string) required
timestream_write/create_batch_load_taskCreates a new Timestream batch load task. A batch load task processes data from a CSV source in an S3 location and writes to a Timestream table. A mapping from source to target is defined in a batch load task. Errors and events are written to a report at an S3 location. For the report, if the KMS key is not specified, the report will be encrypted with an S3 managed key when SSE_S3 is the option. Otherwise an error is thrown. For more information, see Amazon Web Services managed keys. Service quoClientToken (string)
DataModelConfiguration: {
. DataModel (object)
. DataModelS3Configuration (object)
} (object)
DataSourceConfiguration: {
. DataSourceS3Configuration (object)
. CsvConfiguration (object)
. DataFormat (string)
} (object) required
ReportConfiguration: {
. ReportS3Configuration (object)
} (object) required
TargetDatabaseName (string) required
TargetTableName (string) required
RecordVersion (integer)
timestream_write/create_databaseCreates 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. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.DatabaseName (string) required
KmsKeyId (string)
Tags (array)
timestream_write/create_tableAdds 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 might 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.DatabaseName (string) required
TableName (string) required
RetentionProperties: {
. MemoryStoreRetentionPeriodInHours (integer)
. MagneticStoreRetentionPeriodInDays (integer)
} (object)
Tags (array)
MagneticStoreWriteProperties: {
. EnableMagneticStoreWrites (boolean)
. MagneticStoreRejectedDataLocation (object)
} (object)
Schema: {
. CompositePartitionKey (array)
} (object)
timestream_write/delete_databaseDeletes 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.DatabaseName (string) required
timestream_write/delete_tableDeletes 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.DatabaseName (string) required
TableName (string) required
timestream_write/describe_batch_load_taskReturns information about the batch load task, including configurations, mappings, progress, and other details. Service quotas apply. See code sample for details.TaskId (string) required
timestream_write/describe_databaseReturns 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.DatabaseName (string) required
timestream_write/describe_endpointsReturns a list of available endpoints to make Timestream API calls against. This API operation is available through both the Write and Query APIs. Because the Timestream SDKs are designed to transparently work with the service’s architecture, including the management and mapping of the service endpoints, we don't recommend that you use this API operation unless: You are using VPC endpoints Amazon Web Services PrivateLink with Timestream Your application uses a programming language that does notNo parameters
timestream_write/describe_tableReturns 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.DatabaseName (string) required
TableName (string) required
timestream_write/list_batch_load_tasksProvides a list of batch load tasks, along with the name, status, when the task is resumable until, and other details. See code sample for details.NextToken (string)
MaxResults (integer)
TaskStatus (string)
timestream_write/list_databasesReturns a list of your Timestream databases. Service quotas apply. See code sample for details.NextToken (string)
MaxResults (integer)
timestream_write/list_tablesProvides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.DatabaseName (string)
NextToken (string)
MaxResults (integer)
timestream_write/list_tags_for_resourceLists all tags on a Timestream resource.ResourceARN (string) required
timestream_write/resume_batch_load_taskNo description availableTaskId (string) required
timestream_write/tag_resourceAssociates 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.ResourceARN (string) required
Tags (array) required
timestream_write/untag_resourceRemoves the association of tags from a Timestream resource.ResourceARN (string) required
TagKeys (array) required
timestream_write/update_databaseModifies 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.DatabaseName (string) required
KmsKeyId (string) required
timestream_write/update_tableModifies 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 theDatabaseName (string) required
TableName (string) required
RetentionProperties: {
. MemoryStoreRetentionPeriodInHours (integer)
. MagneticStoreRetentionPeriodInDays (integer)
} (object)
MagneticStoreWriteProperties: {
. EnableMagneticStoreWrites (boolean)
. MagneticStoreRejectedDataLocation (object)
} (object)
Schema: {
. CompositePartitionKey (array)
} (object)
timestream_write/write_recordsEnables 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 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 supports eventual consistency read semantics. This means that when you query data immediately after wriDatabaseName (string) required
TableName (string) required
CommonAttributes: {
. Dimensions (array)
. MeasureName (string)
. MeasureValue (string)
. MeasureValueType (string)
. Time (string)
. TimeUnit (string)
. Version (integer)
. MeasureValues (array)
} (object)
Records (array) required
tnb/cancel_sol_network_operationCancels a network operation. A network operation is any operation that is done to your network, such as network instance instantiation or termination.nsLcmOpOccId (string) required
tnb/create_sol_function_packageCreates a function package. A function package is a .zip file in CSAR Cloud Service Archive format that contains a network function an ETSI standard telecommunication application and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see Function packages in the Amazon Web Services Telco Network Builder User Guide. Creating a function package is the first step for creating a network in AWS TNB. This reqtags (object)
tnb/create_sol_network_instanceCreates a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations like terminate, update, and delete can be performed. Creating a network instance is the third step after creating a network package. For more information about network instances, Network instances in the Amazon Web Services Telco Network Builder User Guide. Once you create a network instance, you can instantiate it. To instantiate a networknsdInfoId (string) required
nsName (string) required
nsDescription (string)
tags (object)
tnb/create_sol_network_packageCreates a network package. A network package is a .zip file in CSAR Cloud Service Archive format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see Network instances in the Amazon Web Services Telco Network Builder User Guide. A network package consists of a network service descriptor NSD file required and any additional files optional, such as scripts specific to your needs. For example, if you have mtags (object)
tnb/delete_sol_function_packageDeletes a function package. A function package is a .zip file in CSAR Cloud Service Archive format that contains a network function an ETSI standard telecommunication application and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. To delete a function package, the package must be in a disabled state. To disable a function package, see UpdateSolFunctionPackage.vnfPkgId (string) required
tnb/delete_sol_network_instanceDeletes a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations like terminate, update, and delete can be performed. To delete a network instance, the instance must be in a stopped or terminated state. To terminate a network instance, see TerminateSolNetworkInstance.nsInstanceId (string) required
tnb/delete_sol_network_packageDeletes network package. A network package is a .zip file in CSAR Cloud Service Archive format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. To delete a network package, the package must be in a disable state. To disable a network package, see UpdateSolNetworkPackage.nsdInfoId (string) required
tnb/get_sol_function_instanceGets the details of a network function instance, including the instantiation state and metadata from the function package descriptor in the network function package. A network function instance is a function in a function package .vnfInstanceId (string) required
tnb/get_sol_function_packageGets the details of an individual function package, such as the operational state and whether the package is in use. A function package is a .zip file in CSAR Cloud Service Archive format that contains a network function an ETSI standard telecommunication application and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network..vnfPkgId (string) required
tnb/get_sol_function_package_contentGets the contents of a function package. A function package is a .zip file in CSAR Cloud Service Archive format that contains a network function an ETSI standard telecommunication application and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.vnfPkgId (string) required
accept (string) required
tnb/get_sol_function_package_descriptorGets a function package descriptor in a function package. A function package descriptor is a .yaml file in a function package that uses the TOSCA standard to describe how the network function in the function package should run on your network. A function package is a .zip file in CSAR Cloud Service Archive format that contains a network function an ETSI standard telecommunication application and function package descriptor that uses the TOSCA standard to describe how the network functions shouldvnfPkgId (string) required
accept (string) required
tnb/get_sol_network_instanceGets the details of the network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations like terminate, update, and delete can be performed.nsInstanceId (string) required
tnb/get_sol_network_operationGets the details of a network operation, including the tasks involved in the network operation and the status of the tasks. A network operation is any operation that is done to your network, such as network instance instantiation or termination.nsLcmOpOccId (string) required
tnb/get_sol_network_packageGets the details of a network package. A network package is a .zip file in CSAR Cloud Service Archive format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.nsdInfoId (string) required
tnb/get_sol_network_package_contentGets the contents of a network package. A network package is a .zip file in CSAR Cloud Service Archive format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.nsdInfoId (string) required
accept (string) required
tnb/get_sol_network_package_descriptorGets the content of the network service descriptor. A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.nsdInfoId (string) required
tnb/instantiate_sol_network_instanceInstantiates a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations like terminate, update, and delete can be performed. Before you can instantiate a network instance, you have to create a network instance. For more information, see CreateSolNetworkInstance.nsInstanceId (string) required
dryRun (boolean)
additionalParamsForNs (undefined)
tags (object)
tnb/list_sol_function_instancesLists network function instances. A network function instance is a function in a function package .maxResults (integer)
nextToken (string)
tnb/list_sol_function_packagesLists information about function packages. A function package is a .zip file in CSAR Cloud Service Archive format that contains a network function an ETSI standard telecommunication application and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.maxResults (integer)
nextToken (string)
tnb/list_sol_network_instancesLists your network instances. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations like terminate, update, and delete can be performed.maxResults (integer)
nextToken (string)
tnb/list_sol_network_operationsLists details for a network operation, including when the operation started and the status of the operation. A network operation is any operation that is done to your network, such as network instance instantiation or termination.nsInstanceId (string)
maxResults (integer)
nextToken (string)
tnb/list_sol_network_packagesLists network packages. A network package is a .zip file in CSAR Cloud Service Archive format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.maxResults (integer)
nextToken (string)
tnb/list_tags_for_resourceLists tags for AWS TNB resources.resourceArn (string) required
tnb/put_sol_function_package_contentUploads the contents of a function package. A function package is a .zip file in CSAR Cloud Service Archive format that contains a network function an ETSI standard telecommunication application and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.vnfPkgId (string) required
contentType (string)
file (string) required
tnb/put_sol_network_package_contentUploads the contents of a network package. A network package is a .zip file in CSAR Cloud Service Archive format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.nsdInfoId (string) required
contentType (string)
file (string) required
tnb/tag_resourceTags an AWS TNB resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.resourceArn (string) required
tags (object) required
tnb/terminate_sol_network_instanceTerminates a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations like terminate, update, and delete can be performed. You must terminate a network instance before you can delete it.nsInstanceId (string) required
tags (object)
tnb/untag_resourceUntags an AWS TNB resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.resourceArn (string) required
tagKeys (array) required
tnb/update_sol_function_packageUpdates the operational state of function package. A function package is a .zip file in CSAR Cloud Service Archive format that contains a network function an ETSI standard telecommunication application and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.vnfPkgId (string) required
operationalState (string) required
tnb/update_sol_network_instanceUpdate a network instance. A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations like terminate, update, and delete can be performed. Choose the updateType parameter to target the necessary update of the network instance.nsInstanceId (string) required
updateType (string) required
modifyVnfInfoData: {
. vnfInstanceId (string)
. vnfConfigurableProperties
} (object)
updateNs: {
. nsdInfoId (string)
. additionalParamsForNs
} (object)
tags (object)
tnb/update_sol_network_packageUpdates the operational state of a network package. A network package is a .zip file in CSAR Cloud Service Archive format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.nsdInfoId (string) required
nsdOperationalState (string) required
tnb/validate_sol_function_package_contentValidates function package content. This can be used as a dry run before uploading function package content with PutSolFunctionPackageContent. A function package is a .zip file in CSAR Cloud Service Archive format that contains a network function an ETSI standard telecommunication application and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.vnfPkgId (string) required
contentType (string)
file (string) required
tnb/validate_sol_network_package_contentValidates network package content. This can be used as a dry run before uploading network package content with PutSolNetworkPackageContent. A network package is a .zip file in CSAR Cloud Service Archive format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.nsdInfoId (string) required
contentType (string)
file (string) required
transcribe_streaming/get_medical_scribe_streamProvides details about the specified Amazon Web Services HealthScribe streaming session. To view the status of the streaming session, check the StreamStatus field in the response. To get the details of post-stream analytics, including its status, check the PostStreamAnalyticsResult field in the response.SessionId (string) required
transcribe_streaming/start_call_analytics_stream_transcriptionStarts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application. Use this operation for Call Analytics transcriptions. The following parameters are required: language-code or identify-language media-encoding sample-rate For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.LanguageCode (string)
MediaSampleRateHertz (integer) required
MediaEncoding (string) required
VocabularyName (string)
SessionId (string)
AudioStream (undefined) required
VocabularyFilterName (string)
VocabularyFilterMethod (string)
LanguageModelName (string)
IdentifyLanguage (boolean)
LanguageOptions (string)
PreferredLanguage (string)
VocabularyNames (string)
VocabularyFilterNames (string)
EnablePartialResultsStabilization (boolean)
PartialResultsStability (string)
ContentIdentificationType (string)
ContentRedactionType (string)
PiiEntityTypes (string)
transcribe_streaming/start_medical_scribe_streamStarts a bidirectional HTTP/2 stream, where audio is streamed to Amazon Web Services HealthScribe and the transcription results are streamed to your application. When you start a stream, you first specify the stream configuration in a MedicalScribeConfigurationEvent. This event includes channel definitions, encryption settings, medical scribe context, and post-stream analytics settings, such as the output configuration for aggregated transcript and clinical note generation. These are additionalSessionId (string)
LanguageCode (string) required
MediaSampleRateHertz (integer) required
MediaEncoding (string) required
InputStream (undefined) required
transcribe_streaming/start_medical_stream_transcriptionStarts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application. The following parameters are required: language-code media-encoding sample-rate For more information on streaming with Amazon Transcribe Medical, see Transcribing streaming audio.LanguageCode (string) required
MediaSampleRateHertz (integer) required
MediaEncoding (string) required
VocabularyName (string)
Specialty (string) required
Type (string) required
ShowSpeakerLabel (boolean)
SessionId (string)
AudioStream (undefined) required
EnableChannelIdentification (boolean)
NumberOfChannels (integer)
ContentIdentificationType (string)
transcribe_streaming/start_stream_transcriptionStarts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application. The following parameters are required: language-code or identify-language or identify-multiple-language media-encoding sample-rate For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.LanguageCode (string)
MediaSampleRateHertz (integer) required
MediaEncoding (string) required
VocabularyName (string)
SessionId (string)
AudioStream (undefined) required
VocabularyFilterName (string)
VocabularyFilterMethod (string)
ShowSpeakerLabel (boolean)
EnableChannelIdentification (boolean)
NumberOfChannels (integer)
EnablePartialResultsStabilization (boolean)
PartialResultsStability (string)
ContentIdentificationType (string)
ContentRedactionType (string)
PiiEntityTypes (string)
LanguageModelName (string)
IdentifyLanguage (boolean)
LanguageOptions (string)
PreferredLanguage (string)
IdentifyMultipleLanguages (boolean)
VocabularyNames (string)
VocabularyFilterNames (string)
transcribe/create_call_analytics_categoryCreates a new Call Analytics category. All categories are automatically applied to your Call Analytics transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting your transcription request, as categories cannot be applied retroactively. When creating a new category, you can use the InputType parameter to label the category as a POST_CALL or a REAL_TIME category. POST_CALL categories can only be applied to post-call transcriptions and REACategoryName (string) required
Rules (array) required
Tags (array)
InputType (string)
transcribe/create_language_modelCreates a new custom language model. When creating a new custom 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 modelLanguageCode (string) required
BaseModelName (string) required
ModelName (string) required
InputDataConfig: {
. S3Uri (string)
. TuningDataS3Uri (string)
. DataAccessRoleArn (string)
} (object) required
Tags (array)
transcribe/create_medical_vocabularyCreates a new custom medical vocabulary. Before creating a new custom medical vocabulary, you must first upload a text file that contains your vocabulary table 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 and only accepts vocabularies in table format. Each language has a character set that contains all allowed characters for that specific languageVocabularyName (string) required
LanguageCode (string) required
VocabularyFileUri (string) required
Tags (array)
transcribe/create_vocabularyCreates a new custom vocabulary. When creating a new custom 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 custom vocabulary request fails. Refer to Character Sets fVocabularyName (string) required
LanguageCode (string) required
Phrases (array)
VocabularyFileUri (string)
Tags (array)
DataAccessRoleArn (string)
transcribe/create_vocabulary_filterCreates a new custom vocabulary filter. You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom 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 custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language. For more inVocabularyFilterName (string) required
LanguageCode (string) required
Words (array)
VocabularyFilterFileUri (string)
Tags (array)
DataAccessRoleArn (string)
transcribe/delete_call_analytics_categoryDeletes 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.CategoryName (string) required
transcribe/delete_call_analytics_jobDeletes 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.CallAnalyticsJobName (string) required
transcribe/delete_language_modelDeletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName. custom language model names are case sensitive.ModelName (string) required
transcribe/delete_medical_scribe_jobDeletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using MedicalScribeJobName. Job names are case sensitive.MedicalScribeJobName (string) required
transcribe/delete_medical_transcription_jobDeletes 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.MedicalTranscriptionJobName (string) required
transcribe/delete_medical_vocabularyDeletes a custom medical vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.VocabularyName (string) required
transcribe/delete_transcription_jobDeletes a transcription job. To use this operation, specify the name of the job you want to delete using TranscriptionJobName. Job names are case sensitive.TranscriptionJobName (string) required
transcribe/delete_vocabularyDeletes a custom vocabulary. To use this operation, specify the name of the custom vocabulary you want to delete using VocabularyName. Custom vocabulary names are case sensitive.VocabularyName (string) required
transcribe/delete_vocabulary_filterDeletes a custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you want to delete using VocabularyFilterName. Custom vocabulary filter names are case sensitive.VocabularyFilterName (string) required
transcribe/describe_language_modelProvides information about the specified custom language model. This operation also shows if the base language model that 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.ModelName (string) required
transcribe/get_call_analytics_categoryProvides information about the specified Call Analytics category. To get a list of your Call Analytics categories, use the operation.CategoryName (string) required
transcribe/get_call_analytics_jobProvides 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. ICallAnalyticsJobName (string) required
transcribe/get_medical_scribe_jobProvides information about the specified Medical Scribe job. To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed. To get a list of your Medical Scribe jobs, use the operation.MedicalScribeJobName (string) required
transcribe/get_medical_transcription_jobProvides 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. 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.MedicalTranscriptionJobName (string) required
transcribe/get_medical_vocabularyProvides information about the specified custom medical vocabulary. To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY, your custom 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.VocabularyName (string) required
transcribe/get_transcription_jobProvides 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. 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. ToTranscriptionJobName (string) required
transcribe/get_vocabularyProvides information about the specified custom vocabulary. To view the status of the specified custom vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your custom vocabulary failed. To get a list of your custom vocabularies, use the operation.VocabularyName (string) required
transcribe/get_vocabulary_filterProvides information about the specified custom vocabulary filter. To get a list of your custom vocabulary filters, use the operation.VocabularyFilterName (string) required
transcribe/list_call_analytics_categoriesProvides 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.NextToken (string)
MaxResults (integer)
transcribe/list_call_analytics_jobsProvides 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.Status (string)
JobNameContains (string)
NextToken (string)
MaxResults (integer)
transcribe/list_language_modelsProvides a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned. To get detailed information about a specific custom language model, use the operation.StatusEquals (string)
NameContains (string)
NextToken (string)
MaxResults (integer)
transcribe/list_medical_scribe_jobsProvides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned. To get detailed information about a specific Medical Scribe job, use the operation.Status (string)
JobNameContains (string)
NextToken (string)
MaxResults (integer)
transcribe/list_medical_transcription_jobsProvides 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.Status (string)
JobNameContains (string)
NextToken (string)
MaxResults (integer)
transcribe/list_medical_vocabulariesProvides 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.NextToken (string)
MaxResults (integer)
StateEquals (string)
NameContains (string)
transcribe/list_tags_for_resourceLists 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.ResourceArn (string) required
transcribe/list_transcription_jobsProvides 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.Status (string)
JobNameContains (string)
NextToken (string)
MaxResults (integer)
transcribe/list_vocabulariesProvides 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.NextToken (string)
MaxResults (integer)
StateEquals (string)
NameContains (string)
transcribe/list_vocabulary_filtersProvides 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.NextToken (string)
MaxResults (integer)
NameContains (string)
transcribe/start_call_analytics_jobTranscribes the audio from a customer service call and applies any additional Request Parameters you choose to include in your request. In addition to many 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 auCallAnalyticsJobName (string) required
Media: {
. MediaFileUri (string)
. RedactedMediaFileUri (string)
} (object) required
OutputLocation (string)
OutputEncryptionKMSKeyId (string)
DataAccessRoleArn (string)
Settings: {
. VocabularyName (string)
. VocabularyFilterName (string)
. VocabularyFilterMethod (string)
. LanguageModelName (string)
. ContentRedaction (object)
. LanguageOptions (array)
. LanguageIdSettings (object)
. Summarization (object)
} (object)
Tags (array)
ChannelDefinitions (array)
transcribe/start_medical_scribe_jobTranscribes patient-clinician conversations and generates clinical notes. Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe. To make a StartMedicalScribeJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 locatiMedicalScribeJobName (string) required
Media: {
. MediaFileUri (string)
. RedactedMediaFileUri (string)
} (object) required
OutputBucketName (string) required
OutputEncryptionKMSKeyId (string)
KMSEncryptionContext (object)
DataAccessRoleArn (string) required
Settings: {
. ShowSpeakerLabels (boolean)
. MaxSpeakerLabels (integer)
. ChannelIdentification (boolean)
. VocabularyName (string)
. VocabularyFilterName (string)
. VocabularyFilterMethod (string)
. ClinicalNoteGenerationSettings (object)
} (object) required
ChannelDefinitions (array)
Tags (array)
MedicalScribeContext: {
. PatientContext (object)
} (object)
transcribe/start_medical_transcription_jobTranscribes 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 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, youMedicalTranscriptionJobName (string) required
LanguageCode (string) required
MediaSampleRateHertz (integer)
MediaFormat (string)
Media: {
. MediaFileUri (string)
. RedactedMediaFileUri (string)
} (object) required
OutputBucketName (string) required
OutputKey (string)
OutputEncryptionKMSKeyId (string)
KMSEncryptionContext (object)
Settings: {
. ShowSpeakerLabels (boolean)
. MaxSpeakerLabels (integer)
. ChannelIdentification (boolean)
. ShowAlternatives (boolean)
. MaxAlternatives (integer)
. VocabularyName (string)
} (object)
ContentIdentificationType (string)
Specialty (string) required
Type (string) required
Tags (array)
transcribe/start_transcription_jobTranscribes 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 ServiceTranscriptionJobName (string) required
LanguageCode (string)
MediaSampleRateHertz (integer)
MediaFormat (string)
Media: {
. MediaFileUri (string)
. RedactedMediaFileUri (string)
} (object) required
OutputBucketName (string)
OutputKey (string)
OutputEncryptionKMSKeyId (string)
KMSEncryptionContext (object)
Settings: {
. VocabularyName (string)
. ShowSpeakerLabels (boolean)
. MaxSpeakerLabels (integer)
. ChannelIdentification (boolean)
. ShowAlternatives (boolean)
. MaxAlternatives (integer)
. VocabularyFilterName (string)
. VocabularyFilterMethod (string)
} (object)
ModelSettings: {
. LanguageModelName (string)
} (object)
JobExecutionSettings: {
. AllowDeferredExecution (boolean)
. DataAccessRoleArn (string)
} (object)
ContentRedaction: {
. RedactionType (string)
. RedactionOutput (string)
. PiiEntityTypes (array)
} (object)
IdentifyLanguage (boolean)
IdentifyMultipleLanguages (boolean)
LanguageOptions (array)
Subtitles: {
. Formats (array)
. OutputStartIndex (integer)
} (object)
Tags (array)
LanguageIdSettings (object)
ToxicityDetection (array)
transcribe/tag_resourceAdds 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.ResourceArn (string) required
Tags (array) required
transcribe/untag_resourceRemoves the specified tags from the specified Amazon Transcribe resource. If you include UntagResource in your request, you must also include ResourceArn and TagKeys.ResourceArn (string) required
TagKeys (array) required
transcribe/update_call_analytics_categoryUpdates 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 .CategoryName (string) required
Rules (array) required
InputType (string)
transcribe/update_medical_vocabularyUpdates 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 custom vocabulary.VocabularyName (string) required
LanguageCode (string) required
VocabularyFileUri (string) required
transcribe/update_vocabularyUpdates 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 custom vocabulary.VocabularyName (string) required
LanguageCode (string) required
Phrases (array)
VocabularyFileUri (string)
DataAccessRoleArn (string)
transcribe/update_vocabulary_filterUpdates 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 custom vocabulary filter.VocabularyFilterName (string) required
Words (array)
VocabularyFilterFileUri (string)
DataAccessRoleArn (string)
transfer/create_accessUsed 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.HomeDirectory (string)
HomeDirectoryType (string)
HomeDirectoryMappings (array)
Policy (string)
PosixProfile: {
. Uid (integer)
. Gid (integer)
. SecondaryGids (array)
} (object)
Role (string) required
ServerId (string) required
ExternalId (string) required
transfer/delete_accessAllows you to delete the access specified in the ServerID and ExternalID parameters.ServerId (string) required
ExternalId (string) required
transfer/delete_host_keyDeletes the host key that's specified in the HostKeyId parameter.ServerId (string) required
HostKeyId (string) required
transfer/delete_ssh_public_keyDeletes a user's Secure Shell SSH public key.ServerId (string) required
SshPublicKeyId (string) required
UserName (string) required
transfer/describe_accessDescribes 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.ServerId (string) required
ExternalId (string) required
transfer/describe_executionYou can use DescribeExecution to check the details of the execution of the specified workflow. This API call only returns details for in-progress workflows. If you provide an ID for an execution that is not in progress, or if the execution doesn't match the specified workflow ID, you receive a ResourceNotFound exception.ExecutionId (string) required
WorkflowId (string) required
transfer/describe_host_keyReturns the details of the host key that's specified by the HostKeyId and ServerId.ServerId (string) required
HostKeyId (string) required
transfer/describe_security_policyDescribes the security policy that is attached to your server or SFTP connector. The response contains a description of the security policy's properties. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.SecurityPolicyName (string) required
transfer/import_host_keyAdds a host key to the server that's specified by the ServerId parameter.ServerId (string) required
HostKeyBody (string) required
Description (string)
Tags (array)
transfer/import_ssh_public_keyAdds a Secure Shell SSH public key to a Transfer Family user 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.ServerId (string) required
SshPublicKeyBody (string) required
UserName (string) required
transfer/list_accessesLists the details for all the accesses you have on your server.MaxResults (integer)
NextToken (string)
ServerId (string) required
transfer/list_executionsLists all in-progress executions for the specified workflow. If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.MaxResults (integer)
NextToken (string)
WorkflowId (string) required
transfer/list_file_transfer_resultsReturns real-time updates and detailed information on the status of each individual file being transferred in a specific file transfer operation. You specify the file transfer by providing its ConnectorId and its TransferId. File transfer results are available up to 7 days after an operation has been requested.ConnectorId (string) required
TransferId (string) required
NextToken (string)
MaxResults (integer)
transfer/list_host_keysReturns a list of host keys for the server that's specified by the ServerId parameter.MaxResults (integer)
NextToken (string)
ServerId (string) required
transfer/list_security_policiesLists the security policies that are attached to your servers and SFTP connectors. For more information about security policies, see Working with security policies for servers or Working with security policies for SFTP connectors.MaxResults (integer)
NextToken (string)
transfer/list_tags_for_resourceLists all of the tags associated with the Amazon Resource Name ARN that you specify. The resource can be a user, server, or role.Arn (string) required
MaxResults (integer)
NextToken (string)
transfer/send_workflow_step_stateSends 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.WorkflowId (string) required
ExecutionId (string) required
Token (string) required
Status (string) required
transfer/start_directory_listingRetrieves a list of the contents of a directory from a remote SFTP server. You specify the connector ID, the output path, and the remote directory path. You can also specify the optional MaxItems value to control the maximum number of items that are listed from the remote directory. This API returns a list of all files and directories in the remote directory up to the maximum value, but does not return files or folders in sub-directories. That is, it only returns a list of files and directoriesConnectorId (string) required
RemoteDirectoryPath (string) required
MaxItems (integer)
OutputDirectoryPath (string) required
transfer/start_file_transferBegins a file transfer between local Amazon Web Services storage and a remote AS2 or SFTP server. For an AS2 connector, you specify the ConnectorId and one or more SendFilePaths to identify the files you want to transfer. For an SFTP connector, the file transfer can be either outbound or inbound. In both cases, you specify the ConnectorId. Depending on the direction of the transfer, you also specify the following items: If you are transferring file from a partner's SFTP server to Amazon Web ServConnectorId (string) required
SendFilePaths (array)
RetrieveFilePaths (array)
LocalDirectoryPath (string)
RemoteDirectoryPath (string)
CustomHttpHeaders (array)
transfer/start_remote_deleteDeletes a file or directory on the remote SFTP server.ConnectorId (string) required
DeletePath (string) required
transfer/start_remote_moveMoves or renames a file or directory on the remote SFTP server.ConnectorId (string) required
SourcePath (string) required
TargetPath (string) required
transfer/start_serverChanges 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.ServerId (string) required
transfer/stop_serverChanges 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 ableServerId (string) required
transfer/tag_resourceAttaches 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.Arn (string) required
Tags (array) required
transfer/test_connectionTests whether your SFTP connector is set up successfully. We highly recommend that you call this operation to test your ability to transfer files between local Amazon Web Services storage and a trading partner's SFTP server.ConnectorId (string) required
transfer/test_identity_providerIf 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 ServerProtocoServerId (string) required
ServerProtocol (string)
SourceIp (string)
UserName (string) required
UserPassword (string)
transfer/untag_resourceDetaches 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.Arn (string) required
TagKeys (array) required
transfer/update_accessAllows you to update parameters for the access specified in the ServerID and ExternalID parameters.HomeDirectory (string)
HomeDirectoryType (string)
HomeDirectoryMappings (array)
Policy (string)
PosixProfile: {
. Uid (integer)
. Gid (integer)
. SecondaryGids (array)
} (object)
Role (string)
ServerId (string) required
ExternalId (string) required
transfer/update_host_keyUpdates the description for the host key that's specified by the ServerId and HostKeyId parameters.ServerId (string) required
HostKeyId (string) required
Description (string) required
transfer/create_agreementCreates 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. Specify eiDescription (string)
ServerId (string) required
LocalProfileId (string) required
PartnerProfileId (string) required
BaseDirectory (string)
AccessRole (string) required
Status (string)
Tags (array)
PreserveFilename (string)
EnforceMessageSigning (string)
CustomDirectories: {
. FailedFilesDirectory (string)
. MdnFilesDirectory (string)
. PayloadFilesDirectory (string)
. StatusFilesDirectory (string)
. TemporaryFilesDirectory (string)
} (object)
transfer/describe_agreementDescribes the agreement that's identified by the AgreementId.AgreementId (string) required
ServerId (string) required
transfer/update_agreementUpdates 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. Specify either BaseDirectory or CustomDirectories, but not both. Specifying both causes the command to fail. If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custoAgreementId (string) required
ServerId (string) required
Description (string)
Status (string)
LocalProfileId (string)
PartnerProfileId (string)
BaseDirectory (string)
AccessRole (string)
PreserveFilename (string)
EnforceMessageSigning (string)
CustomDirectories: {
. FailedFilesDirectory (string)
. MdnFilesDirectory (string)
. PayloadFilesDirectory (string)
. StatusFilesDirectory (string)
. TemporaryFilesDirectory (string)
} (object)
transfer/delete_agreementDelete the agreement that's specified in the provided AgreementId.AgreementId (string) required
ServerId (string) required
transfer/list_agreementsReturns 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.MaxResults (integer)
NextToken (string)
ServerId (string) required
transfer/import_certificateImports the signing and encryption certificates that you need to create local AS2 profiles and partner profiles. You can import both the certificate and its chain in the Certificate parameter. After importing a certificate, Transfer Family automatically creates a Amazon CloudWatch metric called DaysUntilExpiry that tracks the number of days until the certificate expires. The metric is based on the InactiveDate parameter and is published daily in the AWS/Transfer namespace. It can take up to a fuUsage (string) required
Certificate (string) required
CertificateChain (string)
PrivateKey (string)
ActiveDate (string)
InactiveDate (string)
Description (string)
Tags (array)
transfer/describe_certificateDescribes the certificate that's identified by the CertificateId. Transfer Family automatically publishes a Amazon CloudWatch metric called DaysUntilExpiry for imported certificates. This metric tracks the number of days until the certificate expires based on the InactiveDate. The metric is available in the AWS/Transfer namespace and includes the CertificateId as a dimension.CertificateId (string) required
transfer/update_certificateUpdates the active and inactive dates for a certificate.CertificateId (string) required
ActiveDate (string)
InactiveDate (string)
Description (string)
transfer/delete_certificateDeletes the certificate that's specified in the CertificateId parameter.CertificateId (string) required
transfer/list_certificatesReturns 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.MaxResults (integer)
NextToken (string)
transfer/create_connectorCreates the connector, which captures the parameters for a connection for the AS2 or SFTP protocol. For AS2, the connector is required for sending files to an externally hosted AS2 server. For SFTP, the connector is required when sending files to an SFTP server or receiving files from an SFTP server. For more details about connectors, see Configure AS2 connectors and Create SFTP connectors. You must specify exactly one configuration object: either for AS2 As2Config or SFTP SftpConfig.Url (string)
As2Config: {
. LocalProfileId (string)
. PartnerProfileId (string)
. MessageSubject (string)
. Compression (string)
. EncryptionAlgorithm (string)
. SigningAlgorithm (string)
. MdnSigningAlgorithm (string)
. MdnResponse (string)
. BasicAuthSecretId (string)
. PreserveContentType (string)
. AsyncMdnConfig (object)
} (object)
AccessRole (string) required
LoggingRole (string)
Tags (array)
SftpConfig: {
. UserSecretId (string)
. TrustedHostKeys (array)
. MaxConcurrentConnections (integer)
} (object)
SecurityPolicyName (string)
EgressConfig (undefined)
transfer/describe_connectorDescribes the connector that's identified by the ConnectorId.ConnectorId (string) required
transfer/update_connectorUpdates 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.ConnectorId (string) required
Url (string)
As2Config: {
. LocalProfileId (string)
. PartnerProfileId (string)
. MessageSubject (string)
. Compression (string)
. EncryptionAlgorithm (string)
. SigningAlgorithm (string)
. MdnSigningAlgorithm (string)
. MdnResponse (string)
. BasicAuthSecretId (string)
. PreserveContentType (string)
. AsyncMdnConfig (object)
} (object)
AccessRole (string)
LoggingRole (string)
SftpConfig: {
. UserSecretId (string)
. TrustedHostKeys (array)
. MaxConcurrentConnections (integer)
} (object)
SecurityPolicyName (string)
EgressConfig (undefined)
transfer/delete_connectorDeletes the connector that's specified in the provided ConnectorId.ConnectorId (string) required
transfer/list_connectorsLists the connectors for the specified Region.MaxResults (integer)
NextToken (string)
transfer/create_profileCreates the local or partner profile to use for AS2 transfers.As2Id (string) required
ProfileType (string) required
CertificateIds (array)
Tags (array)
transfer/describe_profileReturns the details of the profile that's specified by the ProfileId.ProfileId (string) required
transfer/update_profileUpdates 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.ProfileId (string) required
CertificateIds (array)
transfer/delete_profileDeletes the profile that's specified in the ProfileId parameter.ProfileId (string) required
transfer/list_profilesReturns 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.MaxResults (integer)
NextToken (string)
ProfileType (string)
transfer/create_serverInstantiates 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.Certificate (string)
Domain (string)
EndpointDetails: {
. AddressAllocationIds (array)
. SubnetIds (array)
. VpcEndpointId (string)
. VpcId (string)
. SecurityGroupIds (array)
} (object)
EndpointType (string)
HostKey (string)
IdentityProviderDetails: {
. Url (string)
. InvocationRole (string)
. DirectoryId (string)
. Function (string)
. SftpAuthenticationMethods (string)
} (object)
IdentityProviderType (string)
LoggingRole (string)
PostAuthenticationLoginBanner (string)
PreAuthenticationLoginBanner (string)
Protocols (array)
ProtocolDetails: {
. PassiveIp (string)
. TlsSessionResumptionMode (string)
. SetStatOption (string)
. As2Transports (array)
} (object)
SecurityPolicyName (string)
Tags (array)
WorkflowDetails: {
. OnUpload (array)
. OnPartialUpload (array)
} (object)
StructuredLogDestinations (array)
S3StorageOptions: {
. DirectoryListingOptimization (string)
} (object)
IpAddressType (string)
transfer/describe_serverDescribes 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.ServerId (string) required
transfer/update_serverUpdates 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.Certificate (string)
ProtocolDetails: {
. PassiveIp (string)
. TlsSessionResumptionMode (string)
. SetStatOption (string)
. As2Transports (array)
} (object)
EndpointDetails: {
. AddressAllocationIds (array)
. SubnetIds (array)
. VpcEndpointId (string)
. VpcId (string)
. SecurityGroupIds (array)
} (object)
EndpointType (string)
HostKey (string)
IdentityProviderDetails: {
. Url (string)
. InvocationRole (string)
. DirectoryId (string)
. Function (string)
. SftpAuthenticationMethods (string)
} (object)
LoggingRole (string)
PostAuthenticationLoginBanner (string)
PreAuthenticationLoginBanner (string)
Protocols (array)
SecurityPolicyName (string)
ServerId (string) required
WorkflowDetails: {
. OnUpload (array)
. OnPartialUpload (array)
} (object)
StructuredLogDestinations (array)
S3StorageOptions: {
. DirectoryListingOptimization (string)
} (object)
IpAddressType (string)
IdentityProviderType (string)
transfer/delete_serverDeletes the file transfer protocol-enabled server that you specify. No response returns from this operation.ServerId (string) required
transfer/list_serversLists the file transfer protocol-enabled servers that are associated with your Amazon Web Services account.MaxResults (integer)
NextToken (string)
transfer/describe_userDescribes 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.ServerId (string) required
UserName (string) required
transfer/update_userAssigns 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. In the console, you can select Restricted when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to configure this behavior is to update the user. Set their HomeDirectoryTypeHomeDirectory (string)
HomeDirectoryType (string)
HomeDirectoryMappings (array)
Policy (string)
PosixProfile: {
. Uid (integer)
. Gid (integer)
. SecondaryGids (array)
} (object)
Role (string)
ServerId (string) required
UserName (string) required
transfer/delete_userDeletes 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.ServerId (string) required
UserName (string) required
transfer/list_usersLists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.MaxResults (integer)
NextToken (string)
ServerId (string) required
transfer/create_userCreates 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 forHomeDirectory (string)
HomeDirectoryType (string)
HomeDirectoryMappings (array)
Policy (string)
PosixProfile: {
. Uid (integer)
. Gid (integer)
. SecondaryGids (array)
} (object)
Role (string) required
ServerId (string) required
SshPublicKeyBody (string)
Tags (array)
UserName (string) required
transfer/describe_web_app_customizationDescribes the web app customization object that's identified by WebAppId.WebAppId (string) required
transfer/update_web_app_customizationAssigns new customization properties to a web app. You can modify the icon file, logo file, and title.WebAppId (string) required
Title (string)
LogoFile (string)
FaviconFile (string)
transfer/delete_web_app_customizationDeletes the WebAppCustomization object that corresponds to the web app ID specified.WebAppId (string) required
transfer/create_web_appCreates a web app based on specified parameters, and returns the ID for the new web app. You can configure the web app to be publicly accessible or hosted within a VPC. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.IdentityProviderDetails (undefined) required
AccessEndpoint (string)
WebAppUnits (undefined)
Tags (array)
WebAppEndpointPolicy (string)
EndpointDetails (undefined)
transfer/describe_web_appDescribes the web app that's identified by WebAppId. The response includes endpoint configuration details such as whether the web app is publicly accessible or VPC hosted. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.WebAppId (string) required
transfer/update_web_appAssigns new properties to a web app. You can modify the access point, identity provider details, endpoint configuration, and the web app units. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.WebAppId (string) required
IdentityProviderDetails (undefined)
AccessEndpoint (string)
WebAppUnits (undefined)
EndpointDetails (undefined)
transfer/delete_web_appDeletes the specified web app.WebAppId (string) required
transfer/list_web_appsLists all web apps associated with your Amazon Web Services account for your current region. The response includes the endpoint type for each web app, showing whether it is publicly accessible or VPC hosted. For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.MaxResults (integer)
NextToken (string)
transfer/create_workflowAllows 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.Description (string)
Steps (array) required
OnExceptionSteps (array)
Tags (array)
transfer/describe_workflowDescribes the specified workflow.WorkflowId (string) required
transfer/delete_workflowDeletes the specified workflow.WorkflowId (string) required
transfer/list_workflowsLists all workflows associated with your Amazon Web Services account for your current region.MaxResults (integer)
NextToken (string)
translate/create_parallel_dataCreates 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.Name (string) required
Description (string)
ParallelDataConfig: {
. S3Uri (string)
. Format (string)
} (object) required
EncryptionKey: {
. Type (string)
. Id (string)
} (object)
ClientToken (string) required
Tags (array)
translate/delete_parallel_dataDeletes a parallel data resource in Amazon Translate.Name (string) required
translate/delete_terminologyA synchronous action that deletes a custom terminology.Name (string) required
translate/describe_text_translation_jobGets the properties associated with an asynchronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.JobId (string) required
translate/get_parallel_dataProvides information about a parallel data resource.Name (string) required
translate/get_terminologyRetrieves a custom terminology.Name (string) required
TerminologyDataFormat (string)
translate/import_terminologyCreates 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. AftName (string) required
MergeStrategy (string) required
Description (string)
TerminologyData: {
. File (string)
. Format (string)
. Directionality (string)
} (object) required
EncryptionKey: {
. Type (string)
. Id (string)
} (object)
Tags (array)
translate/list_languagesProvides a list of languages RFC-5646 codes and names that Amazon Translate supports.DisplayLanguageCode (string)
NextToken (string)
MaxResults (integer)
translate/list_parallel_dataProvides a list of your parallel data resources in Amazon Translate.NextToken (string)
MaxResults (integer)
translate/list_tags_for_resourceLists all tags associated with a given Amazon Translate resource. For more information, see Tagging your resources.ResourceArn (string) required
translate/list_terminologiesProvides a list of custom terminologies associated with your account.NextToken (string)
MaxResults (integer)
translate/list_text_translation_jobsGets a list of the batch translation jobs that you have submitted.Filter: {
. JobName (string)
. JobStatus (string)
. SubmittedBeforeTime (string)
. SubmittedAfterTime (string)
} (object)
NextToken (string)
MaxResults (integer)
translate/start_text_translation_jobStarts an asynchronous batch translation job. Use batch translation jobs to translate large volumes of text across multiple documents at once. For batch translation, you can input documents with different source languages specify auto as the source language. You can specify one or more target languages. Batch translation translates each input document into each of the target languages. For more information, see Asynchronous batch processing. Batch translation jobs can be described with the DescrJobName (string)
InputDataConfig: {
. S3Uri (string)
. ContentType (string)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. EncryptionKey (object)
} (object) required
DataAccessRoleArn (string) required
SourceLanguageCode (string) required
TargetLanguageCodes (array) required
TerminologyNames (array)
ParallelDataNames (array)
ClientToken (string) required
Settings: {
. Formality (string)
. Profanity (string)
. Brevity (string)
} (object)
translate/stop_text_translation_jobStops 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 tJobId (string) required
translate/tag_resourceAssociates a specific tag with a resource. A tag is a key-value pair that adds as a metadata to a resource. For more information, see Tagging your resources.ResourceArn (string) required
Tags (array) required
translate/translate_documentTranslates the input document from the source language to the target language. This synchronous operation supports text, HTML, or Word documents as the input document. TranslateDocument supports translations from English to any supported language, and from any supported language to English. Therefore, specify either the source language code or the target language code as “en” English. If you set the Formality parameter, the request will fail if the target language does not support formality. ForDocument: {
. Content (string)
. ContentType (string)
} (object) required
TerminologyNames (array)
SourceLanguageCode (string) required
TargetLanguageCode (string) required
Settings: {
. Formality (string)
. Profanity (string)
. Brevity (string)
} (object)
translate/translate_textTranslates input text from the source language to the target language. For a list of available languages and language codes, see Supported languages.Text (string) required
TerminologyNames (array)
SourceLanguageCode (string) required
TargetLanguageCode (string) required
Settings: {
. Formality (string)
. Profanity (string)
. Brevity (string)
} (object)
translate/untag_resourceRemoves a specific tag associated with an Amazon Translate resource. For more information, see Tagging your resources.ResourceArn (string) required
TagKeys (array) required
translate/update_parallel_dataUpdates a previously created parallel data resource by importing a new input file from Amazon S3.Name (string) required
Description (string)
ParallelDataConfig: {
. S3Uri (string)
. Format (string)
} (object) required
ClientToken (string) required
trustedadvisor/batch_update_recommendation_resource_exclusionUpdate one or more exclusion status for a list of recommendation resourcesrecommendationResourceExclusions (array) required
trustedadvisor/get_organization_recommendationGet a specific recommendation within an AWS Organizations organization. This API supports only prioritized recommendations.organizationRecommendationIdentifier (string) required
trustedadvisor/get_recommendationGet a specific RecommendationrecommendationIdentifier (string) required
trustedadvisor/list_checksList a filterable set of ChecksnextToken (string)
maxResults (integer)
pillar (string)
awsService (string)
source (string)
language (string)
trustedadvisor/list_organization_recommendation_accountsLists the accounts that own the resources for an organization aggregate recommendation. This API only supports prioritized recommendations.nextToken (string)
maxResults (integer)
organizationRecommendationIdentifier (string) required
affectedAccountId (string)
trustedadvisor/list_organization_recommendation_resourcesList Resources of a Recommendation within an Organization. This API only supports prioritized recommendations.nextToken (string)
maxResults (integer)
status (string)
exclusionStatus (string)
regionCode (string)
organizationRecommendationIdentifier (string) required
affectedAccountId (string)
trustedadvisor/list_organization_recommendationsList a filterable set of Recommendations within an Organization. This API only supports prioritized recommendations.nextToken (string)
maxResults (integer)
type (string)
status (string)
pillar (string)
awsService (string)
source (string)
checkIdentifier (string)
afterLastUpdatedAt (string)
beforeLastUpdatedAt (string)
trustedadvisor/list_recommendation_resourcesList Resources of a RecommendationnextToken (string)
maxResults (integer)
status (string)
exclusionStatus (string)
regionCode (string)
recommendationIdentifier (string) required
trustedadvisor/list_recommendationsList a filterable set of RecommendationsnextToken (string)
maxResults (integer)
type (string)
status (string)
pillar (string)
awsService (string)
source (string)
checkIdentifier (string)
afterLastUpdatedAt (string)
beforeLastUpdatedAt (string)
trustedadvisor/update_organization_recommendation_lifecycleUpdate the lifecycle of a Recommendation within an Organization. This API only supports prioritized recommendations.lifecycleStage (string) required
updateReason (string)
updateReasonCode (string)
organizationRecommendationIdentifier (string) required
trustedadvisor/update_recommendation_lifecycleUpdate the lifecyle of a Recommendation. This API only supports prioritized recommendations.lifecycleStage (string) required
updateReason (string)
updateReasonCode (string)
recommendationIdentifier (string) required
verifiedpermissions/list_tags_for_resourceReturns the tags associated with the specified Amazon Verified Permissions resource. In Verified Permissions, policy stores can be tagged.resourceArn (string) required
verifiedpermissions/tag_resourceAssigns one or more tags key-value pairs to the specified Amazon Verified Permissions 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 Verified Permissions, policy stores 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 withresourceArn (string) required
tags (object) required
verifiedpermissions/untag_resourceRemoves one or more tags from the specified Amazon Verified Permissions resource. In Verified Permissions, policy stores can be tagged.resourceArn (string) required
tagKeys (array) required
verifiedpermissions/batch_is_authorizedMakes a series of decisions about multiple authorization requests for one principal or resource. Each request contains the equivalent content of an IsAuthorized request: principal, action, resource, and context. Either the principal or the resource parameter must be identical across all requests. For example, Verified Permissions won't evaluate a pair of requests where bob views photo1 and alice views photo2. Authorization of bob to view photo1 and photo2, or bob and alice to view photo1, are vapolicyStoreId (string) required
entities (undefined)
requests (array) required
verifiedpermissions/batch_is_authorized_with_tokenMakes a series of decisions about multiple authorization requests for one token. The principal in this request comes from an external identity source in the form of an identity or access token, formatted as a JSON web token JWT. The information in the parameters can also define additional context that Verified Permissions can include in the evaluations. The request is evaluated against all policies in the specified policy store that match the entities that you provide in the entities declarationpolicyStoreId (string) required
identityToken (string)
accessToken (string)
entities (undefined)
requests (array) required
verifiedpermissions/get_schemaRetrieve the details for the specified schema in the specified policy store.policyStoreId (string) required
verifiedpermissions/is_authorizedMakes an authorization decision about a service request described in the parameters. The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.policyStoreId (string) required
principal: {
. entityType (string)
. entityId (string)
} (object)
action: {
. actionType (string)
. actionId (string)
} (object)
resource: {
. entityType (string)
. entityId (string)
} (object)
context (undefined)
entities (undefined)
verifiedpermissions/is_authorized_with_tokenMakes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity token formatted as a JSON web token JWT. The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a lpolicyStoreId (string) required
identityToken (string)
accessToken (string)
action: {
. actionType (string)
. actionId (string)
} (object)
resource: {
. entityType (string)
. entityId (string)
} (object)
context (undefined)
entities (undefined)
verifiedpermissions/put_schemaCreates or updates the policy schema in the specified policy store. The schema is used to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time. Verified Permissions is eventually consistent . It can take a fpolicyStoreId (string) required
definition (undefined) required
verifiedpermissions/batch_get_policyRetrieves information about a group batch of policies. The BatchGetPolicy operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission verifiedpermissions:GetPolicy in their IAM policies.requests (array) required
verifiedpermissions/create_policy_storeCreates a policy store. A policy store is a container for policy resources. Although Cedar supports multiple namespaces, Verified Permissions currently supports only one namespace per policy store. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.clientToken (string)
validationSettings: {
. mode (string)
} (object) required
description (string)
deletionProtection (string)
encryptionSettings (undefined)
tags (object)
verifiedpermissions/get_policy_storeRetrieves details about a policy store.policyStoreId (string) required
tags (boolean)
verifiedpermissions/update_policy_storeModifies the validation setting for a policy store. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.policyStoreId (string) required
validationSettings: {
. mode (string)
} (object) required
deletionProtection (string)
description (string)
verifiedpermissions/delete_policy_storeDeletes the specified policy store. This operation is idempotent. If you specify a policy store that does not exist, the request response will still return a successful HTTP 200 status code.policyStoreId (string) required
verifiedpermissions/list_policy_storesReturns a paginated list of all policy stores in the calling Amazon Web Services account.nextToken (string)
maxResults (integer)
verifiedpermissions/create_identity_sourceAdds an identity source to a policy store–an Amazon Cognito user pool or OpenID Connect OIDC identity provider IdP. After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken or BatchIsAuthorizedWithToken API operations. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Identity sources provide identity ID tokeclientToken (string)
policyStoreId (string) required
configuration (undefined) required
principalEntityType (string)
verifiedpermissions/get_identity_sourceRetrieves the details about the specified identity source.policyStoreId (string) required
identitySourceId (string) required
verifiedpermissions/update_identity_sourceUpdates the specified identity source to use a new identity provider IdP, or to change the mapping of identities from the IdP to a different principal entity type. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.policyStoreId (string) required
identitySourceId (string) required
updateConfiguration (undefined) required
principalEntityType (string)
verifiedpermissions/delete_identity_sourceDeletes an identity source that references an identity provider IdP such as Amazon Cognito. After you delete the identity source, you can no longer use tokens for identities from that identity source to represent principals in authorization queries made using IsAuthorizedWithToken. operations.policyStoreId (string) required
identitySourceId (string) required
verifiedpermissions/list_identity_sourcesReturns a paginated list of all of the identity sources defined in the specified policy store.policyStoreId (string) required
nextToken (string)
maxResults (integer)
filters (array)
verifiedpermissions/create_policyCreates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template. To create a static policy, provide the Cedar policy text in the StaticPolicy section of the PolicyDefinition. To create a policy that is dynamically linked to a policy template, specify the policy template ID and the principal and resource to associate with this policy in the templateLinked section of the PolicyDefinition. If the policy template is eveclientToken (string)
policyStoreId (string) required
definition (undefined) required
verifiedpermissions/get_policyRetrieves information about the specified policy.policyStoreId (string) required
policyId (string) required
verifiedpermissions/update_policyModifies a Cedar static policy in the specified policy store. You can change only certain elements of the UpdatePolicyDefinition parameter. You can directly update only static policies. To change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate. If policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to validate the policy against the schema in the policy store. If the updated static policy doesn't ppolicyStoreId (string) required
policyId (string) required
definition (undefined)
verifiedpermissions/delete_policyDeletes the specified policy from the policy store. This operation is idempotent; if you specify a policy that doesn't exist, the request response returns a successful HTTP 200 status code.policyStoreId (string) required
policyId (string) required
verifiedpermissions/list_policiesReturns a paginated list of all policies stored in the specified policy store.policyStoreId (string) required
nextToken (string)
maxResults (integer)
filter: {
. principal
. resource
. policyType (string)
. policyTemplateId (string)
} (object)
verifiedpermissions/create_policy_templateCreates a policy template. A template can use placeholders for the principal and resource. A template must be instantiated into a policy by associating it with specific principals and resources to use for the placeholders. That instantiated policy can then be considered in authorization decisions. The instantiated policy works identically to any other policy, except that it is dynamically linked to the template. If the template changes, then any policies that are linked to that template are immeclientToken (string)
policyStoreId (string) required
description (string)
statement (string) required
verifiedpermissions/get_policy_templateRetrieve the details for the specified policy template in the specified policy store.policyStoreId (string) required
policyTemplateId (string) required
verifiedpermissions/update_policy_templateUpdates the specified policy template. You can update only the description and the some elements of the policyBody. Changes you make to the policy template content are immediately within the constraints of eventual consistency reflected in authorization decisions that involve all template-linked policies instantiated from this template. Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the respolicyStoreId (string) required
policyTemplateId (string) required
description (string)
statement (string) required
verifiedpermissions/delete_policy_templateDeletes the specified policy template from the policy store. This operation also deletes any policies that were created from the specified policy template. Those policies are immediately removed from all future API responses, and are asynchronously deleted from the policy store.policyStoreId (string) required
policyTemplateId (string) required
verifiedpermissions/list_policy_templatesReturns a paginated list of all policy templates in the specified policy store.policyStoreId (string) required
nextToken (string)
maxResults (integer)
voice_id/associate_fraudsterAssociates the fraudsters with the watchlist specified in the same domain.DomainId (string) required
WatchlistId (string) required
FraudsterId (string) required
voice_id/create_watchlistCreates a watchlist that fraudsters can be a part of.DomainId (string) required
Name (string) required
Description (string)
ClientToken (string)
voice_id/delete_fraudsterDeletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.DomainId (string) required
FraudsterId (string) required
voice_id/delete_speakerDeletes the specified speaker from Voice ID.DomainId (string) required
SpeakerId (string) required
voice_id/delete_watchlistDeletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted.DomainId (string) required
WatchlistId (string) required
voice_id/describe_fraudsterDescribes the specified fraudster.DomainId (string) required
FraudsterId (string) required
voice_id/describe_fraudster_registration_jobDescribes the specified fraudster registration job.DomainId (string) required
JobId (string) required
voice_id/describe_speakerDescribes the specified speaker.DomainId (string) required
SpeakerId (string) required
voice_id/describe_speaker_enrollment_jobDescribes the specified speaker enrollment job.DomainId (string) required
JobId (string) required
voice_id/describe_watchlistDescribes the specified watchlist.DomainId (string) required
WatchlistId (string) required
voice_id/disassociate_fraudsterDisassociates the fraudsters from the watchlist specified. Voice ID always expects a fraudster to be a part of at least one watchlist. If you try to disassociate a fraudster from its only watchlist, a ValidationException is thrown.DomainId (string) required
WatchlistId (string) required
FraudsterId (string) required
voice_id/evaluate_sessionEvaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.DomainId (string) required
SessionNameOrId (string) required
voice_id/list_fraudster_registration_jobsLists 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.DomainId (string) required
JobStatus (string)
MaxResults (integer)
NextToken (string)
voice_id/list_fraudstersLists all fraudsters in a specified watchlist or domain.DomainId (string) required
WatchlistId (string)
MaxResults (integer)
NextToken (string)
voice_id/list_speaker_enrollment_jobsLists 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.DomainId (string) required
JobStatus (string)
MaxResults (integer)
NextToken (string)
voice_id/list_speakersLists all speakers in a specified domain.DomainId (string) required
MaxResults (integer)
NextToken (string)
voice_id/list_tags_for_resourceLists all tags associated with a specified Voice ID resource.ResourceArn (string) required
voice_id/list_watchlistsLists all watchlists in a specified domain.DomainId (string) required
MaxResults (integer)
NextToken (string)
voice_id/opt_out_speakerOpts 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.DomainId (string) required
SpeakerId (string) required
voice_id/start_fraudster_registration_jobStarts a new batch fraudster registration job using provided details.ClientToken (string)
JobName (string)
DomainId (string) required
DataAccessRoleArn (string) required
RegistrationConfig: {
. DuplicateRegistrationAction (string)
. FraudsterSimilarityThreshold (integer)
. WatchlistIds (array)
} (object)
InputDataConfig: {
. S3Uri (string)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. KmsKeyId (string)
} (object) required
voice_id/start_speaker_enrollment_jobStarts a new batch speaker enrollment job using specified details.ClientToken (string)
JobName (string)
DomainId (string) required
DataAccessRoleArn (string) required
EnrollmentConfig: {
. ExistingEnrollmentAction (string)
. FraudDetectionConfig (object)
} (object)
InputDataConfig: {
. S3Uri (string)
} (object) required
OutputDataConfig: {
. S3Uri (string)
. KmsKeyId (string)
} (object) required
voice_id/tag_resourceTags a Voice ID resource with the provided list of tags.ResourceArn (string) required
Tags (array) required
voice_id/untag_resourceRemoves specified tags from a specified Amazon Connect Voice ID resource.ResourceArn (string) required
TagKeys (array) required
voice_id/update_watchlistUpdates the specified watchlist. Every domain has a default watchlist which cannot be updated.DomainId (string) required
WatchlistId (string) required
Name (string)
Description (string)
voice_id/create_domainCreates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.Name (string) required
Description (string)
ServerSideEncryptionConfiguration: {
. KmsKeyId (string)
} (object) required
ClientToken (string)
Tags (array)
voice_id/describe_domainDescribes the specified domain.DomainId (string) required
voice_id/update_domainUpdates 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.DomainId (string) required
Name (string) required
Description (string)
ServerSideEncryptionConfiguration: {
. KmsKeyId (string)
} (object) required
voice_id/delete_domainDeletes the specified domain from Voice ID.DomainId (string) required
voice_id/list_domainsLists all the domains in the Amazon Web Services account.MaxResults (integer)
NextToken (string)
vpc_lattice/batch_update_ruleUpdates the listener rules in a batch. You can use this operation to change the priority of listener rules. This can be useful when bulk updating or swapping rule priority. Required permissions: vpc-lattice:UpdateRule For more information, see How Amazon VPC Lattice works with IAM in the Amazon VPC Lattice User Guide.serviceIdentifier (string) required
listenerIdentifier (string) required
rules (array) required
vpc_lattice/delete_auth_policyDeletes the specified auth policy. If an auth is set to AWS_IAM and the auth policy is deleted, all requests are denied. If you are trying to remove the auth policy completely, you must set the auth type to NONE. If auth is enabled on the resource, but no auth policy is set, all requests are denied.resourceIdentifier (string) required
vpc_lattice/delete_resource_policyDeletes the specified resource policy.resourceArn (string) required
vpc_lattice/get_auth_policyRetrieves information about the auth policy for the specified service or service network.resourceIdentifier (string) required
vpc_lattice/get_resource_policyRetrieves information about the specified resource policy. The resource policy is an IAM policy created on behalf of the resource owner when they share a resource.resourceArn (string) required
vpc_lattice/list_service_network_vpc_endpoint_associationsLists the associations between a service network and a VPC endpoint.serviceNetworkIdentifier (string) required
maxResults (integer)
nextToken (string)
vpc_lattice/list_tags_for_resourceLists the tags for the specified resource.resourceArn (string) required
vpc_lattice/put_auth_policyCreates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines. For more information, see Auth policies in the Amazon VPC Lattice User Guide.resourceIdentifier (string) required
policy (string) required
vpc_lattice/put_resource_policyAttaches a resource-based permission policy to a service or service network. The policy must contain the same actions and condition statements as the Amazon Web Services Resource Access Manager permission for sharing services and service networks.resourceArn (string) required
policy (string) required
vpc_lattice/tag_resourceAdds the specified tags to the specified resource.resourceArn (string) required
tags (object) required
vpc_lattice/untag_resourceRemoves the specified tags from the specified resource.resourceArn (string) required
tagKeys (array) required
vpc_lattice/create_access_log_subscriptionEnables access logs to be sent to Amazon CloudWatch, Amazon S3, and Amazon Kinesis Data Firehose. The service network owner can use the access logs to audit the services in the network. The service network owner can only see access logs from clients and services that are associated with their service network. Access log entries represent traffic originated from VPCs associated with that network. For more information, see Access logs in the Amazon VPC Lattice User Guide.clientToken (string)
resourceIdentifier (string) required
destinationArn (string) required
serviceNetworkLogType (string)
tags (object)
vpc_lattice/get_access_log_subscriptionRetrieves information about the specified access log subscription.accessLogSubscriptionIdentifier (string) required
vpc_lattice/update_access_log_subscriptionUpdates the specified access log subscription.accessLogSubscriptionIdentifier (string) required
destinationArn (string) required
vpc_lattice/delete_access_log_subscriptionDeletes the specified access log subscription.accessLogSubscriptionIdentifier (string) required
vpc_lattice/list_access_log_subscriptionsLists the access log subscriptions for the specified service network or service.resourceIdentifier (string) required
maxResults (integer)
nextToken (string)
vpc_lattice/start_domain_verificationStarts the domain verification process for a custom domain name.clientToken (string)
domainName (string) required
tags (object)
vpc_lattice/get_domain_verificationRetrieves information about a domain verification.ßdomainVerificationIdentifier (string) required
vpc_lattice/delete_domain_verificationDeletes the specified domain verification.domainVerificationIdentifier (string) required
vpc_lattice/list_domain_verificationsLists the domain verifications.maxResults (integer)
nextToken (string)
vpc_lattice/create_listenerCreates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services. For more information, see Listeners in the Amazon VPC Lattice User Guide.serviceIdentifier (string) required
name (string) required
protocol (string) required
port (integer)
defaultAction (undefined) required
clientToken (string)
tags (object)
vpc_lattice/get_listenerRetrieves information about the specified listener for the specified service.serviceIdentifier (string) required
listenerIdentifier (string) required
vpc_lattice/update_listenerUpdates the specified listener for the specified service.serviceIdentifier (string) required
listenerIdentifier (string) required
defaultAction (undefined) required
vpc_lattice/delete_listenerDeletes the specified listener.serviceIdentifier (string) required
listenerIdentifier (string) required
vpc_lattice/list_listenersLists the listeners for the specified service.serviceIdentifier (string) required
maxResults (integer)
nextToken (string)
vpc_lattice/create_resource_configurationCreates a resource configuration. A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.name (string) required
type (string) required
portRanges (array)
protocol (string)
resourceGatewayIdentifier (string)
resourceConfigurationGroupIdentifier (string)
resourceConfigurationDefinition (undefined)
allowAssociationToShareableServiceNetwork (boolean)
customDomainName (string)
groupDomain (string)
domainVerificationIdentifier (string)
clientToken (string)
tags (object)
vpc_lattice/get_resource_configurationRetrieves information about the specified resource configuration.resourceConfigurationIdentifier (string) required
vpc_lattice/update_resource_configurationUpdates the specified resource configuration.resourceConfigurationIdentifier (string) required
resourceConfigurationDefinition (undefined)
allowAssociationToShareableServiceNetwork (boolean)
portRanges (array)
vpc_lattice/delete_resource_configurationDeletes the specified resource configuration.resourceConfigurationIdentifier (string) required
vpc_lattice/list_resource_configurationsLists the resource configurations owned by or shared with this account.resourceGatewayIdentifier (string)
resourceConfigurationGroupIdentifier (string)
domainVerificationIdentifier (string)
maxResults (integer)
nextToken (string)
vpc_lattice/delete_resource_endpoint_associationDisassociates the resource configuration from the resource VPC endpoint.resourceEndpointAssociationIdentifier (string) required
vpc_lattice/list_resource_endpoint_associationsLists the associations for the specified VPC endpoint.resourceConfigurationIdentifier (string) required
resourceEndpointAssociationIdentifier (string)
vpcEndpointId (string)
vpcEndpointOwner (string)
maxResults (integer)
nextToken (string)
vpc_lattice/create_resource_gatewayA resource gateway is a point of ingress into the VPC where a resource resides. It spans multiple Availability Zones. For your resource to be accessible from all Availability Zones, you should create your resource gateways to span as many Availability Zones as possible. A VPC can have multiple resource gateways.clientToken (string)
name (string) required
vpcIdentifier (string)
subnetIds (array)
securityGroupIds (array)
ipAddressType (string)
ipv4AddressesPerEni (integer)
tags (object)
vpc_lattice/get_resource_gatewayRetrieves information about the specified resource gateway.resourceGatewayIdentifier (string) required
vpc_lattice/update_resource_gatewayUpdates the specified resource gateway.resourceGatewayIdentifier (string) required
securityGroupIds (array)
vpc_lattice/delete_resource_gatewayDeletes the specified resource gateway.resourceGatewayIdentifier (string) required
vpc_lattice/list_resource_gatewaysLists the resource gateways that you own or that were shared with you.maxResults (integer)
nextToken (string)
vpc_lattice/create_ruleCreates a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. For more information, see Listener rules in the Amazon VPC Lattice User Guide.serviceIdentifier (string) required
listenerIdentifier (string) required
name (string) required
match (undefined) required
priority (integer) required
action (undefined) required
clientToken (string)
tags (object)
vpc_lattice/get_ruleRetrieves information about the specified listener rules. You can also retrieve information about the default listener rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.serviceIdentifier (string) required
listenerIdentifier (string) required
ruleIdentifier (string) required
vpc_lattice/update_ruleUpdates a specified rule for the listener. You can't modify a default listener rule. To modify a default listener rule, use UpdateListener.serviceIdentifier (string) required
listenerIdentifier (string) required
ruleIdentifier (string) required
match (undefined)
priority (integer)
action (undefined)
vpc_lattice/delete_ruleDeletes a listener rule. Each listener has a default rule for checking connection requests, but you can define additional rules. Each rule consists of a priority, one or more actions, and one or more conditions. You can delete additional listener rules, but you cannot delete the default rule. For more information, see Listener rules in the Amazon VPC Lattice User Guide.serviceIdentifier (string) required
listenerIdentifier (string) required
ruleIdentifier (string) required
vpc_lattice/list_rulesLists the rules for the specified listener.serviceIdentifier (string) required
listenerIdentifier (string) required
maxResults (integer)
nextToken (string)
vpc_lattice/create_serviceCreates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud VPC. For more information, see Services in the Amazon VPC Lattice User Guide.clientToken (string)
name (string) required
tags (object)
customDomainName (string)
certificateArn (string)
authType (string)
vpc_lattice/get_serviceRetrieves information about the specified service.serviceIdentifier (string) required
vpc_lattice/update_serviceUpdates the specified service.serviceIdentifier (string) required
certificateArn (string)
authType (string)
vpc_lattice/delete_serviceDeletes a service. A service can't be deleted if it's associated with a service network. If you delete a service, all resources related to the service, such as the resource policy, auth policy, listeners, listener rules, and access log subscriptions, are also deleted. For more information, see Delete a service in the Amazon VPC Lattice User Guide.serviceIdentifier (string) required
vpc_lattice/list_servicesLists the services owned by the caller account or shared with the caller account.maxResults (integer)
nextToken (string)
vpc_lattice/create_service_networkCreates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network. For more information, see Service networks in the Amazon VPC Lattice User Guide.clientToken (string)
name (string) required
authType (string)
tags (object)
sharingConfig: {
. enabled (boolean)
} (object)
vpc_lattice/get_service_networkRetrieves information about the specified service network.serviceNetworkIdentifier (string) required
vpc_lattice/update_service_networkUpdates the specified service network.serviceNetworkIdentifier (string) required
authType (string) required
vpc_lattice/delete_service_networkDeletes a service network. You can only delete the service network if there is no service or VPC associated with it. If you delete a service network, all resources related to the service network, such as the resource policy, auth policy, and access log subscriptions, are also deleted. For more information, see Delete a service network in the Amazon VPC Lattice User Guide.serviceNetworkIdentifier (string) required
vpc_lattice/list_service_networksLists the service networks owned by or shared with this account. The account ID in the ARN shows which account owns the service network.maxResults (integer)
nextToken (string)
vpc_lattice/create_service_network_resource_associationAssociates the specified service network with the specified resource configuration. This allows the resource configuration to receive connections through the service network, including through a service network VPC endpoint.clientToken (string)
resourceConfigurationIdentifier (string) required
serviceNetworkIdentifier (string) required
privateDnsEnabled (boolean)
tags (object)
vpc_lattice/get_service_network_resource_associationRetrieves information about the specified association between a service network and a resource configuration.serviceNetworkResourceAssociationIdentifier (string) required
vpc_lattice/delete_service_network_resource_associationDeletes the association between a service network and a resource configuration.serviceNetworkResourceAssociationIdentifier (string) required
vpc_lattice/list_service_network_resource_associationsLists the associations between a service network and a resource configuration.serviceNetworkIdentifier (string)
resourceConfigurationIdentifier (string)
maxResults (integer)
nextToken (string)
includeChildren (boolean)
vpc_lattice/create_service_network_service_associationAssociates the specified service with the specified service network. For more information, see Manage service associations in the Amazon VPC Lattice User Guide. You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it. You cannot associate a service and service network that are shared with a caller. The caller mclientToken (string)
serviceIdentifier (string) required
serviceNetworkIdentifier (string) required
tags (object)
vpc_lattice/get_service_network_service_associationRetrieves information about the specified association between a service network and a service.serviceNetworkServiceAssociationIdentifier (string) required
vpc_lattice/delete_service_network_service_associationDeletes the association between a service and a service network. This operation fails if an association is still in progress.serviceNetworkServiceAssociationIdentifier (string) required
vpc_lattice/list_service_network_service_associationsLists the associations between a service network and a service. You can filter the list either by service or service network. You must provide either the service network identifier or the service identifier. Every association in Amazon VPC Lattice has a unique Amazon Resource Name ARN, such as when a service network is associated with a VPC or when a service is associated with a service network. If the association is for a resource is shared with another account, the association includes the locserviceNetworkIdentifier (string)
serviceIdentifier (string)
maxResults (integer)
nextToken (string)
vpc_lattice/create_service_network_vpc_associationAssociates a VPC with a service network. When you associate a VPC with the service network, it enables all the resources within that VPC to be clients and communicate with other services in the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide. You can't use this operation if there is a disassociation in progress. If the association fails, retry by deleting the association and recreating it. As a result of this operation, the association getsclientToken (string)
serviceNetworkIdentifier (string) required
vpcIdentifier (string) required
privateDnsEnabled (boolean)
securityGroupIds (array)
tags (object)
dnsOptions: {
. privateDnsPreference (string)
. privateDnsSpecifiedDomains (array)
} (object)
vpc_lattice/get_service_network_vpc_associationRetrieves information about the specified association between a service network and a VPC.serviceNetworkVpcAssociationIdentifier (string) required
vpc_lattice/update_service_network_vpc_associationUpdates the service network and VPC association. If you add a security group to the service network and VPC association, the association must continue to have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and then recreate it without security groups.serviceNetworkVpcAssociationIdentifier (string) required
securityGroupIds (array) required
vpc_lattice/delete_service_network_vpc_associationDisassociates the VPC from the service network. You can't disassociate the VPC if there is a create or update association in progress.serviceNetworkVpcAssociationIdentifier (string) required
vpc_lattice/list_service_network_vpc_associationsLists the associations between a service network and a VPC. You can filter the list either by VPC or service network. You must provide either the ID of the service network identifier or the ID of the VPC.serviceNetworkIdentifier (string)
vpcIdentifier (string)
maxResults (integer)
nextToken (string)
vpc_lattice/deregister_targetsDeregisters the specified targets from the specified target group.targetGroupIdentifier (string) required
targets (array) required
vpc_lattice/list_targetsLists the targets for the target group. By default, all targets are included. You can use this API to check the health status of targets. You can also filter the results by target.targetGroupIdentifier (string) required
maxResults (integer)
nextToken (string)
targets (array)
vpc_lattice/register_targetsRegisters the targets with the target group. If it's a Lambda target, you can only have one target in a target group.targetGroupIdentifier (string) required
targets (array) required
vpc_lattice/create_target_groupCreates a target group. A target group is a collection of targets, or compute resources, that run your application or service. A target group can only be used by a single service. For more information, see Target groups in the Amazon VPC Lattice User Guide.name (string) required
type (string) required
config: {
. port (integer)
. protocol (string)
. protocolVersion (string)
. ipAddressType (string)
. vpcIdentifier (string)
. healthCheck (object)
. lambdaEventStructureVersion (string)
} (object)
clientToken (string)
tags (object)
vpc_lattice/get_target_groupRetrieves information about the specified target group.targetGroupIdentifier (string) required
vpc_lattice/update_target_groupUpdates the specified target group.targetGroupIdentifier (string) required
healthCheck: {
. enabled (boolean)
. protocol (string)
. protocolVersion (string)
. port (integer)
. path (string)
. healthCheckIntervalSeconds (integer)
. healthCheckTimeoutSeconds (integer)
. healthyThresholdCount (integer)
. unhealthyThresholdCount (integer)
. matcher
} (object) required
vpc_lattice/delete_target_groupDeletes a target group. You can't delete a target group if it is used in a listener rule or if the target group creation is in progress.targetGroupIdentifier (string) required
vpc_lattice/list_target_groupsLists your target groups. You can narrow your search by using the filters below in your request.maxResults (integer)
nextToken (string)
vpcIdentifier (string)
targetGroupType (string)
waf_regional/associate_web_aclThis 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.WebACLId (string) required
ResourceArn (string) required
waf_regional/create_byte_match_setThis 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, youName (string) required
ChangeToken (string) required
waf_regional/create_geo_match_setThis 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 oneName (string) required
ChangeToken (string) required
waf_regional/create_ipsetThis 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 fromName (string) required
ChangeToken (string) required
waf_regional/create_rate_based_ruleThis 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 cName (string) required
MetricName (string) required
RateKey (string) required
RateLimit (integer) required
ChangeToken (string) required
Tags (array)
waf_regional/create_regex_match_setThis 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, yName (string) required
ChangeToken (string) required
waf_regional/create_regex_pattern_setThis 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 Ba@dBo0t. You can then configure AWS WAF to reject thoName (string) required
ChangeToken (string) required
waf_regional/create_ruleThis 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 matcName (string) required
MetricName (string) required
ChangeToken (string) required
Tags (array)
waf_regional/create_rule_groupThis 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 rName (string) required
MetricName (string) required
ChangeToken (string) required
Tags (array)
waf_regional/create_size_constraint_setThis 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 tName (string) required
ChangeToken (string) required
waf_regional/create_sql_injection_match_setThis 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 likelyName (string) required
ChangeToken (string) required
waf_regional/create_web_aclThis 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. YouName (string) required
MetricName (string) required
DefaultAction: {
. Type (string)
} (object) required
ChangeToken (string) required
Tags (array)
waf_regional/create_web_aclmigration_stackCreates 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 migratWebACLId (string) required
S3BucketName (string) required
IgnoreUnsupportedType (boolean) required
waf_regional/create_xss_match_setThis 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 likelName (string) required
ChangeToken (string) required
waf_regional/delete_byte_match_setThis 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 froByteMatchSetId (string) required
ChangeToken (string) required
waf_regional/delete_geo_match_setThis 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. ToGeoMatchSetId (string) required
ChangeToken (string) required
waf_regional/delete_ipsetThis 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 permanentlyIPSetId (string) required
ChangeToken (string) required
waf_regional/delete_logging_configurationThis 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.ResourceArn (string) required
waf_regional/delete_permission_policyThis 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.ResourceArn (string) required
waf_regional/delete_rate_based_ruleThis 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 froRuleId (string) required
ChangeToken (string) required
waf_regional/delete_regex_match_setThis 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 RegexMatchSeRegexMatchSetId (string) required
ChangeToken (string) required
waf_regional/delete_regex_pattern_setThis 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.RegexPatternSetId (string) required
ChangeToken (string) required
waf_regional/delete_ruleThis 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 WebACRuleId (string) required
ChangeToken (string) required
waf_regional/delete_rule_groupThis 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.RuleGroupId (string) required
ChangeToken (string) required
waf_regional/delete_size_constraint_setThis 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 SizeCoSizeConstraintSetId (string) required
ChangeToken (string) required
waf_regional/delete_sql_injection_match_setThis 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 SqlISqlInjectionMatchSetId (string) required
ChangeToken (string) required
waf_regional/delete_web_aclThis 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 UpdWebACLId (string) required
ChangeToken (string) required
waf_regional/delete_xss_match_setThis 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, useXssMatchSetId (string) required
ChangeToken (string) required
waf_regional/disassociate_web_aclThis 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.ResourceArn (string) required
waf_regional/get_byte_match_setThis 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.ByteMatchSetId (string) required
waf_regional/get_change_tokenThis 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 cNo parameters
waf_regional/get_change_token_statusThis 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 haveChangeToken (string) required
waf_regional/get_geo_match_setThis 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.GeoMatchSetId (string) required
waf_regional/get_ipsetThis 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.IPSetId (string) required
waf_regional/get_logging_configurationThis 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.ResourceArn (string) required
waf_regional/get_permission_policyThis 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.ResourceArn (string) required
waf_regional/get_rate_based_ruleThis 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.RuleId (string) required
waf_regional/get_rate_based_rule_managed_keysThis 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 eRuleId (string) required
NextMarker (string)
waf_regional/get_regex_match_setThis 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.RegexMatchSetId (string) required
waf_regional/get_regex_pattern_setThis 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.RegexPatternSetId (string) required
waf_regional/get_ruleThis 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.RuleId (string) required
waf_regional/get_rule_groupThis 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.RuleGroupId (string) required
waf_regional/get_sampled_requestsThis 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.WebAclId (string) required
RuleId (string) required
TimeWindow: {
. StartTime (string)
. EndTime (string)
} (object) required
MaxItems (integer) required
waf_regional/get_size_constraint_setThis 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.SizeConstraintSetId (string) required
waf_regional/get_sql_injection_match_setThis 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.SqlInjectionMatchSetId (string) required
waf_regional/get_web_aclThis 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.WebACLId (string) required
waf_regional/get_web_aclfor_resourceThis 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.ResourceArn (string) required
waf_regional/get_xss_match_setThis 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.XssMatchSetId (string) required
waf_regional/list_activated_rules_in_rule_groupThis 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.RuleGroupId (string)
NextMarker (string)
Limit (integer)
waf_regional/list_byte_match_setsThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_geo_match_setsThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_ipsetsThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_logging_configurationsThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_rate_based_rulesThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_regex_match_setsThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_regex_pattern_setsThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_resources_for_web_aclThis 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.WebACLId (string) required
ResourceType (string)
waf_regional/list_rule_groupsThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_rulesThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_size_constraint_setsThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_sql_injection_match_setsThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_subscribed_rule_groupsThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_tags_for_resourceThis 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 kNextMarker (string)
Limit (integer)
ResourceARN (string) required
waf_regional/list_web_aclsThis 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.NextMarker (string)
Limit (integer)
waf_regional/list_xss_match_setsThis 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.NextMarker (string)
Limit (integer)
waf_regional/put_logging_configurationThis 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 dataLoggingConfiguration: {
. ResourceArn (string)
. LogDestinationConfigs (array)
. RedactedFields (array)
} (object) required
waf_regional/put_permission_policyThis 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 attacResourceArn (string) required
Policy (string) required
waf_regional/tag_resourceThis 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 'customeResourceARN (string) required
Tags (array) required
waf_regional/untag_resourceThis 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.ResourceARN (string) required
TagKeys (array) required
waf_regional/update_byte_match_setThis 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 chanByteMatchSetId (string) required
ChangeToken (string) required
Updates (array) required
waf_regional/update_geo_match_setThis 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 chanGeoMatchSetId (string) required
ChangeToken (string) required
Updates (array) required
waf_regional/update_ipsetThis 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 IPSetDIPSetId (string) required
ChangeToken (string) required
Updates (array) required
waf_regional/update_rate_based_ruleThis 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 youRuleId (string) required
ChangeToken (string) required
Updates (array) required
RateLimit (integer) required
waf_regional/update_regex_match_setThis 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 wantRegexMatchSetId (string) required
Updates (array) required
ChangeToken (string) required
waf_regional/update_regex_pattern_setThis 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 expressRegexPatternSetId (string) required
Updates (array) required
ChangeToken (string) required
waf_regional/update_ruleThis 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 youRuleId (string) required
ChangeToken (string) required
Updates (array) required
waf_regional/update_rule_groupThis 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 thRuleGroupId (string) required
Updates (array) required
ChangeToken (string) required
waf_regional/update_size_constraint_setThis 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 toSizeConstraintSetId (string) required
ChangeToken (string) required
Updates (array) required
waf_regional/update_sql_injection_match_setThis 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 deletSqlInjectionMatchSetId (string) required
ChangeToken (string) required
Updates (array) required
waf_regional/update_web_aclThis 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 forWebACLId (string) required
ChangeToken (string) required
Updates (array)
DefaultAction: {
. Type (string)
} (object)
waf_regional/update_xss_match_setThis 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 arraXssMatchSetId (string) required
ChangeToken (string) required
Updates (array) required
waf/create_byte_match_setThis 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, youName (string) required
ChangeToken (string) required
waf/create_geo_match_setThis 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 oneName (string) required
ChangeToken (string) required
waf/create_ipsetThis 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 fromName (string) required
ChangeToken (string) required
waf/create_rate_based_ruleThis 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 cName (string) required
MetricName (string) required
RateKey (string) required
RateLimit (integer) required
ChangeToken (string) required
Tags (array)
waf/create_regex_match_setThis 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, yName (string) required
ChangeToken (string) required
waf/create_regex_pattern_setThis 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 Ba@dBo0t. You can then configure AWS WAF to reject thoName (string) required
ChangeToken (string) required
waf/create_ruleThis 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 matcName (string) required
MetricName (string) required
ChangeToken (string) required
Tags (array)
waf/create_rule_groupThis 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 rName (string) required
MetricName (string) required
ChangeToken (string) required
Tags (array)
waf/create_size_constraint_setThis 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 tName (string) required
ChangeToken (string) required
waf/create_sql_injection_match_setThis 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 likelyName (string) required
ChangeToken (string) required
waf/create_web_aclThis 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. YouName (string) required
MetricName (string) required
DefaultAction: {
. Type (string)
} (object) required
ChangeToken (string) required
Tags (array)
waf/create_web_aclmigration_stackCreates 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 migratWebACLId (string) required
S3BucketName (string) required
IgnoreUnsupportedType (boolean) required
waf/create_xss_match_setThis 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 likelName (string) required
ChangeToken (string) required
waf/delete_byte_match_setThis 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 froByteMatchSetId (string) required
ChangeToken (string) required
waf/delete_geo_match_setThis 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. ToGeoMatchSetId (string) required
ChangeToken (string) required
waf/delete_ipsetThis 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 permanentlyIPSetId (string) required
ChangeToken (string) required
waf/delete_logging_configurationThis 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.ResourceArn (string) required
waf/delete_permission_policyThis 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.ResourceArn (string) required
waf/delete_rate_based_ruleThis 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 froRuleId (string) required
ChangeToken (string) required
waf/delete_regex_match_setThis 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 RegexMatchSeRegexMatchSetId (string) required
ChangeToken (string) required
waf/delete_regex_pattern_setThis 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.RegexPatternSetId (string) required
ChangeToken (string) required
waf/delete_ruleThis 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 WebACRuleId (string) required
ChangeToken (string) required
waf/delete_rule_groupThis 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.RuleGroupId (string) required
ChangeToken (string) required
waf/delete_size_constraint_setThis 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 SizeCoSizeConstraintSetId (string) required
ChangeToken (string) required
waf/delete_sql_injection_match_setThis 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 SqlISqlInjectionMatchSetId (string) required
ChangeToken (string) required
waf/delete_web_aclThis 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 UpdWebACLId (string) required
ChangeToken (string) required
waf/delete_xss_match_setThis 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, useXssMatchSetId (string) required
ChangeToken (string) required
waf/get_byte_match_setThis 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.ByteMatchSetId (string) required
waf/get_change_tokenThis 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 cNo parameters
waf/get_change_token_statusThis 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 haveChangeToken (string) required
waf/get_geo_match_setThis 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.GeoMatchSetId (string) required
waf/get_ipsetThis 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.IPSetId (string) required
waf/get_logging_configurationThis 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.ResourceArn (string) required
waf/get_permission_policyThis 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.ResourceArn (string) required
waf/get_rate_based_ruleThis 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.RuleId (string) required
waf/get_rate_based_rule_managed_keysThis 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 eRuleId (string) required
NextMarker (string)
waf/get_regex_match_setThis 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.RegexMatchSetId (string) required
waf/get_regex_pattern_setThis 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.RegexPatternSetId (string) required
waf/get_ruleThis 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.RuleId (string) required
waf/get_rule_groupThis 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.RuleGroupId (string) required
waf/get_sampled_requestsThis 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.WebAclId (string) required
RuleId (string) required
TimeWindow: {
. StartTime (string)
. EndTime (string)
} (object) required
MaxItems (integer) required
waf/get_size_constraint_setThis 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.SizeConstraintSetId (string) required
waf/get_sql_injection_match_setThis 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.SqlInjectionMatchSetId (string) required
waf/get_web_aclThis 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.WebACLId (string) required
waf/get_xss_match_setThis 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.XssMatchSetId (string) required
waf/list_activated_rules_in_rule_groupThis 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.RuleGroupId (string)
NextMarker (string)
Limit (integer)
waf/list_byte_match_setsThis 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.NextMarker (string)
Limit (integer)
waf/list_geo_match_setsThis 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.NextMarker (string)
Limit (integer)
waf/list_ipsetsThis 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.NextMarker (string)
Limit (integer)
waf/list_logging_configurationsThis 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.NextMarker (string)
Limit (integer)
waf/list_rate_based_rulesThis 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.NextMarker (string)
Limit (integer)
waf/list_regex_match_setsThis 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.NextMarker (string)
Limit (integer)
waf/list_regex_pattern_setsThis 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.NextMarker (string)
Limit (integer)
waf/list_rule_groupsThis 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.NextMarker (string)
Limit (integer)
waf/list_rulesThis 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.NextMarker (string)
Limit (integer)
waf/list_size_constraint_setsThis 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.NextMarker (string)
Limit (integer)
waf/list_sql_injection_match_setsThis 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.NextMarker (string)
Limit (integer)
waf/list_subscribed_rule_groupsThis 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.NextMarker (string)
Limit (integer)
waf/list_tags_for_resourceThis 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 kNextMarker (string)
Limit (integer)
ResourceARN (string) required
waf/list_web_aclsThis 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.NextMarker (string)
Limit (integer)
waf/list_xss_match_setsThis 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.NextMarker (string)
Limit (integer)
waf/put_logging_configurationThis 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 dataLoggingConfiguration: {
. ResourceArn (string)
. LogDestinationConfigs (array)
. RedactedFields (array)
} (object) required
waf/put_permission_policyThis 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 attacResourceArn (string) required
Policy (string) required
waf/tag_resourceThis 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 'customeResourceARN (string) required
Tags (array) required
waf/untag_resourceThis 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.ResourceARN (string) required
TagKeys (array) required
waf/update_byte_match_setThis 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 chanByteMatchSetId (string) required
ChangeToken (string) required
Updates (array) required
waf/update_geo_match_setThis 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 chanGeoMatchSetId (string) required
ChangeToken (string) required
Updates (array) required
waf/update_ipsetThis 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 IPSetDIPSetId (string) required
ChangeToken (string) required
Updates (array) required
waf/update_rate_based_ruleThis 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 youRuleId (string) required
ChangeToken (string) required
Updates (array) required
RateLimit (integer) required
waf/update_regex_match_setThis 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 wantRegexMatchSetId (string) required
Updates (array) required
ChangeToken (string) required
waf/update_regex_pattern_setThis 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 expressRegexPatternSetId (string) required
Updates (array) required
ChangeToken (string) required
waf/update_ruleThis 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 youRuleId (string) required
ChangeToken (string) required
Updates (array) required
waf/update_rule_groupThis 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 thRuleGroupId (string) required
Updates (array) required
ChangeToken (string) required
waf/update_size_constraint_setThis 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 toSizeConstraintSetId (string) required
ChangeToken (string) required
Updates (array) required
waf/update_sql_injection_match_setThis 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 deletSqlInjectionMatchSetId (string) required
ChangeToken (string) required
Updates (array) required
waf/update_web_aclThis 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 forWebACLId (string) required
ChangeToken (string) required
Updates (array)
DefaultAction: {
. Type (string)
} (object)
waf/update_xss_match_setThis 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 arraXssMatchSetId (string) required
ChangeToken (string) required
Updates (array) required
wafv2/associate_web_aclAssociates a web ACL with a resource, to protect the resource. Use this for all resource types except for Amazon CloudFront distributions. For Amazon CloudFront, call UpdateDistribution for the distribution and provide the Amazon Resource Name ARN of the web ACL in the web ACL ID. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide. Required permissions for customer-managed IAM policies This call requires permissions that are specific to the protected resource type.WebACLArn (string) required
ResourceArn (string) required
wafv2/check_capacityReturns 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 thaScope (string) required
Rules (array) required
wafv2/create_apikeyCreates an API key that contains a set of token domains. API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide. You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaSScope (string) required
TokenDomains (array) required
wafv2/create_ipsetCreates 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.Name (string) required
Scope (string) required
Description (string)
IPAddressVersion (string) required
Addresses (array) required
Tags (array)
wafv2/create_regex_pattern_setCreates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.Name (string) required
Scope (string) required
Description (string)
RegularExpressionList (array) required
Tags (array)
wafv2/create_rule_groupCreates 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.Name (string) required
Scope (string) required
Capacity (integer) required
Description (string)
Rules (array)
VisibilityConfig: {
. SampledRequestsEnabled (boolean)
. CloudWatchMetricsEnabled (boolean)
. MetricName (string)
} (object) required
Tags (array)
CustomResponseBodies (object)
wafv2/create_web_aclCreates 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 a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. 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 canName (string) required
Scope (string) required
DefaultAction: {
. Block (object)
. Allow (object)
} (object) required
Description (string)
Rules (array)
VisibilityConfig: {
. SampledRequestsEnabled (boolean)
. CloudWatchMetricsEnabled (boolean)
. MetricName (string)
} (object) required
DataProtectionConfig: {
. DataProtections (array)
} (object)
Tags (array)
CustomResponseBodies (object)
CaptchaConfig: {
. ImmunityTimeProperty (object)
} (object)
ChallengeConfig: {
. ImmunityTimeProperty (object)
} (object)
TokenDomains (array)
AssociationConfig: {
. RequestBody (object)
} (object)
OnSourceDDoSProtectionConfig: {
. ALBLowReputationMode (string)
} (object)
ApplicationConfig: {
. Attributes (array)
} (object)
wafv2/delete_apikeyDeletes the specified API key. After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.Scope (string) required
APIKey (string) required
wafv2/delete_firewall_manager_rule_groupsDeletes all rule groups that are managed by Firewall Manager from the specified WebACL. You can only use this if ManagedByFirewallManager and RetrofittedByFirewallManager are both false in the web ACL.WebACLArn (string) required
WebACLLockToken (string) required
wafv2/delete_ipsetDeletes the specified IPSet.Name (string) required
Scope (string) required
Id (string) required
LockToken (string) required
wafv2/delete_logging_configurationDeletes the LoggingConfiguration from the specified web ACL.ResourceArn (string) required
LogType (string)
LogScope (string)
wafv2/delete_permission_policyPermanently deletes an IAM policy from the specified rule group. You must be the owner of the rule group to perform this operation.ResourceArn (string) required
wafv2/delete_regex_pattern_setDeletes the specified RegexPatternSet.Name (string) required
Scope (string) required
Id (string) required
LockToken (string) required
wafv2/delete_rule_groupDeletes the specified RuleGroup.Name (string) required
Scope (string) required
Id (string) required
LockToken (string) required
wafv2/delete_web_aclDeletes the specified WebACL. You can only use this if ManagedByFirewallManager is false in the web ACL. 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 Amazon CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference. For all other resources, call ListResourcesForWeName (string) required
Scope (string) required
Id (string) required
LockToken (string) required
wafv2/describe_all_managed_productsProvides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.Scope (string) required
wafv2/describe_managed_products_by_vendorProvides high-level information for the managed rule groups owned by a specific vendor.VendorName (string) required
Scope (string) required
wafv2/describe_managed_rule_groupProvides high-level information for a managed rule group, including descriptions of the rules.VendorName (string) required
Name (string) required
Scope (string) required
VersionName (string)
wafv2/disassociate_web_aclDisassociates the specified resource from its web ACL association, if it has one. Use this for all resource types except for Amazon CloudFront distributions. For Amazon CloudFront, call UpdateDistribution for the distribution and provide an empty web ACL ID. For information, see UpdateDistribution in the Amazon CloudFront API Reference. Required permissions for customer-managed IAM policies This call requires permissions that are specific to the protected resource type. For details, see PermissiResourceArn (string) required
wafv2/generate_mobile_sdk_release_urlGenerates 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 WAF tokens for use in HTTPS requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.Platform (string) required
ReleaseVersion (string) required
wafv2/get_decrypted_apikeyReturns your API key in decrypted form. Use this to check the token domains that you have defined for the key. API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.Scope (string) required
APIKey (string) required
wafv2/get_ipsetRetrieves the specified IPSet.Name (string) required
Scope (string) required
Id (string) required
wafv2/get_logging_configurationReturns the LoggingConfiguration for the specified web ACL.ResourceArn (string) required
LogType (string)
LogScope (string)
wafv2/get_managed_rule_setRetrieves 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.Name (string) required
Scope (string) required
Id (string) required
wafv2/get_mobile_sdk_releaseRetrieves 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 WAF tokens for use in HTTPS requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.Platform (string) required
ReleaseVersion (string) required
wafv2/get_permission_policyReturns the IAM policy that is attached to the specified rule group. You must be the owner of the rule group to perform this operation.ResourceArn (string) required
wafv2/get_rate_based_statement_managed_keysRetrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address. The maximum number of addresses 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 referScope (string) required
WebACLName (string) required
WebACLId (string) required
RuleGroupRuleName (string)
RuleName (string) required
wafv2/get_regex_pattern_setRetrieves the specified RegexPatternSet.Name (string) required
Scope (string) required
Id (string) required
wafv2/get_rule_groupRetrieves the specified RuleGroup.Name (string)
Scope (string)
Id (string)
ARN (string)
wafv2/get_sampled_requestsGets 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 receivedWebAclArn (string) required
RuleMetricName (string) required
Scope (string) required
TimeWindow: {
. StartTime (string)
. EndTime (string)
} (object) required
MaxItems (integer) required
wafv2/get_web_aclRetrieves the specified WebACL.Name (string)
Scope (string)
Id (string)
ARN (string)
wafv2/get_web_aclfor_resourceRetrieves the WebACL for the specified resource. This call uses GetWebACL, to verify that your account has permission to access the retrieved web ACL. If you get an error that indicates that your account isn't authorized to perform wafv2:GetWebACL on the resource, that error won't be included in your CloudTrail event history. For Amazon CloudFront, don't use this call. Instead, call the CloudFront action GetDistributionConfig. For information, see GetDistributionConfig in the Amazon CloudFront AResourceArn (string) required
wafv2/list_apikeysRetrieves a list of the API keys that you've defined for the specified scope. API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.Scope (string) required
NextMarker (string)
Limit (integer)
wafv2/list_available_managed_rule_groupsRetrieves 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.Scope (string) required
NextMarker (string)
Limit (integer)
wafv2/list_available_managed_rule_group_versionsReturns a list of the available versions for the specified managed rule group.VendorName (string) required
Name (string) required
Scope (string) required
NextMarker (string)
Limit (integer)
wafv2/list_ipsetsRetrieves an array of IPSetSummary objects for the IP sets that you manage.Scope (string) required
NextMarker (string)
Limit (integer)
wafv2/list_logging_configurationsRetrieves an array of your LoggingConfiguration objects.Scope (string) required
NextMarker (string)
Limit (integer)
LogScope (string)
wafv2/list_managed_rule_setsRetrieves 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.Scope (string) required
NextMarker (string)
Limit (integer)
wafv2/list_mobile_sdk_releasesRetrieves 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 WAF tokens for use in HTTPS requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.Platform (string) required
NextMarker (string)
Limit (integer)
wafv2/list_regex_pattern_setsRetrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.Scope (string) required
NextMarker (string)
Limit (integer)
wafv2/list_resources_for_web_aclRetrieves an array of the Amazon Resource Names ARNs for the resources that are associated with the specified web ACL. For Amazon CloudFront, don't use this call. Instead, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference. Required permissions for customer-managed IAM policies This call requires permissions that are specific to the protected resource type. For details, see Permissions for ListResourcesForWWebACLArn (string) required
ResourceType (string)
wafv2/list_rule_groupsRetrieves an array of RuleGroupSummary objects for the rule groups that you manage.Scope (string) required
NextMarker (string)
Limit (integer)
wafv2/list_tags_for_resourceRetrieves 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 sNextMarker (string)
Limit (integer)
ResourceARN (string) required
wafv2/list_web_aclsRetrieves an array of WebACLSummary objects for the web ACLs that you manage.Scope (string) required
NextMarker (string)
Limit (integer)
wafv2/put_logging_configurationEnables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided. If you configure data protection for the web ACL, the protection applies to the data that WAF sends to the logs. This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call. To modify an existing logging configuration, do the following: Retrieve it by calling GetLoggingConfiguration UpLoggingConfiguration: {
. ResourceArn (string)
. LogDestinationConfigs (array)
. RedactedFields (array)
. ManagedByFirewallManager (boolean)
. LoggingFilter (object)
. LogType (string)
. LogScope (string)
} (object) required
wafv2/put_managed_rule_set_versionsDefines 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, PutManagName (string) required
Scope (string) required
Id (string) required
LockToken (string) required
RecommendedVersion (string)
VersionsToPublish (object)
wafv2/put_permission_policyUse this to share a rule group with other accounts. This action attaches an IAM policy to the specified resource. 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. If a rule group has beeResourceArn (string) required
Policy (string) required
wafv2/tag_resourceAssociates 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 patteResourceARN (string) required
Tags (array) required
wafv2/untag_resourceDisassociates 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.ResourceARN (string) required
TagKeys (array) required
wafv2/update_ipsetUpdates 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 an IP set, do the following: Retrieve it by calling GetIPSet Update its settings as needed Provide the complete IP set specification to this call Temporary inconsistencies during updates When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas wherName (string) required
Scope (string) required
Id (string) required
Description (string)
Addresses (array) required
LockToken (string) required
wafv2/update_managed_rule_set_version_expiry_dateUpdates 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 yName (string) required
Scope (string) required
Id (string) required
LockToken (string) required
VersionToExpire (string) required
ExpiryTimestamp (string) required
wafv2/update_regex_pattern_setUpdates 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 a regex pattern set, do the following: Retrieve it by calling GetRegexPatternSet Update its settings as needed Provide the complete regex pattern set specification to this call Temporary inconsistencies during updates When you create or change a web ACL or other WAF resources, the changes take aName (string) required
Scope (string) required
Id (string) required
Description (string)
RegularExpressionList (array) required
LockToken (string) required
wafv2/update_rule_groupUpdates 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 a rule group, do the following: Retrieve it by calling GetRuleGroup Update its settings as needed Provide the complete rule group specification to this call 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 anName (string) required
Scope (string) required
Id (string) required
Description (string)
Rules (array)
VisibilityConfig: {
. SampledRequestsEnabled (boolean)
. CloudWatchMetricsEnabled (boolean)
. MetricName (string)
} (object) required
LockToken (string) required
CustomResponseBodies (object)
wafv2/update_web_aclUpdates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL. 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 a web ACL, do the following: Retrieve it by calling GetWebACL Update its settings as needed Provide the complete web ACL specification to this call A web ACL defines a collection of rules to use tName (string) required
Scope (string) required
Id (string) required
DefaultAction: {
. Block (object)
. Allow (object)
} (object) required
Description (string)
Rules (array)
VisibilityConfig: {
. SampledRequestsEnabled (boolean)
. CloudWatchMetricsEnabled (boolean)
. MetricName (string)
} (object) required
DataProtectionConfig: {
. DataProtections (array)
} (object)
LockToken (string) required
CustomResponseBodies (object)
CaptchaConfig: {
. ImmunityTimeProperty (object)
} (object)
ChallengeConfig: {
. ImmunityTimeProperty (object)
} (object)
TokenDomains (array)
AssociationConfig: {
. RequestBody (object)
} (object)
OnSourceDDoSProtectionConfig: {
. ALBLowReputationMode (string)
} (object)
ApplicationConfig: {
. Attributes (array)
} (object)
wellarchitected/associate_lensesAssociate 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.WorkloadId (string) required
LensAliases (array) required
wellarchitected/associate_profilesAssociate a profile with a workload.WorkloadId (string) required
ProfileArns (array) required
wellarchitected/create_lens_shareCreate a lens share. The owner of a lens can share it with other Amazon Web Services accounts, users, an organization, and organizational units OUs in the same Amazon Web Services Region. Lenses provided by Amazon Web Services Amazon Web Services Official Content cannot be shared. Shared access to a lens is not removed until the lens invitation is deleted. If you share a lens with an organization or OU, all accounts in the organization or OU are granted access to the lens. For more information,LensAlias (string) required
SharedWith (string) required
ClientRequestToken (string) required
wellarchitected/create_lens_versionCreate a new lens version. A lens can have up to 100 versions. Use this operation to publish a new lens version after you have imported a lens. The LensAlias is used to identify the lens to be published. The owner of a lens can share the lens with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.LensAlias (string) required
LensVersion (string) required
IsMajorVersion (boolean)
ClientRequestToken (string) required
wellarchitected/create_milestoneCreate a milestone for an existing workload.WorkloadId (string) required
MilestoneName (string) required
ClientRequestToken (string) required
wellarchitected/create_profileCreate a profile.ProfileName (string) required
ProfileDescription (string) required
ProfileQuestions (array) required
ClientRequestToken (string) required
Tags (object)
wellarchitected/create_profile_shareCreate a profile share.ProfileArn (string) required
SharedWith (string) required
ClientRequestToken (string) required
wellarchitected/create_review_templateCreate a review template. Disclaimer Do not include or gather personal identifiable information PII of end users or other identifiable individuals in or via your review templates. If your review template 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.TemplateName (string) required
Description (string) required
Lenses (array) required
Notes (string)
Tags (object)
ClientRequestToken (string) required
wellarchitected/create_template_shareCreate a review template share. The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units OUs in the same Amazon Web Services Region. Shared access to a review template is not removed until the review template share invitation is deleted. If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template. Disclaimer By sharing your review template wTemplateArn (string) required
SharedWith (string) required
ClientRequestToken (string) required
wellarchitected/create_workloadCreate a new workload. The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units OUs 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. Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload. You also must specify ReviewOwner, even though the parameter is listed as not bWorkloadName (string) required
Description (string) required
Environment (string) required
AccountIds (array)
AwsRegions (array)
NonAwsRegions (array)
PillarPriorities (array)
ArchitecturalDesign (string)
ReviewOwner (string)
IndustryType (string)
Industry (string)
Lenses (array) required
Notes (string)
ClientRequestToken (string) required
Tags (object)
DiscoveryConfig: {
. TrustedAdvisorIntegrationStatus (string)
. WorkloadResourceDefinition (array)
} (object)
Applications (array)
ProfileArns (array)
ReviewTemplateArns (array)
JiraConfiguration: {
. IssueManagementStatus (string)
. IssueManagementType (string)
. JiraProjectKey (string)
} (object)
wellarchitected/create_workload_shareCreate a workload share. The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted. If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload. For more information, see Sharing a workload in the Well-Architected Tool User Guide.WorkloadId (string) required
SharedWith (string) required
PermissionType (string) required
ClientRequestToken (string) required
wellarchitected/delete_lensDelete an existing lens. Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and 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 cuLensAlias (string) required
ClientRequestToken (string) required
LensStatus (string) required
wellarchitected/delete_lens_shareDelete a lens share. After the lens share is deleted, Amazon Web Services accounts, users, organizations, and organizational units OUs 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 shareShareId (string) required
LensAlias (string) required
ClientRequestToken (string) required
wellarchitected/delete_profileDelete a profile. Disclaimer By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.ProfileArn (string) required
ClientRequestToken (string) required
wellarchitected/delete_profile_shareDelete a profile share.ShareId (string) required
ProfileArn (string) required
ClientRequestToken (string) required
wellarchitected/delete_review_templateDelete a review template. Only the owner of a review template can delete it. After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units OUs that you shared the review template with will no longer be able to apply it to new workloads.TemplateArn (string) required
ClientRequestToken (string) required
wellarchitected/delete_template_shareDelete a review template share. After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units OUs that you shared the review template with will no longer be able to apply it to new workloads.ShareId (string) required
TemplateArn (string) required
ClientRequestToken (string) required
wellarchitected/delete_workloadDelete an existing workload.WorkloadId (string) required
ClientRequestToken (string) required
wellarchitected/delete_workload_shareDelete a workload share.ShareId (string) required
WorkloadId (string) required
ClientRequestToken (string) required
wellarchitected/disassociate_lensesDisassociate 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.WorkloadId (string) required
LensAliases (array) required
wellarchitected/disassociate_profilesDisassociate a profile from a workload.WorkloadId (string) required
ProfileArns (array) required
wellarchitected/export_lensExport an existing lens. Only the owner of a lens can export it. Lenses provided by Amazon Web Services Amazon Web Services Official Content cannot be exported. Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide. 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 accouLensAlias (string) required
LensVersion (string)
wellarchitected/get_answerGet the answer to a specific question in a workload review.WorkloadId (string) required
LensAlias (string) required
QuestionId (string) required
MilestoneNumber (integer)
wellarchitected/get_consolidated_reportGet a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you.Format (string) required
IncludeSharedResources (boolean)
NextToken (string)
MaxResults (integer)
wellarchitected/get_global_settingsGlobal settings for all workloads.No parameters
wellarchitected/get_lensGet an existing lens.LensAlias (string) required
LensVersion (string)
wellarchitected/get_lens_reviewGet lens review.WorkloadId (string) required
LensAlias (string) required
MilestoneNumber (integer)
wellarchitected/get_lens_review_reportGet lens review report.WorkloadId (string) required
LensAlias (string) required
MilestoneNumber (integer)
wellarchitected/get_lens_version_differenceGet lens version differences.LensAlias (string) required
BaseLensVersion (string)
TargetLensVersion (string)
wellarchitected/get_milestoneGet a milestone for an existing workload.WorkloadId (string) required
MilestoneNumber (integer) required
wellarchitected/get_profileGet profile information.ProfileArn (string) required
ProfileVersion (string)
wellarchitected/get_profile_templateGet profile template.No parameters
wellarchitected/get_review_templateGet review template.TemplateArn (string) required
wellarchitected/get_review_template_answerGet review template answer.TemplateArn (string) required
LensAlias (string) required
QuestionId (string) required
wellarchitected/get_review_template_lens_reviewGet a lens review associated with a review template.TemplateArn (string) required
LensAlias (string) required
wellarchitected/get_workloadGet an existing workload.WorkloadId (string) required
wellarchitected/import_lensImport a new custom lens or update an existing custom lens. To update an existing custom lens, specify its ARN as the LensAlias. If no ARN is specified, a new custom lens is created. The new or updated lens will have a status of DRAFT. 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 customLensAlias (string)
JSONString (string) required
ClientRequestToken (string) required
Tags (object)
wellarchitected/list_answersList of answers for a particular workload and lens.WorkloadId (string) required
LensAlias (string) required
PillarId (string)
MilestoneNumber (integer)
NextToken (string)
MaxResults (integer)
QuestionPriority (string)
wellarchitected/list_check_detailsList of Trusted Advisor check details by account related to the workload.WorkloadId (string) required
NextToken (string)
MaxResults (integer)
LensArn (string) required
PillarId (string) required
QuestionId (string) required
ChoiceId (string) required
wellarchitected/list_check_summariesList of Trusted Advisor checks summarized for all accounts related to the workload.WorkloadId (string) required
NextToken (string)
MaxResults (integer)
LensArn (string) required
PillarId (string) required
QuestionId (string) required
ChoiceId (string) required
wellarchitected/list_lensesList the available lenses.NextToken (string)
MaxResults (integer)
LensType (string)
LensStatus (string)
LensName (string)
wellarchitected/list_lens_review_improvementsList the improvements of a particular lens review.WorkloadId (string) required
LensAlias (string) required
PillarId (string)
MilestoneNumber (integer)
NextToken (string)
MaxResults (integer)
QuestionPriority (string)
wellarchitected/list_lens_reviewsList lens reviews for a particular workload.WorkloadId (string) required
MilestoneNumber (integer)
NextToken (string)
MaxResults (integer)
wellarchitected/list_lens_sharesList the lens shares associated with the lens.LensAlias (string) required
SharedWithPrefix (string)
NextToken (string)
MaxResults (integer)
Status (string)
wellarchitected/list_milestonesList all milestones for an existing workload.WorkloadId (string) required
NextToken (string)
MaxResults (integer)
wellarchitected/list_notificationsList lens notifications.WorkloadId (string)
NextToken (string)
MaxResults (integer)
ResourceArn (string)
wellarchitected/list_profile_notificationsList profile notifications.WorkloadId (string)
NextToken (string)
MaxResults (integer)
wellarchitected/list_profilesList profiles.ProfileNamePrefix (string)
ProfileOwnerType (string)
NextToken (string)
MaxResults (integer)
wellarchitected/list_profile_sharesList profile shares.ProfileArn (string) required
SharedWithPrefix (string)
NextToken (string)
MaxResults (integer)
Status (string)
wellarchitected/list_review_template_answersList the answers of a review template.TemplateArn (string) required
LensAlias (string) required
PillarId (string)
NextToken (string)
MaxResults (integer)
wellarchitected/list_review_templatesList review templates.NextToken (string)
MaxResults (integer)
wellarchitected/list_share_invitationsList the share invitations. WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.WorkloadNamePrefix (string)
LensNamePrefix (string)
ShareResourceType (string)
NextToken (string)
MaxResults (integer)
ProfileNamePrefix (string)
TemplateNamePrefix (string)
wellarchitected/list_tags_for_resourceList the tags for a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.WorkloadArn (string) required
wellarchitected/list_template_sharesList review template shares.TemplateArn (string) required
SharedWithPrefix (string)
NextToken (string)
MaxResults (integer)
Status (string)
wellarchitected/list_workloadsPaginated list of workloads.WorkloadNamePrefix (string)
NextToken (string)
MaxResults (integer)
wellarchitected/list_workload_sharesList the workload shares associated with the workload.WorkloadId (string) required
SharedWithPrefix (string)
NextToken (string)
MaxResults (integer)
Status (string)
wellarchitected/tag_resourceAdds one or more tags to the specified resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.WorkloadArn (string) required
Tags (object) required
wellarchitected/untag_resourceDeletes specified tags from a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. To specify multiple tags, use separate tagKeys parameters, for example: DELETE /tags/WorkloadArn?tagKeys=key1 and tagKeys=key2WorkloadArn (string) required
TagKeys (array) required
wellarchitected/update_answerUpdate the answer to a specific question in a workload review.WorkloadId (string) required
LensAlias (string) required
QuestionId (string) required
SelectedChoices (array)
ChoiceUpdates (object)
Notes (string)
IsApplicable (boolean)
Reason (string)
wellarchitected/update_global_settingsUpdate whether the Amazon Web Services account is opted into organization sharing and discovery integration features.OrganizationSharingStatus (string)
DiscoveryIntegrationStatus (string)
JiraConfiguration: {
. IssueManagementStatus (string)
. IssueManagementType (string)
. JiraProjectKey (string)
. IntegrationStatus (string)
} (object)
wellarchitected/update_integrationUpdate integration features.WorkloadId (string) required
ClientRequestToken (string) required
IntegratingService (string) required
wellarchitected/update_lens_reviewUpdate lens review for a particular workload.WorkloadId (string) required
LensAlias (string) required
LensNotes (string)
PillarNotes (object)
JiraConfiguration: {
. SelectedPillars (array)
} (object)
wellarchitected/update_profileUpdate a profile.ProfileArn (string) required
ProfileDescription (string)
ProfileQuestions (array)
wellarchitected/update_review_templateUpdate a review template.TemplateArn (string) required
TemplateName (string)
Description (string)
Notes (string)
LensesToAssociate (array)
LensesToDisassociate (array)
wellarchitected/update_review_template_answerUpdate a review template answer.TemplateArn (string) required
LensAlias (string) required
QuestionId (string) required
SelectedChoices (array)
ChoiceUpdates (object)
Notes (string)
IsApplicable (boolean)
Reason (string)
wellarchitected/update_review_template_lens_reviewUpdate a lens review associated with a review template.TemplateArn (string) required
LensAlias (string) required
LensNotes (string)
PillarNotes (object)
wellarchitected/update_share_invitationUpdate a workload or custom lens share invitation. This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.ShareInvitationId (string) required
ShareInvitationAction (string) required
wellarchitected/update_workloadUpdate an existing workload.WorkloadId (string) required
WorkloadName (string)
Description (string)
Environment (string)
AccountIds (array)
AwsRegions (array)
NonAwsRegions (array)
PillarPriorities (array)
ArchitecturalDesign (string)
ReviewOwner (string)
IsReviewOwnerUpdateAcknowledged (boolean)
IndustryType (string)
Industry (string)
Notes (string)
ImprovementStatus (string)
DiscoveryConfig: {
. TrustedAdvisorIntegrationStatus (string)
. WorkloadResourceDefinition (array)
} (object)
Applications (array)
JiraConfiguration: {
. IssueManagementStatus (string)
. IssueManagementType (string)
. JiraProjectKey (string)
} (object)
wellarchitected/update_workload_shareUpdate a workload share.ShareId (string) required
WorkloadId (string) required
PermissionType (string) required
wellarchitected/upgrade_lens_reviewUpgrade lens review for a particular workload.WorkloadId (string) required
LensAlias (string) required
MilestoneName (string) required
ClientRequestToken (string)
wellarchitected/upgrade_profile_versionUpgrade a profile.WorkloadId (string) required
ProfileArn (string) required
MilestoneName (string)
ClientRequestToken (string)
wellarchitected/upgrade_review_template_lens_reviewUpgrade the lens review of a review template.TemplateArn (string) required
LensAlias (string) required
ClientRequestToken (string)
wickr/batch_create_userCreates multiple users in a specified Wickr network. This operation allows you to provision multiple user accounts simultaneously, optionally specifying security groups, and validation requirements for each user. codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.networkId (string) required
users (array) required
clientToken (string)
wickr/batch_delete_userDeletes multiple users from a specified Wickr network. This operation permanently removes user accounts and their associated data from the network.networkId (string) required
userIds (array) required
clientToken (string)
wickr/batch_lookup_user_unameLooks up multiple user usernames from their unique username hashes unames. This operation allows you to retrieve the email addresses associated with a list of username hashes.networkId (string) required
unames (array) required
clientToken (string)
wickr/batch_reinvite_userResends invitation codes to multiple users who have pending invitations in a Wickr network. This operation is useful when users haven't accepted their initial invitations or when invitations have expired.networkId (string) required
userIds (array) required
clientToken (string)
wickr/batch_reset_devices_for_userResets multiple devices for a specific user in a Wickr network. This operation forces the selected devices to log out and requires users to re-authenticate, which is useful for security purposes or when devices need to be revoked.networkId (string) required
userId (string) required
appIds (array) required
clientToken (string)
wickr/batch_toggle_user_suspend_statusSuspends or unsuspends multiple users in a Wickr network. Suspended users cannot access the network until they are unsuspended. This operation is useful for temporarily restricting access without deleting user accounts.networkId (string) required
suspend (boolean) required
userIds (array) required
clientToken (string)
wickr/create_botCreates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and automation of tasks.networkId (string) required
username (string) required
displayName (string)
groupId (string) required
challenge (string) required
wickr/create_data_retention_botCreates a data retention bot in a Wickr network. Data retention bots are specialized bots that handle message archiving and compliance by capturing and storing messages for regulatory or organizational requirements.networkId (string) required
wickr/create_data_retention_bot_challengeCreates a new challenge password for the data retention bot. This password is used for authentication when the bot connects to the network.networkId (string) required
wickr/create_networkCreates a new Wickr network with specified access level and configuration. This operation provisions a new communication network for your organization.networkName (string) required
accessLevel (string) required
enablePremiumFreeTrial (boolean)
encryptionKeyArn (string)
wickr/create_security_groupCreates a new security group in a Wickr network. Security groups allow you to organize users and control their permissions, features, and security settings.networkId (string) required
name (string) required
securityGroupSettings: {
. lockoutThreshold (integer)
. permittedNetworks (array)
. enableGuestFederation (boolean)
. globalFederation (boolean)
. federationMode (integer)
. enableRestrictedGlobalFederation (boolean)
. permittedWickrAwsNetworks (array)
. permittedWickrEnterpriseNetworks (array)
} (object) required
clientToken (string)
wickr/delete_botDeletes a bot from a specified Wickr network. This operation permanently removes the bot account and its associated data from the network.networkId (string) required
botId (string) required
wickr/delete_data_retention_botDeletes the data retention bot from a Wickr network. This operation permanently removes the bot and all its associated data from the database.networkId (string) required
wickr/delete_networkDeletes a Wickr network and all its associated resources, including users, bots, security groups, and settings. This operation is permanent and cannot be undone.networkId (string) required
clientToken (string)
wickr/delete_security_groupDeletes a security group from a Wickr network. This operation cannot be performed on the default security group.networkId (string) required
groupId (string) required
wickr/get_botRetrieves detailed information about a specific bot in a Wickr network, including its status, group membership, and authentication details.networkId (string) required
botId (string) required
wickr/get_bots_countRetrieves the count of bots in a Wickr network, categorized by their status pending, active, and total.networkId (string) required
wickr/get_data_retention_botRetrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.networkId (string) required
wickr/get_guest_user_history_countRetrieves historical guest user count data for a Wickr network, showing the number of guest users per billing period over the past 90 days.networkId (string) required
wickr/get_networkRetrieves detailed information about a specific Wickr network, including its configuration, access level, and status.networkId (string) required
wickr/get_network_settingsRetrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.networkId (string) required
wickr/get_oidc_infoRetrieves the OpenID Connect OIDC configuration for a Wickr network, including SSO settings and optional token information if access token parameters are provided.networkId (string) required
clientId (string)
code (string)
grantType (string)
redirectUri (string)
url (string)
clientSecret (string)
codeVerifier (string)
certificate (string)
wickr/get_security_groupRetrieves detailed information about a specific security group in a Wickr network, including its settings, member counts, and configuration.networkId (string) required
groupId (string) required
wickr/get_userRetrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.networkId (string) required
userId (string) required
startTime (string)
endTime (string)
wickr/get_users_countRetrieves the count of users in a Wickr network, categorized by their status pending, active, rejected and showing how many users can still be added.networkId (string) required
wickr/list_blocked_guest_usersRetrieves a paginated list of guest users who have been blocked from a Wickr network. You can filter and sort the results.networkId (string) required
maxResults (integer)
sortDirection (string)
sortFields (string)
username (string)
admin (string)
nextToken (string)
wickr/list_botsRetrieves a paginated list of bots in a specified Wickr network. You can filter and sort the results based on various criteria.networkId (string) required
nextToken (string)
maxResults (integer)
sortFields (string)
sortDirection (string)
displayName (string)
username (string)
status (integer)
groupId (string)
wickr/list_devices_for_userRetrieves a paginated list of devices associated with a specific user in a Wickr network. This operation returns information about all devices where the user has logged into Wickr.networkId (string) required
userId (string) required
nextToken (string)
maxResults (integer)
sortFields (string)
sortDirection (string)
wickr/list_guest_usersRetrieves a paginated list of guest users who have communicated with your Wickr network. Guest users are external users from federated networks who can communicate with network members.networkId (string) required
maxResults (integer)
sortDirection (string)
sortFields (string)
username (string)
billingPeriod (string)
nextToken (string)
wickr/list_networksRetrieves a paginated list of all Wickr networks associated with your Amazon Web Services account. You can sort the results by network ID or name.maxResults (integer)
sortFields (string)
sortDirection (string)
nextToken (string)
wickr/list_security_groupsRetrieves a paginated list of security groups in a specified Wickr network. You can sort the results by various criteria.networkId (string) required
nextToken (string)
maxResults (integer)
sortFields (string)
sortDirection (string)
wickr/list_security_group_usersRetrieves a paginated list of users who belong to a specific security group in a Wickr network.networkId (string) required
groupId (string) required
nextToken (string)
maxResults (integer)
sortFields (string)
sortDirection (string)
wickr/list_usersRetrieves a paginated list of users in a specified Wickr network. You can filter and sort the results based on various criteria such as name, status, or security group membership.networkId (string) required
nextToken (string)
maxResults (integer)
sortFields (string)
sortDirection (string)
firstName (string)
lastName (string)
username (string)
status (integer)
groupId (string)
wickr/register_oidc_configRegisters and saves an OpenID Connect OIDC configuration for a Wickr network, enabling Single Sign-On SSO authentication through an identity provider.networkId (string) required
companyId (string) required
customUsername (string)
extraAuthParams (string)
issuer (string) required
scopes (string) required
secret (string)
ssoTokenBufferMinutes (integer)
userId (string)
wickr/register_oidc_config_testTests an OpenID Connect OIDC configuration for a Wickr network by validating the connection to the identity provider and retrieving its supported capabilities.networkId (string) required
extraAuthParams (string)
issuer (string) required
scopes (string) required
certificate (string)
wickr/update_botUpdates the properties of an existing bot in a Wickr network. This operation allows you to modify the bot's display name, security group, password, or suspension status.networkId (string) required
botId (string) required
displayName (string)
groupId (string)
challenge (string)
suspend (boolean)
wickr/update_data_retentionUpdates the data retention bot settings, allowing you to enable or disable the data retention service, or acknowledge the public key message.networkId (string) required
actionType (string) required
wickr/update_guest_userUpdates the block status of a guest user in a Wickr network. This operation allows you to block or unblock a guest user from accessing the network.networkId (string) required
usernameHash (string) required
block (boolean) required
wickr/update_networkUpdates the properties of an existing Wickr network, such as its name or encryption key configuration.networkId (string) required
networkName (string) required
clientToken (string)
encryptionKeyArn (string)
wickr/update_network_settingsUpdates network-level settings for a Wickr network. You can modify settings such as client metrics, data retention, and other network-wide options.networkId (string) required
settings: {
. enableClientMetrics (boolean)
. readReceiptConfig (object)
. dataRetention (boolean)
} (object) required
wickr/update_security_groupUpdates the properties of an existing security group in a Wickr network, such as its name or settings.networkId (string) required
groupId (string) required
name (string)
securityGroupSettings: {
. alwaysReauthenticate (boolean)
. atakPackageValues (array)
. calling (object)
. checkForUpdates (boolean)
. enableAtak (boolean)
. enableCrashReports (boolean)
. enableFileDownload (boolean)
. enableGuestFederation (boolean)
. enableNotificationPreview (boolean)
. enableOpenAccessOption (boolean)
. enableRestrictedGlobalFederation (boolean)
. filesEnabled (boolean)
. forceDeviceLockout (integer)
. forceOpenAccess (boolean)
. forceReadReceipts (boolean)
. globalFederation (boolean)
. isAtoEnabled (boolean)
. isLinkPreviewEnabled (boolean)
. locationAllowMaps (boolean)
. locationEnabled (boolean)
. maxAutoDownloadSize (integer)
. maxBor (integer)
. maxTtl (integer)
. messageForwardingEnabled (boolean)
. passwordRequirements (object)
. presenceEnabled (boolean)
. quickResponses (array)
. showMasterRecoveryKey (boolean)
. shredder (object)
. ssoMaxIdleMinutes (integer)
. federationMode (integer)
. lockoutThreshold (integer)
. permittedNetworks (array)
. permittedWickrAwsNetworks (array)
. permittedWickrEnterpriseNetworks (array)
} (object)
wickr/update_userUpdates the properties of an existing user in a Wickr network. This operation allows you to modify the user's name, password, security group membership, and invite code settings. codeValidation, inviteCode, and inviteCodeTtl are restricted to networks under preview only.networkId (string) required
userId (string) required
userDetails: {
. firstName (string)
. lastName (string)
. username (string)
. securityGroupIds (array)
. inviteCode (string)
. inviteCodeTtl (integer)
. codeValidation (boolean)
} (object)
wisdom/list_tags_for_resourceLists the tags for the specified resource.resourceArn (string) required
wisdom/tag_resourceAdds the specified tags to the specified resource.resourceArn (string) required
tags (object) required
wisdom/untag_resourceRemoves the specified tags from the specified resource.resourceArn (string) required
tagKeys (array) required
wisdom/get_recommendationsRetrieves 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.assistantId (string) required
sessionId (string) required
maxResults (integer)
waitTimeSeconds (integer)
wisdom/notify_recommendations_receivedRemoves 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.assistantId (string) required
sessionId (string) required
recommendationIds (array) required
wisdom/query_assistantPerforms a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.assistantId (string) required
queryText (string) required
nextToken (string)
maxResults (integer)
wisdom/search_sessionsSearches for sessions.nextToken (string)
maxResults (integer)
assistantId (string) required
searchExpression: {
. filters (array)
} (object) required
wisdom/create_assistantCreates an Amazon Connect Wisdom assistant.clientToken (string)
name (string) required
type (string) required
description (string)
tags (object)
serverSideEncryptionConfiguration: {
. kmsKeyId (string)
} (object)
wisdom/get_assistantRetrieves information about an assistant.assistantId (string) required
wisdom/delete_assistantDeletes an assistant.assistantId (string) required
wisdom/list_assistantsLists information about assistants.nextToken (string)
maxResults (integer)
wisdom/create_assistant_associationCreates 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.assistantId (string) required
associationType (string) required
association (undefined) required
clientToken (string)
tags (object)
wisdom/get_assistant_associationRetrieves information about an assistant association.assistantAssociationId (string) required
assistantId (string) required
wisdom/delete_assistant_associationDeletes an assistant association.assistantAssociationId (string) required
assistantId (string) required
wisdom/list_assistant_associationsLists information about assistant associations.nextToken (string)
maxResults (integer)
assistantId (string) required
wisdom/create_sessionCreates 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.clientToken (string)
assistantId (string) required
name (string) required
description (string)
tags (object)
wisdom/get_sessionRetrieves information for a specified session.assistantId (string) required
sessionId (string) required
wisdom/delete_import_jobDeletes the quick response import job.knowledgeBaseId (string) required
importJobId (string) required
wisdom/get_import_jobRetrieves the started import job.importJobId (string) required
knowledgeBaseId (string) required
wisdom/list_import_jobsLists information about import jobs.nextToken (string)
maxResults (integer)
knowledgeBaseId (string) required
wisdom/remove_knowledge_base_template_uriRemoves a URI template from a knowledge base.knowledgeBaseId (string) required
wisdom/search_contentSearches for content in a specified knowledge base. Can be used to get a specific content resource by its name.nextToken (string)
maxResults (integer)
knowledgeBaseId (string) required
searchExpression: {
. filters (array)
} (object) required
wisdom/search_quick_responsesSearches existing Wisdom quick responses in a Wisdom knowledge base.knowledgeBaseId (string) required
searchExpression: {
. queries (array)
. filters (array)
. orderOnField (object)
} (object) required
nextToken (string)
maxResults (integer)
attributes (object)
wisdom/start_content_uploadGet 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.knowledgeBaseId (string) required
contentType (string) required
presignedUrlTimeToLive (integer)
wisdom/start_import_jobStart an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data. For importing Wisdom quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.knowledgeBaseId (string) required
importJobType (string) required
uploadId (string) required
clientToken (string)
metadata (object)
externalSourceConfiguration: {
. source (string)
. configuration
} (object)
wisdom/update_knowledge_base_template_uriUpdates 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.knowledgeBaseId (string) required
templateUri (string) required
wisdom/create_knowledge_baseCreates 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. 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: Call DeleteKnowledgeBase. Call DeleteDataIntegration. Call CreateDataIntegration to recreateclientToken (string)
name (string) required
knowledgeBaseType (string) required
sourceConfiguration (undefined)
renderingConfiguration: {
. templateUri (string)
} (object)
serverSideEncryptionConfiguration: {
. kmsKeyId (string)
} (object)
description (string)
tags (object)
wisdom/get_knowledge_baseRetrieves information about the knowledge base.knowledgeBaseId (string) required
wisdom/delete_knowledge_baseDeletes 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.knowledgeBaseId (string) required
wisdom/list_knowledge_basesLists the knowledge bases.nextToken (string)
maxResults (integer)
wisdom/get_content_summaryRetrieves summary information about the content.contentId (string) required
knowledgeBaseId (string) required
wisdom/create_contentCreates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.knowledgeBaseId (string) required
name (string) required
title (string)
overrideLinkOutUri (string)
metadata (object)
uploadId (string) required
clientToken (string)
tags (object)
wisdom/get_contentRetrieves content, including a pre-signed URL to download the content.contentId (string) required
knowledgeBaseId (string) required
wisdom/update_contentUpdates information about the content.knowledgeBaseId (string) required
contentId (string) required
revisionId (string)
title (string)
overrideLinkOutUri (string)
removeOverrideLinkOutUri (boolean)
metadata (object)
uploadId (string)
wisdom/delete_contentDeletes the content.knowledgeBaseId (string) required
contentId (string) required
wisdom/list_contentsLists the content.nextToken (string)
maxResults (integer)
knowledgeBaseId (string) required
wisdom/create_quick_responseCreates a Wisdom quick response.knowledgeBaseId (string) required
name (string) required
content (undefined) required
contentType (string)
groupingConfiguration: {
. criteria (string)
. values (array)
} (object)
description (string)
shortcutKey (string)
isActive (boolean)
channels (array)
language (string)
clientToken (string)
tags (object)
wisdom/get_quick_responseRetrieves the quick response.quickResponseId (string) required
knowledgeBaseId (string) required
wisdom/update_quick_responseUpdates an existing Wisdom quick response.knowledgeBaseId (string) required
quickResponseId (string) required
name (string)
content (undefined)
contentType (string)
groupingConfiguration: {
. criteria (string)
. values (array)
} (object)
removeGroupingConfiguration (boolean)
description (string)
removeDescription (boolean)
shortcutKey (string)
removeShortcutKey (boolean)
isActive (boolean)
channels (array)
language (string)
wisdom/delete_quick_responseDeletes a quick response.knowledgeBaseId (string) required
quickResponseId (string) required
wisdom/list_quick_responsesLists information about quick response.nextToken (string)
maxResults (integer)
knowledgeBaseId (string) required
workdocs/abort_document_version_uploadAborts 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.AuthenticationToken (string)
DocumentId (string) required
VersionId (string) required
workdocs/activate_userActivates the specified user. Only active users can access Amazon WorkDocs.UserId (string) required
AuthenticationToken (string)
workdocs/add_resource_permissionsCreates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.AuthenticationToken (string)
ResourceId (string) required
Principals (array) required
NotificationOptions: {
. SendEmail (boolean)
. EmailMessage (string)
} (object)
workdocs/create_commentAdds a new comment to the specified document version.AuthenticationToken (string)
DocumentId (string) required
VersionId (string) required
ParentId (string)
ThreadId (string)
Text (string) required
Visibility (string)
NotifyCollaborators (boolean)
workdocs/create_custom_metadataAdds one or more custom properties to the specified resource a folder, document, or version.AuthenticationToken (string)
ResourceId (string) required
VersionId (string)
CustomMetadata (object) required
workdocs/create_folderCreates a folder with the specified name and parent folder.AuthenticationToken (string)
Name (string)
ParentFolderId (string) required
workdocs/create_labelsAdds the specified list of labels to the given resource a document or folderResourceId (string) required
Labels (array) required
AuthenticationToken (string)
workdocs/create_notification_subscriptionConfigure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription. For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.OrganizationId (string) required
Endpoint (string) required
Protocol (string) required
SubscriptionType (string) required
workdocs/create_userCreates 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.OrganizationId (string)
Username (string) required
EmailAddress (string)
GivenName (string) required
Surname (string) required
Password (string) required
TimeZoneId (string)
StorageRule: {
. StorageAllocatedInBytes (integer)
. StorageType (string)
} (object)
AuthenticationToken (string)
workdocs/deactivate_userDeactivates the specified user, which revokes the user's access to Amazon WorkDocs.UserId (string) required
AuthenticationToken (string)
workdocs/delete_commentDeletes the specified comment from the document version.AuthenticationToken (string)
DocumentId (string) required
VersionId (string) required
CommentId (string) required
workdocs/delete_custom_metadataDeletes custom metadata from the specified resource.AuthenticationToken (string)
ResourceId (string) required
VersionId (string)
Keys (array)
DeleteAll (boolean)
workdocs/delete_documentPermanently deletes the specified document and its associated metadata.AuthenticationToken (string)
DocumentId (string) required
workdocs/delete_document_versionDeletes a specific version of a document.AuthenticationToken (string)
DocumentId (string) required
VersionId (string) required
DeletePriorVersions (boolean) required
workdocs/delete_folderPermanently deletes the specified folder and its contents.AuthenticationToken (string)
FolderId (string) required
workdocs/delete_folder_contentsDeletes the contents of the specified folder.AuthenticationToken (string)
FolderId (string) required
workdocs/delete_labelsDeletes the specified list of labels from a resource.ResourceId (string) required
AuthenticationToken (string)
Labels (array)
DeleteAll (boolean)
workdocs/delete_notification_subscriptionDeletes the specified subscription from the specified organization.SubscriptionId (string) required
OrganizationId (string) required
workdocs/delete_userDeletes the specified user from a Simple AD or Microsoft AD directory. Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.AuthenticationToken (string)
UserId (string) required
workdocs/describe_activitiesDescribes the user activities in a specified time period.AuthenticationToken (string)
StartTime (string)
EndTime (string)
OrganizationId (string)
ActivityTypes (string)
ResourceId (string)
UserId (string)
IncludeIndirectActivities (boolean)
Limit (integer)
Marker (string)
workdocs/describe_commentsList all the comments for the specified document version.AuthenticationToken (string)
DocumentId (string) required
VersionId (string) required
Limit (integer)
Marker (string)
workdocs/describe_document_versionsRetrieves the document versions for the specified document. By default, only active versions are returned.AuthenticationToken (string)
DocumentId (string) required
Marker (string)
Limit (integer)
Include (string)
Fields (string)
workdocs/describe_folder_contentsDescribes 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.AuthenticationToken (string)
FolderId (string) required
Sort (string)
Order (string)
Limit (integer)
Marker (string)
Type (string)
Include (string)
workdocs/describe_groupsDescribes the groups specified by the query. Groups are defined by the underlying Active Directory.AuthenticationToken (string)
SearchQuery (string) required
OrganizationId (string)
Marker (string)
Limit (integer)
workdocs/describe_notification_subscriptionsLists the specified notification subscriptions.OrganizationId (string) required
Marker (string)
Limit (integer)
workdocs/describe_resource_permissionsDescribes the permissions of a specified resource.AuthenticationToken (string)
ResourceId (string) required
PrincipalId (string)
Limit (integer)
Marker (string)
workdocs/describe_root_foldersDescribes 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.AuthenticationToken (string) required
Limit (integer)
Marker (string)
workdocs/describe_usersDescribes 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.AuthenticationToken (string)
OrganizationId (string)
UserIds (string)
Query (string)
Include (string)
Order (string)
Sort (string)
Marker (string)
Limit (integer)
Fields (string)
workdocs/get_current_userRetrieves 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.AuthenticationToken (string) required
workdocs/get_documentRetrieves details of a document.AuthenticationToken (string)
DocumentId (string) required
IncludeCustomMetadata (boolean)
workdocs/get_document_pathRetrieves 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.AuthenticationToken (string)
DocumentId (string) required
Limit (integer)
Fields (string)
Marker (string)
workdocs/get_document_versionRetrieves version metadata for the specified document.AuthenticationToken (string)
DocumentId (string) required
VersionId (string) required
Fields (string)
IncludeCustomMetadata (boolean)
workdocs/get_folderRetrieves the metadata of the specified folder.AuthenticationToken (string)
FolderId (string) required
IncludeCustomMetadata (boolean)
workdocs/get_folder_pathRetrieves 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.AuthenticationToken (string)
FolderId (string) required
Limit (integer)
Fields (string)
Marker (string)
workdocs/get_resourcesRetrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.AuthenticationToken (string)
UserId (string)
CollectionType (string)
Limit (integer)
Marker (string)
workdocs/initiate_document_version_uploadCreates 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.AuthenticationToken (string)
Id (string)
Name (string)
ContentCreatedTimestamp (string)
ContentModifiedTimestamp (string)
ContentType (string)
DocumentSizeInBytes (integer)
ParentFolderId (string)
workdocs/remove_all_resource_permissionsRemoves all the permissions from the specified resource.AuthenticationToken (string)
ResourceId (string) required
workdocs/remove_resource_permissionRemoves the permission for the specified principal from the specified resource.AuthenticationToken (string)
ResourceId (string) required
PrincipalId (string) required
PrincipalType (string)
workdocs/restore_document_versionsRecovers a deleted version of an Amazon WorkDocs document.AuthenticationToken (string)
DocumentId (string) required
workdocs/search_resourcesSearches metadata and the content of folders, documents, document versions, and comments.AuthenticationToken (string)
QueryText (string)
QueryScopes (array)
OrganizationId (string)
AdditionalResponseFields (array)
Filters: {
. TextLocales (array)
. ContentCategories (array)
. ResourceTypes (array)
. Labels (array)
. Principals (array)
. AncestorIds (array)
. SearchCollectionTypes (array)
. SizeRange (object)
. CreatedRange (object)
. ModifiedRange (object)
} (object)
OrderBy (array)
Limit (integer)
Marker (string)
workdocs/update_documentUpdates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.AuthenticationToken (string)
DocumentId (string) required
Name (string)
ParentFolderId (string)
ResourceState (string)
workdocs/update_document_versionChanges 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.AuthenticationToken (string)
DocumentId (string) required
VersionId (string) required
VersionStatus (string)
workdocs/update_folderUpdates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.AuthenticationToken (string)
FolderId (string) required
Name (string)
ParentFolderId (string)
ResourceState (string)
workdocs/update_userUpdates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.AuthenticationToken (string)
UserId (string) required
GivenName (string)
Surname (string)
Type (string)
StorageRule: {
. StorageAllocatedInBytes (integer)
. StorageType (string)
} (object)
TimeZoneId (string)
Locale (string)
GrantPoweruserPrivileges (string)
workmail/associate_delegate_to_resourceAdds a member user or group to the resource's set of delegates.OrganizationId (string) required
ResourceId (string) required
EntityId (string) required
workmail/associate_member_to_groupAdds a member user or group to the group's set.OrganizationId (string) required
GroupId (string) required
MemberId (string) required
workmail/assume_impersonation_roleAssumes an impersonation role for the given WorkMail organization. This method returns an authentication token you can use to make impersonated calls.OrganizationId (string) required
ImpersonationRoleId (string) required
workmail/cancel_mailbox_export_jobCancels a mailbox export job. If the mailbox export job is near completion, it might not be possible to cancel it.ClientToken (string) required
JobId (string) required
OrganizationId (string) required
workmail/create_aliasAdds an alias to the set of a given member user or group of WorkMail.OrganizationId (string) required
EntityId (string) required
Alias (string) required
workmail/create_availability_configurationCreates an AvailabilityConfiguration for the given WorkMail organization and domain.ClientToken (string)
OrganizationId (string) required
DomainName (string) required
EwsProvider: {
. EwsEndpoint (string)
. EwsUsername (string)
. EwsPassword (string)
} (object)
LambdaProvider: {
. LambdaArn (string)
} (object)
workmail/create_groupCreates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.OrganizationId (string) required
Name (string) required
HiddenFromGlobalAddressList (boolean)
workmail/create_identity_center_applicationCreates the WorkMail application in IAM Identity Center that can be used later in the WorkMail - IdC integration. For more information, see PutIdentityProviderConfiguration. This action does not affect the authentication settings for any WorkMail organizations.Name (string) required
InstanceArn (string) required
ClientToken (string)
workmail/create_impersonation_roleCreates 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.ClientToken (string)
OrganizationId (string) required
Name (string) required
Type (string) required
Description (string)
Rules (array) required
workmail/create_mobile_device_access_ruleCreates a new mobile device access rule for the specified WorkMail organization.OrganizationId (string) required
ClientToken (string)
Name (string) required
Description (string)
Effect (string) required
DeviceTypes (array)
NotDeviceTypes (array)
DeviceModels (array)
NotDeviceModels (array)
DeviceOperatingSystems (array)
NotDeviceOperatingSystems (array)
DeviceUserAgents (array)
NotDeviceUserAgents (array)
workmail/create_organizationCreates 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 emailDirectoryId (string)
Alias (string) required
ClientToken (string)
Domains (array)
KmsKeyArn (string)
EnableInteroperability (boolean)
workmail/create_resourceCreates a new WorkMail resource.OrganizationId (string) required
Name (string) required
Type (string) required
Description (string)
HiddenFromGlobalAddressList (boolean)
workmail/create_userCreates a user who can be used in WorkMail by calling the RegisterToWorkMail operation.OrganizationId (string) required
Name (string) required
DisplayName (string) required
Password (string)
Role (string)
FirstName (string)
LastName (string)
HiddenFromGlobalAddressList (boolean)
IdentityProviderUserId (string)
workmail/delete_access_control_ruleDeletes 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.OrganizationId (string) required
Name (string) required
workmail/delete_aliasRemove one or more specified aliases from a set of aliases for a given user.OrganizationId (string) required
EntityId (string) required
Alias (string) required
workmail/delete_availability_configurationDeletes the AvailabilityConfiguration for the given WorkMail organization and domain.OrganizationId (string) required
DomainName (string) required
workmail/delete_email_monitoring_configurationDeletes the email monitoring configuration for a specified organization.OrganizationId (string) required
workmail/delete_groupDeletes a group from WorkMail.OrganizationId (string) required
GroupId (string) required
workmail/delete_identity_center_applicationDeletes the IAM Identity Center application from WorkMail. This action does not affect the authentication settings for any WorkMail organizations.ApplicationArn (string) required
workmail/delete_identity_provider_configurationDisables the integration between IdC and WorkMail. Authentication will continue with the directory as it was before the IdC integration. You might have to reset your directory passwords and reconfigure your desktop and mobile email clients.OrganizationId (string) required
workmail/delete_impersonation_roleDeletes an impersonation role for the given WorkMail organization.OrganizationId (string) required
ImpersonationRoleId (string) required
workmail/delete_mailbox_permissionsDeletes permissions granted to a member user or group.OrganizationId (string) required
EntityId (string) required
GranteeId (string) required
workmail/delete_mobile_device_access_overrideDeletes 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.OrganizationId (string) required
UserId (string) required
DeviceId (string) required
workmail/delete_mobile_device_access_ruleDeletes 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.OrganizationId (string) required
MobileDeviceAccessRuleId (string) required
workmail/delete_organizationDeletes 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.ClientToken (string)
OrganizationId (string) required
DeleteDirectory (boolean) required
ForceDelete (boolean)
DeleteIdentityCenterApplication (boolean)
workmail/delete_personal_access_tokenDeletes the Personal Access Token from the provided WorkMail Organization.OrganizationId (string) required
PersonalAccessTokenId (string) required
workmail/delete_resourceDeletes the specified resource.OrganizationId (string) required
ResourceId (string) required
workmail/delete_retention_policyDeletes the specified retention policy from the specified organization.OrganizationId (string) required
Id (string) required
workmail/delete_userDeletes 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.OrganizationId (string) required
UserId (string) required
workmail/deregister_from_work_mailMark 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.OrganizationId (string) required
EntityId (string) required
workmail/deregister_mail_domainRemoves 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.OrganizationId (string) required
DomainName (string) required
workmail/describe_email_monitoring_configurationDescribes the current email monitoring configuration for a specified organization.OrganizationId (string) required
workmail/describe_entityReturns basic details about an entity in WorkMail.OrganizationId (string) required
Email (string) required
workmail/describe_groupReturns the data available for the group.OrganizationId (string) required
GroupId (string) required
workmail/describe_identity_provider_configurationReturns detailed information on the current IdC setup for the WorkMail organization.OrganizationId (string) required
workmail/describe_inbound_dmarc_settingsLists the settings in a DMARC policy for a specified organization.OrganizationId (string) required
workmail/describe_mailbox_export_jobDescribes the current status of a mailbox export job.JobId (string) required
OrganizationId (string) required
workmail/describe_organizationProvides more information regarding a given organization based on its identifier.OrganizationId (string) required
workmail/describe_resourceReturns the data available for the resource.OrganizationId (string) required
ResourceId (string) required
workmail/describe_userProvides information regarding the user.OrganizationId (string) required
UserId (string) required
workmail/disassociate_delegate_from_resourceRemoves a member from the resource's set of delegates.OrganizationId (string) required
ResourceId (string) required
EntityId (string) required
workmail/disassociate_member_from_groupRemoves a member from a group.OrganizationId (string) required
GroupId (string) required
MemberId (string) required
workmail/get_access_control_effectGets 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.OrganizationId (string) required
IpAddress (string) required
Action (string) required
UserId (string)
ImpersonationRoleId (string)
workmail/get_default_retention_policyGets the default retention policy details for the specified organization.OrganizationId (string) required
workmail/get_impersonation_roleGets the impersonation role details for the given WorkMail organization.OrganizationId (string) required
ImpersonationRoleId (string) required
workmail/get_impersonation_role_effectTests whether the given impersonation role can impersonate a target user.OrganizationId (string) required
ImpersonationRoleId (string) required
TargetUser (string) required
workmail/get_mailbox_detailsRequests a user's mailbox details for a specified organization and user.OrganizationId (string) required
UserId (string) required
workmail/get_mail_domainGets details for a mail domain, including domain records required to configure your domain with recommended security.OrganizationId (string) required
DomainName (string) required
workmail/get_mobile_device_access_effectSimulates 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.OrganizationId (string) required
DeviceType (string)
DeviceModel (string)
DeviceOperatingSystem (string)
DeviceUserAgent (string)
workmail/get_mobile_device_access_overrideGets the mobile device access override for the given WorkMail organization, user, and device.OrganizationId (string) required
UserId (string) required
DeviceId (string) required
workmail/get_personal_access_token_metadataRequests details of a specific Personal Access Token within the WorkMail organization.OrganizationId (string) required
PersonalAccessTokenId (string) required
workmail/list_access_control_rulesLists the access control rules for the specified organization.OrganizationId (string) required
workmail/list_aliasesCreates a paginated call to list the aliases associated with a given entity.OrganizationId (string) required
EntityId (string) required
NextToken (string)
MaxResults (integer)
workmail/list_availability_configurationsList all the AvailabilityConfiguration's for the given WorkMail organization.OrganizationId (string) required
MaxResults (integer)
NextToken (string)
workmail/list_group_membersReturns an overview of the members of a group. Users and groups can be members of a group.OrganizationId (string) required
GroupId (string) required
NextToken (string)
MaxResults (integer)
workmail/list_groupsReturns summaries of the organization's groups.OrganizationId (string) required
NextToken (string)
MaxResults (integer)
Filters: {
. NamePrefix (string)
. PrimaryEmailPrefix (string)
. State (string)
} (object)
workmail/list_groups_for_entityReturns all the groups to which an entity belongs.OrganizationId (string) required
EntityId (string) required
Filters: {
. GroupNamePrefix (string)
} (object)
NextToken (string)
MaxResults (integer)
workmail/list_impersonation_rolesLists all the impersonation roles for the given WorkMail organization.OrganizationId (string) required
NextToken (string)
MaxResults (integer)
workmail/list_mailbox_export_jobsLists the mailbox export jobs started for the specified organization within the last seven days.OrganizationId (string) required
NextToken (string)
MaxResults (integer)
workmail/list_mailbox_permissionsLists the mailbox permissions associated with a user, group, or resource mailbox.OrganizationId (string) required
EntityId (string) required
NextToken (string)
MaxResults (integer)
workmail/list_mail_domainsLists the mail domains in a given WorkMail organization.OrganizationId (string) required
MaxResults (integer)
NextToken (string)
workmail/list_mobile_device_access_overridesLists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.OrganizationId (string) required
UserId (string)
DeviceId (string)
NextToken (string)
MaxResults (integer)
workmail/list_mobile_device_access_rulesLists the mobile device access rules for the specified WorkMail organization.OrganizationId (string) required
workmail/list_organizationsReturns summaries of the customer's organizations.NextToken (string)
MaxResults (integer)
workmail/list_personal_access_tokensReturns a summary of your Personal Access Tokens.OrganizationId (string) required
UserId (string)
NextToken (string)
MaxResults (integer)
workmail/list_resource_delegatesLists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.OrganizationId (string) required
ResourceId (string) required
NextToken (string)
MaxResults (integer)
workmail/list_resourcesReturns summaries of the organization's resources.OrganizationId (string) required
NextToken (string)
MaxResults (integer)
Filters: {
. NamePrefix (string)
. PrimaryEmailPrefix (string)
. State (string)
} (object)
workmail/list_tags_for_resourceLists the tags applied to an WorkMail organization resource.ResourceARN (string) required
workmail/list_usersReturns summaries of the organization's users.OrganizationId (string) required
NextToken (string)
MaxResults (integer)
Filters: {
. UsernamePrefix (string)
. DisplayNamePrefix (string)
. PrimaryEmailPrefix (string)
. State (string)
. IdentityProviderUserIdPrefix (string)
} (object)
workmail/put_access_control_ruleAdds 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.Name (string) required
Effect (string) required
Description (string) required
IpRanges (array)
NotIpRanges (array)
Actions (array)
NotActions (array)
UserIds (array)
NotUserIds (array)
OrganizationId (string) required
ImpersonationRoleIds (array)
NotImpersonationRoleIds (array)
workmail/put_email_monitoring_configurationCreates or updates the email monitoring configuration for a specified organization.OrganizationId (string) required
RoleArn (string)
LogGroupArn (string) required
workmail/put_identity_provider_configurationEnables integration between IAM Identity Center IdC and WorkMail to proxy authentication requests for mailbox users. You can connect your IdC directory or your external directory to WorkMail through IdC and manage access to WorkMail mailboxes in a single place. For enhanced protection, you could enable Multifactor Authentication MFA and Personal Access Tokens.OrganizationId (string) required
AuthenticationMode (string) required
IdentityCenterConfiguration: {
. InstanceArn (string)
. ApplicationArn (string)
} (object) required
PersonalAccessTokenConfiguration: {
. Status (string)
. LifetimeInDays (integer)
} (object) required
workmail/put_inbound_dmarc_settingsEnables or disables a DMARC policy for a given organization.OrganizationId (string) required
Enforced (boolean) required
workmail/put_mailbox_permissionsSets permissions for a user, group, or resource. This replaces any pre-existing permissions.OrganizationId (string) required
EntityId (string) required
GranteeId (string) required
PermissionValues (array) required
workmail/put_mobile_device_access_overrideCreates or updates a mobile device access override for the given WorkMail organization, user, and device.OrganizationId (string) required
UserId (string) required
DeviceId (string) required
Effect (string) required
Description (string)
workmail/put_retention_policyPuts a retention policy to the specified organization.OrganizationId (string) required
Id (string)
Name (string) required
Description (string)
FolderConfigurations (array) required
workmail/register_mail_domainRegisters 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.ClientToken (string)
OrganizationId (string) required
DomainName (string) required
workmail/register_to_work_mailRegisters 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 synchronizeOrganizationId (string) required
EntityId (string) required
Email (string) required
workmail/reset_passwordAllows the administrator to reset the password for a user.OrganizationId (string) required
UserId (string) required
Password (string) required
workmail/start_mailbox_export_jobStarts 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.ClientToken (string) required
OrganizationId (string) required
EntityId (string) required
Description (string)
RoleArn (string) required
KmsKeyArn (string) required
S3BucketName (string) required
S3Prefix (string) required
workmail/tag_resourceApplies the specified tags to the specified WorkMailorganization resource.ResourceARN (string) required
Tags (array) required
workmail/test_availability_configurationPerforms 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 DomainNaOrganizationId (string) required
DomainName (string)
EwsProvider: {
. EwsEndpoint (string)
. EwsUsername (string)
. EwsPassword (string)
} (object)
LambdaProvider: {
. LambdaArn (string)
} (object)
workmail/untag_resourceUntags the specified tags from the specified WorkMail organization resource.ResourceARN (string) required
TagKeys (array) required
workmail/update_availability_configurationUpdates an existing AvailabilityConfiguration for the given WorkMail organization and domain.OrganizationId (string) required
DomainName (string) required
EwsProvider: {
. EwsEndpoint (string)
. EwsUsername (string)
. EwsPassword (string)
} (object)
LambdaProvider: {
. LambdaArn (string)
} (object)
workmail/update_default_mail_domainUpdates 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.OrganizationId (string) required
DomainName (string) required
workmail/update_groupUpdates attributes in a group.OrganizationId (string) required
GroupId (string) required
HiddenFromGlobalAddressList (boolean)
workmail/update_impersonation_roleUpdates an impersonation role for the given WorkMail organization.OrganizationId (string) required
ImpersonationRoleId (string) required
Name (string) required
Type (string) required
Description (string)
Rules (array) required
workmail/update_mailbox_quotaUpdates a user's current mailbox quota for a specified organization and user.OrganizationId (string) required
UserId (string) required
MailboxQuota (integer) required
workmail/update_mobile_device_access_ruleUpdates a mobile device access rule for the specified WorkMail organization.OrganizationId (string) required
MobileDeviceAccessRuleId (string) required
Name (string) required
Description (string)
Effect (string) required
DeviceTypes (array)
NotDeviceTypes (array)
DeviceModels (array)
NotDeviceModels (array)
DeviceOperatingSystems (array)
NotDeviceOperatingSystems (array)
DeviceUserAgents (array)
NotDeviceUserAgents (array)
workmail/update_primary_email_addressUpdates 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.OrganizationId (string) required
EntityId (string) required
Email (string) required
workmail/update_resourceUpdates 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.OrganizationId (string) required
ResourceId (string) required
Name (string)
BookingOptions: {
. AutoAcceptRequests (boolean)
. AutoDeclineRecurringRequests (boolean)
. AutoDeclineConflictingRequests (boolean)
} (object)
Description (string)
Type (string)
HiddenFromGlobalAddressList (boolean)
workmail/update_userUpdates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another DescribeUser call.OrganizationId (string) required
UserId (string) required
Role (string)
DisplayName (string)
FirstName (string)
LastName (string)
HiddenFromGlobalAddressList (boolean)
Initials (string)
Telephone (string)
Street (string)
JobTitle (string)
City (string)
Company (string)
ZipCode (string)
Department (string)
Country (string)
Office (string)
IdentityProviderUserId (string)
workmailmessageflow/get_raw_message_contentRetrieves the raw content of an in-transit email message, in MIME format.messageId (string) required
workmailmessageflow/put_raw_message_contentUpdates 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 GemessageId (string) required
content: {
. s3Reference (object)
} (object) required
workspaces_instances/associate_volumeAttaches a volume to a WorkSpace Instance.WorkspaceInstanceId (string) required
VolumeId (string) required
Device (string) required
workspaces_instances/create_volumeCreates a new volume for WorkSpace Instances.AvailabilityZone (string) required
ClientToken (string)
Encrypted (boolean)
Iops (integer)
KmsKeyId (string)
SizeInGB (integer)
SnapshotId (string)
TagSpecifications (array)
Throughput (integer)
VolumeType (string)
workspaces_instances/create_workspace_instanceLaunches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.ClientToken (string)
Tags (array)
ManagedInstance: {
. BlockDeviceMappings (array)
. CapacityReservationSpecification (object)
. CpuOptions (object)
. CreditSpecification (object)
. DisableApiStop (boolean)
. EbsOptimized (boolean)
. EnablePrimaryIpv6 (boolean)
. EnclaveOptions (object)
. HibernationOptions (object)
. IamInstanceProfile (object)
. ImageId (string)
. InstanceMarketOptions (object)
. InstanceType (string)
. Ipv6Addresses (array)
. Ipv6AddressCount (integer)
. KernelId (string)
. KeyName (string)
. LicenseSpecifications (array)
. MaintenanceOptions (object)
. MetadataOptions (object)
. Monitoring (object)
. NetworkInterfaces (array)
. NetworkPerformanceOptions (object)
. Placement (object)
. PrivateDnsNameOptions (object)
. PrivateIpAddress (string)
. RamdiskId (string)
. SecurityGroupIds (array)
. SecurityGroups (array)
. SubnetId (string)
. TagSpecifications (array)
. UserData (string)
} (object) required
BillingConfiguration: {
. BillingMode (string)
} (object)
workspaces_instances/delete_volumeDeletes a specified volume.VolumeId (string) required
workspaces_instances/delete_workspace_instanceDeletes the specified WorkSpace Usage of this API will result in deletion of the resource in question.WorkspaceInstanceId (string) required
workspaces_instances/disassociate_volumeDetaches a volume from a WorkSpace Instance.WorkspaceInstanceId (string) required
VolumeId (string) required
Device (string)
DisassociateMode (string)
workspaces_instances/get_workspace_instanceRetrieves detailed information about a specific WorkSpace Instance.WorkspaceInstanceId (string) required
workspaces_instances/list_instance_typesRetrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.MaxResults (integer)
NextToken (string)
InstanceConfigurationFilter: {
. BillingMode (string)
. PlatformType (string)
. Tenancy (string)
} (object)
workspaces_instances/list_regionsRetrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.MaxResults (integer)
NextToken (string)
workspaces_instances/list_tags_for_resourceRetrieves tags for a WorkSpace Instance.WorkspaceInstanceId (string) required
workspaces_instances/list_workspace_instancesRetrieves a collection of WorkSpaces Instances based on specified filters.ProvisionStates (array)
MaxResults (integer)
NextToken (string)
workspaces_instances/tag_resourceAdds tags to a WorkSpace Instance.WorkspaceInstanceId (string) required
Tags (array) required
workspaces_instances/untag_resourceRemoves tags from a WorkSpace Instance.WorkspaceInstanceId (string) required
TagKeys (array) required
workspaces_thin_client/create_environmentCreates an environment for your thin client devices.name (string)
desktopArn (string) required
desktopEndpoint (string)
softwareSetUpdateSchedule (string)
maintenanceWindow: {
. type (string)
. startTimeHour (integer)
. startTimeMinute (integer)
. endTimeHour (integer)
. endTimeMinute (integer)
. daysOfTheWeek (array)
. applyTimeOf (string)
} (object)
softwareSetUpdateMode (string)
desiredSoftwareSetId (string)
kmsKeyArn (string)
clientToken (string)
tags (object)
deviceCreationTags (object)
workspaces_thin_client/delete_deviceDeletes a thin client device.id (string) required
clientToken (string)
workspaces_thin_client/delete_environmentDeletes an environment.id (string) required
clientToken (string)
workspaces_thin_client/deregister_deviceDeregisters a thin client device.id (string) required
targetDeviceStatus (string)
clientToken (string)
workspaces_thin_client/get_deviceReturns information for a thin client device.id (string) required
workspaces_thin_client/get_environmentReturns information for an environment.id (string) required
workspaces_thin_client/get_software_setReturns information for a software set.id (string) required
workspaces_thin_client/list_devicesReturns a list of thin client devices.nextToken (string)
maxResults (integer)
workspaces_thin_client/list_environmentsReturns a list of environments.nextToken (string)
maxResults (integer)
workspaces_thin_client/list_software_setsReturns a list of software sets.nextToken (string)
maxResults (integer)
workspaces_thin_client/list_tags_for_resourceReturns a list of tags for a resource.resourceArn (string) required
workspaces_thin_client/tag_resourceAssigns one or more tags key-value pairs to the specified resource.resourceArn (string) required
tags (object) required
workspaces_thin_client/untag_resourceRemoves a tag or tags from a resource.resourceArn (string) required
tagKeys (array) required
workspaces_thin_client/update_deviceUpdates a thin client device.id (string) required
name (string)
desiredSoftwareSetId (string)
softwareSetUpdateSchedule (string)
workspaces_thin_client/update_environmentUpdates an environment.id (string) required
name (string)
desktopArn (string)
desktopEndpoint (string)
softwareSetUpdateSchedule (string)
maintenanceWindow: {
. type (string)
. startTimeHour (integer)
. startTimeMinute (integer)
. endTimeHour (integer)
. endTimeMinute (integer)
. daysOfTheWeek (array)
. applyTimeOf (string)
} (object)
softwareSetUpdateMode (string)
desiredSoftwareSetId (string)
deviceCreationTags (object)
workspaces_thin_client/update_software_setUpdates a software set.id (string) required
validationStatus (string) required
workspaces_web/expire_sessionExpires an active secure browser session.portalId (string) required
sessionId (string) required
workspaces_web/get_sessionGets information for a secure browser session.portalId (string) required
sessionId (string) required
workspaces_web/list_sessionsLists information for multiple secure browser sessions from a specific portal.portalId (string) required
username (string)
sessionId (string)
sortBy (string)
status (string)
maxResults (integer)
nextToken (string)
workspaces_web/list_tags_for_resourceRetrieves a list of tags for a resource.resourceArn (string) required
workspaces_web/tag_resourceAdds or overwrites one or more tags for the specified resource.resourceArn (string) required
tags (array) required
clientToken (string)
workspaces_web/untag_resourceRemoves one or more tags from the specified resource.resourceArn (string) required
tagKeys (array) required
workspaces_web/create_browser_settingsCreates 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.tags (array)
customerManagedKey (string)
additionalEncryptionContext (object)
browserPolicy (string)
clientToken (string)
webContentFilteringPolicy: {
. blockedCategories (array)
. allowedUrls (array)
. blockedUrls (array)
} (object)
workspaces_web/get_browser_settingsGets browser settings.browserSettingsArn (string) required
workspaces_web/update_browser_settingsUpdates browser settings.browserSettingsArn (string) required
browserPolicy (string)
clientToken (string)
webContentFilteringPolicy: {
. blockedCategories (array)
. allowedUrls (array)
. blockedUrls (array)
} (object)
workspaces_web/delete_browser_settingsDeletes browser settings.browserSettingsArn (string) required
workspaces_web/list_browser_settingsRetrieves a list of browser settings.nextToken (string)
maxResults (integer)
workspaces_web/create_data_protection_settingsCreates a data protection settings resource that can be associated with a web portal.displayName (string)
description (string)
tags (array)
customerManagedKey (string)
additionalEncryptionContext (object)
inlineRedactionConfiguration: {
. inlineRedactionPatterns (array)
. globalEnforcedUrls (array)
. globalExemptUrls (array)
. globalConfidenceLevel (integer)
} (object)
clientToken (string)
workspaces_web/get_data_protection_settingsGets the data protection settings.dataProtectionSettingsArn (string) required
workspaces_web/update_data_protection_settingsUpdates data protection settings.dataProtectionSettingsArn (string) required
inlineRedactionConfiguration: {
. inlineRedactionPatterns (array)
. globalEnforcedUrls (array)
. globalExemptUrls (array)
. globalConfidenceLevel (integer)
} (object)
displayName (string)
description (string)
clientToken (string)
workspaces_web/delete_data_protection_settingsDeletes data protection settings.dataProtectionSettingsArn (string) required
workspaces_web/list_data_protection_settingsRetrieves a list of data protection settings.nextToken (string)
maxResults (integer)
workspaces_web/create_identity_providerCreates an identity provider resource that is then associated with a web portal.portalArn (string) required
identityProviderName (string) required
identityProviderType (string) required
identityProviderDetails (object) required
clientToken (string)
tags (array)
workspaces_web/get_identity_providerGets the identity provider.identityProviderArn (string) required
workspaces_web/update_identity_providerUpdates the identity provider.identityProviderArn (string) required
identityProviderName (string)
identityProviderType (string)
identityProviderDetails (object)
clientToken (string)
workspaces_web/delete_identity_providerDeletes the identity provider.identityProviderArn (string) required
workspaces_web/list_identity_providersRetrieves a list of identity providers for a specific web portal.nextToken (string)
maxResults (integer)
portalArn (string) required
workspaces_web/create_ip_access_settingsCreates an IP access settings resource that can be associated with a web portal.displayName (string)
description (string)
tags (array)
customerManagedKey (string)
additionalEncryptionContext (object)
ipRules (array) required
clientToken (string)
workspaces_web/get_ip_access_settingsGets the IP access settings.ipAccessSettingsArn (string) required
workspaces_web/update_ip_access_settingsUpdates IP access settings.ipAccessSettingsArn (string) required
displayName (string)
description (string)
ipRules (array)
clientToken (string)
workspaces_web/delete_ip_access_settingsDeletes IP access settings.ipAccessSettingsArn (string) required
workspaces_web/list_ip_access_settingsRetrieves a list of IP access settings.nextToken (string)
maxResults (integer)
workspaces_web/create_network_settingsCreates 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.vpcId (string) required
subnetIds (array) required
securityGroupIds (array) required
tags (array)
clientToken (string)
workspaces_web/get_network_settingsGets the network settings.networkSettingsArn (string) required
workspaces_web/update_network_settingsUpdates network settings.networkSettingsArn (string) required
vpcId (string)
subnetIds (array)
securityGroupIds (array)
clientToken (string)
workspaces_web/delete_network_settingsDeletes network settings.networkSettingsArn (string) required
workspaces_web/list_network_settingsRetrieves a list of network settings.nextToken (string)
maxResults (integer)
workspaces_web/associate_browser_settingsAssociates a browser settings resource with a web portal.portalArn (string) required
browserSettingsArn (string) required
workspaces_web/associate_data_protection_settingsAssociates a data protection settings resource with a web portal.portalArn (string) required
dataProtectionSettingsArn (string) required
workspaces_web/associate_ip_access_settingsAssociates an IP access settings resource with a web portal.portalArn (string) required
ipAccessSettingsArn (string) required
workspaces_web/associate_network_settingsAssociates a network settings resource with a web portal.portalArn (string) required
networkSettingsArn (string) required
workspaces_web/associate_session_loggerAssociates a session logger with a portal.portalArn (string) required
sessionLoggerArn (string) required
workspaces_web/associate_trust_storeAssociates a trust store with a web portal.portalArn (string) required
trustStoreArn (string) required
workspaces_web/associate_user_access_logging_settingsAssociates a user access logging settings resource with a web portal.portalArn (string) required
userAccessLoggingSettingsArn (string) required
workspaces_web/associate_user_settingsAssociates a user settings resource with a web portal.portalArn (string) required
userSettingsArn (string) required
workspaces_web/disassociate_browser_settingsDisassociates browser settings from a web portal.portalArn (string) required
workspaces_web/disassociate_data_protection_settingsDisassociates data protection settings from a web portal.portalArn (string) required
workspaces_web/disassociate_ip_access_settingsDisassociates IP access settings from a web portal.portalArn (string) required
workspaces_web/disassociate_network_settingsDisassociates network settings from a web portal.portalArn (string) required
workspaces_web/disassociate_session_loggerDisassociates a session logger from a portal.portalArn (string) required
workspaces_web/disassociate_trust_storeDisassociates a trust store from a web portal.portalArn (string) required
workspaces_web/disassociate_user_access_logging_settingsDisassociates user access logging settings from a web portal.portalArn (string) required
workspaces_web/disassociate_user_settingsDisassociates user settings from a web portal.portalArn (string) required
workspaces_web/get_portal_service_provider_metadataGets the service provider metadata.portalArn (string) required
workspaces_web/create_portalCreates a web portal.displayName (string)
tags (array)
customerManagedKey (string)
additionalEncryptionContext (object)
clientToken (string)
authenticationType (string)
instanceType (string)
maxConcurrentSessions (integer)
portalCustomDomain (string)
workspaces_web/get_portalGets the web portal.portalArn (string) required
workspaces_web/update_portalUpdates a web portal.portalArn (string) required
displayName (string)
authenticationType (string)
instanceType (string)
maxConcurrentSessions (integer)
portalCustomDomain (string)
workspaces_web/delete_portalDeletes a web portal.portalArn (string) required
workspaces_web/list_portalsRetrieves a list or web portals.nextToken (string)
maxResults (integer)
workspaces_web/create_session_loggerCreates a session logger.eventFilter (undefined) required
logConfiguration: {
. s3 (object)
} (object) required
displayName (string)
customerManagedKey (string)
additionalEncryptionContext (object)
tags (array)
clientToken (string)
workspaces_web/get_session_loggerGets details about a specific session logger resource.sessionLoggerArn (string) required
workspaces_web/update_session_loggerUpdates the details of a session logger.sessionLoggerArn (string) required
eventFilter (undefined)
logConfiguration: {
. s3 (object)
} (object)
displayName (string)
workspaces_web/delete_session_loggerDeletes a session logger resource.sessionLoggerArn (string) required
workspaces_web/list_session_loggersLists all available session logger resources.nextToken (string)
maxResults (integer)
workspaces_web/get_trust_store_certificateGets the trust store certificate.trustStoreArn (string) required
thumbprint (string) required
workspaces_web/list_trust_store_certificatesRetrieves a list of trust store certificates.trustStoreArn (string) required
nextToken (string)
maxResults (integer)
workspaces_web/create_trust_storeCreates 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.certificateList (array) required
tags (array)
clientToken (string)
workspaces_web/get_trust_storeGets the trust store.trustStoreArn (string) required
workspaces_web/update_trust_storeUpdates the trust store.trustStoreArn (string) required
certificatesToAdd (array)
certificatesToDelete (array)
clientToken (string)
workspaces_web/delete_trust_storeDeletes the trust store.trustStoreArn (string) required
workspaces_web/list_trust_storesRetrieves a list of trust stores.nextToken (string)
maxResults (integer)
workspaces_web/create_user_access_logging_settingsCreates a user access logging settings resource that can be associated with a web portal.kinesisStreamArn (string) required
tags (array)
clientToken (string)
workspaces_web/get_user_access_logging_settingsGets user access logging settings.userAccessLoggingSettingsArn (string) required
workspaces_web/update_user_access_logging_settingsUpdates the user access logging settings.userAccessLoggingSettingsArn (string) required
kinesisStreamArn (string)
clientToken (string)
workspaces_web/delete_user_access_logging_settingsDeletes user access logging settings.userAccessLoggingSettingsArn (string) required
workspaces_web/list_user_access_logging_settingsRetrieves a list of user access logging settings.nextToken (string)
maxResults (integer)
workspaces_web/create_user_settingsCreates 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.copyAllowed (string) required
pasteAllowed (string) required
downloadAllowed (string) required
uploadAllowed (string) required
printAllowed (string) required
tags (array)
disconnectTimeoutInMinutes (integer)
idleDisconnectTimeoutInMinutes (integer)
clientToken (string)
cookieSynchronizationConfiguration: {
. allowlist (array)
. blocklist (array)
} (object)
customerManagedKey (string)
additionalEncryptionContext (object)
deepLinkAllowed (string)
toolbarConfiguration: {
. toolbarType (string)
. visualMode (string)
. hiddenToolbarItems (array)
. maxDisplayResolution (string)
} (object)
brandingConfigurationInput: {
. logo
. wallpaper
. favicon
. localizedStrings (object)
. colorTheme (string)
. termsOfService (string)
} (object)
webAuthnAllowed (string)
workspaces_web/get_user_settingsGets user settings.userSettingsArn (string) required
workspaces_web/update_user_settingsUpdates the user settings.userSettingsArn (string) required
copyAllowed (string)
pasteAllowed (string)
downloadAllowed (string)
uploadAllowed (string)
printAllowed (string)
disconnectTimeoutInMinutes (integer)
idleDisconnectTimeoutInMinutes (integer)
clientToken (string)
cookieSynchronizationConfiguration: {
. allowlist (array)
. blocklist (array)
} (object)
deepLinkAllowed (string)
toolbarConfiguration: {
. toolbarType (string)
. visualMode (string)
. hiddenToolbarItems (array)
. maxDisplayResolution (string)
} (object)
brandingConfigurationInput: {
. logo
. wallpaper
. favicon
. localizedStrings (object)
. colorTheme (string)
. termsOfService (string)
} (object)
webAuthnAllowed (string)
workspaces_web/delete_user_settingsDeletes user settings.userSettingsArn (string) required
workspaces_web/list_user_settingsRetrieves a list of user settings.nextToken (string)
maxResults (integer)
workspaces/accept_account_link_invitationAccepts the account link invitation. There's currently no unlinking capability after you accept the account linking invitation.LinkId (string) required
ClientToken (string)
workspaces/associate_connection_aliasAssociates 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.AliasId (string) required
ResourceId (string) required
workspaces/associate_ip_groupsAssociates the specified IP access control group with the specified directory.DirectoryId (string) required
GroupIds (array) required
workspaces/associate_workspace_applicationAssociates the specified application to the specified WorkSpace.WorkspaceId (string) required
ApplicationId (string) required
workspaces/authorize_ip_rulesAdds 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.GroupId (string) required
UserRules (array) required
workspaces/copy_workspace_imageCopies 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 beenName (string) required
Description (string)
SourceImageId (string) required
SourceRegion (string) required
Tags (array)
workspaces/create_account_link_invitationCreates the account link invitation.TargetAccountId (string) required
ClientToken (string)
workspaces/create_connect_client_add_inCreates 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.ResourceId (string) required
Name (string) required
URL (string) required
workspaces/create_connection_aliasCreates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.ConnectionString (string) required
Tags (array)
workspaces/create_ip_groupCreates 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 accessGroupName (string) required
GroupDesc (string)
UserRules (array)
Tags (array)
workspaces/create_standby_workspacesCreates a standby WorkSpace in a secondary Region.PrimaryRegion (string) required
StandbyWorkspaces (array) required
workspaces/create_tagsCreates the specified tags for the specified WorkSpaces resource.ResourceId (string) required
Tags (array) required
workspaces/create_updated_workspace_imageCreates 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 Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time. Microsoft Windows updates and other application uName (string) required
Description (string) required
SourceImageId (string) required
Tags (array)
workspaces/create_workspace_bundleCreates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.BundleName (string) required
BundleDescription (string) required
ImageId (string) required
ComputeType: {
. Name (string)
} (object) required
UserStorage: {
. Capacity (string)
} (object) required
RootStorage: {
. Capacity (string)
} (object)
Tags (array)
workspaces/create_workspace_imageCreates a new WorkSpace image from an existing WorkSpace.Name (string) required
Description (string) required
WorkspaceId (string) required
Tags (array)
workspaces/create_workspacesCreates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core. You don't need to specify the PCOIP protocol for Linux bundles because DCV formerly WSP is the default protocol for those bundles. User-decoupled WorkSpaces are only supported by Amazon WorkSpaces CoreWorkspaces (array) required
workspaces/create_workspaces_poolCreates a pool of WorkSpaces.PoolName (string) required
Description (string) required
BundleId (string) required
DirectoryId (string) required
Capacity: {
. DesiredUserSessions (integer)
} (object) required
Tags (array)
ApplicationSettings: {
. Status (string)
. SettingsGroup (string)
} (object)
TimeoutSettings: {
. DisconnectTimeoutInSeconds (integer)
. IdleDisconnectTimeoutInSeconds (integer)
. MaxUserDurationInSeconds (integer)
} (object)
RunningMode (string)
workspaces/delete_account_link_invitationDeletes the account link invitation.LinkId (string) required
ClientToken (string)
workspaces/delete_client_brandingDeletes 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.ResourceId (string) required
Platforms (array) required
workspaces/delete_connect_client_add_inDeletes a client-add-in for Amazon Connect that is configured within a directory.AddInId (string) required
ResourceId (string) required
workspaces/delete_connection_aliasDeletes 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 connAliasId (string) required
workspaces/delete_ip_groupDeletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory.GroupId (string) required
workspaces/delete_tagsDeletes the specified tags from the specified WorkSpaces resource.ResourceId (string) required
TagKeys (array) required
workspaces/delete_workspace_bundleDeletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.BundleId (string)
workspaces/delete_workspace_imageDeletes 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.ImageId (string) required
workspaces/deploy_workspace_applicationsDeploys associated applications to the specified WorkSpaceWorkspaceId (string) required
Force (boolean)
workspaces/deregister_workspace_directoryDeregisters 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 useDirectoryId (string) required
workspaces/describe_accountRetrieves a list that describes the configuration of Bring Your Own License BYOL for the specified account.No parameters
workspaces/describe_account_modificationsRetrieves a list that describes modifications to the configuration of Bring Your Own License BYOL for the specified account.NextToken (string)
workspaces/describe_application_associationsDescribes the associations between the application and the specified associated resources.MaxResults (integer)
NextToken (string)
ApplicationId (string) required
AssociatedResourceTypes (array) required
workspaces/describe_applicationsDescribes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.ApplicationIds (array)
ComputeTypeNames (array)
LicenseType (string)
OperatingSystemNames (array)
Owner (string)
MaxResults (integer)
NextToken (string)
workspaces/describe_bundle_associationsDescribes the associations between the applications and the specified bundle.BundleId (string) required
AssociatedResourceTypes (array) required
workspaces/describe_client_brandingDescribes 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.ResourceId (string) required
workspaces/describe_client_propertiesRetrieves a list that describes one or more specified Amazon WorkSpaces clients.ResourceIds (array) required
workspaces/describe_connect_client_add_insRetrieves a list of Amazon Connect client add-ins that have been created.ResourceId (string) required
NextToken (string)
MaxResults (integer)
workspaces/describe_connection_aliasesRetrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.AliasIds (array)
ResourceId (string)
Limit (integer)
NextToken (string)
workspaces/describe_connection_alias_permissionsDescribes 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.AliasId (string) required
NextToken (string)
MaxResults (integer)
workspaces/describe_custom_workspace_image_importRetrieves information about a WorkSpace BYOL image being imported via ImportCustomWorkspaceImage.ImageId (string) required
workspaces/describe_image_associationsDescribes the associations between the applications and the specified image.ImageId (string) required
AssociatedResourceTypes (array) required
workspaces/describe_ip_groupsDescribes one or more of your IP access control groups.GroupIds (array)
NextToken (string)
MaxResults (integer)
workspaces/describe_tagsDescribes the specified tags for the specified WorkSpaces resource.ResourceId (string) required
workspaces/describe_workspace_associationsDescribes the associations betweens applications and the specified WorkSpace.WorkspaceId (string) required
AssociatedResourceTypes (array) required
workspaces/describe_workspace_bundlesRetrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.BundleIds (array)
Owner (string)
NextToken (string)
workspaces/describe_workspace_directoriesDescribes the available directories that are registered with Amazon WorkSpaces.DirectoryIds (array)
WorkspaceDirectoryNames (array)
Limit (integer)
NextToken (string)
Filters (array)
workspaces/describe_workspace_image_permissionsDescribes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.ImageId (string) required
NextToken (string)
MaxResults (integer)
workspaces/describe_workspace_imagesRetrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.ImageIds (array)
ImageType (string)
NextToken (string)
MaxResults (integer)
workspaces/describe_workspacesDescribes 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.WorkspaceIds (array)
DirectoryId (string)
UserName (string)
BundleId (string)
Limit (integer)
NextToken (string)
WorkspaceName (string)
workspaces/describe_workspaces_connection_statusDescribes the connection status of the specified WorkSpaces.WorkspaceIds (array)
NextToken (string)
workspaces/describe_workspace_snapshotsDescribes the snapshots for the specified WorkSpace.WorkspaceId (string) required
workspaces/describe_workspaces_poolsDescribes the specified WorkSpaces Pools.PoolIds (array)
Filters (array)
Limit (integer)
NextToken (string)
workspaces/describe_workspaces_pool_sessionsRetrieves a list that describes the streaming sessions for a specified pool.PoolId (string) required
UserId (string)
Limit (integer)
NextToken (string)
workspaces/disassociate_connection_aliasDisassociates 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.AliasId (string) required
workspaces/disassociate_ip_groupsDisassociates the specified IP access control group from the specified directory.DirectoryId (string) required
GroupIds (array) required
workspaces/disassociate_workspace_applicationDisassociates the specified application from a WorkSpace.WorkspaceId (string) required
ApplicationId (string) required
workspaces/get_account_linkRetrieves account link information.LinkId (string)
LinkedAccountId (string)
workspaces/import_client_brandingImports 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 toResourceId (string) required
DeviceTypeWindows: {
. Logo (string)
. SupportEmail (string)
. SupportLink (string)
. ForgotPasswordLink (string)
. LoginMessage (object)
} (object)
DeviceTypeOsx: {
. Logo (string)
. SupportEmail (string)
. SupportLink (string)
. ForgotPasswordLink (string)
. LoginMessage (object)
} (object)
DeviceTypeAndroid: {
. Logo (string)
. SupportEmail (string)
. SupportLink (string)
. ForgotPasswordLink (string)
. LoginMessage (object)
} (object)
DeviceTypeIos: {
. Logo (string)
. Logo2x (string)
. Logo3x (string)
. SupportEmail (string)
. SupportLink (string)
. ForgotPasswordLink (string)
. LoginMessage (object)
} (object)
DeviceTypeLinux: {
. Logo (string)
. SupportEmail (string)
. SupportLink (string)
. ForgotPasswordLink (string)
. LoginMessage (object)
} (object)
DeviceTypeWeb: {
. Logo (string)
. SupportEmail (string)
. SupportLink (string)
. ForgotPasswordLink (string)
. LoginMessage (object)
} (object)
workspaces/import_custom_workspace_imageImports the specified Windows 10 or 11 Bring Your Own License BYOL image into Amazon WorkSpaces using EC2 Image Builder. The image must be an already licensed 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.ImageName (string) required
ImageDescription (string) required
ComputeType (string) required
Protocol (string) required
ImageSource (undefined) required
InfrastructureConfigurationArn (string) required
Platform (string) required
OsVersion (string) required
Tags (array)
workspaces/import_workspace_imageImports the specified Windows 10 or 11 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.Ec2ImageId (string) required
IngestionProcess (string) required
ImageName (string) required
ImageDescription (string) required
Tags (array)
Applications (array)
workspaces/list_account_linksLists all account links.LinkStatusFilter (array)
NextToken (string)
MaxResults (integer)
workspaces/list_available_management_cidr_rangesRetrieves 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 deskManagementCidrRangeConstraint (string) required
MaxResults (integer)
NextToken (string)
workspaces/migrate_workspaceMigrates 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 fileSourceWorkspaceId (string) required
BundleId (string) required
workspaces/modify_accountModifies the configuration of Bring Your Own License BYOL for the specified account.DedicatedTenancySupport (string)
DedicatedTenancyManagementCidrRange (string)
workspaces/modify_certificate_based_auth_propertiesModifies the properties of the certificate-based authentication you want to use with your WorkSpaces.ResourceId (string) required
CertificateBasedAuthProperties: {
. Status (string)
. CertificateAuthorityArn (string)
} (object)
PropertiesToDelete (array)
workspaces/modify_client_propertiesModifies the properties of the specified Amazon WorkSpaces clients.ResourceId (string) required
ClientProperties: {
. ReconnectEnabled (string)
. LogUploadEnabled (string)
} (object) required
workspaces/modify_endpoint_encryption_modeModifies the endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.DirectoryId (string) required
EndpointEncryptionMode (string) required
workspaces/modify_saml_propertiesModifies 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.ResourceId (string) required
SamlProperties: {
. Status (string)
. UserAccessUrl (string)
. RelayStateParameterName (string)
} (object)
PropertiesToDelete (array)
workspaces/modify_selfservice_permissionsModifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.ResourceId (string) required
SelfservicePermissions: {
. RestartWorkspace (string)
. IncreaseVolumeSize (string)
. ChangeComputeType (string)
. SwitchRunningMode (string)
. RebuildWorkspace (string)
} (object) required
workspaces/modify_streaming_propertiesModifies the specified streaming properties.ResourceId (string) required
StreamingProperties: {
. StreamingExperiencePreferredProtocol (string)
. UserSettings (array)
. StorageConnectors (array)
. GlobalAccelerator (object)
} (object)
workspaces/modify_workspace_access_propertiesSpecifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.ResourceId (string) required
WorkspaceAccessProperties: {
. DeviceTypeWindows (string)
. DeviceTypeOsx (string)
. DeviceTypeWeb (string)
. DeviceTypeIos (string)
. DeviceTypeAndroid (string)
. DeviceTypeChromeOs (string)
. DeviceTypeZeroClient (string)
. DeviceTypeLinux (string)
. DeviceTypeWorkSpacesThinClient (string)
. AccessEndpointConfig (object)
} (object) required
workspaces/modify_workspace_creation_propertiesModify the default properties used to create WorkSpaces.ResourceId (string) required
WorkspaceCreationProperties: {
. EnableInternetAccess (boolean)
. DefaultOu (string)
. CustomSecurityGroupId (string)
. UserEnabledAsLocalAdministrator (boolean)
. EnableMaintenanceMode (boolean)
. InstanceIamRoleArn (string)
} (object) required
workspaces/modify_workspace_propertiesModifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace. The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.WorkspaceId (string) required
WorkspaceProperties: {
. RunningMode (string)
. RunningModeAutoStopTimeoutInMinutes (integer)
. RootVolumeSizeGib (integer)
. UserVolumeSizeGib (integer)
. ComputeTypeName (string)
. Protocols (array)
. OperatingSystemName (string)
. GlobalAccelerator (object)
} (object)
DataReplication (string)
workspaces/modify_workspace_stateSets 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.WorkspaceId (string) required
WorkspaceState (string) required
workspaces/reboot_workspacesReboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is AVAILABLE, UNHEALTHY, or REBOOTING. Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes. This operation is asynchronous and returns before the WorkSpaces have rebooted.RebootWorkspaceRequests (array) required
workspaces/rebuild_workspacesRebuilds 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.RebuildWorkspaceRequests (array) required
workspaces/register_workspace_directoryRegisters 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.DirectoryId (string)
SubnetIds (array)
EnableSelfService (boolean)
Tenancy (string)
Tags (array)
WorkspaceDirectoryName (string)
WorkspaceDirectoryDescription (string)
UserIdentityType (string)
IdcInstanceArn (string)
MicrosoftEntraConfig: {
. TenantId (string)
. ApplicationConfigSecretArn (string)
} (object)
WorkspaceType (string)
ActiveDirectoryConfig: {
. DomainName (string)
. ServiceAccountSecretArn (string)
} (object)
workspaces/reject_account_link_invitationRejects the account link invitation.LinkId (string) required
ClientToken (string)
workspaces/restore_workspaceRestores 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.WorkspaceId (string) required
workspaces/revoke_ip_rulesRemoves one or more rules from the specified IP access control group.GroupId (string) required
UserRules (array) required
workspaces/start_workspacesStarts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop or Manual and a state of STOPPED.StartWorkspaceRequests (array) required
workspaces/start_workspaces_poolStarts the specified pool. You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED.PoolId (string) required
workspaces/stop_workspacesStops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a running mode of AutoStop or Manual and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.StopWorkspaceRequests (array) required
workspaces/stop_workspaces_poolStops the specified pool. You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.PoolId (string) required
workspaces/terminate_workspacesTerminates 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 theTerminateWorkspaceRequests (array) required
workspaces/terminate_workspaces_poolTerminates the specified pool.PoolId (string) required
workspaces/terminate_workspaces_pool_sessionTerminates the pool session.SessionId (string) required
workspaces/update_connect_client_add_inUpdates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.AddInId (string) required
ResourceId (string) required
Name (string)
URL (string)
workspaces/update_connection_alias_permissionShares 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 tAliasId (string) required
ConnectionAliasPermission: {
. SharedAccountId (string)
. AllowAssociation (boolean)
} (object) required
workspaces/update_rules_of_ip_groupReplaces the current rules of the specified IP access control group with the specified rules.GroupId (string) required
UserRules (array) required
workspaces/update_workspace_bundleUpdates 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.BundleId (string)
ImageId (string)
workspaces/update_workspace_image_permissionShares 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 AmazImageId (string) required
AllowCopyImage (boolean) required
SharedAccountId (string) required
workspaces/update_workspaces_poolUpdates the specified pool.PoolId (string) required
Description (string)
BundleId (string)
DirectoryId (string)
Capacity: {
. DesiredUserSessions (integer)
} (object)
ApplicationSettings: {
. Status (string)
. SettingsGroup (string)
} (object)
TimeoutSettings: {
. DisconnectTimeoutInSeconds (integer)
. IdleDisconnectTimeoutInSeconds (integer)
. MaxUserDurationInSeconds (integer)
} (object)
RunningMode (string)
xray/batch_get_tracesYou cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray. 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.TraceIds (array) required
NextToken (string)
xray/cancel_trace_retrievalCancels an ongoing trace retrieval job initiated by StartTraceRetrieval using the provided RetrievalToken. A successful cancellation will return an HTTP 200 response.RetrievalToken (string) required
xray/create_groupCreates a group resource with a name and a filter expression.GroupName (string) required
FilterExpression (string)
InsightsConfiguration: {
. InsightsEnabled (boolean)
. NotificationsEnabled (boolean)
} (object)
Tags (array)
xray/create_sampling_ruleCreates 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 reseSamplingRule: {
. RuleName (string)
. RuleARN (string)
. ResourceARN (string)
. Priority (integer)
. FixedRate (number)
. ReservoirSize (integer)
. ServiceName (string)
. ServiceType (string)
. Host (string)
. HTTPMethod (string)
. URLPath (string)
. Version (integer)
. Attributes (object)
. SamplingRateBoost (object)
} (object) required
Tags (array)
xray/delete_groupDeletes a group resource.GroupName (string)
GroupARN (string)
xray/delete_resource_policyDeletes a resource policy from the target Amazon Web Services account.PolicyName (string) required
PolicyRevisionId (string)
xray/delete_sampling_ruleDeletes a sampling rule.RuleName (string)
RuleARN (string)
xray/get_encryption_configRetrieves the current encryption configuration for X-Ray data.No parameters
xray/get_groupRetrieves group resource details.GroupName (string)
GroupARN (string)
xray/get_groupsRetrieves all active group details.NextToken (string)
xray/get_indexing_rulesRetrieves all indexing rules. Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see Transaction Search.NextToken (string)
xray/get_insightRetrieves 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.InsightId (string) required
xray/get_insight_eventsX-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.InsightId (string) required
MaxResults (integer)
NextToken (string)
xray/get_insight_impact_graphRetrieves 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.InsightId (string) required
StartTime (string) required
EndTime (string) required
NextToken (string)
xray/get_insight_summariesRetrieves the summaries of all insights in the specified group matching the provided filter values.States (array)
GroupARN (string)
GroupName (string)
StartTime (string) required
EndTime (string) required
MaxResults (integer)
NextToken (string)
xray/get_retrieved_traces_graphRetrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search. This API does not initiate a retrieval job. You must first execute StartTraceRetrieval to obtain the required RetrievalToken. The trace graph describes services that process incoming requests and any downstream services they call, which may include Amazon Web Services resources, external APIs, or databases. The response is empty until the RetrievalStatus is CORetrievalToken (string) required
NextToken (string)
xray/get_sampling_rulesRetrieves all sampling rules.NextToken (string)
xray/get_sampling_statistic_summariesRetrieves information about recent sampling results for all sampling rules.NextToken (string)
xray/get_sampling_targetsRequests a sampling quota for rules that the service is using to sample requests.SamplingStatisticsDocuments (array) required
SamplingBoostStatisticsDocuments (array)
xray/get_service_graphRetrieves 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.StartTime (string) required
EndTime (string) required
GroupName (string)
GroupARN (string)
NextToken (string)
xray/get_time_series_service_statisticsGet an aggregation of service statistics defined by a specific time range.StartTime (string) required
EndTime (string) required
GroupName (string)
GroupARN (string)
EntitySelectorExpression (string)
Period (integer)
ForecastStatistics (boolean)
NextToken (string)
xray/get_trace_graphRetrieves a service graph for one or more specific trace IDs.TraceIds (array) required
NextToken (string)
xray/get_trace_segment_destinationRetrieves the current destination of data sent to PutTraceSegments and OpenTelemetry protocol OTLP endpoint. The Transaction Search feature requires a CloudWatchLogs destination. For more information, see Transaction Search and OpenTelemetry.No parameters
xray/get_trace_summariesRetrieves 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 vaStartTime (string) required
EndTime (string) required
TimeRangeType (string)
Sampling (boolean)
SamplingStrategy: {
. Name (string)
. Value (number)
} (object)
FilterExpression (string)
NextToken (string)
xray/list_resource_policiesReturns the list of resource policies in the target Amazon Web Services account.NextToken (string)
xray/list_retrieved_tracesRetrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see BatchGetTraces. This API does not initiate a retrieval process. To start a trace retrieval, use StartTraceRetrieval, which generates the required RetrievalToken. When the RetrievalStatus is not COMPLETE, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces. For crRetrievalToken (string) required
TraceFormat (string)
NextToken (string)
xray/list_tags_for_resourceReturns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.ResourceARN (string) required
NextToken (string)
xray/put_encryption_configUpdates the encryption configuration for X-Ray data.KeyId (string)
Type (string) required
xray/put_resource_policySets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.PolicyName (string) required
PolicyDocument (string) required
PolicyRevisionId (string)
BypassPolicyLockoutCheck (boolean)
xray/put_telemetry_recordsUsed by the Amazon Web Services X-Ray daemon to upload telemetry.TelemetryRecords (array) required
EC2InstanceId (string)
Hostname (string)
ResourceARN (string)
xray/put_trace_segmentsUploads segment documents to Amazon Web Services X-Ray. 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 sameTraceSegmentDocuments (array) required
xray/start_trace_retrievalInitiates a trace retrieval process using the specified time range and for the given trace IDs in the Transaction Search generated CloudWatch log group. For more information, see Transaction Search. API returns a RetrievalToken, which can be used with ListRetrievedTraces or GetRetrievedTracesGraph to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals. If you are using CloudWatch cross-account observability, you canTraceIds (array) required
StartTime (string) required
EndTime (string) required
xray/tag_resourceApplies tags to an existing Amazon Web Services X-Ray group or sampling rule.ResourceARN (string) required
Tags (array) required
xray/untag_resourceRemoves tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags those with an aws: prefix.ResourceARN (string) required
TagKeys (array) required
xray/update_groupUpdates a group resource.GroupName (string)
GroupARN (string)
FilterExpression (string)
InsightsConfiguration: {
. InsightsEnabled (boolean)
. NotificationsEnabled (boolean)
} (object)
xray/update_indexing_ruleModifies an indexing rule’s configuration. Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see Transaction Search.Name (string) required
Rule (undefined) required
xray/update_sampling_ruleModifies a sampling rule's configuration.SamplingRuleUpdate: {
. RuleName (string)
. RuleARN (string)
. ResourceARN (string)
. Priority (integer)
. FixedRate (number)
. ReservoirSize (integer)
. Host (string)
. ServiceName (string)
. ServiceType (string)
. HTTPMethod (string)
. URLPath (string)
. Attributes (object)
. SamplingRateBoost (object)
} (object) required
xray/update_trace_segment_destinationModifies the destination of data sent to PutTraceSegments. The Transaction Search feature requires the CloudWatchLogs destination. For more information, see Transaction Search.Destination (string)