From c57206a4bcb8c6ed09ffc064e6d47b42ecd71e2b Mon Sep 17 00:00:00 2001 From: Sreeja Milkuri Date: Tue, 20 May 2025 15:13:24 -0400 Subject: [PATCH 1/8] test(middleware-flexible-checksums): increase hook timeout to 60s for middleware-md5-fallback.e2e (#7095) --- .../src/middleware-md5-fallback.e2e.spec.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/middleware-flexible-checksums/src/middleware-md5-fallback.e2e.spec.ts b/packages/middleware-flexible-checksums/src/middleware-md5-fallback.e2e.spec.ts index fcc2babbe67b4..52a556e24085b 100644 --- a/packages/middleware-flexible-checksums/src/middleware-md5-fallback.e2e.spec.ts +++ b/packages/middleware-flexible-checksums/src/middleware-md5-fallback.e2e.spec.ts @@ -44,7 +44,7 @@ describe("S3 MD5 Fallback for DeleteObjects", () => { console.error("Setup failed:", err); throw err; } - }); + }, 60_000); afterAll(async () => { try { @@ -60,7 +60,7 @@ describe("S3 MD5 Fallback for DeleteObjects", () => { } catch (error) { console.error("Cleanup failed:", error); } - }); + }, 60_000); it("should use CRC32 checksum by default for DeleteObjects", async () => { const response = await s3.send( From ed51782d7192b06752c93f15a502006c247179e6 Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 21 May 2025 18:10:37 +0000 Subject: [PATCH 2/8] feat(client-partnercentral-selling): Modified validation to allow expectedCustomerSpend array with zero elements in Partner Opportunity operations. --- .../client-partnercentral-selling/README.md | 63 +- .../src/PartnerCentralSelling.ts | 62 +- .../src/PartnerCentralSellingClient.ts | 62 +- .../AcceptEngagementInvitationCommand.ts | 35 +- .../src/commands/AssignOpportunityCommand.ts | 33 +- .../commands/AssociateOpportunityCommand.ts | 64 +- .../src/commands/CreateEngagementCommand.ts | 37 +- .../CreateEngagementInvitationCommand.ts | 34 +- .../src/commands/CreateOpportunityCommand.ts | 55 +- .../commands/CreateResourceSnapshotCommand.ts | 35 +- .../CreateResourceSnapshotJobCommand.ts | 37 +- .../DeleteResourceSnapshotJobCommand.ts | 28 +- .../DisassociateOpportunityCommand.ts | 35 +- .../GetAwsOpportunitySummaryCommand.ts | 29 +- .../src/commands/GetEngagementCommand.ts | 22 +- .../GetEngagementInvitationCommand.ts | 30 +- .../src/commands/GetOpportunityCommand.ts | 28 +- .../commands/GetResourceSnapshotCommand.ts | 19 +- .../commands/GetResourceSnapshotJobCommand.ts | 22 +- .../GetSellingSystemSettingsCommand.ts | 22 +- ...gementByAcceptingInvitationTasksCommand.ts | 22 +- ...stEngagementFromOpportunityTasksCommand.ts | 22 +- .../ListEngagementInvitationsCommand.ts | 28 +- .../commands/ListEngagementMembersCommand.ts | 24 +- ...stEngagementResourceAssociationsCommand.ts | 22 +- .../src/commands/ListEngagementsCommand.ts | 23 +- .../src/commands/ListOpportunitiesCommand.ts | 48 +- .../ListResourceSnapshotJobsCommand.ts | 23 +- .../commands/ListResourceSnapshotsCommand.ts | 40 +- .../src/commands/ListSolutionsCommand.ts | 24 +- .../commands/ListTagsForResourceCommand.ts | 24 +- .../PutSellingSystemSettingsCommand.ts | 22 +- .../RejectEngagementInvitationCommand.ts | 34 +- ...agementByAcceptingInvitationTaskCommand.ts | 43 +- ...artEngagementFromOpportunityTaskCommand.ts | 41 +- .../StartResourceSnapshotJobCommand.ts | 19 +- .../StopResourceSnapshotJobCommand.ts | 19 +- .../src/commands/SubmitOpportunityCommand.ts | 29 +- .../src/commands/TagResourceCommand.ts | 30 +- .../src/commands/UntagResourceCommand.ts | 30 +- .../src/commands/UpdateOpportunityCommand.ts | 39 +- .../src/index.ts | 62 +- .../src/models/models_0.ts | 2646 ++++------------- .../aws-models/partnercentral-selling.json | 1081 +++---- 44 files changed, 1303 insertions(+), 3844 deletions(-) diff --git a/clients/client-partnercentral-selling/README.md b/clients/client-partnercentral-selling/README.md index 48d2672e70785..eabcfe0d9a0d7 100644 --- a/clients/client-partnercentral-selling/README.md +++ b/clients/client-partnercentral-selling/README.md @@ -6,68 +6,7 @@ AWS SDK for JavaScript PartnerCentralSelling Client for Node.js, Browser and React Native. -AWS Partner Central API for Selling - -

-AWS Partner Central API for Selling Reference -Guide -

-

This Amazon Web Services (AWS) Partner Central API reference is designed to help -AWS Partners integrate -Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can -automate interactions with AWS Partner Central, which helps to ensure effective -engagements in joint business activities.

-

The API provides standard AWS API functionality. Access it by either using API Actions or by using an AWS SDK that's tailored to your programming language -or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.

-

-Features offered by AWS Partner Central API -

-
    -
  1. -

    -Opportunity management: Manages coselling -opportunities through API actions such as CreateOpportunity, -UpdateOpportunity, ListOpportunities, -GetOpportunity, and AssignOpportunity.

    -
    2. -
  2. -

    -AWS referral management: Manages referrals -shared by AWS using actions such as ListEngagementInvitations, -GetEngagementInvitation, -StartEngagementByAcceptingInvitation, and -RejectEngagementInvitation.

    -
    3. -
  3. -

    -Entity association: Associates related -entities such as AWS Products, Partner -Solutions, and AWS Marketplace Private -Offers with opportunities using the actions -AssociateOpportunity, and -DisassociateOpportunity.

    -
    4. -
  4. -

    -View AWS opportunity details: Retrieves -real-time summaries of AWS opportunities using the -GetAWSOpportunitySummary action.

    -
    5. -
  5. -

    -List solutions: Provides list APIs for -listing partner offers using ListSolutions.

    -
    6. -
  6. -

    -Event subscription: Subscribe to real-time -opportunity updates through AWS EventBridge by using actions such as -Opportunity Created, Opportunity -Updated, Engagement Invitation Accepted, -Engagement Invitation Rejected, and -Engagement Invitation Created.

    -
    7. -
+AWS Partner Central API for Selling

AWS Partner Central API for Selling Reference Guide

This Amazon Web Services (AWS) Partner Central API reference is designed to help AWS Partners integrate Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can automate interactions with AWS Partner Central, which helps to ensure effective engagements in joint business activities.

The API provides standard AWS API functionality. Access it by either using API Actions or by using an AWS SDK that's tailored to your programming language or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.

Features offered by AWS Partner Central API

  1. Opportunity management: Manages coselling opportunities through API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity.

  2. AWS referral management: Manages referrals shared by AWS using actions such as ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation.

  3. Entity association: Associates related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity, and DisassociateOpportunity.

  4. View AWS opportunity details: Retrieves real-time summaries of AWS opportunities using the GetAWSOpportunitySummary action.

  5. List solutions: Provides list APIs for listing partner offers using ListSolutions.

  6. Event subscription: Subscribe to real-time opportunity updates through AWS EventBridge by using actions such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected, and Engagement Invitation Created.

## Installing diff --git a/clients/client-partnercentral-selling/src/PartnerCentralSelling.ts b/clients/client-partnercentral-selling/src/PartnerCentralSelling.ts index 0cb7271a0aa3f..7dca03b294bf1 100644 --- a/clients/client-partnercentral-selling/src/PartnerCentralSelling.ts +++ b/clients/client-partnercentral-selling/src/PartnerCentralSelling.ts @@ -850,67 +850,7 @@ export interface PartnerCentralSelling { } /** - * AWS Partner Central API for Selling - *

- * AWS Partner Central API for Selling Reference - * Guide - *

- *

This Amazon Web Services (AWS) Partner Central API reference is designed to help - * AWS Partners integrate - * Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can - * automate interactions with AWS Partner Central, which helps to ensure effective - * engagements in joint business activities.

- *

The API provides standard AWS API functionality. Access it by either using API Actions or by using an AWS SDK that's tailored to your programming language - * or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.

- *

- * Features offered by AWS Partner Central API - *

- *
    - *
  1. - *

    - * Opportunity management: Manages coselling - * opportunities through API actions such as CreateOpportunity, - * UpdateOpportunity, ListOpportunities, - * GetOpportunity, and AssignOpportunity.

    - *
    2. - *
  2. - *

    - * AWS referral management: Manages referrals - * shared by AWS using actions such as ListEngagementInvitations, - * GetEngagementInvitation, - * StartEngagementByAcceptingInvitation, and - * RejectEngagementInvitation.

    - *
    3. - *
  3. - *

    - * Entity association: Associates related - * entities such as AWS Products, Partner - * Solutions, and AWS Marketplace Private - * Offers with opportunities using the actions - * AssociateOpportunity, and - * DisassociateOpportunity.

    - *
    4. - *
  4. - *

    - * View AWS opportunity details: Retrieves - * real-time summaries of AWS opportunities using the - * GetAWSOpportunitySummary action.

    - *
    5. - *
  5. - *

    - * List solutions: Provides list APIs for - * listing partner offers using ListSolutions.

    - *
    6. - *
  6. - *

    - * Event subscription: Subscribe to real-time - * opportunity updates through AWS EventBridge by using actions such as - * Opportunity Created, Opportunity - * Updated, Engagement Invitation Accepted, - * Engagement Invitation Rejected, and - * Engagement Invitation Created.

    - *
    7. - *
+ * AWS Partner Central API for Selling

AWS Partner Central API for Selling Reference Guide

This Amazon Web Services (AWS) Partner Central API reference is designed to help AWS Partners integrate Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can automate interactions with AWS Partner Central, which helps to ensure effective engagements in joint business activities.

The API provides standard AWS API functionality. Access it by either using API Actions or by using an AWS SDK that's tailored to your programming language or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.

Features offered by AWS Partner Central API

  1. Opportunity management: Manages coselling opportunities through API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity.

  2. AWS referral management: Manages referrals shared by AWS using actions such as ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation.

  3. Entity association: Associates related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity, and DisassociateOpportunity.

  4. View AWS opportunity details: Retrieves real-time summaries of AWS opportunities using the GetAWSOpportunitySummary action.

  5. List solutions: Provides list APIs for listing partner offers using ListSolutions.

  6. Event subscription: Subscribe to real-time opportunity updates through AWS EventBridge by using actions such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected, and Engagement Invitation Created.

* @public */ export class PartnerCentralSelling extends PartnerCentralSellingClient implements PartnerCentralSelling {} diff --git a/clients/client-partnercentral-selling/src/PartnerCentralSellingClient.ts b/clients/client-partnercentral-selling/src/PartnerCentralSellingClient.ts index 4cd066735b49e..d0db0aa6b0c2b 100644 --- a/clients/client-partnercentral-selling/src/PartnerCentralSellingClient.ts +++ b/clients/client-partnercentral-selling/src/PartnerCentralSellingClient.ts @@ -457,67 +457,7 @@ export type PartnerCentralSellingClientResolvedConfigType = __SmithyResolvedConf export interface PartnerCentralSellingClientResolvedConfig extends PartnerCentralSellingClientResolvedConfigType {} /** - * AWS Partner Central API for Selling - *

- * AWS Partner Central API for Selling Reference - * Guide - *

- *

This Amazon Web Services (AWS) Partner Central API reference is designed to help - * AWS Partners integrate - * Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can - * automate interactions with AWS Partner Central, which helps to ensure effective - * engagements in joint business activities.

- *

The API provides standard AWS API functionality. Access it by either using API Actions or by using an AWS SDK that's tailored to your programming language - * or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.

- *

- * Features offered by AWS Partner Central API - *

- *
    - *
  1. - *

    - * Opportunity management: Manages coselling - * opportunities through API actions such as CreateOpportunity, - * UpdateOpportunity, ListOpportunities, - * GetOpportunity, and AssignOpportunity.

    - *
    2. - *
  2. - *

    - * AWS referral management: Manages referrals - * shared by AWS using actions such as ListEngagementInvitations, - * GetEngagementInvitation, - * StartEngagementByAcceptingInvitation, and - * RejectEngagementInvitation.

    - *
    3. - *
  3. - *

    - * Entity association: Associates related - * entities such as AWS Products, Partner - * Solutions, and AWS Marketplace Private - * Offers with opportunities using the actions - * AssociateOpportunity, and - * DisassociateOpportunity.

    - *
    4. - *
  4. - *

    - * View AWS opportunity details: Retrieves - * real-time summaries of AWS opportunities using the - * GetAWSOpportunitySummary action.

    - *
    5. - *
  5. - *

    - * List solutions: Provides list APIs for - * listing partner offers using ListSolutions.

    - *
    6. - *
  6. - *

    - * Event subscription: Subscribe to real-time - * opportunity updates through AWS EventBridge by using actions such as - * Opportunity Created, Opportunity - * Updated, Engagement Invitation Accepted, - * Engagement Invitation Rejected, and - * Engagement Invitation Created.

    - *
    7. - *
+ * AWS Partner Central API for Selling

AWS Partner Central API for Selling Reference Guide

This Amazon Web Services (AWS) Partner Central API reference is designed to help AWS Partners integrate Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can automate interactions with AWS Partner Central, which helps to ensure effective engagements in joint business activities.

The API provides standard AWS API functionality. Access it by either using API Actions or by using an AWS SDK that's tailored to your programming language or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.

Features offered by AWS Partner Central API

  1. Opportunity management: Manages coselling opportunities through API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity.

  2. AWS referral management: Manages referrals shared by AWS using actions such as ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation.

  3. Entity association: Associates related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity, and DisassociateOpportunity.

  4. View AWS opportunity details: Retrieves real-time summaries of AWS opportunities using the GetAWSOpportunitySummary action.

  5. List solutions: Provides list APIs for listing partner offers using ListSolutions.

  6. Event subscription: Subscribe to real-time opportunity updates through AWS EventBridge by using actions such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected, and Engagement Invitation Created.

* @public */ export class PartnerCentralSellingClient extends __Client< diff --git a/clients/client-partnercentral-selling/src/commands/AcceptEngagementInvitationCommand.ts b/clients/client-partnercentral-selling/src/commands/AcceptEngagementInvitationCommand.ts index 39037b3f060bb..95a2920696032 100644 --- a/clients/client-partnercentral-selling/src/commands/AcceptEngagementInvitationCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/AcceptEngagementInvitationCommand.ts @@ -32,10 +32,7 @@ export interface AcceptEngagementInvitationCommandInput extends AcceptEngagement export interface AcceptEngagementInvitationCommandOutput extends __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -59,40 +56,22 @@ export interface AcceptEngagementInvitationCommandOutput extends __MetadataBeare * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/AssignOpportunityCommand.ts b/clients/client-partnercentral-selling/src/commands/AssignOpportunityCommand.ts index 1a4fef487ed0a..0e3be7a143986 100644 --- a/clients/client-partnercentral-selling/src/commands/AssignOpportunityCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/AssignOpportunityCommand.ts @@ -32,14 +32,7 @@ export interface AssignOpportunityCommandInput extends AssignOpportunityRequest export interface AssignOpportunityCommandOutput extends __MetadataBearer {} /** - *

Enables 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 who creates it. Currently, - * there's no API to enumerate the list of available users.

+ *

Enables 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 who creates it. Currently, there's no API to enumerate the list of available users.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -69,33 +62,19 @@ export interface AssignOpportunityCommandOutput extends __MetadataBearer {} * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/AssociateOpportunityCommand.ts b/clients/client-partnercentral-selling/src/commands/AssociateOpportunityCommand.ts index 901c7ddc46e46..ffbf61ecd007f 100644 --- a/clients/client-partnercentral-selling/src/commands/AssociateOpportunityCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/AssociateOpportunityCommand.ts @@ -32,45 +32,7 @@ export interface AssociateOpportunityCommandInput extends AssociateOpportunityRe export interface AssociateOpportunityCommandOutput extends __MetadataBearer {} /** - *

Enables 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:

- * - *

To obtain identifiers for these entities, use the following methods:

- * + *

Enables 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:

To obtain identifiers for these entities, use the following methods:

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -96,33 +58,19 @@ export interface AssociateOpportunityCommandOutput extends __MetadataBearer {} * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/CreateEngagementCommand.ts b/clients/client-partnercentral-selling/src/commands/CreateEngagementCommand.ts index 254553f701c8e..27a697e0dcb15 100644 --- a/clients/client-partnercentral-selling/src/commands/CreateEngagementCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/CreateEngagementCommand.ts @@ -36,11 +36,7 @@ export interface CreateEngagementCommandInput extends CreateEngagementRequest {} export interface CreateEngagementCommandOutput extends CreateEngagementResponse, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -89,41 +85,22 @@ export interface CreateEngagementCommandOutput extends CreateEngagementResponse, * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

This error occurs when the request would cause a service quota to be exceeded. Service - * quotas represent the maximum allowed use of a specific resource, and this error - * indicates that the request would surpass that limit.

- *

Suggested action: Review the Quotas for the - * resource, and either reduce usage or request a quota increase.

+ *

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/CreateEngagementInvitationCommand.ts b/clients/client-partnercentral-selling/src/commands/CreateEngagementInvitationCommand.ts index 482f3805368a4..58df9277e3589 100644 --- a/clients/client-partnercentral-selling/src/commands/CreateEngagementInvitationCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/CreateEngagementInvitationCommand.ts @@ -36,8 +36,7 @@ export interface CreateEngagementInvitationCommandInput extends CreateEngagement export interface CreateEngagementInvitationCommandOutput extends CreateEngagementInvitationResponse, __MetadataBearer {} /** - *

This action creates an invitation from a sender to a single receiver to join an - * engagement.

+ *

This action creates an invitation from a sender to a single receiver to join an engagement.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -110,41 +109,22 @@ export interface CreateEngagementInvitationCommandOutput extends CreateEngagemen * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

This error occurs when the request would cause a service quota to be exceeded. Service - * quotas represent the maximum allowed use of a specific resource, and this error - * indicates that the request would surpass that limit.

- *

Suggested action: Review the Quotas for the - * resource, and either reduce usage or request a quota increase.

+ *

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/CreateOpportunityCommand.ts b/clients/client-partnercentral-selling/src/commands/CreateOpportunityCommand.ts index da9959822426c..52e13b988f0ba 100644 --- a/clients/client-partnercentral-selling/src/commands/CreateOpportunityCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/CreateOpportunityCommand.ts @@ -36,30 +36,7 @@ export interface CreateOpportunityCommandInput extends CreateOpportunityRequest export interface CreateOpportunityCommandOutput extends CreateOpportunityResponse, __MetadataBearer {} /** - *

Creates 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:

- *
    - *
  1. - *

    To create the opportunity, use CreateOpportunity.

    - *
    2. - *
  2. - *

    To associate a solution with the opportunity, use - * AssociateOpportunity.

    - *
    3. - *
  3. - *

    To start the engagement with AWS, use - * StartEngagementFromOpportunity.

    - *
    4. - *
- *

After submission, you can't edit the opportunity until the review is complete. But - * opportunities in the Pending Submission state must have complete details. - * You can update the opportunity while it's in the Pending Submission - * state.

- *

There's a set of mandatory fields to create opportunities, but consider providing - * optional fields to enrich the opportunity record.

+ *

Creates 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:

  1. To create the opportunity, use CreateOpportunity.

  2. To associate a solution with the opportunity, use AssociateOpportunity.

  3. To start the engagement with AWS, use StartEngagementFromOpportunity.

After submission, you can't edit the opportunity until the review is complete. But opportunities in the Pending Submission state must have complete details. You can update the opportunity while it's in the Pending Submission state.

There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -192,40 +169,22 @@ export interface CreateOpportunityCommandOutput extends CreateOpportunityRespons * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/CreateResourceSnapshotCommand.ts b/clients/client-partnercentral-selling/src/commands/CreateResourceSnapshotCommand.ts index ae4044b4f528d..7ce788fb70775 100644 --- a/clients/client-partnercentral-selling/src/commands/CreateResourceSnapshotCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/CreateResourceSnapshotCommand.ts @@ -32,9 +32,7 @@ export interface CreateResourceSnapshotCommandInput extends CreateResourceSnapsh export interface CreateResourceSnapshotCommandOutput extends CreateResourceSnapshotResponse, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -65,41 +63,22 @@ export interface CreateResourceSnapshotCommandOutput extends CreateResourceSnaps * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

This error occurs when the request would cause a service quota to be exceeded. Service - * quotas represent the maximum allowed use of a specific resource, and this error - * indicates that the request would surpass that limit.

- *

Suggested action: Review the Quotas for the - * resource, and either reduce usage or request a quota increase.

+ *

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/CreateResourceSnapshotJobCommand.ts b/clients/client-partnercentral-selling/src/commands/CreateResourceSnapshotJobCommand.ts index 002dc0eaed0cd..7d1792eaff113 100644 --- a/clients/client-partnercentral-selling/src/commands/CreateResourceSnapshotJobCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/CreateResourceSnapshotJobCommand.ts @@ -32,11 +32,7 @@ export interface CreateResourceSnapshotJobCommandInput extends CreateResourceSna export interface CreateResourceSnapshotJobCommandOutput extends CreateResourceSnapshotJobResponse, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -73,41 +69,22 @@ export interface CreateResourceSnapshotJobCommandOutput extends CreateResourceSn * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

This error occurs when the request would cause a service quota to be exceeded. Service - * quotas represent the maximum allowed use of a specific resource, and this error - * indicates that the request would surpass that limit.

- *

Suggested action: Review the Quotas for the - * resource, and either reduce usage or request a quota increase.

+ *

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/DeleteResourceSnapshotJobCommand.ts b/clients/client-partnercentral-selling/src/commands/DeleteResourceSnapshotJobCommand.ts index 8eb9006a3aba4..d4e7a35bd423f 100644 --- a/clients/client-partnercentral-selling/src/commands/DeleteResourceSnapshotJobCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/DeleteResourceSnapshotJobCommand.ts @@ -32,8 +32,7 @@ export interface DeleteResourceSnapshotJobCommandInput extends DeleteResourceSna export interface DeleteResourceSnapshotJobCommandOutput extends __MetadataBearer {} /** - *

Use this action to deletes a previously created resource snapshot job. The job must - * be in a stopped state before it can be deleted.

+ *

Use this action to deletes a previously created resource snapshot job. The job must be in a stopped state before it can be deleted.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -57,34 +56,19 @@ export interface DeleteResourceSnapshotJobCommandOutput extends __MetadataBearer * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/DisassociateOpportunityCommand.ts b/clients/client-partnercentral-selling/src/commands/DisassociateOpportunityCommand.ts index 9f3aac965c48b..740d49db0ab2f 100644 --- a/clients/client-partnercentral-selling/src/commands/DisassociateOpportunityCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/DisassociateOpportunityCommand.ts @@ -32,16 +32,7 @@ export interface DisassociateOpportunityCommandInput extends DisassociateOpportu export interface DisassociateOpportunityCommandOutput extends __MetadataBearer {} /** - *

Allows 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 associations helps maintain clarity and accuracy to track and manage business - * opportunities. When you replace an entity, first attach the new entity and then - * disassociate the one to be removed, especially if it's the last remaining entity that's - * required.

+ *

Allows 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 associations helps maintain clarity and accuracy to track and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the one to be removed, especially if it's the last remaining entity that's required.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -67,33 +58,19 @@ export interface DisassociateOpportunityCommandOutput extends __MetadataBearer { * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/GetAwsOpportunitySummaryCommand.ts b/clients/client-partnercentral-selling/src/commands/GetAwsOpportunitySummaryCommand.ts index 548b2cf811d29..7cc40b018cad1 100644 --- a/clients/client-partnercentral-selling/src/commands/GetAwsOpportunitySummaryCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/GetAwsOpportunitySummaryCommand.ts @@ -36,10 +36,7 @@ export interface GetAwsOpportunitySummaryCommandInput extends GetAwsOpportunityS export interface GetAwsOpportunitySummaryCommandOutput extends GetAwsOpportunitySummaryResponse, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -124,33 +121,19 @@ export interface GetAwsOpportunitySummaryCommandOutput extends GetAwsOpportunity * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/GetEngagementCommand.ts b/clients/client-partnercentral-selling/src/commands/GetEngagementCommand.ts index 67070fceb5dc5..d15498a2c037e 100644 --- a/clients/client-partnercentral-selling/src/commands/GetEngagementCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/GetEngagementCommand.ts @@ -36,8 +36,7 @@ export interface GetEngagementCommandInput extends GetEngagementRequest {} export interface GetEngagementCommandOutput extends GetEngagementResponse, __MetadataBearer {} /** - *

Use this action to retrieve the engagement record for a given - * EngagementIdentifier.

+ *

Use this action to retrieve the engagement record for a given EngagementIdentifier.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -89,27 +88,16 @@ export interface GetEngagementCommandOutput extends GetEngagementResponse, __Met * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/GetEngagementInvitationCommand.ts b/clients/client-partnercentral-selling/src/commands/GetEngagementInvitationCommand.ts index b383e7415e284..d081c6b9a039b 100644 --- a/clients/client-partnercentral-selling/src/commands/GetEngagementInvitationCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/GetEngagementInvitationCommand.ts @@ -36,11 +36,7 @@ export interface GetEngagementInvitationCommandInput extends GetEngagementInvita export interface GetEngagementInvitationCommandOutput extends GetEngagementInvitationResponse, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -127,33 +123,19 @@ export interface GetEngagementInvitationCommandOutput extends GetEngagementInvit * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/GetOpportunityCommand.ts b/clients/client-partnercentral-selling/src/commands/GetOpportunityCommand.ts index d119823f8093c..73103c825265e 100644 --- a/clients/client-partnercentral-selling/src/commands/GetOpportunityCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/GetOpportunityCommand.ts @@ -36,9 +36,7 @@ export interface GetOpportunityCommandInput extends GetOpportunityRequest {} export interface GetOpportunityCommandOutput extends GetOpportunityResponse, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -183,33 +181,19 @@ export interface GetOpportunityCommandOutput extends GetOpportunityResponse, __M * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/GetResourceSnapshotCommand.ts b/clients/client-partnercentral-selling/src/commands/GetResourceSnapshotCommand.ts index 7c8e5412cc9ff..9246a15e3f34a 100644 --- a/clients/client-partnercentral-selling/src/commands/GetResourceSnapshotCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/GetResourceSnapshotCommand.ts @@ -153,27 +153,16 @@ export interface GetResourceSnapshotCommandOutput extends GetResourceSnapshotRes * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/GetResourceSnapshotJobCommand.ts b/clients/client-partnercentral-selling/src/commands/GetResourceSnapshotJobCommand.ts index 2d4562d578c05..4c04d50bbeb99 100644 --- a/clients/client-partnercentral-selling/src/commands/GetResourceSnapshotJobCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/GetResourceSnapshotJobCommand.ts @@ -32,8 +32,7 @@ export interface GetResourceSnapshotJobCommandInput extends GetResourceSnapshotJ export interface GetResourceSnapshotJobCommandOutput extends GetResourceSnapshotJobResponse, __MetadataBearer {} /** - *

Use this action to retrieves information about a specific resource snapshot - * job.

+ *

Use this action to retrieves information about a specific resource snapshot job.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -70,27 +69,16 @@ export interface GetResourceSnapshotJobCommandOutput extends GetResourceSnapshot * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/GetSellingSystemSettingsCommand.ts b/clients/client-partnercentral-selling/src/commands/GetSellingSystemSettingsCommand.ts index 8cef6dda7ef5b..c68ff717bfe20 100644 --- a/clients/client-partnercentral-selling/src/commands/GetSellingSystemSettingsCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/GetSellingSystemSettingsCommand.ts @@ -32,8 +32,7 @@ export interface GetSellingSystemSettingsCommandInput extends GetSellingSystemSe export interface GetSellingSystemSettingsCommandOutput extends GetSellingSystemSettingsResponse, __MetadataBearer {} /** - *

Retrieves the currently set system settings, which include the IAM Role used for - * resource snapshot jobs.

+ *

Retrieves the currently set system settings, which include the IAM Role used for resource snapshot jobs.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -59,27 +58,16 @@ export interface GetSellingSystemSettingsCommandOutput extends GetSellingSystemS * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/ListEngagementByAcceptingInvitationTasksCommand.ts b/clients/client-partnercentral-selling/src/commands/ListEngagementByAcceptingInvitationTasksCommand.ts index e9db9c62988f8..98e720406bf96 100644 --- a/clients/client-partnercentral-selling/src/commands/ListEngagementByAcceptingInvitationTasksCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListEngagementByAcceptingInvitationTasksCommand.ts @@ -41,8 +41,7 @@ export interface ListEngagementByAcceptingInvitationTasksCommandOutput __MetadataBearer {} /** - *

Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask - * tasks that were initiated by the caller's account.

+ *

Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -98,27 +97,16 @@ export interface ListEngagementByAcceptingInvitationTasksCommandOutput * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/ListEngagementFromOpportunityTasksCommand.ts b/clients/client-partnercentral-selling/src/commands/ListEngagementFromOpportunityTasksCommand.ts index 4a13247e8e1d4..38308bc5d3bb1 100644 --- a/clients/client-partnercentral-selling/src/commands/ListEngagementFromOpportunityTasksCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListEngagementFromOpportunityTasksCommand.ts @@ -40,8 +40,7 @@ export interface ListEngagementFromOpportunityTasksCommandOutput __MetadataBearer {} /** - *

Lists all in-progress, completed, or failed EngagementFromOpportunity - * tasks that were initiated by the caller's account.

+ *

Lists all in-progress, completed, or failed EngagementFromOpportunity tasks that were initiated by the caller's account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -98,27 +97,16 @@ export interface ListEngagementFromOpportunityTasksCommandOutput * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/ListEngagementInvitationsCommand.ts b/clients/client-partnercentral-selling/src/commands/ListEngagementInvitationsCommand.ts index c3331f1c50049..3d3331b7c14ea 100644 --- a/clients/client-partnercentral-selling/src/commands/ListEngagementInvitationsCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListEngagementInvitationsCommand.ts @@ -37,9 +37,7 @@ export interface ListEngagementInvitationsCommandInput extends ListEngagementInv export interface ListEngagementInvitationsCommandOutput extends ListEngagementInvitationsResponse, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -105,33 +103,19 @@ export interface ListEngagementInvitationsCommandOutput extends ListEngagementIn * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/ListEngagementMembersCommand.ts b/clients/client-partnercentral-selling/src/commands/ListEngagementMembersCommand.ts index dd2139c84fa11..be5d10aa97dbc 100644 --- a/clients/client-partnercentral-selling/src/commands/ListEngagementMembersCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListEngagementMembersCommand.ts @@ -36,10 +36,7 @@ export interface ListEngagementMembersCommandInput extends ListEngagementMembers export interface ListEngagementMembersCommandOutput extends ListEngagementMembersResponse, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -74,27 +71,16 @@ export interface ListEngagementMembersCommandOutput extends ListEngagementMember * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/ListEngagementResourceAssociationsCommand.ts b/clients/client-partnercentral-selling/src/commands/ListEngagementResourceAssociationsCommand.ts index ea470975b8856..403578c84b298 100644 --- a/clients/client-partnercentral-selling/src/commands/ListEngagementResourceAssociationsCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListEngagementResourceAssociationsCommand.ts @@ -42,8 +42,7 @@ export interface ListEngagementResourceAssociationsCommandOutput __MetadataBearer {} /** - *

Lists the associations between resources and engagements where the caller is a member - * and has at least one snapshot in the engagement.

+ *

Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -83,27 +82,16 @@ export interface ListEngagementResourceAssociationsCommandOutput * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/ListEngagementsCommand.ts b/clients/client-partnercentral-selling/src/commands/ListEngagementsCommand.ts index 00abb28a2c944..f0bd05d46d8f6 100644 --- a/clients/client-partnercentral-selling/src/commands/ListEngagementsCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListEngagementsCommand.ts @@ -37,9 +37,7 @@ export interface ListEngagementsCommandInput extends ListEngagementsRequest {} export interface ListEngagementsCommandOutput extends ListEngagementsResponse, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -89,27 +87,16 @@ export interface ListEngagementsCommandOutput extends ListEngagementsResponse, _ * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/ListOpportunitiesCommand.ts b/clients/client-partnercentral-selling/src/commands/ListOpportunitiesCommand.ts index 32e121eba4a9a..8942e3109e876 100644 --- a/clients/client-partnercentral-selling/src/commands/ListOpportunitiesCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListOpportunitiesCommand.ts @@ -36,29 +36,7 @@ export interface ListOpportunitiesCommandInput extends ListOpportunitiesRequest export interface ListOpportunitiesCommandOutput extends ListOpportunitiesResponse, __MetadataBearer {} /** - *

This 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, only list 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 recommend the following approach:

- *
    - *
  1. - *

    Find the latest LastModifiedDate that you stored, and only use - * the values that came from Amazon Web Services. Don’t use values generated by your - * system.

    - *
    2. - *
  2. - *

    When you send a ListOpportunities request, submit the date in ISO - * 8601 format in the AfterLastModifiedDate filter.

    - *
    3. - *
  3. - *

    Amazon Web Services only returns opportunities created or updated on or after - * that date and time. Use NextToken to iterate over all pages.

    - *
    4. - *
+ *

This 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, only list 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 recommend the following approach:

  1. Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don’t use values generated by your system.

  2. When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter.

  3. Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -153,33 +131,19 @@ export interface ListOpportunitiesCommandOutput extends ListOpportunitiesRespons * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/ListResourceSnapshotJobsCommand.ts b/clients/client-partnercentral-selling/src/commands/ListResourceSnapshotJobsCommand.ts index e719735a11c91..c6b4b585eec70 100644 --- a/clients/client-partnercentral-selling/src/commands/ListResourceSnapshotJobsCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListResourceSnapshotJobsCommand.ts @@ -32,9 +32,7 @@ export interface ListResourceSnapshotJobsCommandInput extends ListResourceSnapsh export interface ListResourceSnapshotJobsCommandOutput extends ListResourceSnapshotJobsResponse, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -75,27 +73,16 @@ export interface ListResourceSnapshotJobsCommandOutput extends ListResourceSnaps * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/ListResourceSnapshotsCommand.ts b/clients/client-partnercentral-selling/src/commands/ListResourceSnapshotsCommand.ts index 6f7a3bebbea35..67193a3ad417b 100644 --- a/clients/client-partnercentral-selling/src/commands/ListResourceSnapshotsCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListResourceSnapshotsCommand.ts @@ -37,26 +37,7 @@ export interface ListResourceSnapshotsCommandInput extends ListResourceSnapshots export interface ListResourceSnapshotsCommandOutput extends ListResourceSnapshotsResponse, __MetadataBearer {} /** - *

Retrieves a list of resource view snapshots based on specified criteria. This - * operation supports various use cases, including:

- * + *

Retrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including:

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -98,27 +79,16 @@ export interface ListResourceSnapshotsCommandOutput extends ListResourceSnapshot * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/ListSolutionsCommand.ts b/clients/client-partnercentral-selling/src/commands/ListSolutionsCommand.ts index ffee6bbcade24..2b0c98d32e8fc 100644 --- a/clients/client-partnercentral-selling/src/commands/ListSolutionsCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListSolutionsCommand.ts @@ -32,9 +32,7 @@ export interface ListSolutionsCommandInput extends ListSolutionsRequest {} export interface ListSolutionsCommandOutput extends ListSolutionsResponse, __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -85,28 +83,16 @@ export interface ListSolutionsCommandOutput extends ListSolutionsResponse, __Met * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/ListTagsForResourceCommand.ts b/clients/client-partnercentral-selling/src/commands/ListTagsForResourceCommand.ts index e73cb29ffab2d..58f6754f81c53 100644 --- a/clients/client-partnercentral-selling/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/ListTagsForResourceCommand.ts @@ -62,33 +62,19 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/PutSellingSystemSettingsCommand.ts b/clients/client-partnercentral-selling/src/commands/PutSellingSystemSettingsCommand.ts index fad480a91ddd7..599d0cbf84ae9 100644 --- a/clients/client-partnercentral-selling/src/commands/PutSellingSystemSettingsCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/PutSellingSystemSettingsCommand.ts @@ -32,8 +32,7 @@ export interface PutSellingSystemSettingsCommandInput extends PutSellingSystemSe export interface PutSellingSystemSettingsCommandOutput extends PutSellingSystemSettingsResponse, __MetadataBearer {} /** - *

Updates the currently set system settings, which include the IAM Role used for - * resource snapshot jobs.

+ *

Updates the currently set system settings, which include the IAM Role used for resource snapshot jobs.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -60,27 +59,16 @@ export interface PutSellingSystemSettingsCommandOutput extends PutSellingSystemS * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/RejectEngagementInvitationCommand.ts b/clients/client-partnercentral-selling/src/commands/RejectEngagementInvitationCommand.ts index 34fb63037516f..eb56b4f3c3ba6 100644 --- a/clients/client-partnercentral-selling/src/commands/RejectEngagementInvitationCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/RejectEngagementInvitationCommand.ts @@ -32,9 +32,7 @@ export interface RejectEngagementInvitationCommandInput extends RejectEngagement export interface RejectEngagementInvitationCommandOutput extends __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -59,40 +57,22 @@ export interface RejectEngagementInvitationCommandOutput extends __MetadataBeare * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/StartEngagementByAcceptingInvitationTaskCommand.ts b/clients/client-partnercentral-selling/src/commands/StartEngagementByAcceptingInvitationTaskCommand.ts index 839679de3cd95..866995c255c30 100644 --- a/clients/client-partnercentral-selling/src/commands/StartEngagementByAcceptingInvitationTaskCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/StartEngagementByAcceptingInvitationTaskCommand.ts @@ -41,12 +41,7 @@ export interface StartEngagementByAcceptingInvitationTaskCommandOutput __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -87,47 +82,25 @@ export interface StartEngagementByAcceptingInvitationTaskCommandOutput * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

This error occurs when the request would cause a service quota to be exceeded. Service - * quotas represent the maximum allowed use of a specific resource, and this error - * indicates that the request would surpass that limit.

- *

Suggested action: Review the Quotas for the - * resource, and either reduce usage or request a quota increase.

+ *

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/StartEngagementFromOpportunityTaskCommand.ts b/clients/client-partnercentral-selling/src/commands/StartEngagementFromOpportunityTaskCommand.ts index f9add6f10c737..9377239187d7b 100644 --- a/clients/client-partnercentral-selling/src/commands/StartEngagementFromOpportunityTaskCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/StartEngagementFromOpportunityTaskCommand.ts @@ -40,10 +40,7 @@ export interface StartEngagementFromOpportunityTaskCommandOutput __MetadataBearer {} /** - *

This action initiates the engagement process from an existing opportunity by accepting - * the engagement invitation and creating a corresponding opportunity in the partner’s - * system. Similar to StartEngagementByAcceptingInvitationTask, this action is - * asynchronous and performs multiple steps before completion.

+ *

This action initiates the engagement process from an existing opportunity by accepting the engagement invitation and creating a corresponding opportunity in the partner’s system. Similar to StartEngagementByAcceptingInvitationTask, this action is asynchronous and performs multiple steps before completion.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -89,47 +86,25 @@ export interface StartEngagementFromOpportunityTaskCommandOutput * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ServiceQuotaExceededException} (client fault) - *

This error occurs when the request would cause a service quota to be exceeded. Service - * quotas represent the maximum allowed use of a specific resource, and this error - * indicates that the request would surpass that limit.

- *

Suggested action: Review the Quotas for the - * resource, and either reduce usage or request a quota increase.

+ *

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/StartResourceSnapshotJobCommand.ts b/clients/client-partnercentral-selling/src/commands/StartResourceSnapshotJobCommand.ts index b68b89273439f..6fa041e905b27 100644 --- a/clients/client-partnercentral-selling/src/commands/StartResourceSnapshotJobCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/StartResourceSnapshotJobCommand.ts @@ -56,27 +56,16 @@ export interface StartResourceSnapshotJobCommandOutput extends __MetadataBearer * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/StopResourceSnapshotJobCommand.ts b/clients/client-partnercentral-selling/src/commands/StopResourceSnapshotJobCommand.ts index 4cf472e1d7671..ef3d5db8ed60c 100644 --- a/clients/client-partnercentral-selling/src/commands/StopResourceSnapshotJobCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/StopResourceSnapshotJobCommand.ts @@ -56,27 +56,16 @@ export interface StopResourceSnapshotJobCommandOutput extends __MetadataBearer { * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/SubmitOpportunityCommand.ts b/clients/client-partnercentral-selling/src/commands/SubmitOpportunityCommand.ts index 07aedf144e2e0..86921d735497e 100644 --- a/clients/client-partnercentral-selling/src/commands/SubmitOpportunityCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/SubmitOpportunityCommand.ts @@ -32,10 +32,7 @@ export interface SubmitOpportunityCommandInput extends SubmitOpportunityRequest export interface SubmitOpportunityCommandOutput extends __MetadataBearer {} /** - *

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

+ *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -61,33 +58,19 @@ export interface SubmitOpportunityCommandOutput extends __MetadataBearer {} * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/TagResourceCommand.ts b/clients/client-partnercentral-selling/src/commands/TagResourceCommand.ts index d3d40b925419d..cd13a431e4117 100644 --- a/clients/client-partnercentral-selling/src/commands/TagResourceCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/TagResourceCommand.ts @@ -61,40 +61,22 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/UntagResourceCommand.ts b/clients/client-partnercentral-selling/src/commands/UntagResourceCommand.ts index e7ce7535967db..1f7fa9ba7596e 100644 --- a/clients/client-partnercentral-selling/src/commands/UntagResourceCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/UntagResourceCommand.ts @@ -58,40 +58,22 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/commands/UpdateOpportunityCommand.ts b/clients/client-partnercentral-selling/src/commands/UpdateOpportunityCommand.ts index 258f99df5b1a2..d8a6432da68cd 100644 --- a/clients/client-partnercentral-selling/src/commands/UpdateOpportunityCommand.ts +++ b/clients/client-partnercentral-selling/src/commands/UpdateOpportunityCommand.ts @@ -36,14 +36,7 @@ export interface UpdateOpportunityCommandInput extends UpdateOpportunityRequest export interface UpdateOpportunityCommandOutput extends UpdateOpportunityResponse, __MetadataBearer {} /** - *

Updates 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 send the complete payload with the updated values to be changed.

+ *

Updates 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 send the complete payload with the updated values to be changed.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -166,40 +159,22 @@ export interface UpdateOpportunityCommandOutput extends UpdateOpportunityRespons * @see {@link PartnerCentralSellingClientResolvedConfig | config} for PartnerCentralSellingClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* * @throws {@link ConflictException} (client fault) - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* * @throws {@link InternalServerException} (server fault) - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* * @throws {@link ResourceNotFoundException} (client fault) - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* * @throws {@link ThrottlingException} (client fault) - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* * @throws {@link ValidationException} (client fault) - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* * @throws {@link PartnerCentralSellingServiceException} *

Base exception class for all service exceptions from PartnerCentralSelling service.

diff --git a/clients/client-partnercentral-selling/src/index.ts b/clients/client-partnercentral-selling/src/index.ts index 5768bdae2bfa9..946160e0367b3 100644 --- a/clients/client-partnercentral-selling/src/index.ts +++ b/clients/client-partnercentral-selling/src/index.ts @@ -1,67 +1,7 @@ // smithy-typescript generated code /* eslint-disable */ /** - * AWS Partner Central API for Selling - *

- * AWS Partner Central API for Selling Reference - * Guide - *

- *

This Amazon Web Services (AWS) Partner Central API reference is designed to help - * AWS Partners integrate - * Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can - * automate interactions with AWS Partner Central, which helps to ensure effective - * engagements in joint business activities.

- *

The API provides standard AWS API functionality. Access it by either using API Actions or by using an AWS SDK that's tailored to your programming language - * or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.

- *

- * Features offered by AWS Partner Central API - *

- *
    - *
  1. - *

    - * Opportunity management: Manages coselling - * opportunities through API actions such as CreateOpportunity, - * UpdateOpportunity, ListOpportunities, - * GetOpportunity, and AssignOpportunity.

    - *
    2. - *
  2. - *

    - * AWS referral management: Manages referrals - * shared by AWS using actions such as ListEngagementInvitations, - * GetEngagementInvitation, - * StartEngagementByAcceptingInvitation, and - * RejectEngagementInvitation.

    - *
    3. - *
  3. - *

    - * Entity association: Associates related - * entities such as AWS Products, Partner - * Solutions, and AWS Marketplace Private - * Offers with opportunities using the actions - * AssociateOpportunity, and - * DisassociateOpportunity.

    - *
    4. - *
  4. - *

    - * View AWS opportunity details: Retrieves - * real-time summaries of AWS opportunities using the - * GetAWSOpportunitySummary action.

    - *
    5. - *
  5. - *

    - * List solutions: Provides list APIs for - * listing partner offers using ListSolutions.

    - *
    6. - *
  6. - *

    - * Event subscription: Subscribe to real-time - * opportunity updates through AWS EventBridge by using actions such as - * Opportunity Created, Opportunity - * Updated, Engagement Invitation Accepted, - * Engagement Invitation Rejected, and - * Engagement Invitation Created.

    - *
    7. - *
+ * AWS Partner Central API for Selling

AWS Partner Central API for Selling Reference Guide

This Amazon Web Services (AWS) Partner Central API reference is designed to help AWS Partners integrate Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can automate interactions with AWS Partner Central, which helps to ensure effective engagements in joint business activities.

The API provides standard AWS API functionality. Access it by either using API Actions or by using an AWS SDK that's tailored to your programming language or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.

Features offered by AWS Partner Central API

  1. Opportunity management: Manages coselling opportunities through API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity.

  2. AWS referral management: Manages referrals shared by AWS using actions such as ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation.

  3. Entity association: Associates related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity, and DisassociateOpportunity.

  4. View AWS opportunity details: Retrieves real-time summaries of AWS opportunities using the GetAWSOpportunitySummary action.

  5. List solutions: Provides list APIs for listing partner offers using ListSolutions.

  6. Event subscription: Subscribe to real-time opportunity updates through AWS EventBridge by using actions such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected, and Engagement Invitation Created.

* * @packageDocumentation */ diff --git a/clients/client-partnercentral-selling/src/models/models_0.ts b/clients/client-partnercentral-selling/src/models/models_0.ts index bacf7642f4ccc..1e69af75c0df0 100644 --- a/clients/client-partnercentral-selling/src/models/models_0.ts +++ b/clients/client-partnercentral-selling/src/models/models_0.ts @@ -8,28 +8,20 @@ import { PartnerCentralSellingServiceException as __BaseException } from "./Part */ export interface AcceptEngagementInvitationRequest { /** - *

The CatalogType parameter specifies the catalog associated with the - * engagement invitation. Accepted values are AWS and Sandbox, - * which determine the environment in which the engagement invitation is managed.

+ *

The CatalogType parameter specifies the catalog associated with the engagement invitation. Accepted values are AWS and Sandbox, which determine the environment in which the engagement invitation is managed.

* @public */ Catalog: string | undefined; /** - *

The Identifier parameter in the - * AcceptEngagementInvitationRequest specifies the unique identifier of - * the EngagementInvitation to be accepted. Providing the correct identifier - * ensures that the intended invitation is accepted.

+ *

The Identifier parameter in the AcceptEngagementInvitationRequest specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier ensures that the intended invitation is accepted.

* @public */ Identifier: string | undefined; } /** - *

This error occurs when you don't have permission to perform the requested - * action.

- *

You don’t have access to this action or resource. Review IAM policies or contact your - * AWS administrator for assistance.

+ *

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

* @public */ export class AccessDeniedException extends __BaseException { @@ -51,11 +43,7 @@ export class AccessDeniedException extends __BaseException { } /** - *

This error occurs when the request can’t be processed due to a conflict with the - * target resource's current state, which could result from updating or deleting the - * resource.

- *

Suggested action: Fetch the latest state of the resource, verify the state, and retry - * the request.

+ *

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

* @public */ export class ConflictException extends __BaseException { @@ -77,10 +65,7 @@ export class ConflictException extends __BaseException { } /** - *

This error occurs when the specified resource can’t be found or doesn't exist. - * Resource ID and type might be incorrect.

- *

Suggested action: This is usually a transient error. Retry after the provided retry - * delay or a short interval. If the problem persists, contact AWS support.

+ *

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

* @public */ export class InternalServerException extends __BaseException { @@ -102,10 +87,7 @@ export class InternalServerException extends __BaseException { } /** - *

This error occurs when the specified resource can't be found. The resource might not - * exist, or isn't visible with the current credentials.

- *

Suggested action: Verify that the resource ID is correct and the resource is in the - * expected AWS region. Check IAM permissions for accessing the resource.

+ *

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

* @public */ export class ResourceNotFoundException extends __BaseException { @@ -127,9 +109,7 @@ export class ResourceNotFoundException extends __BaseException { } /** - *

This error occurs when there are too many requests sent. Review the provided quotas - * and adapt your usage to avoid throttling.

- *

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

+ *

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

* @public */ export class ThrottlingException extends __BaseException { @@ -173,55 +153,7 @@ export type ValidationExceptionErrorCode = (typeof ValidationExceptionErrorCode)[keyof typeof ValidationExceptionErrorCode]; /** - *

Indicates an invalid value for a field.

- * + *

Indicates an invalid value for a field.

* @public */ export interface ValidationExceptionError { @@ -259,10 +191,7 @@ export const ValidationExceptionReason = { export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason]; /** - *

The input fails to satisfy the constraints specified by the service or business - * validation rules.

- *

Suggested action: Review the error message, including the failed fields and reasons, - * to correct the request payload.

+ *

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

* @public */ export class ValidationException extends __BaseException { @@ -270,30 +199,13 @@ export class ValidationException extends __BaseException { readonly $fault: "client" = "client"; Message: string | undefined; /** - *

The primary reason for this validation exception to occur.

- * + *

The primary reason for this validation exception to occur.

* @public */ Reason: ValidationExceptionReason | undefined; /** - *

A list of issues that were discovered in the submitted request or the resource - * state.

+ *

A list of issues that were discovered in the submitted request or the resource state.

* @public */ ErrorList?: ValidationExceptionError[] | undefined; @@ -575,53 +487,36 @@ export const CountryCode = { export type CountryCode = (typeof CountryCode)[keyof typeof CountryCode]; /** - *

Specifies the end Customer's address details associated with the - * Opportunity.

+ *

Specifies the end Customer's address details associated with the Opportunity.

* @public */ export interface Address { /** - *

Specifies the end Customer's city associated with the - * Opportunity.

+ *

Specifies the end Customer's city associated with the Opportunity.

* @public */ City?: string | undefined; /** - *

Specifies the end Customer's postal code associated with the - * Opportunity.

+ *

Specifies the end Customer's postal code associated with the Opportunity.

* @public */ PostalCode?: string | undefined; /** - *

Specifies the end Customer's state or region associated with the - * Opportunity.

- *

Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | - * California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated - * States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | - * Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland - * | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska - * | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | - * North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | - * Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | - * Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West - * Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP - *

+ *

Specifies the end Customer's state or region associated with the Opportunity.

Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

* @public */ StateOrRegion?: string | undefined; /** - *

Specifies the end Customer's country associated with the - * Opportunity.

+ *

Specifies the end Customer's country associated with the Opportunity.

* @public */ CountryCode?: CountryCode | undefined; /** - *

Specifies the end Customer's street address associated with the - * Opportunity.

+ *

Specifies the end Customer's street address associated with the Opportunity.

* @public */ StreetAddress?: string | undefined; @@ -668,53 +563,42 @@ export const Industry = { export type Industry = (typeof Industry)[keyof typeof Industry]; /** - *

Specifies the Customer's account details associated with the - * Opportunity.

+ *

Specifies the Customer's account details associated with the Opportunity.

* @public */ export interface Account { /** - *

Specifies the industry the end Customer belongs to that's associated with - * the Opportunity. It refers to the category or sector where the customer's - * business operates. This is a required field.

+ *

Specifies the industry the end Customer belongs to that's associated with the Opportunity. It refers to the category or sector where the customer's business operates. This is a required field.

* @public */ Industry?: Industry | undefined; /** - *

Specifies the end Customer's industry associated with the - * Opportunity, when the selected value in the Industry field - * is Other.

+ *

Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other.

* @public */ OtherIndustry?: string | undefined; /** - *

Specifies the end Customer's company name associated with the - * Opportunity.

+ *

Specifies the end Customer's company name associated with the Opportunity.

* @public */ CompanyName: string | undefined; /** - *

Specifies the end customer's company website URL associated with the - * Opportunity. This value is crucial to map the customer within the - * Amazon Web Services CRM system. This field is required in all cases except when the - * opportunity is related to national security.

+ *

Specifies the end customer's company website URL associated with the Opportunity. This value is crucial to map the customer within the Amazon Web Services CRM system. This field is required in all cases except when the opportunity is related to national security.

* @public */ WebsiteUrl?: string | undefined; /** - *

Specifies the Customer - * Amazon Web Services account ID associated with the Opportunity.

+ *

Specifies the Customer Amazon Web Services account ID associated with the Opportunity.

* @public */ AwsAccountId?: string | undefined; /** - *

Specifies the end Customer's address details associated with the - * Opportunity.

+ *

Specifies the end Customer's address details associated with the Opportunity.

* @public */ Address?: Address | undefined; @@ -727,21 +611,18 @@ export interface Account { } /** - *

Contains the account details of the partner who received the Engagement Invitation, - * including the AWS account ID and company name.

+ *

Contains the account details of the partner who received the Engagement Invitation, including the AWS account ID and company name.

* @public */ export interface AccountReceiver { /** - *

Represents the alias of the partner account receiving the Engagement Invitation, - * making it easier to identify and track the recipient in reports or logs.

+ *

Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.

* @public */ Alias?: string | undefined; /** - *

Indicates the AWS account ID of the partner who received the Engagement Invitation. - * This is a unique identifier for managing engagements with specific AWS accounts.

+ *

Indicates the AWS account ID of the partner who received the Engagement Invitation. This is a unique identifier for managing engagements with specific AWS accounts.

* @public */ AwsAccountId: string | undefined; @@ -753,40 +634,25 @@ export interface AccountReceiver { */ export interface AddressSummary { /** - *

Specifies the end Customer's city associated with the - * Opportunity.

+ *

Specifies the end Customer's city associated with the Opportunity.

* @public */ City?: string | undefined; /** - *

Specifies the end Customer's postal code associated with the - * Opportunity.

+ *

Specifies the end Customer's postal code associated with the Opportunity.

* @public */ PostalCode?: string | undefined; /** - *

Specifies the end Customer's state or region associated with the - * Opportunity.

- *

Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | - * California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated - * States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | - * Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland - * | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska - * | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | - * North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | - * Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | - * Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West - * Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP - *

+ *

Specifies the end Customer's state or region associated with the Opportunity.

Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

* @public */ StateOrRegion?: string | undefined; /** - *

Specifies the end Customer's country associated with the - * Opportunity.

+ *

Specifies the end Customer's country associated with the Opportunity.

* @public */ CountryCode?: CountryCode | undefined; @@ -798,83 +664,61 @@ export interface AddressSummary { */ export interface AccountSummary { /** - *

Specifies which industry the end Customer belongs to associated with the - * Opportunity. It refers to the category or sector that the customer's - * business operates in.

- *

To submit a value outside the picklist, use Other.

- *

Conditionally mandatory if Other is selected for Industry Vertical in - * LOVs.

+ *

Specifies which industry the end Customer belongs to associated with the Opportunity. It refers to the category or sector that the customer's business operates in.

To submit a value outside the picklist, use Other.

Conditionally mandatory if Other is selected for Industry Vertical in LOVs.

* @public */ Industry?: Industry | undefined; /** - *

Specifies the end Customer's industry associated with the - * Opportunity, when the selected value in the Industry field is - * Other. This field is relevant when the customer's industry doesn't fall - * under the predefined picklist values and requires a custom description.

+ *

Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other. This field is relevant when the customer's industry doesn't fall under the predefined picklist values and requires a custom description.

* @public */ OtherIndustry?: string | undefined; /** - *

Specifies the end Customer's company name associated with the - * Opportunity.

+ *

Specifies the end Customer's company name associated with the Opportunity.

* @public */ CompanyName: string | undefined; /** - *

Specifies the end customer's company website URL associated with the - * Opportunity. This value is crucial to map the customer within the - * Amazon Web Services CRM system.

+ *

Specifies the end customer's company website URL associated with the Opportunity. This value is crucial to map the customer within the Amazon Web Services CRM system.

* @public */ WebsiteUrl?: string | undefined; /** - *

Specifies the end Customer's address details associated with the - * Opportunity.

+ *

Specifies the end Customer's address details associated with the Opportunity.

* @public */ Address?: AddressSummary | undefined; } /** - *

Represents the contact details of the individual assigned to manage the opportunity - * within the partner organization. This helps to ensure that there is a point of contact - * for the opportunity's progress.

+ *

Represents the contact details of the individual assigned to manage the opportunity within the partner organization. This helps to ensure that there is a point of contact for the opportunity's progress.

* @public */ export interface AssigneeContact { /** - *

Provides the email address of the assignee. This email is used for communications and - * notifications related to the opportunity.

+ *

Provides the email address of the assignee. This email is used for communications and notifications related to the opportunity.

* @public */ Email: string | undefined; /** - *

Specifies the first name of the assignee managing the opportunity. The system - * automatically retrieves this value from the user profile by referencing the associated - * email address.

+ *

Specifies the first name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.

* @public */ FirstName: string | undefined; /** - *

Specifies the last name of the assignee managing the opportunity. The system - * automatically retrieves this value from the user profile by referencing the associated - * email address.

+ *

Specifies the last name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.

* @public */ LastName: string | undefined; /** - *

Specifies the business title of the assignee managing the opportunity. This helps - * clarify the individual's role and responsibilities within the organization. Use the - * value PartnerAccountManager to update details of the opportunity - * owner.

+ *

Specifies the business title of the assignee managing the opportunity. This helps clarify the individual's role and responsibilities within the organization. Use the value PartnerAccountManager to update details of the opportunity owner.

* @public */ BusinessTitle: string | undefined; @@ -885,28 +729,19 @@ export interface AssigneeContact { */ export interface AssignOpportunityRequest { /** - *

Specifies the catalog associated with the request. This field takes a string value - * from a predefined list: AWS or Sandbox. The catalog determines - * which environment the opportunity is assigned in. Use AWS to assign real - * opportunities in the Amazon Web Services catalog, and Sandbox for testing in - * secure, isolated environments.

+ *

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is assigned in. Use AWS to assign real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

* @public */ Catalog: string | undefined; /** - *

Requires the Opportunity's unique identifier when you want to assign it - * to another user. Provide the correct identifier so the intended opportunity is - * reassigned.

+ *

Requires the Opportunity's unique identifier when you want to assign it to another user. Provide the correct identifier so the intended opportunity is reassigned.

* @public */ Identifier: string | undefined; /** - *

Specifies the user or team member responsible for managing the assigned opportunity. - * This field identifies the Assignee based on the partner's internal - * team structure. Ensure that the email address is associated with a registered user in - * your Partner Central account.

+ *

Specifies the user or team member responsible for managing the assigned opportunity. This field identifies the Assignee based on the partner's internal team structure. Ensure that the email address is associated with a registered user in your Partner Central account.

* @public */ Assignee: AssigneeContact | undefined; @@ -932,35 +767,25 @@ export type RelatedEntityType = (typeof RelatedEntityType)[keyof typeof RelatedE */ export interface AssociateOpportunityRequest { /** - *

Specifies the catalog associated with the request. This field takes a string value - * from a predefined list: AWS or Sandbox. The catalog determines - * which environment the opportunity association is made in. Use AWS to - * associate opportunities in the Amazon Web Services catalog, and Sandbox for - * testing in secure, isolated environments.

+ *

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

* @public */ Catalog: string | undefined; /** - *

Requires the Opportunity's unique identifier when you want to associate - * it with a related entity. Provide the correct identifier so the intended opportunity is - * updated with the association.

+ *

Requires the Opportunity's unique identifier when you want to associate it with a related entity. Provide the correct identifier so the intended opportunity is updated with the association.

* @public */ OpportunityIdentifier: string | undefined; /** - *

Specifies the entity type that you're associating with the Opportunity. - * This helps to categorize and properly process the association.

+ *

Specifies the entity type that you're associating with the Opportunity. This helps to categorize and properly process the association.

* @public */ RelatedEntityType: RelatedEntityType | undefined; /** - *

Requires the related entity's unique identifier when you want to associate it with the - * Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon - * Resource Name (ARN). Use the - * Amazon Web Services Marketplace API to obtain the ARN.

+ *

Requires the related entity's unique identifier when you want to associate it with the Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon Resource Name (ARN). Use the Amazon Web Services Marketplace API to obtain the ARN.

* @public */ RelatedEntityIdentifier: string | undefined; @@ -1082,9 +907,7 @@ export interface Contact { LastName?: string | undefined; /** - *

The partner contact's title (job title or role) associated with the - * Opportunity. BusinessTitle supports either - * PartnerAccountManager or OpportunityOwner.

+ *

The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.

* @public */ BusinessTitle?: string | undefined; @@ -1097,15 +920,12 @@ export interface Contact { } /** - *

Represents the customer associated with the AWS opportunity. This field captures key - * details about the customer that are necessary for managing the opportunity.

+ *

Represents the customer associated with the AWS opportunity. This field captures key details about the customer that are necessary for managing the opportunity.

* @public */ export interface AwsOpportunityCustomer { /** - *

Provides a list of customer contacts involved in the opportunity. These contacts may - * include decision makers, influencers, and other stakeholders within the customer's - * organization.

+ *

Provides a list of customer contacts involved in the opportunity. These contacts may include decision makers, influencers, and other stakeholders within the customer's organization.

* @public */ Contacts?: Contact[] | undefined; @@ -1127,43 +947,36 @@ export const EngagementScore = { export type EngagementScore = (typeof EngagementScore)[keyof typeof EngagementScore]; /** - *

Contains insights provided by AWS for the opportunity, offering recommendations and - * analysis that can help the partner optimize their engagement and strategy.

+ *

Contains insights provided by AWS for the opportunity, offering recommendations and analysis that can help the partner optimize their engagement and strategy.

* @public */ export interface AwsOpportunityInsights { /** - *

Provides recommendations from AWS on the next best actions to take in order to move - * the opportunity forward and increase the likelihood of success.

+ *

Provides recommendations from AWS on the next best actions to take in order to move the opportunity forward and increase the likelihood of success.

* @public */ NextBestActions?: string | undefined; /** - *

Represents a score assigned by AWS to indicate the level of engagement and potential - * success for the opportunity. This score helps partners prioritize their efforts.

+ *

Represents a score assigned by AWS to indicate the level of engagement and potential success for the opportunity. This score helps partners prioritize their efforts.

* @public */ EngagementScore?: EngagementScore | undefined; } /** - *

Tracks the history of next steps associated with the opportunity. This field captures - * the actions planned for the future and their timeline.

+ *

Tracks the history of next steps associated with the opportunity. This field captures the actions planned for the future and their timeline.

* @public */ export interface ProfileNextStepsHistory { /** - *

Represents the details of the next step recorded, such as follow-up actions or - * decisions made. This field helps in tracking progress and ensuring alignment with - * project goals.

+ *

Represents the details of the next step recorded, such as follow-up actions or decisions made. This field helps in tracking progress and ensuring alignment with project goals.

* @public */ Value: string | undefined; /** - *

Indicates the date and time when a particular next step was recorded or planned. This - * helps in managing the timeline for the opportunity.

+ *

Indicates the date and time when a particular next step was recorded or planned. This helps in managing the timeline for the opportunity.

* @public */ Time: Date | undefined; @@ -1206,46 +1019,36 @@ export const AwsOpportunityStage = { export type AwsOpportunityStage = (typeof AwsOpportunityStage)[keyof typeof AwsOpportunityStage]; /** - *

Tracks the lifecycle of the AWS opportunity, including stages such as qualification, - * validation, and closure. This field helps partners understand the current status and - * progression of the opportunity.

+ *

Tracks the lifecycle of the AWS opportunity, including stages such as qualification, validation, and closure. This field helps partners understand the current status and progression of the opportunity.

* @public */ export interface AwsOpportunityLifeCycle { /** - *

Indicates the expected date by which the opportunity is projected to close. This field - * helps in planning resources and timelines for both the partner and AWS.

+ *

Indicates the expected date by which the opportunity is projected to close. This field helps in planning resources and timelines for both the partner and AWS.

* @public */ TargetCloseDate?: string | undefined; /** - *

Indicates the reason why an opportunity was marked as Closed Lost. This - * helps in understanding the context behind the lost opportunity and aids in refining - * future strategies.

+ *

Indicates the reason why an opportunity was marked as Closed Lost. This helps in understanding the context behind the lost opportunity and aids in refining future strategies.

* @public */ ClosedLostReason?: AwsClosedLostReason | undefined; /** - *

Represents the current stage of the opportunity in its lifecycle, such as - * Qualification, Validation, or Closed Won. - * This helps in understanding the opportunity's progress.

+ *

Represents the current stage of the opportunity in its lifecycle, such as Qualification, Validation, or Closed Won. This helps in understanding the opportunity's progress.

* @public */ Stage?: AwsOpportunityStage | undefined; /** - *

Specifies the immediate next steps required to progress the opportunity. These steps - * are based on AWS guidance and the current stage of the opportunity.

+ *

Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS guidance and the current stage of the opportunity.

* @public */ NextSteps?: string | undefined; /** - *

Provides a historical log of previous next steps that were taken to move the - * opportunity forward. This helps in tracking the decision-making process and identifying - * any delays or obstacles encountered.

+ *

Provides a historical log of previous next steps that were taken to move the opportunity forward. This helps in tracking the decision-making process and identifying any delays or obstacles encountered.

* @public */ NextStepsHistory?: ProfileNextStepsHistory[] | undefined; @@ -1445,39 +1248,30 @@ export const PaymentFrequency = { export type PaymentFrequency = (typeof PaymentFrequency)[keyof typeof PaymentFrequency]; /** - *

Provides an estimate of the revenue that the partner is expected to generate from the - * opportunity. This information helps partners assess the financial value of the - * project.

+ *

Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.

* @public */ export interface ExpectedCustomerSpend { /** - *

Represents the estimated monthly revenue that the partner expects to earn from the - * opportunity. This helps in forecasting financial returns.

+ *

Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.

* @public */ Amount: string | undefined; /** - *

Indicates the currency in which the revenue estimate is provided. This helps in - * understanding the financial impact across different markets.

+ *

Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.

* @public */ CurrencyCode: CurrencyCode | undefined; /** - *

Indicates how frequently the customer is expected to spend the projected amount. This - * can include values such as Monthly, Quarterly, or - * Annually. The default value is Monthly, representing - * recurring monthly spend.

+ *

Indicates how frequently the customer is expected to spend the projected amount. This can include values such as Monthly, Quarterly, or Annually. The default value is Monthly, representing recurring monthly spend.

* @public */ Frequency: PaymentFrequency | undefined; /** - *

Specifies the name of the partner company that is expected to generate revenue from - * the opportunity. This field helps track the partner’s involvement in the - * opportunity.

+ *

Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity.

* @public */ TargetCompany: string | undefined; @@ -1490,48 +1284,37 @@ export interface ExpectedCustomerSpend { } /** - *

Captures details about the project associated with the opportunity, including - * objectives, scope, and customer requirements.

+ *

Captures details about the project associated with the opportunity, including objectives, scope, and customer requirements.

* @public */ export interface AwsOpportunityProject { /** - *

Indicates the expected spending by the customer over the course of the project. This - * value helps partners and AWS estimate the financial impact of the opportunity. Use the - * AWS Pricing Calculator to create an - * estimate of the customer’s total spend. If only annual recurring revenue (ARR) is - * available, distribute it across 12 months to provide an average monthly value.

+ *

Indicates the expected spending by the customer over the course of the project. This value helps partners and AWS estimate the financial impact of the opportunity. Use the AWS Pricing Calculator to create an estimate of the customer’s total spend. If only annual recurring revenue (ARR) is available, distribute it across 12 months to provide an average monthly value.

* @public */ ExpectedCustomerSpend?: ExpectedCustomerSpend[] | undefined; } /** - *

Represents other entities related to the AWS opportunity, such as AWS products, - * partner solutions, and marketplace offers. These associations help build a complete - * picture of the solution being sold.

+ *

Represents other entities related to the AWS opportunity, such as AWS products, partner solutions, and marketplace offers. These associations help build a complete picture of the solution being sold.

* @public */ export interface AwsOpportunityRelatedEntities { /** - *

Specifies the AWS products associated with the opportunity. This field helps track the - * specific products that are part of the proposed solution.

+ *

Specifies the AWS products associated with the opportunity. This field helps track the specific products that are part of the proposed solution.

* @public */ AwsProducts?: string[] | undefined; /** - *

Specifies the partner solutions related to the opportunity. These solutions represent - * the partner's offerings that are being positioned as part of the overall AWS - * opportunity.

+ *

Specifies the partner solutions related to the opportunity. These solutions represent the partner's offerings that are being positioned as part of the overall AWS opportunity.

* @public */ Solutions?: string[] | undefined; } /** - *

Represents an Amazon Web Services team member for the engagement. This structure - * includes details such as name, email, and business title.

+ *

Represents an Amazon Web Services team member for the engagement. This structure includes details such as name, email, and business title.

* @public */ export interface AwsTeamMember { @@ -1554,52 +1337,44 @@ export interface AwsTeamMember { LastName?: string | undefined; /** - *

Specifies the Amazon Web Services team member's business title and indicates their - * organizational role.

+ *

Specifies the Amazon Web Services team member's business title and indicates their organizational role.

* @public */ BusinessTitle?: AwsMemberBusinessTitle | undefined; } /** - *

Contains details about the customer associated with the Engagement Invitation, - * including company information and industry.

+ *

Contains details about the customer associated with the Engagement Invitation, including company information and industry.

* @public */ export interface EngagementCustomer { /** - *

Specifies the industry to which the customer’s company belongs. This field helps - * categorize the opportunity based on the customer’s business sector.

+ *

Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.

* @public */ Industry: Industry | undefined; /** - *

Represents the name of the customer’s company associated with the Engagement - * Invitation. This field is used to identify the customer.

+ *

Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.

* @public */ CompanyName: string | undefined; /** - *

Provides the website URL of the customer’s company. This field helps partners verify - * the legitimacy and size of the customer organization.

+ *

Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.

* @public */ WebsiteUrl: string | undefined; /** - *

Indicates the country in which the customer’s company operates. This field is useful - * for understanding regional requirements or compliance needs.

+ *

Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.

* @public */ CountryCode: CountryCode | undefined; } /** - *

Provides comprehensive details about a customer project associated with an Engagement. - * This may include information such as project goals, timelines, and specific customer - * requirements.

+ *

Provides comprehensive details about a customer project associated with an Engagement. This may include information such as project goals, timelines, and specific customer requirements.

* @public */ export interface EngagementCustomerProjectDetails { @@ -1623,21 +1398,12 @@ export interface EngagementCustomerProjectDetails { } /** - *

The CustomerProjects structure in Engagements offers a flexible framework for managing - * customer-project relationships. It supports multiple customers per Engagement and - * multiple projects per customer, while also allowing for customers without projects and - * projects without specific customers.

- *

All Engagement members have full visibility of customers and their associated - * projects, enabling the capture of relevant context even when project details are not - * fully defined. This structure also facilitates targeted invitations, allowing partners - * to focus on specific customers and their business problems when sending Engagement - * invitations.

+ *

The CustomerProjects structure in Engagements offers a flexible framework for managing customer-project relationships. It supports multiple customers per Engagement and multiple projects per customer, while also allowing for customers without projects and projects without specific customers.

All Engagement members have full visibility of customers and their associated projects, enabling the capture of relevant context even when project details are not fully defined. This structure also facilitates targeted invitations, allowing partners to focus on specific customers and their business problems when sending Engagement invitations.

* @public */ export interface CustomerProjectsContext { /** - *

Contains details about the customer associated with the Engagement Invitation, - * including company information and industry.

+ *

Contains details about the customer associated with the Engagement Invitation, including company information and industry.

* @public */ Customer?: EngagementCustomer | undefined; @@ -1650,8 +1416,7 @@ export interface CustomerProjectsContext { } /** - *

Represents the payload of an Engagement context. The structure of this payload varies - * based on the context type specified in the EngagementContextDetails.

+ *

Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails.

* @public */ export type EngagementContextPayload = @@ -1663,9 +1428,7 @@ export type EngagementContextPayload = */ export namespace EngagementContextPayload { /** - *

Contains detailed information about a customer project when the context type is - * "CustomerProject". This field is present only when the Type in EngagementContextDetails - * is set to "CustomerProject".

+ *

Contains detailed information about a customer project when the context type is "CustomerProject". This field is present only when the Type in EngagementContextDetails is set to "CustomerProject".

* @public */ export interface CustomerProjectMember { @@ -1706,22 +1469,18 @@ export const EngagementContextType = { export type EngagementContextType = (typeof EngagementContextType)[keyof typeof EngagementContextType]; /** - *

Provides detailed context information for an Engagement. This structure allows for - * specifying the type of context and its associated payload.

+ *

Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload.

* @public */ export interface EngagementContextDetails { /** - *

Specifies the type of Engagement context. Valid values are "CustomerProject" or - * "Document", indicating whether the context relates to a customer project or a document - * respectively.

+ *

Specifies the type of Engagement context. Valid values are "CustomerProject" or "Document", indicating whether the context relates to a customer project or a document respectively.

* @public */ Type: EngagementContextType | undefined; /** - *

Contains the specific details of the Engagement context. The structure of this payload - * varies depending on the Type field.

+ *

Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.

* @public */ Payload?: EngagementContextPayload | undefined; @@ -1732,18 +1491,13 @@ export interface EngagementContextDetails { */ export interface CreateEngagementRequest { /** - *

The CreateEngagementRequest$Catalog parameter specifies the catalog - * related to the engagement. Accepted values are AWS and - * Sandbox, which determine the environment in which the engagement is - * managed.

+ *

The CreateEngagementRequest$Catalog parameter specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.

* @public */ Catalog: string | undefined; /** - *

The CreateEngagementRequest$ClientToken parameter specifies a unique, - * case-sensitive identifier to ensure that the request is handled exactly once. The value - * must not exceed sixty-four alphanumeric characters.

+ *

The CreateEngagementRequest$ClientToken parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.

* @public */ ClientToken?: string | undefined; @@ -1761,21 +1515,7 @@ export interface CreateEngagementRequest { Description: string | undefined; /** - *

The Contexts field is a required array of objects, with a maximum of 5 - * contexts allowed, specifying detailed information about customer projects associated - * with the Engagement. Each context object contains a Type field indicating - * the context type, which must be CustomerProject in this version, and a - * Payload field containing the CustomerProject details. The - * CustomerProject object is composed of two main components: - * Customer and Project. The Customer object - * includes information such as CompanyName, WebsiteUrl, - * Industry, and CountryCode, providing essential details - * about the customer. The Project object contains Title, - * BusinessProblem, and TargetCompletionDate, offering - * insights into the specific project associated with the customer. This structure allows - * comprehensive context to be included within the Engagement, facilitating effective - * collaboration between parties by providing relevant customer and project - * information.

+ *

The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem, and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.

* @public */ Contexts?: EngagementContextDetails[] | undefined; @@ -1799,11 +1539,7 @@ export interface CreateEngagementResponse { } /** - *

This error occurs when the request would cause a service quota to be exceeded. Service - * quotas represent the maximum allowed use of a specific resource, and this error - * indicates that the request would surpass that limit.

- *

Suggested action: Review the Quotas for the - * resource, and either reduce usage or request a quota increase.

+ *

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

* @public */ export class ServiceQuotaExceededException extends __BaseException { @@ -1829,8 +1565,7 @@ export class ServiceQuotaExceededException extends __BaseException { */ export interface GetEngagementRequest { /** - *

Specifies the catalog related to the engagement request. Valid values are - * AWS and Sandbox.

+ *

Specifies the catalog related to the engagement request. Valid values are AWS and Sandbox.

* @public */ Catalog: string | undefined; @@ -1859,46 +1594,37 @@ export interface GetEngagementResponse { Arn?: string | undefined; /** - *

The title of the engagement. It provides a brief, descriptive name for the engagement - * that is meaningful and easily recognizable.

+ *

The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.

* @public */ Title?: string | undefined; /** - *

A more detailed description of the engagement. This provides additional context or - * information about the engagement's purpose or scope.

+ *

A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.

* @public */ Description?: string | undefined; /** - *

The date and time when the Engagement was created, presented in ISO 8601 format (UTC). - * For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the - * Engagement.

+ *

The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: "2023-05-01T20:37:46Z". This timestamp helps track the lifecycle of the Engagement.

* @public */ CreatedAt?: Date | undefined; /** - *

The AWS account ID of the user who originally created the engagement. This field helps - * in tracking the origin of the engagement.

+ *

The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.

* @public */ CreatedBy?: string | undefined; /** - *

Specifies the current count of members participating in the Engagement. This count - * includes all active members regardless of their roles or permissions within the - * Engagement.

+ *

Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.

* @public */ MemberCount?: number | undefined; /** - *

A list of context objects associated with the engagement. Each context provides - * additional information related to the Engagement, such as customer projects or - * documents.

+ *

A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

* @public */ Contexts?: EngagementContextDetails[] | undefined; @@ -1934,15 +1660,7 @@ export interface ListEngagementMembersRequest { } /** - *

Engagement members are the participants in an Engagement, which is likely a - * collaborative project or business opportunity within the AWS partner network. Members - * can be different partner organizations or AWS accounts that are working together on a - * specific engagement.

- *

Each member is represented by their AWS Account ID, Company Name, and associated - * details. Members have a status within the Engagement (PENDING, ACCEPTED, REJECTED, or - * WITHDRAWN), indicating their current state of participation. Only existing members of an - * Engagement can view the list of other members. This implies a level of privacy and - * access control within the Engagement structure.

+ *

Engagement members are the participants in an Engagement, which is likely a collaborative project or business opportunity within the AWS partner network. Members can be different partner organizations or AWS accounts that are working together on a specific engagement.

Each member is represented by their AWS Account ID, Company Name, and associated details. Members have a status within the Engagement (PENDING, ACCEPTED, REJECTED, or WITHDRAWN), indicating their current state of participation. Only existing members of an Engagement can view the list of other members. This implies a level of privacy and access control within the Engagement structure.

* @public */ export interface EngagementMember { @@ -1953,15 +1671,13 @@ export interface EngagementMember { CompanyName?: string | undefined; /** - *

The URL of the member company's website. This offers a way to find more information - * about the member organization and serves as an additional identifier.

+ *

The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier.

* @public */ WebsiteUrl?: string | undefined; /** - *

This is the unique identifier for the AWS account associated with the member - * organization. It's used for AWS-related operations and identity verification.

+ *

This is the unique identifier for the AWS account associated with the member organization. It's used for AWS-related operations and identity verification.

* @public */ AccountId?: string | undefined; @@ -1978,10 +1694,7 @@ export interface ListEngagementMembersResponse { EngagementMemberList: EngagementMember[] | undefined; /** - *

A pagination token used to retrieve the next set of results. If there are more results - * available than can be returned in a single response, this token will be present. Use - * this token in a subsequent request to retrieve the next page of results. If there are no - * more results, this value will be null.

+ *

A pagination token used to retrieve the next set of results. If there are more results available than can be returned in a single response, this token will be present. Use this token in a subsequent request to retrieve the next page of results. If there are no more results, this value will be null.

* @public */ NextToken?: string | undefined; @@ -2043,24 +1756,19 @@ export interface ListEngagementsRequest { Catalog: string | undefined; /** - *

A list of AWS account IDs. When specified, the response includes engagements created - * by these accounts. This filter is useful for finding engagements created by specific - * team members.

+ *

A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.

* @public */ CreatedBy?: string[] | undefined; /** - *

An array of strings representing AWS Account IDs. Use this to exclude engagements - * created by specific users.

+ *

An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.

* @public */ ExcludeCreatedBy?: string[] | undefined; /** - *

- * An object that specifies the sort order of the results. - *

+ *

Specifies the sorting parameters for listing Engagements.

* @public */ Sort?: EngagementSort | undefined; @@ -2072,8 +1780,7 @@ export interface ListEngagementsRequest { MaxResults?: number | undefined; /** - *

The token for the next set of results. This value is returned from a previous - * call.

+ *

The token for the next set of results. This value is returned from a previous call.

* @public */ NextToken?: string | undefined; @@ -2138,8 +1845,7 @@ export interface ListEngagementsResponse { EngagementSummaryList: EngagementSummary[] | undefined; /** - *

The token to retrieve the next set of results. This field will be null if there are no - * more results.

+ *

The token to retrieve the next set of results. This field will be null if there are no more results.

* @public */ NextToken?: string | undefined; @@ -2159,8 +1865,7 @@ export const ListTasksSortName = { export type ListTasksSortName = (typeof ListTasksSortName)[keyof typeof ListTasksSortName]; /** - *

Defines the sorting parameters for listing tasks. This structure allows for - * specifying the field to sort by and the order of sorting.

+ *

Defines the sorting parameters for listing tasks. This structure allows for specifying the field to sort by and the order of sorting.

* @public */ export interface ListTasksSortBase { @@ -2197,66 +1902,49 @@ export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus]; */ export interface ListEngagementByAcceptingInvitationTasksRequest { /** - *

Use this parameter to control the number of items returned in each request, which can - * be useful for performance tuning and managing large result sets.

+ *

Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

* @public */ MaxResults?: number | undefined; /** - *

Use this parameter for pagination when the result set spans multiple pages. This - * value is obtained from the NextToken field in the response of a previous call to this - * API.

+ *

Use this parameter for pagination when the result set spans multiple pages. This value is obtained from the NextToken field in the response of a previous call to this API.

* @public */ NextToken?: string | undefined; /** - *

Specifies the sorting criteria for the returned results. This allows you to order the - * tasks based on specific attributes.

+ *

Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.

* @public */ Sort?: ListTasksSortBase | undefined; /** - *

Specifies the catalog related to the request. Valid values are:

- * + *

Specifies the catalog related to the request. Valid values are:

* @public */ Catalog: string | undefined; /** - *

Filters the tasks based on their current status. This allows you to focus on tasks in - * specific states.

+ *

Filters the tasks based on their current status. This allows you to focus on tasks in specific states.

* @public */ TaskStatus?: TaskStatus[] | undefined; /** - *

Filters tasks by the identifiers of the opportunities they created or are associated - * with.

+ *

Filters tasks by the identifiers of the opportunities they created or are associated with.

* @public */ OpportunityIdentifier?: string[] | undefined; /** - *

Filters tasks by the identifiers of the engagement invitations they are processing. - *

+ *

Filters tasks by the identifiers of the engagement invitations they are processing.

* @public */ EngagementInvitationIdentifier?: string[] | undefined; /** - *

Filters tasks by their unique identifiers. Use this when you want to retrieve - * information about specific tasks.

+ *

Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.

* @public */ TaskIdentifier?: string[] | undefined; @@ -2294,8 +1982,7 @@ export const ReasonCode = { export type ReasonCode = (typeof ReasonCode)[keyof typeof ReasonCode]; /** - *

Specifies a subset of fields associated with tasks related to accepting an engagement - * invitation.

+ *

Specifies a subset of fields associated with tasks related to accepting an engagement invitation.

* @public */ export interface ListEngagementByAcceptingInvitationTaskSummary { @@ -2359,18 +2046,13 @@ export interface ListEngagementByAcceptingInvitationTaskSummary { */ export interface ListEngagementByAcceptingInvitationTasksResponse { /** - *

An array of EngagementByAcceptingInvitationTaskSummary objects, each - * representing a task that matches the specified filters. The array may be empty if no - * tasks match the criteria.

+ *

An array of EngagementByAcceptingInvitationTaskSummary objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.

* @public */ TaskSummaries?: ListEngagementByAcceptingInvitationTaskSummary[] | undefined; /** - *

A token used for pagination to retrieve the next page of results.If there are more - * results available, this field will contain a token that can be used in a subsequent API - * call to retrieve the next page. If there are no more results, this field will be null or - * an empty string.

+ *

A token used for pagination to retrieve the next page of results.If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.

* @public */ NextToken?: string | undefined; @@ -2399,30 +2081,25 @@ export interface Tag { */ export interface StartEngagementByAcceptingInvitationTaskRequest { /** - *

Specifies the catalog related to the task. Use AWS for production - * engagements and Sandbox for testing scenarios.

+ *

Specifies the catalog related to the task. Use AWS for production engagements and Sandbox for testing scenarios.

* @public */ Catalog: string | undefined; /** - *

A unique, case-sensitive identifier provided by the client that helps to ensure the - * idempotency of the request. This can be a random or meaningful string but must be unique - * for each request.

+ *

A unique, case-sensitive identifier provided by the client that helps to ensure the idempotency of the request. This can be a random or meaningful string but must be unique for each request.

* @public */ ClientToken?: string | undefined; /** - *

Specifies the unique identifier of the EngagementInvitation to be - * accepted. Providing the correct identifier helps ensure that the correct engagement is - * processed.

+ *

Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.

* @public */ Identifier: string | undefined; /** - * A list of objects specifying each tag name and value. + *

A map of the key-value pairs of the tag or tags to assign.

* @public */ Tags?: Tag[] | undefined; @@ -2439,15 +2116,13 @@ export interface StartEngagementByAcceptingInvitationTaskResponse { TaskId?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the task, used for tracking and managing the task - * within AWS.

+ *

The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.

* @public */ TaskArn?: string | undefined; /** - *

The timestamp indicating when the task was initiated. The format follows RFC 3339 - * section 5.6.

+ *

The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.

* @public */ StartTime?: Date | undefined; @@ -2459,8 +2134,7 @@ export interface StartEngagementByAcceptingInvitationTaskResponse { TaskStatus?: TaskStatus | undefined; /** - *

If the task fails, this field contains a detailed message describing the failure and - * possible recovery steps.

+ *

If the task fails, this field contains a detailed message describing the failure and possible recovery steps.

* @public */ Message?: string | undefined; @@ -2472,8 +2146,7 @@ export interface StartEngagementByAcceptingInvitationTaskResponse { ReasonCode?: ReasonCode | undefined; /** - *

Returns the original opportunity identifier passed in the request. This is the unique - * identifier for the opportunity.

+ *

Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.

* @public */ OpportunityId?: string | undefined; @@ -2485,8 +2158,7 @@ export interface StartEngagementByAcceptingInvitationTaskResponse { ResourceSnapshotJobId?: string | undefined; /** - *

Returns the identifier of the engagement invitation that was accepted and used to - * create the opportunity.

+ *

Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.

* @public */ EngagementInvitationId?: string | undefined; @@ -2497,53 +2169,37 @@ export interface StartEngagementByAcceptingInvitationTaskResponse { */ export interface ListEngagementFromOpportunityTasksRequest { /** - *

Specifies the maximum number of results to return in a single page of the - * response.Use this parameter to control the number of items returned in each request, - * which can be useful for performance tuning and managing large result sets.

+ *

Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

* @public */ MaxResults?: number | undefined; /** - *

The token for requesting the next page of results. This value is obtained from the - * NextToken field in the response of a previous call to this API. Use this parameter for - * pagination when the result set spans multiple pages.

+ *

The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.

* @public */ NextToken?: string | undefined; /** - *

Specifies the sorting criteria for the returned results. This allows you to order the - * tasks based on specific attributes.

+ *

Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.

* @public */ Sort?: ListTasksSortBase | undefined; /** - *

Specifies the catalog related to the request. Valid values are:

- * + *

Specifies the catalog related to the request. Valid values are:

* @public */ Catalog: string | undefined; /** - *

Filters the tasks based on their current status. This allows you to focus on tasks in - * specific states.

+ *

Filters the tasks based on their current status. This allows you to focus on tasks in specific states.

* @public */ TaskStatus?: TaskStatus[] | undefined; /** - *

Filters tasks by their unique identifiers. Use this when you want to retrieve - * information about specific tasks.

+ *

Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.

* @public */ TaskIdentifier?: string[] | undefined; @@ -2555,17 +2211,14 @@ export interface ListEngagementFromOpportunityTasksRequest { OpportunityIdentifier?: string[] | undefined; /** - *

Filters tasks by the identifiers of the engagements they created or are associated - * with.

+ *

Filters tasks by the identifiers of the engagements they created or are associated with.

* @public */ EngagementIdentifier?: string[] | undefined; } /** - *

Provides a summary of a task related to creating an engagement from an opportunity. - * This structure contains key information about the task's status, associated identifiers, - * and any failure details.

+ *

Provides a summary of a task related to creating an engagement from an opportunity. This structure contains key information about the task's status, associated identifiers, and any failure details.

* @public */ export interface ListEngagementFromOpportunityTaskSummary { @@ -2576,15 +2229,13 @@ export interface ListEngagementFromOpportunityTaskSummary { TaskId?: string | undefined; /** - *

The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN - * can be used for referencing the task in other AWS services or APIs.

+ *

The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.

* @public */ TaskArn?: string | undefined; /** - *

The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time - * format.

+ *

The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.

* @public */ StartTime?: Date | undefined; @@ -2596,38 +2247,31 @@ export interface ListEngagementFromOpportunityTaskSummary { TaskStatus?: TaskStatus | undefined; /** - *

A detailed message providing additional information about the task, especially useful - * in case of failures. This field may contain error details or other relevant information - * about the task's execution

+ *

A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution

* @public */ Message?: string | undefined; /** - *

A code indicating the specific reason for a task failure. This field is populated - * when the task status is FAILED and provides a categorized reason for the failure. - *

+ *

A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.

* @public */ ReasonCode?: ReasonCode | undefined; /** - *

The unique identifier of the original Opportunity from which the Engagement is being - * created. This field helps track the source of the Engagement creation task.

+ *

The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.

* @public */ OpportunityId?: string | undefined; /** - *

The identifier of the resource snapshot job associated with this task, if a snapshot - * was created as part of the Engagement creation process.

+ *

The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.

* @public */ ResourceSnapshotJobId?: string | undefined; /** - *

The unique identifier of the engagement created as a result of the task. This field - * is populated when the task is completed successfully.

+ *

The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.

* @public */ EngagementId?: string | undefined; @@ -2644,17 +2288,13 @@ export interface ListEngagementFromOpportunityTaskSummary { */ export interface ListEngagementFromOpportunityTasksResponse { /** - *

TaskSummaries An array of TaskSummary objects containing details about each task. - *

+ *

TaskSummaries An array of TaskSummary objects containing details about each task.

* @public */ TaskSummaries?: ListEngagementFromOpportunityTaskSummary[] | undefined; /** - *

A token used for pagination to retrieve the next page of results. If there are more - * results available, this field will contain a token that can be used in a subsequent API - * call to retrieve the next page. If there are no more results, this field will be null or - * an empty string.

+ *

A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.

* @public */ NextToken?: string | undefined; @@ -2689,24 +2329,18 @@ export const Visibility = { export type Visibility = (typeof Visibility)[keyof typeof Visibility]; /** - *

Indicates the level of AWS involvement in the opportunity. This field helps track AWS - * participation throughout the engagement, such as providing technical support, deal - * assistance, and sales support.

+ *

Indicates the level of AWS involvement in the opportunity. This field helps track AWS participation throughout the engagement, such as providing technical support, deal assistance, and sales support.

* @public */ export interface AwsSubmission { /** - *

Specifies the type of AWS involvement in the opportunity, such as coselling, deal - * support, or technical consultation. This helps categorize the nature of AWS - * participation.

+ *

Specifies the type of AWS involvement in the opportunity, such as coselling, deal support, or technical consultation. This helps categorize the nature of AWS participation.

* @public */ InvolvementType: SalesInvolvementType | undefined; /** - *

Determines who can view AWS involvement in the opportunity. Typically, this field is - * set to Full for most cases, but it may be restricted based on special - * program requirements or confidentiality needs.

+ *

Determines who can view AWS involvement in the opportunity. Typically, this field is set to Full for most cases, but it may be restricted based on special program requirements or confidentiality needs.

* @public */ Visibility?: Visibility | undefined; @@ -2717,37 +2351,31 @@ export interface AwsSubmission { */ export interface StartEngagementFromOpportunityTaskRequest { /** - *

Specifies the catalog in which the engagement is tracked. Acceptable values include - * AWS for production and Sandbox for testing - * environments.

+ *

Specifies the catalog in which the engagement is tracked. Acceptable values include AWS for production and Sandbox for testing environments.

* @public */ Catalog: string | undefined; /** - *

A unique token provided by the client to help ensure the idempotency of the request. - * It helps prevent the same task from being performed multiple times.

+ *

A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.

* @public */ ClientToken?: string | undefined; /** - *

The unique identifier of the opportunity from which the engagement task is to be - * initiated. This helps ensure that the task is applied to the correct opportunity.

+ *

The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.

* @public */ Identifier: string | undefined; /** - *

Indicates the level of AWS involvement in the opportunity. This field helps track AWS - * participation throughout the engagement, such as providing technical support, deal - * assistance, and sales support.

+ *

Indicates the level of AWS involvement in the opportunity. This field helps track AWS participation throughout the engagement, such as providing technical support, deal assistance, and sales support.

* @public */ AwsSubmission: AwsSubmission | undefined; /** - * A list of objects specifying each tag name and value. + *

A map of the key-value pairs of the tag or tags to assign.

* @public */ Tags?: Tag[] | undefined; @@ -2758,36 +2386,31 @@ export interface StartEngagementFromOpportunityTaskRequest { */ export interface StartEngagementFromOpportunityTaskResponse { /** - *

The unique identifier of the task, used to track the task’s progress. This value - * follows a specific pattern: ^oit-[0-9a-z]\{13\}$.

+ *

The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]\{13\}$.

* @public */ TaskId?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the task, used for tracking and managing the task - * within AWS.

+ *

The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.

* @public */ TaskArn?: string | undefined; /** - *

The timestamp indicating when the task was initiated. The format follows RFC 3339 - * section 5.6.

+ *

The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.

* @public */ StartTime?: Date | undefined; /** - *

Indicates the current status of the task. Valid values include - * IN_PROGRESS, COMPLETE, and FAILED.

+ *

Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.

* @public */ TaskStatus?: TaskStatus | undefined; /** - *

If the task fails, this field contains a detailed message describing the failure and - * possible recovery steps.

+ *

If the task fails, this field contains a detailed message describing the failure and possible recovery steps.

* @public */ Message?: string | undefined; @@ -2799,64 +2422,55 @@ export interface StartEngagementFromOpportunityTaskResponse { ReasonCode?: ReasonCode | undefined; /** - *

Returns the original opportunity identifier passed in the request, which is the unique - * identifier for the opportunity created in the partner’s system.

+ *

Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.

* @public */ OpportunityId?: string | undefined; /** - *

The identifier of the resource snapshot job created to add the opportunity resource - * snapshot to the Engagement. Only populated if TaskStatus is COMPLETE

+ *

The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE

* @public */ ResourceSnapshotJobId?: string | undefined; /** - *

The identifier of the newly created Engagement. Only populated if TaskStatus is - * COMPLETE.

+ *

The identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.

* @public */ EngagementId?: string | undefined; /** - *

The identifier of the new Engagement invitation. Only populated if TaskStatus is - * COMPLETE.

+ *

The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.

* @public */ EngagementInvitationId?: string | undefined; } /** - *

Contains details about the project associated with the Engagement Invitation, - * including the business problem and expected outcomes.

+ *

Contains details about the project associated with the Engagement Invitation, including the business problem and expected outcomes.

* @public */ export interface ProjectDetails { /** - *

Describes the business problem that the project aims to solve. This information is - * crucial for understanding the project’s goals and objectives.

+ *

Describes the business problem that the project aims to solve. This information is crucial for understanding the project’s goals and objectives.

* @public */ BusinessProblem: string | undefined; /** - *

Specifies the title of the project. This title helps partners quickly identify and - * understand the focus of the project.

+ *

Specifies the title of the project. This title helps partners quickly identify and understand the focus of the project.

* @public */ Title: string | undefined; /** - *

Specifies the estimated date of project completion. This field helps track the project - * timeline and manage expectations.

+ *

Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations.

* @public */ TargetCompletionDate: string | undefined; /** - *

Contains revenue estimates for the partner related to the project. This field provides - * an idea of the financial potential of the opportunity for the partner.

+ *

Contains revenue estimates for the partner related to the project. This field provides an idea of the financial potential of the opportunity for the partner.

* @public */ ExpectedCustomerSpend: ExpectedCustomerSpend[] | undefined; @@ -2884,87 +2498,73 @@ export const ReceiverResponsibility = { export type ReceiverResponsibility = (typeof ReceiverResponsibility)[keyof typeof ReceiverResponsibility]; /** - *

An object that contains the details of the sender-provided contact person for the - * EngagementInvitation.

+ *

An object that contains the details of the sender-provided contact person for the EngagementInvitation.

* @public */ export interface SenderContact { /** - *

The sender-provided contact's email address associated with the - * EngagementInvitation.

+ *

The sender-provided contact's email address associated with the EngagementInvitation.

* @public */ Email: string | undefined; /** - *

The sender-provided contact's last name associated with the - * EngagementInvitation.

+ *

The sender-provided contact's last name associated with the EngagementInvitation.

* @public */ FirstName?: string | undefined; /** - *

The sender-provided contact's first name associated with the - * EngagementInvitation.

+ *

The sender-provided contact's first name associated with the EngagementInvitation.

* @public */ LastName?: string | undefined; /** - *

The sender-provided contact's title (job title or role) associated with the - * EngagementInvitation.

+ *

The sender-provided contact's title (job title or role) associated with the EngagementInvitation.

* @public */ BusinessTitle?: string | undefined; /** - *

The sender-provided contact's phone number associated with the - * EngagementInvitation.

+ *

The sender-provided contact's phone number associated with the EngagementInvitation.

* @public */ Phone?: string | undefined; } /** - *

Represents the data payload of an Engagement Invitation for a specific opportunity. - * This contains detailed information that partners use to evaluate the engagement.

+ *

Represents the data payload of an Engagement Invitation for a specific opportunity. This contains detailed information that partners use to evaluate the engagement.

* @public */ export interface OpportunityInvitationPayload { /** - *

Represents the contact details of the AWS representatives involved in sending the - * Engagement Invitation. These contacts are opportunity stakeholders.

+ *

Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders.

* @public */ SenderContacts?: SenderContact[] | undefined; /** - *

Outlines the responsibilities or expectations of the receiver in the context of the - * invitation.

+ *

Outlines the responsibilities or expectations of the receiver in the context of the invitation.

* @public */ ReceiverResponsibilities: ReceiverResponsibility[] | undefined; /** - *

Contains information about the customer related to the opportunity in the Engagement - * Invitation. This data helps partners understand the customer’s profile and - * requirements.

+ *

Contains information about the customer related to the opportunity in the Engagement Invitation. This data helps partners understand the customer’s profile and requirements.

* @public */ Customer: EngagementCustomer | undefined; /** - *

Describes the project details associated with the opportunity, including the - * customer’s needs and the scope of work expected to be performed.

+ *

Describes the project details associated with the opportunity, including the customer’s needs and the scope of work expected to be performed.

* @public */ Project: ProjectDetails | undefined; } /** - *

Contains the data payload associated with the Engagement Invitation. This payload - * includes essential details related to the AWS opportunity and is used by partners to - * evaluate whether to accept or reject the engagement.

+ *

Contains the data payload associated with the Engagement Invitation. This payload includes essential details related to the AWS opportunity and is used by partners to evaluate whether to accept or reject the engagement.

* @public */ export type Payload = Payload.OpportunityInvitationMember | Payload.$UnknownMember; @@ -2974,9 +2574,7 @@ export type Payload = Payload.OpportunityInvitationMember | Payload.$UnknownMemb */ export namespace Payload { /** - *

Specifies the details of the opportunity invitation within the Engagement Invitation - * payload. This data helps partners understand the context, scope, and expected - * involvement for the opportunity from AWS.

+ *

Specifies the details of the opportunity invitation within the Engagement Invitation payload. This data helps partners understand the context, scope, and expected involvement for the opportunity from AWS.

* @public */ export interface OpportunityInvitationMember { @@ -3004,9 +2602,7 @@ export namespace Payload { } /** - *

Represents the entity that received the Engagement Invitation, including account and - * company details. This field is essential for tracking the partner who is being invited - * to collaborate.

+ *

Represents the entity that received the Engagement Invitation, including account and company details. This field is essential for tracking the partner who is being invited to collaborate.

* @public */ export type Receiver = Receiver.AccountMember | Receiver.$UnknownMember; @@ -3016,8 +2612,7 @@ export type Receiver = Receiver.AccountMember | Receiver.$UnknownMember; */ export namespace Receiver { /** - *

Specifies the AWS account of the partner who received the Engagement Invitation. This - * field is used to track the invitation recipient within the AWS ecosystem.

+ *

Specifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.

* @public */ export interface AccountMember { @@ -3045,9 +2640,7 @@ export namespace Receiver { } /** - *

The Invitation structure represents an invitation exchanged between partners and AWS. - * It includes a message, receiver information, and a payload providing context for the - * invitation.

+ *

The Invitation structure represents an invitation exchanged between partners and AWS. It includes a message, receiver information, and a payload providing context for the invitation.

* @public */ export interface Invitation { @@ -3058,17 +2651,13 @@ export interface Invitation { Message: string | undefined; /** - *

Represents the entity that received the Engagement Invitation, including account and - * company details. This field is essential for tracking the partner who is being invited - * to collaborate.

+ *

Represents the entity that received the Engagement Invitation, including account and company details. This field is essential for tracking the partner who is being invited to collaborate.

* @public */ Receiver: Receiver | undefined; /** - *

Contains the data payload associated with the Engagement Invitation. This payload - * includes essential details related to the AWS opportunity and is used by partners to - * evaluate whether to accept or reject the engagement.

+ *

Contains the data payload associated with the Engagement Invitation. This payload includes essential details related to the AWS opportunity and is used by partners to evaluate whether to accept or reject the engagement.

* @public */ Payload: Payload | undefined; @@ -3079,34 +2668,25 @@ export interface Invitation { */ export interface CreateEngagementInvitationRequest { /** - *

Specifies the catalog related to the engagement. Accepted values are AWS - * and Sandbox, which determine the environment in which the engagement is - * managed.

+ *

Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.

* @public */ Catalog: string | undefined; /** - *

Specifies a unique, client-generated UUID to ensure that the request is handled - * exactly once. This token helps prevent duplicate invitation creations.

+ *

Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.

* @public */ ClientToken?: string | undefined; /** - *

The unique identifier of the Engagement associated with the invitation. - * This parameter ensures the invitation is created within the correct - * Engagement context.

+ *

The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.

* @public */ EngagementIdentifier: string | undefined; /** - *

The Invitation object all information necessary to initiate an - * engagement invitation to a partner. It contains a personalized message from the sender, - * the invitation's receiver, and a payload. The Payload can be the - * OpportunityInvitation, which includes detailed structures for sender - * contacts, partner responsibilities, customer information, and project details.

+ *

The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details.

* @public */ Invitation: Invitation | undefined; @@ -3123,8 +2703,7 @@ export interface CreateEngagementInvitationResponse { Id: string | undefined; /** - *

The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation. - *

+ *

The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.

* @public */ Arn: string | undefined; @@ -3135,9 +2714,7 @@ export interface CreateEngagementInvitationResponse { */ export interface GetEngagementInvitationRequest { /** - *

Specifies the catalog associated with the request. The field accepts values from the - * predefined set: AWS for live operations or Sandbox for testing - * environments.

+ *

Specifies the catalog associated with the request. The field accepts values from the predefined set: AWS for live operations or Sandbox for testing environments.

* @public */ Catalog: string | undefined; @@ -3150,10 +2727,7 @@ export interface GetEngagementInvitationRequest { } /** - *

The EngagementMemberSummary provides a snapshot of essential information about - * participants in an AWS Partner Central Engagement. This compact data structure - * encapsulates key details of each member, facilitating efficient collaboration and - * management within the Engagement.

+ *

The EngagementMemberSummary provides a snapshot of essential information about participants in an AWS Partner Central Engagement. This compact data structure encapsulates key details of each member, facilitating efficient collaboration and management within the Engagement.

* @public */ export interface EngagementMemberSummary { @@ -3164,8 +2738,7 @@ export interface EngagementMemberSummary { CompanyName?: string | undefined; /** - *

The URL of the member company's website. This offers a way to find more information - * about the member organization and serves as an additional identifier.

+ *

The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier.

* @public */ WebsiteUrl?: string | undefined; @@ -3212,8 +2785,7 @@ export interface GetEngagementInvitationResponse { Arn?: string | undefined; /** - *

The type of payload contained in the engagement invitation, indicating what data or - * context the payload covers.

+ *

The type of payload contained in the engagement invitation, indicating what data or context the payload covers.

* @public */ PayloadType?: EngagementInvitationPayloadType | undefined; @@ -3225,15 +2797,13 @@ export interface GetEngagementInvitationResponse { Id: string | undefined; /** - *

The identifier of the engagement associated with this invitation.This ID links the - * invitation to its corresponding engagement.

+ *

The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.

* @public */ EngagementId?: string | undefined; /** - *

The title of the engagement invitation, summarizing the purpose or objectives of the - * opportunity shared by AWS.

+ *

The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.

* @public */ EngagementTitle?: string | undefined; @@ -3251,15 +2821,13 @@ export interface GetEngagementInvitationResponse { InvitationDate?: Date | undefined; /** - *

Indicates the date on which the engagement invitation will expire if not accepted by - * the partner.

+ *

Indicates the date on which the engagement invitation will expire if not accepted by the partner.

* @public */ ExpirationDate?: Date | undefined; /** - *

Specifies the AWS Account ID of the sender, which identifies the AWS team responsible - * for sharing the engagement invitation.

+ *

Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.

* @public */ SenderAwsAccountId?: string | undefined; @@ -3271,30 +2839,25 @@ export interface GetEngagementInvitationResponse { SenderCompanyName?: string | undefined; /** - *

Information about the partner organization or team that received the engagement - * invitation, including contact details and identifiers.

+ *

Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.

* @public */ Receiver?: Receiver | undefined; /** - *

Indicates the catalog from which the engagement invitation details are retrieved. This - * field helps in identifying the appropriate catalog (e.g., AWS or - * Sandbox) used in the request.

+ *

Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., AWS or Sandbox) used in the request.

* @public */ Catalog: string | undefined; /** - *

If the engagement invitation was rejected, this field specifies the reason provided by - * the partner for the rejection.

+ *

If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.

* @public */ RejectionReason?: string | undefined; /** - *

Details of the engagement invitation payload, including specific data relevant to the - * invitation's contents, such as customer information and opportunity insights.

+ *

Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.

* @public */ Payload?: Payload | undefined; @@ -3312,17 +2875,7 @@ export interface GetEngagementInvitationResponse { EngagementDescription?: string | undefined; /** - *

A list of active members currently part of the Engagement. This array contains a - * maximum of 10 members, each represented by an object with the following - * properties.

- * + *

A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties.

* @public */ ExistingMembers?: EngagementMemberSummary[] | undefined; @@ -3357,21 +2910,18 @@ export type OpportunityEngagementInvitationSortName = (typeof OpportunityEngagementInvitationSortName)[keyof typeof OpportunityEngagementInvitationSortName]; /** - *

Defines sorting options for retrieving Engagement Invitations. Sorting can be done - * based on various criteria like the invitation date or status.

+ *

Defines sorting options for retrieving Engagement Invitations. Sorting can be done based on various criteria like the invitation date or status.

* @public */ export interface OpportunityEngagementInvitationSort { /** - *

Defines the order in which the Engagement Invitations are sorted. The values can be - * ASC (ascending) or DESC (descending).

+ *

Defines the order in which the Engagement Invitations are sorted. The values can be ASC (ascending) or DESC (descending).

* @public */ SortOrder: SortOrder | undefined; /** - *

Specifies the field by which the Engagement Invitations are sorted. Common values - * include InvitationDate and Status.

+ *

Specifies the field by which the Engagement Invitations are sorted. Common values include InvitationDate and Status.

* @public */ SortBy: OpportunityEngagementInvitationSortName | undefined; @@ -3382,47 +2932,37 @@ export interface OpportunityEngagementInvitationSort { */ export interface ListEngagementInvitationsRequest { /** - *

Specifies the catalog from which to list the engagement invitations. Use - * AWS for production invitations or Sandbox for testing - * environments.

+ *

Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.

* @public */ Catalog: string | undefined; /** - *

Specifies the maximum number of engagement invitations to return in the response. If - * more results are available, a pagination token will be provided.

+ *

Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.

* @public */ MaxResults?: number | undefined; /** - *

A pagination token used to retrieve additional pages of results when the response to a - * previous request was truncated. Pass this token to continue listing invitations from - * where the previous call left off.

+ *

A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.

* @public */ NextToken?: string | undefined; /** - *

Specifies the sorting options for listing engagement invitations. Invitations can be - * sorted by fields such as InvitationDate or Status to help - * partners view results in their preferred order.

+ *

Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.

* @public */ Sort?: OpportunityEngagementInvitationSort | undefined; /** - *

Defines the type of payload associated with the engagement invitations to be listed. - * The attributes in this payload help decide on acceptance or rejection of the - * invitation.

+ *

Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.

* @public */ PayloadType?: EngagementInvitationPayloadType[] | undefined; /** - *

Specifies the type of participant for which to list engagement invitations. Identifies - * the role of the participant.

+ *

Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.

* @public */ ParticipantType: ParticipantType | undefined; @@ -3434,11 +2974,7 @@ export interface ListEngagementInvitationsRequest { Status?: InvitationStatus[] | undefined; /** - *

Retrieves a list of engagement invitation summaries based on specified filters. The - * ListEngagementInvitations operation allows you to view all invitations that you have - * sent or received. You must specify the ParticipantType to filter invitations where you - * are either the SENDER or the RECEIVER. Invitations will automatically expire if not - * accepted within 15 days.

+ *

Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.

* @public */ EngagementIdentifier?: string[] | undefined; @@ -3451,102 +2987,78 @@ export interface ListEngagementInvitationsRequest { } /** - *

Provides a summarized view of the Engagement Invitation, including details like the - * identifier, status, and sender. This summary helps partners track and manage AWS - * originated opportunities.

+ *

Provides a summarized view of the Engagement Invitation, including details like the identifier, status, and sender. This summary helps partners track and manage AWS originated opportunities.

* @public */ export interface EngagementInvitationSummary { /** - *

The Amazon Resource Name (ARN) of the Engagement Invitation. The ARN is a unique - * identifier that allows partners to reference the invitation in their system and manage - * its lifecycle.

+ *

The Amazon Resource Name (ARN) of the Engagement Invitation. The ARN is a unique identifier that allows partners to reference the invitation in their system and manage its lifecycle.

* @public */ Arn?: string | undefined; /** - *

Describes the type of payload associated with the Engagement Invitation, such as - * Opportunity or MarketplaceOffer. This helps partners - * understand the nature of the engagement request from AWS.

+ *

Describes the type of payload associated with the Engagement Invitation, such as Opportunity or MarketplaceOffer. This helps partners understand the nature of the engagement request from AWS.

* @public */ PayloadType?: EngagementInvitationPayloadType | undefined; /** - *

Represents the unique identifier of the Engagement Invitation. This identifier is used - * to track the invitation and to manage responses like acceptance or rejection.

+ *

Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection.

* @public */ Id: string | undefined; /** - *

The identifier of the Engagement associated with this invitation. This links the - * invitation to its parent Engagement.

+ *

The identifier of the Engagement associated with this invitation. This links the invitation to its parent Engagement.

* @public */ EngagementId?: string | undefined; /** - *

Provides a short title or description of the Engagement Invitation. This title helps - * partners quickly identify and differentiate between multiple engagement - * opportunities.

+ *

Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities.

* @public */ EngagementTitle?: string | undefined; /** - *

Represents the current status of the Engagement Invitation, such as - * Pending, Accepted, or Rejected. The status - * helps track the progress and response to the invitation.

+ *

Represents the current status of the Engagement Invitation, such as Pending, Accepted, or Rejected. The status helps track the progress and response to the invitation.

* @public */ Status?: InvitationStatus | undefined; /** - *

Indicates the date when the Engagement Invitation was sent to the partner. This - * provides context for when the opportunity was shared and helps in tracking the timeline - * for engagement.

+ *

Indicates the date when the Engagement Invitation was sent to the partner. This provides context for when the opportunity was shared and helps in tracking the timeline for engagement.

* @public */ InvitationDate?: Date | undefined; /** - *

Indicates the date and time when the Engagement Invitation will expire. After this - * date, the invitation can no longer be accepted, and the opportunity will be unavailable - * to the partner.

+ *

Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will be unavailable to the partner.

* @public */ ExpirationDate?: Date | undefined; /** - *

Specifies the AWS account ID of the sender who initiated the Engagement Invitation. - * This allows the partner to identify the AWS entity or representative responsible for - * sharing the opportunity.

+ *

Specifies the AWS account ID of the sender who initiated the Engagement Invitation. This allows the partner to identify the AWS entity or representative responsible for sharing the opportunity.

* @public */ SenderAwsAccountId?: string | undefined; /** - *

Indicates the name of the company or AWS division that sent the Engagement Invitation. - * This information is useful for partners to know which part of AWS is requesting - * engagement.

+ *

Indicates the name of the company or AWS division that sent the Engagement Invitation. This information is useful for partners to know which part of AWS is requesting engagement.

* @public */ SenderCompanyName?: string | undefined; /** - *

Specifies the partner company or individual that received the Engagement Invitation. - * This field is important for tracking who the invitation was sent to within the partner - * organization.

+ *

Specifies the partner company or individual that received the Engagement Invitation. This field is important for tracking who the invitation was sent to within the partner organization.

* @public */ Receiver?: Receiver | undefined; /** - *

Specifies the catalog in which the Engagement Invitation resides. This can be either - * the AWS or Sandbox catalog, indicating whether the opportunity - * is live or being tested.

+ *

Specifies the catalog in which the Engagement Invitation resides. This can be either the AWS or Sandbox catalog, indicating whether the opportunity is live or being tested.

* @public */ Catalog: string | undefined; @@ -3563,17 +3075,13 @@ export interface EngagementInvitationSummary { */ export interface ListEngagementInvitationsResponse { /** - *

An array containing summaries of engagement invitations. Each summary includes - * information such as the invitation title, invitation date, and the current status of the - * invitation.

+ *

An array containing summaries of engagement invitations. Each summary includes information such as the invitation title, invitation date, and the current status of the invitation.

* @public */ EngagementInvitationSummaries?: EngagementInvitationSummary[] | undefined; /** - *

A pagination token returned when there are more results available than can be returned - * in a single call. Use this token to retrieve additional pages of engagement invitation - * summaries.

+ *

A pagination token returned when there are more results available than can be returned in a single call. Use this token to retrieve additional pages of engagement invitation summaries.

* @public */ NextToken?: string | undefined; @@ -3584,62 +3092,58 @@ export interface ListEngagementInvitationsResponse { */ export interface RejectEngagementInvitationRequest { /** - *

This is the catalog that's associated with the engagement invitation. Acceptable - * values are AWS or Sandbox, and these values determine the - * environment in which the opportunity is managed.

+ *

This is the catalog that's associated with the engagement invitation. Acceptable values are AWS or Sandbox, and these values determine the environment in which the opportunity is managed.

* @public */ Catalog: string | undefined; /** - *

This is the unique identifier of the rejected EngagementInvitation. - * Providing the correct identifier helps to ensure that the intended invitation is - * rejected.

+ *

This is the unique identifier of the rejected EngagementInvitation. Providing the correct identifier helps to ensure that the intended invitation is rejected.

* @public */ Identifier: string | undefined; /** - *

This describes the reason for rejecting the engagement invitation, which helps AWS - * track usage patterns. Acceptable values include the following:

- * + *

This describes the reason for rejecting the engagement invitation, which helps AWS track usage patterns. Acceptable values include the following:

* @public */ RejectionReason?: string | undefined; } +/** + * @public + */ +export interface GetSellingSystemSettingsRequest { + /** + *

Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.

+ * @public + */ + Catalog: string | undefined; +} + +/** + * @public + */ +export interface GetSellingSystemSettingsResponse { + /** + *

Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.

+ * @public + */ + Catalog: string | undefined; + + /** + *

Specifies the ARN of the IAM Role used for resource snapshot job executions.

+ * @public + */ + ResourceSnapshotJobRoleArn?: string | undefined; +} + /** * @public */ export interface ListTagsForResourceRequest { /** - *

The Amazon Resource Name (ARN) of the resource for which you want to retrieve - * tags.

+ *

The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.

* @public */ ResourceArn: string | undefined; @@ -3657,8 +3161,7 @@ export interface ListTagsForResourceResponse { } /** - *

An object that contains the customer's Account and - * Contact.

+ *

An object that contains the customer's Account and Contact.

* @public */ export interface Customer { @@ -3669,10 +3172,7 @@ export interface Customer { Account?: Account | undefined; /** - *

Represents the contact details for individuals associated with the customer of the - * Opportunity. This field captures relevant contacts, including - * decision-makers, influencers, and technical stakeholders within the customer - * organization. These contacts are key to progressing the opportunity.

+ *

Represents the contact details for individuals associated with the customer of the Opportunity. This field captures relevant contacts, including decision-makers, influencers, and technical stakeholders within the customer organization. These contacts are key to progressing the opportunity.

* @public */ Contacts?: Contact[] | undefined; @@ -3710,8 +3210,7 @@ export const ClosedLostReason = { export type ClosedLostReason = (typeof ClosedLostReason)[keyof typeof ClosedLostReason]; /** - *

Read-only; shows the last 50 values and change dates for the NextSteps - * field.

+ *

Read-only; shows the last 50 values and change dates for the NextSteps field.

* @public */ export interface NextStepsHistory { @@ -3771,232 +3270,49 @@ export type Stage = (typeof Stage)[keyof typeof Stage]; */ export interface LifeCycle { /** - *

Specifies the current stage of the Opportunity's lifecycle as it maps to - * Amazon Web Services stages from the current stage in the partner CRM. This field - * provides a translated value of the stage, and offers insight into the - * Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

- * - *

A lead and a prospect must be further matured to a Qualified - * opportunity before submission. Opportunities that were closed/lost before submission - * aren't suitable for submission.

- * - *

The descriptions of each sales stage are:

- * + *

Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.

The descriptions of each sales stage are:

* @public */ Stage?: Stage | undefined; /** - *

Specifies the reason code when an opportunity is marked as Closed - * Lost. When you select an appropriate reason code, you communicate the - * context for closing the Opportunity, and aid in accurate reports and - * analysis of opportunity outcomes. The possible values are:

- * + *

Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes. The possible values are:

* @public */ ClosedLostReason?: ClosedLostReason | undefined; /** - *

Specifies the upcoming actions or tasks for the Opportunity. Use this - * field to communicate with Amazon Web Services about the next actions required for the - * Opportunity.

+ *

Specifies the upcoming actions or tasks for the Opportunity. Use this field to communicate with Amazon Web Services about the next actions required for the Opportunity.

* @public */ NextSteps?: string | undefined; /** - *

Specifies the date when Amazon Web Services expects to start significant billing, when - * the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

- *

Ensure the Target Close Date isn't in the past.

+ *

Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

Ensure the Target Close Date isn't in the past.

* @public */ TargetCloseDate?: string | undefined; /** - *

Indicates the review status of an opportunity referred by a partner. This field is - * read-only and only applicable for partner referrals. The possible values are:

- * + *

Indicates the review status of an opportunity referred by a partner. This field is read-only and only applicable for partner referrals. The possible values are:

* @public */ ReviewStatus?: ReviewStatus | undefined; /** - *

Indicates why an opportunity was sent back for further details. Partners must take - * corrective action based on the ReviewComments.

+ *

Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.

* @public */ ReviewComments?: string | undefined; /** - *

Indicates the reason a decision was made during the opportunity review process. This - * field combines the reasons for both disqualified and action required statuses, and - * provide clarity for why an opportunity was disqualified or requires further - * action.

+ *

Indicates the reason a decision was made during the opportunity review process. This field combines the reasons for both disqualified and action required statuses, and provide clarity for why an opportunity was disqualified or requires further action.

* @public */ ReviewStatusReason?: string | undefined; /** - *

Captures a chronological record of the next steps or actions planned or taken for the - * current opportunity, along with the timestamp.

+ *

Captures a chronological record of the next steps or actions planned or taken for the current opportunity, along with the timestamp.

* @public */ NextStepsHistory?: NextStepsHistory[] | undefined; @@ -4047,54 +3363,31 @@ export type MarketingSource = (typeof MarketingSource)[keyof typeof MarketingSou */ export interface Marketing { /** - *

Specifies the Opportunity marketing campaign code. The Amazon Web Services - * campaign code is a reference to specific marketing initiatives, promotions, or - * activities. This field captures the identifier used to track and categorize the - * Opportunity within marketing campaigns. If you don't have a campaign - * code, contact your Amazon Web Services point of contact to obtain one.

+ *

Specifies the Opportunity marketing campaign code. The Amazon Web Services campaign code is a reference to specific marketing initiatives, promotions, or activities. This field captures the identifier used to track and categorize the Opportunity within marketing campaigns. If you don't have a campaign code, contact your Amazon Web Services point of contact to obtain one.

* @public */ CampaignName?: string | undefined; /** - *

Indicates if the Opportunity was sourced from an Amazon Web Services - * marketing activity. Use the value Marketing Activity. Use None - * if it's not associated with an Amazon Web Services marketing activity. This field helps - * Amazon Web Services track the return on marketing investments and enables better - * distribution of marketing budgets among partners.

+ *

Indicates if the Opportunity was sourced from an Amazon Web Services marketing activity. Use the value Marketing Activity. Use None if it's not associated with an Amazon Web Services marketing activity. This field helps Amazon Web Services track the return on marketing investments and enables better distribution of marketing budgets among partners.

* @public */ Source?: MarketingSource | undefined; /** - *

Specifies the marketing activity use case or purpose that led to the - * Opportunity's creation or contact. This field captures the context or - * marketing activity's execution's intention and the direct correlation to the generated - * opportunity or contact. Must be empty when Marketing.AWSFundingUsed = - * No.

- *

Valid values: AI/ML | Analytics | Application Integration | Blockchain | - * Business Applications | Cloud Financial Management | Compute | Containers | Customer - * Engagement | Databases | Developer Tools | End User Computing | Front End Web & - * Mobile | Game Tech | IoT | Management & Governance | Media Services | Migration - * & Transfer | Networking & Content Delivery | Quantum Technologies | Robotics - * | Satellite | Security | Serverless | Storage | VR & AR - *

+ *

Specifies the marketing activity use case or purpose that led to the Opportunity's creation or contact. This field captures the context or marketing activity's execution's intention and the direct correlation to the generated opportunity or contact. Must be empty when Marketing.AWSFundingUsed = No.

Valid values: AI/ML | Analytics | Application Integration | Blockchain | Business Applications | Cloud Financial Management | Compute | Containers | Customer Engagement | Databases | Developer Tools | End User Computing | Front End Web & Mobile | Game Tech | IoT | Management & Governance | Media Services | Migration & Transfer | Networking & Content Delivery | Quantum Technologies | Robotics | Satellite | Security | Serverless | Storage | VR & AR

* @public */ UseCases?: string[] | undefined; /** - *

Specifies the Opportunity's channel that the marketing activity is - * associated with or was contacted through. This field provides information about the - * specific marketing channel that contributed to the generation of the lead or - * contact.

+ *

Specifies the Opportunity's channel that the marketing activity is associated with or was contacted through. This field provides information about the specific marketing channel that contributed to the generation of the lead or contact.

* @public */ Channels?: Channel[] | undefined; /** - *

Indicates if the Opportunity is a marketing development fund (MDF) funded - * activity.

+ *

Indicates if the Opportunity is a marketing development fund (MDF) funded activity.

* @public */ AwsFundingUsed?: AwsFundingUsed | undefined; @@ -4230,44 +3523,13 @@ export type SalesActivity = (typeof SalesActivity)[keyof typeof SalesActivity]; */ export interface Project { /** - *

Specifies the deployment or consumption model for your solution or service in the - * Opportunity's context. You can select multiple options.

- *

Options' descriptions from the Delivery Model field are:

- * + *

Specifies the deployment or consumption model for your solution or service in the Opportunity's context. You can select multiple options.

Options' descriptions from the Delivery Model field are:

* @public */ DeliveryModels?: DeliveryModel[] | undefined; /** - *

Represents the estimated amount that the customer is expected to spend on AWS services - * related to the opportunity. This helps in evaluating the potential financial value of - * the opportunity for AWS.

+ *

Represents the estimated amount that the customer is expected to spend on AWS services related to the opportunity. This helps in evaluating the potential financial value of the opportunity for AWS.

* @public */ ExpectedCustomerSpend?: ExpectedCustomerSpend[] | undefined; @@ -4279,54 +3541,19 @@ export interface Project { Title?: string | undefined; /** - *

Specifies the Amazon Partner Network (APN) program that influenced the - * Opportunity. APN programs refer to specific partner programs or - * initiatives that can impact the Opportunity.

- *

Valid values: APN Immersion Days | APN Solution Space | ATO (Authority to - * Operate) | AWS Marketplace Campaign | IS Immersion Day SFID Program | ISV Workload - * Migration | Migration Acceleration Program | P3 | Partner Launch Initiative | - * Partner Opportunity Acceleration Funded | The Next Smart | VMware Cloud on AWS | - * Well-Architected | Windows | Workspaces/AppStream Accelerator Program | WWPS - * NDPP - *

+ *

Specifies the Amazon Partner Network (APN) program that influenced the Opportunity. APN programs refer to specific partner programs or initiatives that can impact the Opportunity.

Valid values: APN Immersion Days | APN Solution Space | ATO (Authority to Operate) | AWS Marketplace Campaign | IS Immersion Day SFID Program | ISV Workload Migration | Migration Acceleration Program | P3 | Partner Launch Initiative | Partner Opportunity Acceleration Funded | The Next Smart | VMware Cloud on AWS | Well-Architected | Windows | Workspaces/AppStream Accelerator Program | WWPS NDPP

* @public */ ApnPrograms?: string[] | undefined; /** - *

Describes the problem the end customer has, and how the partner is helping. Utilize - * this field to provide a concise narrative that outlines the customer's business - * challenge or issue. Elaborate on how the partner's solution or offerings align to - * resolve the customer's business problem. Include relevant information about the - * partner's value proposition, unique selling points, and expertise to tackle the issue. - * Offer insights on how the proposed solution meets the customer's needs and provides - * value. Use concise language and precise descriptions to convey the context and - * significance of the Opportunity. The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic - * fit of the partner's solution.

+ *

Describes the problem the end customer has, and how the partner is helping. Utilize this field to provide a concise narrative that outlines the customer's business challenge or issue. Elaborate on how the partner's solution or offerings align to resolve the customer's business problem. Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue. Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise language and precise descriptions to convey the context and significance of the Opportunity. The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic fit of the partner's solution.

* @public */ CustomerBusinessProblem?: string | undefined; /** - *

Specifies the proposed solution focus or type of workload for the Opportunity. This - * field captures the primary use case or objective of the proposed solution, and provides - * context and clarity to the addressed workload.

- *

Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data - * Warehouse/Data Integration/ETL/Data Lake/BI | Blockchain | Business Applications: - * Mainframe Modernization | Business Applications & Contact Center | Business - * Applications & SAP Production | Centralized Operations Management | Cloud - * Management Tools | Cloud Management Tools & DevOps with Continuous Integration - * & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | - * Connected Services | Containers & Serverless | Content Delivery & Edge - * Services | Database | Edge Computing/End User Computing | Energy | Enterprise - * Governance & Controls | Enterprise Resource Planning | Financial Services | - * Healthcare and Life Sciences | High Performance Computing | Hybrid Application - * Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | - * Media & High performance computing (HPC) | Migration/Database Migration | - * Monitoring, logging and performance | Monitoring & Observability | Networking | - * Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | - * VMWare | Web development & DevOps - *

+ *

Specifies the proposed solution focus or type of workload for the Opportunity. This field captures the primary use case or objective of the proposed solution, and provides context and clarity to the addressed workload.

Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse/Data Integration/ETL/Data Lake/BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing/End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration/Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps

* @public */ CustomerUseCase?: string | undefined; @@ -4338,50 +3565,13 @@ export interface Project { RelatedOpportunityIdentifier?: string | undefined; /** - *

Specifies the Opportunity's sales activities conducted with the end - * customer. These activities help drive Amazon Web Services assignment priority.

- *

Valid values:

- * + *

Specifies the Opportunity's sales activities conducted with the end customer. These activities help drive Amazon Web Services assignment priority.

Valid values:

* @public */ SalesActivities?: SalesActivity[] | undefined; /** - *

Name of the Opportunity's competitor (if any). Use Other to - * submit a value not in the picklist.

+ *

Name of the Opportunity's competitor (if any). Use Other to submit a value not in the picklist.

* @public */ CompetitorName?: CompetitorName | undefined; @@ -4393,15 +3583,13 @@ export interface Project { OtherCompetitorNames?: string | undefined; /** - *

Specifies the offered solution for the customer's business problem when the - * RelatedEntityIdentifiers.Solutions field value is Other.

+ *

Specifies the offered solution for the customer's business problem when the RelatedEntityIdentifiers.Solutions field value is Other.

* @public */ OtherSolutionDescription?: string | undefined; /** - *

Captures additional comments or information for the Opportunity that - * weren't captured in other fields.

+ *

Captures additional comments or information for the Opportunity that weren't captured in other fields.

* @public */ AdditionalComments?: string | undefined; @@ -4441,14 +3629,12 @@ export interface MonetaryValue { } /** - *

Specifies a customer's procurement terms details. Required only for partners in - * eligible programs.

+ *

Specifies a customer's procurement terms details. Required only for partners in eligible programs.

* @public */ export interface SoftwareRevenue { /** - *

Specifies the customer's intended payment type agreement or procurement method to - * acquire the solution or service outlined in the Opportunity.

+ *

Specifies the customer's intended payment type agreement or procurement method to acquire the solution or service outlined in the Opportunity.

* @public */ DeliveryModel?: RevenueModel | undefined; @@ -4460,15 +3646,13 @@ export interface SoftwareRevenue { Value?: MonetaryValue | undefined; /** - *

Specifies the Opportunity's customer engagement start date for the - * contract's effectiveness.

+ *

Specifies the Opportunity's customer engagement start date for the contract's effectiveness.

* @public */ EffectiveDate?: string | undefined; /** - *

Specifies the expiration date for the contract between the customer and Amazon Web Services partner. It signifies the termination date of the agreed-upon engagement - * period between both parties.

+ *

Specifies the expiration date for the contract between the customer and Amazon Web Services partner. It signifies the termination date of the agreed-upon engagement period between both parties.

* @public */ ExpirationDate?: string | undefined; @@ -4479,77 +3663,25 @@ export interface SoftwareRevenue { */ export interface CreateOpportunityRequest { /** - *

Specifies the catalog associated with the request. This field takes a string value - * from a predefined list: AWS or Sandbox. The catalog determines - * which environment the opportunity is created in. Use AWS to create - * opportunities in the Amazon Web Services catalog, and Sandbox for testing in - * secure, isolated environments.

+ *

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is created in. Use AWS to create opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

* @public */ Catalog: string | undefined; /** - *

Identifies the type of support the partner needs from Amazon Web Services.

- *

Valid values:

- * + *

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

* @public */ PrimaryNeedsFromAws?: PrimaryNeedFromAws[] | undefined; /** - *

Indicates whether the Opportunity pertains to a national security - * project. This field must be set to true only when the customer's industry - * is Government. Additional privacy and security measures apply - * during the review and management process for opportunities marked as - * NationalSecurity.

+ *

Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.

* @public */ NationalSecurity?: NationalSecurity | undefined; /** - *

Specifies the opportunity's unique identifier in the partner's CRM system. This value - * is essential to track and reconcile because it's included in the outbound payload to the - * partner.

- *

This field allows partners to link an opportunity to their CRM, which helps to ensure - * seamless integration and accurate synchronization between the Partner Central API and - * the partner's internal systems.

+ *

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload to the partner.

This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems.

* @public */ PartnerOpportunityIdentifier?: string | undefined; @@ -4567,23 +3699,7 @@ export interface CreateOpportunityRequest { Project?: Project | undefined; /** - *

Specifies the opportunity type as a renewal, new, or expansion.

- *

Opportunity types:

- * + *

Specifies the opportunity type as a renewal, new, or expansion.

Opportunity types:

* @public */ OpportunityType?: OpportunityType | undefined; @@ -4595,21 +3711,13 @@ export interface CreateOpportunityRequest { Marketing?: Marketing | undefined; /** - *

Specifies details of a customer's procurement terms. This is required only for - * partners in eligible programs.

+ *

Specifies details of a customer's procurement terms. This is required only for partners in eligible programs.

* @public */ SoftwareRevenue?: SoftwareRevenue | undefined; /** - *

Required to be unique, and should be unchanging, it can be randomly generated or a - * meaningful string.

- *

Default: None

- *

Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique - * Identifier (UUID) as the ClientToken. You can use standard libraries from - * most programming languages to generate this. If you use the same client token, the API - * returns the following error: "Conflicting client token submitted for a new request - * body."

+ *

Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.

Default: None

Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the ClientToken. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: "Conflicting client token submitted for a new request body."

* @public */ ClientToken?: string | undefined; @@ -4621,17 +3729,13 @@ export interface CreateOpportunityRequest { LifeCycle?: LifeCycle | undefined; /** - *

Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog: - * AWS, this field must only be Partner Referral. However, when - * using Catalog: Sandbox, you can set this field to AWS Referral - * to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.

+ *

Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog: AWS, this field must only be Partner Referral. However, when using Catalog: Sandbox, you can set this field to AWS Referral to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.

* @public */ Origin?: OpportunityOrigin | undefined; /** - *

Represents the internal team handling the opportunity. Specify collaborating members - * of this opportunity who are within the partner's organization.

+ *

Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.

* @public */ OpportunityTeam?: Contact[] | undefined; @@ -4642,25 +3746,19 @@ export interface CreateOpportunityRequest { */ export interface CreateOpportunityResponse { /** - *

Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's used for all subsequent opportunity - * actions, such as updates, associations, and submissions. It helps to ensure that each - * opportunity is accurately tracked and managed.

+ *

Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's used for all subsequent opportunity actions, such as updates, associations, and submissions. It helps to ensure that each opportunity is accurately tracked and managed.

* @public */ Id: string | undefined; /** - *

Specifies the opportunity's unique identifier in the partner's CRM system. This value - * is essential to track and reconcile because it's included in the outbound payload sent - * back to the partner.

+ *

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

* @public */ PartnerOpportunityIdentifier?: string | undefined; /** - *

- * DateTime when the opportunity was last modified. When the - * Opportunity is created, its value is CreatedDate.

+ *

DateTime when the opportunity was last modified. When the Opportunity is created, its value is CreatedDate.

* @public */ LastModifiedDate?: Date | undefined; @@ -4671,48 +3769,25 @@ export interface CreateOpportunityResponse { */ export interface DisassociateOpportunityRequest { /** - *

Specifies the catalog associated with the request. This field takes a string value - * from a predefined list: AWS or Sandbox. The catalog determines - * which environment the opportunity disassociation is made in. Use AWS to - * disassociate opportunities in the Amazon Web Services catalog, and Sandbox - * for testing in secure, isolated environments.

+ *

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity disassociation is made in. Use AWS to disassociate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

* @public */ Catalog: string | undefined; /** - *

The opportunity's unique identifier for when you want to disassociate it from related - * entities. This identifier helps to ensure that the correct opportunity is - * updated.

- *

Validation: Ensure that the provided identifier corresponds to an existing opportunity - * in the Amazon Web Services system because incorrect identifiers result in an error and no - * changes are made.

+ *

The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier helps to ensure that the correct opportunity is updated.

Validation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because incorrect identifiers result in an error and no changes are made.

* @public */ OpportunityIdentifier: string | undefined; /** - *

The type of the entity that you're disassociating from the opportunity. When you - * specify the entity type, it helps the system correctly process the disassociation - * request to ensure that the right connections are removed.

- *

Examples of entity types include Partner Solution, Amazon Web Services product, and - * Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity - * types.

- *

Validation: Provide a valid entity type to help ensure successful disassociation. An - * invalid or incorrect entity type results in an error.

+ *

The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps the system correctly process the disassociation request to ensure that the right connections are removed.

Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.

Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.

* @public */ RelatedEntityType: RelatedEntityType | undefined; /** - *

The related entity's identifier that you want to disassociate from the opportunity. - * Depending on the type of entity, this could be a simple identifier or an Amazon Resource - * Name (ARN) for entities managed through Amazon Web Services Marketplace.

- *

For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the - * necessary ARNs. For guidance on retrieving these ARNs, see - * Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.

- *

Validation: Ensure the identifier or ARN is valid and corresponds to an existing - * entity. An incorrect or invalid identifier results in an error.

+ *

The related entity's identifier that you want to disassociate from the opportunity. Depending on the type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed through Amazon Web Services Marketplace.

For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, see Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.

Validation: Ensure the identifier or ARN is valid and corresponds to an existing entity. An incorrect or invalid identifier results in an error.

* @public */ RelatedEntityIdentifier: string | undefined; @@ -4723,17 +3798,13 @@ export interface DisassociateOpportunityRequest { */ export interface GetAwsOpportunitySummaryRequest { /** - *

Specifies the catalog in which the AWS Opportunity is located. Accepted values include - * AWS for production opportunities or Sandbox for testing - * purposes. The catalog determines which environment the opportunity data is pulled - * from.

+ *

Specifies the catalog in which the AWS Opportunity is located. Accepted values include AWS for production opportunities or Sandbox for testing purposes. The catalog determines which environment the opportunity data is pulled from.

* @public */ Catalog: string | undefined; /** - *

The unique identifier for the related partner opportunity. Use this field to correlate - * an AWS opportunity with its corresponding partner opportunity.

+ *

The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity.

* @public */ RelatedOpportunityIdentifier: string | undefined; @@ -4762,96 +3833,73 @@ export type InvolvementTypeChangeReason = */ export interface GetAwsOpportunitySummaryResponse { /** - *

Specifies the catalog in which the AWS Opportunity exists. This is the environment - * (e.g., AWS or Sandbox) where the opportunity is being - * managed.

+ *

Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., AWS or Sandbox) where the opportunity is being managed.

* @public */ Catalog: string | undefined; /** - *

Provides the unique identifier of the related partner opportunity, allowing partners - * to link the AWS Opportunity to their corresponding opportunity in their CRM - * system.

+ *

Provides the unique identifier of the related partner opportunity, allowing partners to link the AWS Opportunity to their corresponding opportunity in their CRM system.

* @public */ RelatedOpportunityId?: string | undefined; /** - *

Specifies whether the AWS Opportunity originated from AWS or the partner. This helps - * distinguish between opportunities that were sourced by AWS and those referred by the - * partner.

+ *

Specifies whether the AWS Opportunity originated from AWS or the partner. This helps distinguish between opportunities that were sourced by AWS and those referred by the partner.

* @public */ Origin?: OpportunityOrigin | undefined; /** - *

Specifies the type of involvement AWS has in the opportunity, such as direct cosell or - * advisory support. This field helps partners understand the role AWS plays in advancing - * the opportunity.

+ *

Specifies the type of involvement AWS has in the opportunity, such as direct cosell or advisory support. This field helps partners understand the role AWS plays in advancing the opportunity.

* @public */ InvolvementType?: SalesInvolvementType | undefined; /** - *

Defines the visibility level for the AWS Opportunity. Use Full visibility - * for most cases, while Limited visibility is reserved for special programs - * or sensitive opportunities.

+ *

Defines the visibility level for the AWS Opportunity. Use Full visibility for most cases, while Limited visibility is reserved for special programs or sensitive opportunities.

* @public */ Visibility?: Visibility | undefined; /** - *

Contains lifecycle information for the AWS Opportunity, including review status, - * stage, and target close date. This field is crucial for partners to monitor the - * progression of the opportunity.

+ *

Contains lifecycle information for the AWS Opportunity, including review status, stage, and target close date. This field is crucial for partners to monitor the progression of the opportunity.

* @public */ LifeCycle?: AwsOpportunityLifeCycle | undefined; /** - *

Details the AWS opportunity team, including members involved. This information helps - * partners know who from AWS is engaged and what their role is.

+ *

Details the AWS opportunity team, including members involved. This information helps partners know who from AWS is engaged and what their role is.

* @public */ OpportunityTeam?: AwsTeamMember[] | undefined; /** - *

Provides insights into the AWS Opportunity, including engagement score and recommended - * actions that AWS suggests for the partner.

+ *

Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests for the partner.

* @public */ Insights?: AwsOpportunityInsights | undefined; /** - *

Provides a reason for any changes in the involvement type of AWS in the opportunity. - * This field is used to track why the level of AWS engagement has changed from For - * Visibility Only to Co-sell offering transparency into the - * partnership dynamics.

+ *

Provides a reason for any changes in the involvement type of AWS in the opportunity. This field is used to track why the level of AWS engagement has changed from For Visibility Only to Co-sell offering transparency into the partnership dynamics.

* @public */ InvolvementTypeChangeReason?: InvolvementTypeChangeReason | undefined; /** - *

Lists related entity identifiers, such as AWS products or partner solutions, - * associated with the AWS Opportunity. These identifiers provide additional context and - * help partners understand which AWS services are involved.

+ *

Lists related entity identifiers, such as AWS products or partner solutions, associated with the AWS Opportunity. These identifiers provide additional context and help partners understand which AWS services are involved.

* @public */ RelatedEntityIds?: AwsOpportunityRelatedEntities | undefined; /** - *

Provides details about the customer associated with the AWS Opportunity, including - * account information, industry, and other customer data. These details help partners - * understand the business context of the opportunity.

+ *

Provides details about the customer associated with the AWS Opportunity, including account information, industry, and other customer data. These details help partners understand the business context of the opportunity.

* @public */ Customer?: AwsOpportunityCustomer | undefined; /** - *

Provides details about the project associated with the AWS Opportunity, including the - * customer’s business problem, expected outcomes, and project scope. This information is - * crucial for understanding the broader context of the opportunity.

+ *

Provides details about the project associated with the AWS Opportunity, including the customer’s business problem, expected outcomes, and project scope. This information is crucial for understanding the broader context of the opportunity.

* @public */ Project?: AwsOpportunityProject | undefined; @@ -4862,11 +3910,7 @@ export interface GetAwsOpportunitySummaryResponse { */ export interface GetOpportunityRequest { /** - *

Specifies the catalog associated with the request. This field takes a string value - * from a predefined list: AWS or Sandbox. The catalog determines - * which environment the opportunity is fetched from. Use AWS to retrieve - * opportunities in the Amazon Web Services catalog, and Sandbox to retrieve - * opportunities in a secure, isolated testing environment.

+ *

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is fetched from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure, isolated testing environment.

* @public */ Catalog: string | undefined; @@ -4879,46 +3923,24 @@ export interface GetOpportunityRequest { } /** - *

This field provides the associations' information for other entities with the - * opportunity. These entities include identifiers for AWSProducts, - * Partner Solutions, and AWSMarketplaceOffers.

+ *

This field provides the associations' information for other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

* @public */ export interface RelatedEntityIdentifiers { /** - *

Takes one value per opportunity. Each value is an Amazon Resource Name (ARN), in this - * format: "offers": - * ["arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/Offer/offer-sampleOffer32"].

- *

Use the ListEntities action in the Marketplace Catalog APIs for a list of offers in - * the associated Marketplace seller account.

+ *

Takes one value per opportunity. Each value is an Amazon Resource Name (ARN), in this format: "offers": ["arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/Offer/offer-sampleOffer32"].

Use the ListEntities action in the Marketplace Catalog APIs for a list of offers in the associated Marketplace seller account.

* @public */ AwsMarketplaceOffers?: string[] | undefined; /** - *

Enables partner solutions or offerings' association with an opportunity. To associate - * a solution, provide the solution's unique identifier, which you can obtain with the - * ListSolutions operation.

- *

If the specific solution identifier is not available, you can use the value - * Other and provide details about the solution in the - * otherSolutionOffered field. But when the opportunity reaches the - * Committed stage or beyond, the Other value cannot be used, - * and a valid solution identifier must be provided.

- *

By associating the relevant solutions with the opportunity, you can communicate the - * offerings that are being considered or implemented to address the customer's business - * problem.

+ *

Enables partner solutions or offerings' association with an opportunity. To associate a solution, provide the solution's unique identifier, which you can obtain with the ListSolutions operation.

If the specific solution identifier is not available, you can use the value Other and provide details about the solution in the otherSolutionOffered field. But when the opportunity reaches the Committed stage or beyond, the Other value cannot be used, and a valid solution identifier must be provided.

By associating the relevant solutions with the opportunity, you can communicate the offerings that are being considered or implemented to address the customer's business problem.

* @public */ Solutions?: string[] | undefined; /** - *

Enables the association of specific Amazon Web Services products with the - * Opportunity. Partners can indicate the relevant Amazon Web Services - * products for the Opportunity's solution and align with the customer's - * needs. Returns multiple values separated by commas. For example, "AWSProducts" : - * ["AmazonRedshift", "AWSAppFabric", "AWSCleanRooms"].

- *

Use the file with the list of Amazon Web Services products hosted on GitHub: - * Amazon Web Services products.

+ *

Enables the association of specific Amazon Web Services products with the Opportunity. Partners can indicate the relevant Amazon Web Services products for the Opportunity's solution and align with the customer's needs. Returns multiple values separated by commas. For example, "AWSProducts" : ["AmazonRedshift", "AWSAppFabric", "AWSCleanRooms"].

Use the file with the list of Amazon Web Services products hosted on GitHub: Amazon Web Services products.

* @public */ AwsProducts?: string[] | undefined; @@ -4929,74 +3951,25 @@ export interface RelatedEntityIdentifiers { */ export interface GetOpportunityResponse { /** - *

Specifies the catalog associated with the request. This field takes a string value - * from a predefined list: AWS or Sandbox. The catalog determines - * which environment the opportunity information is retrieved from. Use AWS to - * retrieve opportunities in the Amazon Web Services catalog, and Sandbox to - * retrieve opportunities in a secure and isolated testing environment.

+ *

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity information is retrieved from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.

* @public */ Catalog: string | undefined; /** - *

Identifies the type of support the partner needs from Amazon Web Services.

- *

Valid values:

- * + *

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

* @public */ PrimaryNeedsFromAws?: PrimaryNeedFromAws[] | undefined; /** - *

Indicates whether the Opportunity pertains to a national security - * project. This field must be set to true only when the customer's industry - * is Government. Additional privacy and security measures apply - * during the review and management process for opportunities marked as - * NationalSecurity.

+ *

Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.

* @public */ NationalSecurity?: NationalSecurity | undefined; /** - *

Specifies the opportunity's unique identifier in the partner's CRM system. This value - * is essential to track and reconcile because it's included in the outbound payload sent - * back to the partner.

+ *

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

* @public */ PartnerOpportunityIdentifier?: string | undefined; @@ -5008,31 +3981,13 @@ export interface GetOpportunityResponse { Customer?: Customer | undefined; /** - *

An object that contains project details summary for the - * Opportunity.

+ *

An object that contains project details summary for the Opportunity.

* @public */ Project?: Project | undefined; /** - *

Specifies the opportunity type as renewal, new, or expansion.

- *

Opportunity types:

- * + *

Specifies the opportunity type as renewal, new, or expansion.

Opportunity types:

* @public */ OpportunityType?: OpportunityType | undefined; @@ -5044,8 +3999,7 @@ export interface GetOpportunityResponse { Marketing?: Marketing | undefined; /** - *

Specifies details of a customer's procurement terms. Required only for partners in - * eligible programs.

+ *

Specifies details of a customer's procurement terms. Required only for partners in eligible programs.

* @public */ SoftwareRevenue?: SoftwareRevenue | undefined; @@ -5063,23 +4017,19 @@ export interface GetOpportunityResponse { Arn?: string | undefined; /** - *

- * DateTime when the opportunity was last modified.

+ *

DateTime when the opportunity was last modified.

* @public */ LastModifiedDate: Date | undefined; /** - *

- * DateTime when the Opportunity was last created.

+ *

DateTime when the Opportunity was last created.

* @public */ CreatedDate: Date | undefined; /** - *

Provides information about the associations of other entities with the opportunity. - * These entities include identifiers for AWSProducts, Partner - * Solutions, and AWSMarketplaceOffers.

+ *

Provides information about the associations of other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

* @public */ RelatedEntityIdentifiers: RelatedEntityIdentifiers | undefined; @@ -5091,29 +4041,25 @@ export interface GetOpportunityResponse { LifeCycle?: LifeCycle | undefined; /** - *

Represents the internal team handling the opportunity. Specify the members involved in - * collaborating on this opportunity within the partner's organization.

+ *

Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.

* @public */ OpportunityTeam?: Contact[] | undefined; } /** - *

Defines a filter to retrieve opportunities based on the last modified date. This - * filter is useful for tracking changes or updates to opportunities over time.

+ *

Defines a filter to retrieve opportunities based on the last modified date. This filter is useful for tracking changes or updates to opportunities over time.

* @public */ export interface LastModifiedDate { /** - *

Specifies the date after which the opportunities were modified. Use this filter to - * retrieve only those opportunities that were modified after a given timestamp.

+ *

Specifies the date after which the opportunities were modified. Use this filter to retrieve only those opportunities that were modified after a given timestamp.

* @public */ AfterLastModifiedDate?: Date | undefined; /** - *

Specifies the date before which the opportunities were modified. Use this filter to - * retrieve only those opportunities that were modified before a given timestamp.

+ *

Specifies the date before which the opportunities were modified. Use this filter to retrieve only those opportunities that were modified before a given timestamp.

* @public */ BeforeLastModifiedDate?: Date | undefined; @@ -5140,9 +4086,7 @@ export type OpportunitySortName = (typeof OpportunitySortName)[keyof typeof Oppo */ export interface OpportunitySort { /** - *

Sort order.

- *

Default: Descending - *

+ *

Sort order.

Default: Descending

* @public */ SortOrder: SortOrder | undefined; @@ -5159,77 +4103,55 @@ export interface OpportunitySort { */ export interface ListOpportunitiesRequest { /** - *

Specifies the catalog associated with the request. This field takes a string value - * from a predefined list: AWS or Sandbox. The catalog determines - * which environment the opportunities are listed in. Use AWS for listing real - * opportunities in the Amazon Web Services catalog, and Sandbox for testing in - * secure, isolated environments.

+ *

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunities are listed in. Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

* @public */ Catalog: string | undefined; /** - *

Specifies the maximum number of results to return in a single call. This limits the - * number of opportunities returned in the response to avoid providing too many results at - * once.

- *

Default: 20

+ *

Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.

Default: 20

* @public */ MaxResults?: number | undefined; /** - *

A pagination token used to retrieve the next set of results in subsequent calls. This - * token is included in the response only if there are additional result pages - * available.

+ *

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

* @public */ NextToken?: string | undefined; /** - *

An object that specifies how the response is sorted. The default - * Sort.SortBy value is LastModifiedDate.

+ *

An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate.

* @public */ Sort?: OpportunitySort | undefined; /** - *

Filters the opportunities based on their last modified date. This filter helps - * retrieve opportunities that were updated after the specified date, allowing partners to - * track recent changes or updates.

+ *

Filters the opportunities based on their last modified date. This filter helps retrieve opportunities that were updated after the specified date, allowing partners to track recent changes or updates.

* @public */ LastModifiedDate?: LastModifiedDate | undefined; /** - *

Filters the opportunities based on the opportunity identifier. This allows partners to - * retrieve specific opportunities by providing their unique identifiers, ensuring precise - * results.

+ *

Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results.

* @public */ Identifier?: string[] | undefined; /** - *

Filters the opportunities based on their lifecycle stage. This filter allows partners - * to retrieve opportunities at various stages in the sales cycle, such as - * Qualified, Technical Validation, Business - * Validation, or Closed Won.

+ *

Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.

* @public */ LifeCycleStage?: Stage[] | undefined; /** - *

Filters the opportunities based on their current lifecycle approval status. Use this - * filter to retrieve opportunities with statuses such as Pending Submission, - * In Review, Action Required, or - * Approved.

+ *

Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as Pending Submission, In Review, Action Required, or Approved.

* @public */ LifeCycleReviewStatus?: ReviewStatus[] | undefined; /** - *

Filters the opportunities based on the customer's company name. This allows partners - * to search for opportunities associated with a specific customer by matching the provided - * company name string.

+ *

Filters the opportunities based on the customer's company name. This allows partners to search for opportunities associated with a specific customer by matching the provided company name string.

* @public */ CustomerCompanyName?: string[] | undefined; @@ -5253,159 +4175,43 @@ export interface CustomerSummary { */ export interface LifeCycleSummary { /** - *

Specifies the current stage of the Opportunity's lifecycle as it maps to - * Amazon Web Services stages from the current stage in the partner CRM. This field - * provides a translated value of the stage, and offers insight into the - * Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

- * - *

A lead and a prospect must be further matured to a Qualified - * opportunity before submission. Opportunities that were closed/lost before submission - * aren't suitable for submission.

- * - *

The descriptions of each sales stage are:

- * + *

Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.

The descriptions of each sales stage are:

* @public */ Stage?: Stage | undefined; /** - *

Specifies the reason code when an opportunity is marked as Closed - * Lost. When you select an appropriate reason code, you communicate the - * context for closing the Opportunity, and aid in accurate reports and - * analysis of opportunity outcomes.

+ *

Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes.

* @public */ ClosedLostReason?: ClosedLostReason | undefined; /** - *

Specifies the upcoming actions or tasks for the Opportunity. This field - * is utilized to communicate to Amazon Web Services the next actions required for the - * Opportunity.

+ *

Specifies the upcoming actions or tasks for the Opportunity. This field is utilized to communicate to Amazon Web Services the next actions required for the Opportunity.

* @public */ NextSteps?: string | undefined; /** - *

Specifies the date when Amazon Web Services expects to start significant billing, when - * the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

- *

Ensure the Target Close Date isn't in the past.

+ *

Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

Ensure the Target Close Date isn't in the past.

* @public */ TargetCloseDate?: string | undefined; /** - *

Indicates the review status of a partner referred opportunity. This field is read-only - * and only applicable for partner referrals. Valid values:

- * + *

Indicates the review status of a partner referred opportunity. This field is read-only and only applicable for partner referrals. Valid values:

* @public */ ReviewStatus?: ReviewStatus | undefined; /** - *

Indicates why an opportunity was sent back for further details. Partners must take - * corrective action based on the ReviewComments.

+ *

Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.

* @public */ ReviewComments?: string | undefined; /** - *

Indicates the reason a specific decision was taken during the opportunity review - * process. This field combines the reasons for both disqualified and action required - * statuses, and provides clarity for why an opportunity was disqualified or required - * further action.

+ *

Indicates the reason a specific decision was taken during the opportunity review process. This field combines the reasons for both disqualified and action required statuses, and provides clarity for why an opportunity was disqualified or required further action.

* @public */ ReviewStatusReason?: string | undefined; @@ -5417,43 +4223,13 @@ export interface LifeCycleSummary { */ export interface ProjectSummary { /** - *

Specifies your solution or service's deployment or consumption model in the - * Opportunity's context. You can select multiple options.

- *

Options' descriptions from the Delivery Model field are:

- * + *

Specifies your solution or service's deployment or consumption model in the Opportunity's context. You can select multiple options.

Options' descriptions from the Delivery Model field are:

* @public */ DeliveryModels?: DeliveryModel[] | undefined; /** - *

Provides a summary of the expected customer spend for the project, offering a - * high-level view of the potential financial impact.

+ *

Provides a summary of the expected customer spend for the project, offering a high-level view of the potential financial impact.

* @public */ ExpectedCustomerSpend?: ExpectedCustomerSpend[] | undefined; @@ -5465,9 +4241,7 @@ export interface ProjectSummary { */ export interface OpportunitySummary { /** - *

Specifies the catalog associated with the opportunity, either AWS or - * Sandbox. This indicates the environment in which the opportunity is - * managed.

+ *

Specifies the catalog associated with the opportunity, either AWS or Sandbox. This indicates the environment in which the opportunity is managed.

* @public */ Catalog: string | undefined; @@ -5479,53 +4253,31 @@ export interface OpportunitySummary { Id?: string | undefined; /** - *

The Amazon Resource Name (ARN) for the opportunity. This globally unique identifier - * can be used for IAM policies and cross-service references.

+ *

The Amazon Resource Name (ARN) for the opportunity. This globally unique identifier can be used for IAM policies and cross-service references.

* @public */ Arn?: string | undefined; /** - *

Specifies the Opportunity's unique identifier in the partner's CRM - * system. This value is essential to track and reconcile because it's included in the - * outbound payload sent back to the partner. It allows partners to link an opportunity to - * their CRM.

+ *

Specifies the Opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner. It allows partners to link an opportunity to their CRM.

* @public */ PartnerOpportunityIdentifier?: string | undefined; /** - *

Specifies opportunity type as a renewal, new, or expansion.

- *

Opportunity types:

- * + *

Specifies opportunity type as a renewal, new, or expansion.

Opportunity types:

* @public */ OpportunityType?: OpportunityType | undefined; /** - *

- * DateTime when the Opportunity was last modified.

+ *

DateTime when the Opportunity was last modified.

* @public */ LastModifiedDate?: Date | undefined; /** - *

- * DateTime when the Opportunity was last created.

+ *

DateTime when the Opportunity was last created.

* @public */ CreatedDate?: Date | undefined; @@ -5554,16 +4306,13 @@ export interface OpportunitySummary { */ export interface ListOpportunitiesResponse { /** - *

An array that contains minimal details for opportunities that match the request - * criteria. This summary view provides a quick overview of relevant opportunities.

+ *

An array that contains minimal details for opportunities that match the request criteria. This summary view provides a quick overview of relevant opportunities.

* @public */ OpportunitySummaries: OpportunitySummary[] | undefined; /** - *

A pagination token used to retrieve the next set of results in subsequent calls. This - * token is included in the response only if there are additional result pages - * available.

+ *

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

* @public */ NextToken?: string | undefined; @@ -5574,62 +4323,25 @@ export interface ListOpportunitiesResponse { */ export interface SubmitOpportunityRequest { /** - *

Specifies the catalog related to the request. Valid values are:

- * + *

Specifies the catalog related to the request. Valid values are:

* @public */ Catalog: string | undefined; /** - *

The identifier of the Opportunity previously created by partner and needs to be - * submitted.

+ *

The identifier of the Opportunity previously created by partner and needs to be submitted.

* @public */ Identifier: string | undefined; /** - *

Specifies the level of AWS sellers' involvement on the opportunity. Valid - * values:

- * + *

Specifies the level of AWS sellers' involvement on the opportunity. Valid values:

* @public */ InvolvementType: SalesInvolvementType | undefined; /** - *

Determines whether to restrict visibility of the opportunity from AWS sales. Default - * value is Full. Valid values:

- * + *

Determines whether to restrict visibility of the opportunity from AWS sales. Default value is Full. Valid values:

* @public */ Visibility?: Visibility | undefined; @@ -5640,75 +4352,25 @@ export interface SubmitOpportunityRequest { */ export interface UpdateOpportunityRequest { /** - *

Specifies the catalog associated with the request. This field takes a string value - * from a predefined list: AWS or Sandbox. The catalog determines - * which environment the opportunity is updated in. Use AWS to update real - * opportunities in the production environment, and Sandbox for testing in - * secure, isolated environments. When you use the Sandbox catalog, it allows - * you to simulate and validate your interactions with Amazon Web Services services without - * affecting live data or operations.

+ *

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is updated in. Use AWS to update real opportunities in the production environment, and Sandbox for testing in secure, isolated environments. When you use the Sandbox catalog, it allows you to simulate and validate your interactions with Amazon Web Services services without affecting live data or operations.

* @public */ Catalog: string | undefined; /** - *

Identifies the type of support the partner needs from Amazon Web Services.

- *

Valid values:

- * + *

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

* @public */ PrimaryNeedsFromAws?: PrimaryNeedFromAws[] | undefined; /** - *

Specifies if the opportunity is associated with national security concerns. This flag - * is only applicable when the industry is Government. For - * national-security-related opportunities, validation and compliance rules may apply, - * impacting the opportunity's visibility and processing.

+ *

Specifies if the opportunity is associated with national security concerns. This flag is only applicable when the industry is Government. For national-security-related opportunities, validation and compliance rules may apply, impacting the opportunity's visibility and processing.

* @public */ NationalSecurity?: NationalSecurity | undefined; /** - *

Specifies the opportunity's unique identifier in the partner's CRM system. This value - * is essential to track and reconcile because it's included in the outbound payload sent - * back to the partner.

+ *

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

* @public */ PartnerOpportunityIdentifier?: string | undefined; @@ -5720,30 +4382,13 @@ export interface UpdateOpportunityRequest { Customer?: Customer | undefined; /** - *

An object that contains project details summary for the - * Opportunity.

+ *

An object that contains project details summary for the Opportunity.

* @public */ Project?: Project | undefined; /** - *

Specifies the opportunity type as a renewal, new, or expansion.

- *

Opportunity types:

- * + *

Specifies the opportunity type as a renewal, new, or expansion.

Opportunity types:

* @public */ OpportunityType?: OpportunityType | undefined; @@ -5755,15 +4400,13 @@ export interface UpdateOpportunityRequest { Marketing?: Marketing | undefined; /** - *

Specifies details of a customer's procurement terms. Required only for partners in - * eligible programs.

+ *

Specifies details of a customer's procurement terms. Required only for partners in eligible programs.

* @public */ SoftwareRevenue?: SoftwareRevenue | undefined; /** - *

- * DateTime when the opportunity was last modified.

+ *

DateTime when the opportunity was last modified.

* @public */ LastModifiedDate: Date | undefined; @@ -5792,13 +4435,46 @@ export interface UpdateOpportunityResponse { Id: string | undefined; /** - *

- * DateTime when the opportunity was last modified.

+ *

DateTime when the opportunity was last modified.

* @public */ LastModifiedDate: Date | undefined; } +/** + * @public + */ +export interface PutSellingSystemSettingsRequest { + /** + *

Specifies the catalog in which the settings will be updated. Acceptable values include AWS for production and Sandbox for testing environments.

+ * @public + */ + Catalog: string | undefined; + + /** + *

Specifies the ARN of the IAM Role used for resource snapshot job executions.

+ * @public + */ + ResourceSnapshotJobRoleIdentifier?: string | undefined; +} + +/** + * @public + */ +export interface PutSellingSystemSettingsResponse { + /** + *

Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.

+ * @public + */ + Catalog: string | undefined; + + /** + *

Specifies the ARN of the IAM Role used for resource snapshot job executions.

+ * @public + */ + ResourceSnapshotJobRoleArn?: string | undefined; +} + /** * @public * @enum @@ -5817,47 +4493,37 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType]; */ export interface CreateResourceSnapshotRequest { /** - *

Specifies the catalog where the snapshot is created. Valid values are - * AWS and Sandbox.

+ *

Specifies the catalog where the snapshot is created. Valid values are AWS and Sandbox.

* @public */ Catalog: string | undefined; /** - *

The unique identifier of the engagement associated with this snapshot. This field - * links the snapshot to a specific engagement context.

+ *

The unique identifier of the engagement associated with this snapshot. This field links the snapshot to a specific engagement context.

* @public */ EngagementIdentifier: string | undefined; /** - *

Specifies the type of resource for which the snapshot is being created. This field - * determines the structure and content of the snapshot. Must be one of the supported - * resource types, such as: Opportunity.

+ *

Specifies the type of resource for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: Opportunity.

* @public */ ResourceType: ResourceType | undefined; /** - *

The unique identifier of the specific resource to be snapshotted. The format and - * constraints of this identifier depend on the ResourceType specified. For - * example: For Opportunity type, it will be an opportunity ID.

+ *

The unique identifier of the specific resource to be snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For example: For Opportunity type, it will be an opportunity ID.

* @public */ ResourceIdentifier: string | undefined; /** - *

The name of the template that defines the schema for the snapshot. This template - * determines which subset of the resource data will be included in the snapshot. Must - * correspond to an existing and valid template for the specified - * ResourceType.

+ *

The name of the template that defines the schema for the snapshot. This template determines which subset of the resource data will be included in the snapshot. Must correspond to an existing and valid template for the specified ResourceType.

* @public */ ResourceSnapshotTemplateIdentifier: string | undefined; /** - *

Specifies a unique, client-generated UUID to ensure that the request is handled - * exactly once. This token helps prevent duplicate snapshot creations.

+ *

Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations.

* @public */ ClientToken?: string | undefined; @@ -5868,16 +4534,13 @@ export interface CreateResourceSnapshotRequest { */ export interface CreateResourceSnapshotResponse { /** - *

Specifies the Amazon Resource Name (ARN) that uniquely identifies the snapshot - * created.

+ *

Specifies the Amazon Resource Name (ARN) that uniquely identifies the snapshot created.

* @public */ Arn?: string | undefined; /** - *

Specifies the revision number of the created snapshot. This field provides important - * information about the snapshot's place in the sequence of snapshots for the given - * resource.

+ *

Specifies the revision number of the created snapshot. This field provides important information about the snapshot's place in the sequence of snapshots for the given resource.

* @public */ Revision?: number | undefined; @@ -5888,64 +4551,44 @@ export interface CreateResourceSnapshotResponse { */ export interface GetResourceSnapshotRequest { /** - *

Specifies the catalog related to the request. Valid values are:

- * + *

Specifies the catalog related to the request. Valid values are:

* @public */ Catalog: string | undefined; /** - *

The unique identifier of the engagement associated with the snapshot. This field links - * the snapshot to a specific engagement context.

+ *

The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.

* @public */ EngagementIdentifier: string | undefined; /** - *

Specifies the type of resource that was snapshotted. This field determines the - * structure and content of the snapshot payload. Valid value - * includes:Opportunity: For opportunity-related data.

+ *

Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.

* @public */ ResourceType: ResourceType | undefined; /** - *

The unique identifier of the specific resource that was snapshotted. The format and - * constraints of this identifier depend on the ResourceType specified. For - * Opportunity type, it will be an opportunity ID - *

+ *

The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For Opportunity type, it will be an opportunity ID

* @public */ ResourceIdentifier: string | undefined; /** - *

he name of the template that defines the schema for the snapshot. This template - * determines which subset of the resource data is included in the snapshot and must - * correspond to an existing and valid template for the specified - * ResourceType.

+ *

he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified ResourceType.

* @public */ ResourceSnapshotTemplateIdentifier: string | undefined; /** - *

Specifies which revision of the snapshot to retrieve. If omitted returns the latest - * revision.

+ *

Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.

* @public */ Revision?: number | undefined; } /** - *

Provides the lifecycle view of an opportunity resource shared through a snapshot. - *

+ *

Provides the lifecycle view of an opportunity resource shared through a snapshot.

* @public */ export interface LifeCycleForView { @@ -5975,23 +4618,18 @@ export interface LifeCycleForView { } /** - *

Provides the project view of an opportunity resource shared through a snapshot. - *

+ *

Provides the project view of an opportunity resource shared through a snapshot.

* @public */ export interface ProjectView { /** - *

Describes the deployment or consumption model for the partner solution or offering. - * This field indicates how the project's solution will be delivered or implemented for the - * customer.

+ *

Describes the deployment or consumption model for the partner solution or offering. This field indicates how the project's solution will be delivered or implemented for the customer.

* @public */ DeliveryModels?: DeliveryModel[] | undefined; /** - *

Provides information about the anticipated customer spend related to this project. - * This may include details such as amount, frequency, and currency of expected - * expenditure.

+ *

Provides information about the anticipated customer spend related to this project. This may include details such as amount, frequency, and currency of expected expenditure.

* @public */ ExpectedCustomerSpend?: ExpectedCustomerSpend[] | undefined; @@ -6003,26 +4641,20 @@ export interface ProjectView { CustomerUseCase?: string | undefined; /** - *

Lists the pre-sales activities that have occurred with the end-customer related to - * the opportunity. This field is conditionally mandatory when the project is qualified for - * Co-Sell and helps drive assignment priority on the AWS side. It provides insight into - * the engagement level with the customer.

+ *

Lists the pre-sales activities that have occurred with the end-customer related to the opportunity. This field is conditionally mandatory when the project is qualified for Co-Sell and helps drive assignment priority on the AWS side. It provides insight into the engagement level with the customer.

* @public */ SalesActivities?: SalesActivity[] | undefined; /** - *

Offers a description of other solutions if the standard solutions do not adequately - * cover the project's scope.

+ *

Offers a description of other solutions if the standard solutions do not adequately cover the project's scope.

* @public */ OtherSolutionDescription?: string | undefined; } /** - *

Provides a comprehensive view of an opportunity summary, including lifecycle - * information, team details, opportunity type, primary needs from AWS, and associated - * project information.

+ *

Provides a comprehensive view of an opportunity summary, including lifecycle information, team details, opportunity type, primary needs from AWS, and associated project information.

* @public */ export interface OpportunitySummaryView { @@ -6033,15 +4665,13 @@ export interface OpportunitySummaryView { OpportunityType?: OpportunityType | undefined; /** - *

Contains information about the opportunity's lifecycle, including its current stage, - * status, and important dates such as creation and last modification times.

+ *

Contains information about the opportunity's lifecycle, including its current stage, status, and important dates such as creation and last modification times.

* @public */ Lifecycle?: LifeCycleForView | undefined; /** - *

Represents the internal team handling the opportunity. Specify the members involved - * in collaborating on an opportunity within the partner's organization.

+ *

Represents the internal team handling the opportunity. Specify the members involved in collaborating on an opportunity within the partner's organization.

* @public */ OpportunityTeam?: Contact[] | undefined; @@ -6053,32 +4683,26 @@ export interface OpportunitySummaryView { PrimaryNeedsFromAws?: PrimaryNeedFromAws[] | undefined; /** - *

An object that contains the customer's Account and - * Contact.

+ *

An object that contains the customer's Account and Contact.

* @public */ Customer?: Customer | undefined; /** - *

Contains summary information about the project associated with the opportunity, - * including project name, description, timeline, and other relevant details.

+ *

Contains summary information about the project associated with the opportunity, including project name, description, timeline, and other relevant details.

* @public */ Project?: ProjectView | undefined; /** - *

This field provides the associations' information for other entities with the - * opportunity. These entities include identifiers for AWSProducts, - * Partner Solutions, and AWSMarketplaceOffers.

+ *

This field provides the associations' information for other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

* @public */ RelatedEntityIdentifiers?: RelatedEntityIdentifiers | undefined; } /** - *

Represents the payload of a resource snapshot. This structure is designed to - * accommodate different types of resource snapshots, currently supporting opportunity - * summaries.

+ *

Represents the payload of a resource snapshot. This structure is designed to accommodate different types of resource snapshots, currently supporting opportunity summaries.

* @public */ export type ResourceSnapshotPayload = @@ -6122,8 +4746,7 @@ export namespace ResourceSnapshotPayload { */ export interface GetResourceSnapshotResponse { /** - *

The catalog in which the snapshot was created. Matches the Catalog specified in the - * request.

+ *

The catalog in which the snapshot was created. Matches the Catalog specified in the request.

* @public */ Catalog: string | undefined; @@ -6135,59 +4758,49 @@ export interface GetResourceSnapshotResponse { Arn?: string | undefined; /** - *

The AWS account ID of the principal (user or role) who created the snapshot. This - * helps in tracking the origin of the snapshot.

+ *

The AWS account ID of the principal (user or role) who created the snapshot. This helps in tracking the origin of the snapshot.

* @public */ CreatedBy?: string | undefined; /** - *

The timestamp when the snapshot was created, in ISO 8601 format (e.g., - * "2023-06-01T14:30:00Z"). This allows for precise tracking of when the snapshot was - * taken.

+ *

The timestamp when the snapshot was created, in ISO 8601 format (e.g., "2023-06-01T14:30:00Z"). This allows for precise tracking of when the snapshot was taken.

* @public */ CreatedAt?: Date | undefined; /** - *

The identifier of the engagement associated with this snapshot. Matches the - * EngagementIdentifier specified in the request.

+ *

The identifier of the engagement associated with this snapshot. Matches the EngagementIdentifier specified in the request.

* @public */ EngagementId?: string | undefined; /** - *

The type of the resource that was snapshotted. Matches the ResourceType specified in - * the request.

+ *

The type of the resource that was snapshotted. Matches the ResourceType specified in the request.

* @public */ ResourceType?: ResourceType | undefined; /** - *

The identifier of the specific resource that was snapshotted. Matches the - * ResourceIdentifier specified in the request.

+ *

The identifier of the specific resource that was snapshotted. Matches the ResourceIdentifier specified in the request.

* @public */ ResourceId?: string | undefined; /** - *

The name of the view used for this snapshot. This is the same as the template - * name.

+ *

The name of the view used for this snapshot. This is the same as the template name.

* @public */ ResourceSnapshotTemplateName?: string | undefined; /** - *

The revision number of this snapshot. This is a positive integer that is sequential - * and unique within the context of a resource view.

+ *

The revision number of this snapshot. This is a positive integer that is sequential and unique within the context of a resource view.

* @public */ Revision?: number | undefined; /** - *

Represents the payload of a resource snapshot. This structure is designed to - * accommodate different types of resource snapshots, currently supporting opportunity - * summaries.

+ *

Represents the payload of a resource snapshot. This structure is designed to accommodate different types of resource snapshots, currently supporting opportunity summaries.

* @public */ Payload?: ResourceSnapshotPayload | undefined; @@ -6198,76 +4811,50 @@ export interface GetResourceSnapshotResponse { */ export interface ListEngagementResourceAssociationsRequest { /** - *

Specifies the catalog in which to search for engagement-resource associations. Valid - * Values: "AWS" or "Sandbox"

- * + *

Specifies the catalog in which to search for engagement-resource associations. Valid Values: "AWS" or "Sandbox"

* @public */ Catalog: string | undefined; /** - *

Limits the number of results returned in a single call. Use this to control the number - * of results returned, especially useful for pagination.

+ *

Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination.

* @public */ MaxResults?: number | undefined; /** - *

A token used for pagination of results. Include this token in subsequent requests to - * retrieve the next set of results.

+ *

A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results.

* @public */ NextToken?: string | undefined; /** - *

Filters the results to include only associations related to the specified engagement. - * Use this when you want to find all resources associated with a specific - * engagement.

+ *

Filters the results to include only associations related to the specified engagement. Use this when you want to find all resources associated with a specific engagement.

* @public */ EngagementIdentifier?: string | undefined; /** - *

Filters the results to include only associations with resources of the specified - * type.

+ *

Filters the results to include only associations with resources of the specified type.

* @public */ ResourceType?: ResourceType | undefined; /** - *

Filters the results to include only associations with the specified resource. Varies - * depending on the resource type. Use this when you want to find all engagements - * associated with a specific resource.

+ *

Filters the results to include only associations with the specified resource. Varies depending on the resource type. Use this when you want to find all engagements associated with a specific resource.

* @public */ ResourceIdentifier?: string | undefined; /** - *

Filters the response to include only snapshots of resources owned by the specified - * AWS account ID. Use this when you want to find associations related to resources owned - * by a particular account.

+ *

Filters the response to include only snapshots of resources owned by the specified AWS account ID. Use this when you want to find associations related to resources owned by a particular account.

* @public */ CreatedBy?: string | undefined; } /** - *

This provide a streamlined view of the relationships between engagements and - * resources. These summaries offer a crucial link between collaborative engagements and - * the specific resources involved, such as opportunities.These summaries are particularly - * valuable for partners navigating complex engagements with multiple resources. They - * enable quick insights into resource distribution across engagements, support efficient - * resource management, and help maintain a clear overview of collaborative activities. - *

+ *

This provide a streamlined view of the relationships between engagements and resources. These summaries offer a crucial link between collaborative engagements and the specific resources involved, such as opportunities.These summaries are particularly valuable for partners navigating complex engagements with multiple resources. They enable quick insights into resource distribution across engagements, support efficient resource management, and help maintain a clear overview of collaborative activities.

* @public */ export interface EngagementResourceAssociationSummary { @@ -6290,15 +4877,13 @@ export interface EngagementResourceAssociationSummary { ResourceType?: ResourceType | undefined; /** - *

A unique identifier for the specific resource. Varies depending on the resource type. - *

+ *

A unique identifier for the specific resource. Varies depending on the resource type.

* @public */ ResourceId?: string | undefined; /** - *

The AWS account ID of the entity that owns the resource. Identifies the account - * responsible for or having primary control over the resource.

+ *

The AWS account ID of the entity that owns the resource. Identifies the account responsible for or having primary control over the resource.

* @public */ CreatedBy?: string | undefined; @@ -6315,8 +4900,7 @@ export interface ListEngagementResourceAssociationsResponse { EngagementResourceAssociationSummaries: EngagementResourceAssociationSummary[] | undefined; /** - *

A token to retrieve the next set of results. Use this token in a subsequent request - * to retrieve additional results if the response was truncated.

+ *

A token to retrieve the next set of results. Use this token in a subsequent request to retrieve additional results if the response was truncated.

* @public */ NextToken?: string | undefined; @@ -6351,8 +4935,7 @@ export interface ListResourceSnapshotsRequest { EngagementIdentifier: string | undefined; /** - *

Filters the response to include only snapshots of the specified resource type. - *

+ *

Filters the response to include only snapshots of the specified resource type.

* @public */ ResourceType?: ResourceType | undefined; @@ -6364,37 +4947,31 @@ export interface ListResourceSnapshotsRequest { ResourceIdentifier?: string | undefined; /** - *

Filters the response to include only snapshots created using the specified - * template.

+ *

Filters the response to include only snapshots created using the specified template.

* @public */ ResourceSnapshotTemplateIdentifier?: string | undefined; /** - *

Filters the response to include only snapshots of resources owned by the specified - * AWS account.

+ *

Filters the response to include only snapshots of resources owned by the specified AWS account.

* @public */ CreatedBy?: string | undefined; } /** - *

Provides a concise summary of a resource snapshot, including its unique identifier - * and version information. This structure is used to quickly reference and identify - * specific versions of resource snapshots.

+ *

Provides a concise summary of a resource snapshot, including its unique identifier and version information. This structure is used to quickly reference and identify specific versions of resource snapshots.

* @public */ export interface ResourceSnapshotSummary { /** - *

The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can - * be used for cross-service references and in IAM policies.

+ *

The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can be used for cross-service references and in IAM policies.

* @public */ Arn?: string | undefined; /** - *

The revision number of the snapshot. This integer value is incremented each time the - * snapshot is updated, allowing for version tracking of the resource snapshot.

+ *

The revision number of the snapshot. This integer value is incremented each time the snapshot is updated, allowing for version tracking of the resource snapshot.

* @public */ Revision?: number | undefined; @@ -6406,8 +4983,7 @@ export interface ResourceSnapshotSummary { ResourceType?: ResourceType | undefined; /** - *

The identifier of the specific resource snapshotted. The format might vary depending - * on the ResourceType.

+ *

The identifier of the specific resource snapshotted. The format might vary depending on the ResourceType.

* @public */ ResourceId?: string | undefined; @@ -6419,8 +4995,7 @@ export interface ResourceSnapshotSummary { ResourceSnapshotTemplateName?: string | undefined; /** - *

The AWS account ID of the entity that owns the resource from which the snapshot was - * created.

+ *

The AWS account ID of the entity that owns the resource from which the snapshot was created.

* @public */ CreatedBy?: string | undefined; @@ -6437,8 +5012,7 @@ export interface ListResourceSnapshotsResponse { ResourceSnapshotSummaries: ResourceSnapshotSummary[] | undefined; /** - *

The token to retrieve the next set of results. If there are no additional results, - * this value is null.

+ *

The token to retrieve the next set of results. If there are no additional results, this value is null.

* @public */ NextToken?: string | undefined; @@ -6449,37 +5023,31 @@ export interface ListResourceSnapshotsResponse { */ export interface CreateResourceSnapshotJobRequest { /** - *

Specifies the catalog in which to create the snapshot job. Valid values are - * AWS and Sandbox.

+ *

Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.

* @public */ Catalog: string | undefined; /** - *

A client-generated UUID used for idempotency check. The token helps prevent duplicate - * job creations.

+ *

A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.

* @public */ ClientToken?: string | undefined; /** - *

Specifies the identifier of the engagement associated with the resource to be - * snapshotted.

+ *

Specifies the identifier of the engagement associated with the resource to be snapshotted.

* @public */ EngagementIdentifier: string | undefined; /** - *

The type of resource for which the snapshot job is being created. Must be one of the - * supported resource types i.e. Opportunity - *

+ *

The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity

* @public */ ResourceType: ResourceType | undefined; /** - *

Specifies the identifier of the specific resource to be snapshotted. The format - * depends on the ResourceType.

+ *

Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.

* @public */ ResourceIdentifier: string | undefined; @@ -6491,7 +5059,7 @@ export interface CreateResourceSnapshotJobRequest { ResourceSnapshotTemplateIdentifier: string | undefined; /** - * A list of objects specifying each tag name and value. + *

A map of the key-value pairs of the tag or tags to assign.

* @public */ Tags?: Tag[] | undefined; @@ -6519,8 +5087,7 @@ export interface CreateResourceSnapshotJobResponse { */ export interface DeleteResourceSnapshotJobRequest { /** - *

Specifies the catalog from which to delete the snapshot job. Valid values are - * AWS and Sandbox.

+ *

Specifies the catalog from which to delete the snapshot job. Valid values are AWS and Sandbox.

* @public */ Catalog: string | undefined; @@ -6537,23 +5104,13 @@ export interface DeleteResourceSnapshotJobRequest { */ export interface GetResourceSnapshotJobRequest { /** - *

Specifies the catalog related to the request. Valid values are:

- * + *

Specifies the catalog related to the request. Valid values are:

* @public */ Catalog: string | undefined; /** - *

The unique identifier of the resource snapshot job to be retrieved. This identifier is - * crucial for pinpointing the specific job you want to query.

+ *

The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query.

* @public */ ResourceSnapshotJobIdentifier: string | undefined; @@ -6578,93 +5135,73 @@ export type ResourceSnapshotJobStatus = (typeof ResourceSnapshotJobStatus)[keyof */ export interface GetResourceSnapshotJobResponse { /** - *

The catalog in which the snapshot job was created. This will match the Catalog - * specified in the request.

+ *

The catalog in which the snapshot job was created. This will match the Catalog specified in the request.

* @public */ Catalog: string | undefined; /** - *

The unique identifier of the snapshot job. This matches the - * ResourceSnapshotJobIdentifier provided in the request.

+ *

The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.

* @public */ Id?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier - * can be used for resource-specific operations across AWS services.

+ *

The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.

* @public */ Arn?: string | undefined; /** - *

The identifier of the engagement associated with this snapshot job. This links the job - * to a specific engagement context.

+ *

The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.

* @public */ EngagementId?: string | undefined; /** - *

The type of resource being snapshotted. This would have "Opportunity" as a value as it - * is dependent on the supported resource type.

+ *

The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.

* @public */ ResourceType?: ResourceType | undefined; /** - *

The identifier of the specific resource being snapshotted. The format might vary - * depending on the ResourceType.

+ *

The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.

* @public */ ResourceId?: string | undefined; /** - *

The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a - * globally unique identifier for the resource across AWS.

+ *

The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.

* @public */ ResourceArn?: string | undefined; /** - *

The name of the template used for creating the snapshot. This is the same as the - * template name. It defines the structure and content of the snapshot.

+ *

The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.

* @public */ ResourceSnapshotTemplateName?: string | undefined; /** - *

The date and time when the snapshot job was created in ISO 8601 format (UTC). - * Example: "2023-05-01T20:37:46Z"

+ *

The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"

* @public */ CreatedAt?: Date | undefined; /** - *

The current status of the snapshot job. Valid values:

- * + *

The current status of the snapshot job. Valid values:

* @public */ Status?: ResourceSnapshotJobStatus | undefined; /** - *

The date and time of the last successful execution of the job, in ISO 8601 format - * (UTC). Example: "2023-05-01T20:37:46Z"

+ *

The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"

* @public */ LastSuccessfulExecutionDate?: Date | undefined; /** - *

If the job has encountered any failures, this field contains the error message from - * the most recent failure. This can be useful for troubleshooting issues with the job. - *

+ *

If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.

* @public */ LastFailure?: string | undefined; @@ -6684,8 +5221,7 @@ export const SortBy = { export type SortBy = (typeof SortBy)[keyof typeof SortBy]; /** - *

Defines the sorting parameters for listing resource snapshot jobs. This structure - * allows you to specify the field to sort by and the order of sorting.

+ *

Defines the sorting parameters for listing resource snapshot jobs. This structure allows you to specify the field to sort by and the order of sorting.

* @public */ export interface SortObject { @@ -6713,8 +5249,7 @@ export interface ListResourceSnapshotJobsRequest { Catalog: string | undefined; /** - *

The maximum number of results to return in a single call. If omitted, defaults to 50. - *

+ *

The maximum number of results to return in a single call. If omitted, defaults to 50.

* @public */ MaxResults?: number | undefined; @@ -6738,22 +5273,19 @@ export interface ListResourceSnapshotJobsRequest { Status?: ResourceSnapshotJobStatus | undefined; /** - *

Configures the sorting of the response. If omitted, results are sorted by - * CreatedDate in descending order.

+ *

Configures the sorting of the response. If omitted, results are sorted by CreatedDate in descending order.

* @public */ Sort?: SortObject | undefined; } /** - *

An object that contains a Resource Snapshot Job's subset of fields. - *

+ *

An object that contains a Resource Snapshot Job's subset of fields.

* @public */ export interface ResourceSnapshotJobSummary { /** - *

The unique identifier for the resource snapshot job within the AWS Partner Central - * system. This ID is used for direct references to the job within the service.

+ *

The unique identifier for the resource snapshot job within the AWS Partner Central system. This ID is used for direct references to the job within the service.

* @public */ Id?: string | undefined; @@ -6771,16 +5303,7 @@ export interface ResourceSnapshotJobSummary { EngagementId?: string | undefined; /** - *

The current status of the snapshot job.

- *

Valid values:

- * + *

The current status of the snapshot job.

Valid values:

* @public */ Status?: ResourceSnapshotJobStatus | undefined; @@ -6797,8 +5320,7 @@ export interface ListResourceSnapshotJobsResponse { ResourceSnapshotJobSummaries: ResourceSnapshotJobSummary[] | undefined; /** - *

The token to retrieve the next set of results. If there are no additional results, - * this value is null.

+ *

The token to retrieve the next set of results. If there are no additional results, this value is null.

* @public */ NextToken?: string | undefined; @@ -6809,16 +5331,7 @@ export interface ListResourceSnapshotJobsResponse { */ export interface StartResourceSnapshotJobRequest { /** - *

Specifies the catalog related to the request. Valid values are:

- * + *

Specifies the catalog related to the request. Valid values are:

* @public */ Catalog: string | undefined; @@ -6835,16 +5348,7 @@ export interface StartResourceSnapshotJobRequest { */ export interface StopResourceSnapshotJobRequest { /** - *

Specifies the catalog related to the request. Valid values are:

- * + *

Specifies the catalog related to the request. Valid values are:

* @public */ Catalog: string | undefined; @@ -6856,76 +5360,6 @@ export interface StopResourceSnapshotJobRequest { ResourceSnapshotJobIdentifier: string | undefined; } -/** - * @public - */ -export interface GetSellingSystemSettingsRequest { - /** - *

Specifies the catalog in which the settings are defined. Acceptable values include - * AWS for production and Sandbox for testing - * environments.

- * @public - */ - Catalog: string | undefined; -} - -/** - * @public - */ -export interface GetSellingSystemSettingsResponse { - /** - *

Specifies the catalog in which the settings are defined. Acceptable values include - * AWS for production and Sandbox for testing - * environments.

- * @public - */ - Catalog: string | undefined; - - /** - *

Specifies the ARN of the IAM Role used for resource snapshot job executions.

- * @public - */ - ResourceSnapshotJobRoleArn?: string | undefined; -} - -/** - * @public - */ -export interface PutSellingSystemSettingsRequest { - /** - *

Specifies the catalog in which the settings will be updated. Acceptable values include - * AWS for production and Sandbox for testing - * environments.

- * @public - */ - Catalog: string | undefined; - - /** - *

Specifies the ARN of the IAM Role used for resource snapshot job executions.

- * @public - */ - ResourceSnapshotJobRoleIdentifier?: string | undefined; -} - -/** - * @public - */ -export interface PutSellingSystemSettingsResponse { - /** - *

Specifies the catalog in which the settings are defined. Acceptable values include - * AWS for production and Sandbox for testing - * environments.

- * @public - */ - Catalog: string | undefined; - - /** - *

Specifies the ARN of the IAM Role used for resource snapshot job executions.

- * @public - */ - ResourceSnapshotJobRoleArn?: string | undefined; -} - /** * @public * @enum @@ -6944,21 +5378,18 @@ export const SolutionSortName = { export type SolutionSortName = (typeof SolutionSortName)[keyof typeof SolutionSortName]; /** - *

Configures the solutions' response sorting that enables partners to order solutions - * based on specified attributes.

+ *

Configures the solutions' response sorting that enables partners to order solutions based on specified attributes.

* @public */ export interface SolutionSort { /** - *

Specifies the sorting order, either Ascending or Descending. - * The default is Descending.

+ *

Specifies the sorting order, either Ascending or Descending. The default is Descending.

* @public */ SortOrder: SortOrder | undefined; /** - *

Specifies the attribute to sort by, such as Name, - * CreatedDate, or Status.

+ *

Specifies the attribute to sort by, such as Name, CreatedDate, or Status.

* @public */ SortBy: SolutionSortName | undefined; @@ -6984,71 +5415,55 @@ export type SolutionStatus = (typeof SolutionStatus)[keyof typeof SolutionStatus */ export interface ListSolutionsRequest { /** - *

Specifies the catalog associated with the request. This field takes a string value - * from a predefined list: AWS or Sandbox. The catalog determines - * which environment the solutions are listed in. Use AWS to list solutions in - * the Amazon Web Services catalog, and Sandbox to list solutions in a secure - * and isolated testing environment.

+ *

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the solutions are listed in. Use AWS to list solutions in the Amazon Web Services catalog, and Sandbox to list solutions in a secure and isolated testing environment.

* @public */ Catalog: string | undefined; /** - *

The maximum number of results returned by a single call. This value must be provided - * in the next call to retrieve the next set of results.

- *

Default: 20

+ *

The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results.

Default: 20

* @public */ MaxResults?: number | undefined; /** - *

A pagination token used to retrieve the next set of results in subsequent calls. This - * token is included in the response only if there are additional result pages - * available.

+ *

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

* @public */ NextToken?: string | undefined; /** - *

Object that configures sorting done on the response. Default Sort.SortBy - * is Identifier.

+ *

Object that configures sorting done on the response. Default Sort.SortBy is Identifier.

* @public */ Sort?: SolutionSort | undefined; /** - *

Filters solutions based on their status. This filter helps partners manage their - * solution portfolios effectively.

+ *

Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.

* @public */ Status?: SolutionStatus[] | undefined; /** - *

Filters the solutions based on their unique identifier. Use this filter to retrieve - * specific solutions by providing the solution's identifier for accurate results.

+ *

Filters the solutions based on their unique identifier. Use this filter to retrieve specific solutions by providing the solution's identifier for accurate results.

* @public */ Identifier?: string[] | undefined; /** - *

Filters the solutions based on the category to which they belong. This allows partners - * to search for solutions within specific categories, such as Software, - * Consulting, or Managed Services.

+ *

Filters the solutions based on the category to which they belong. This allows partners to search for solutions within specific categories, such as Software, Consulting, or Managed Services.

* @public */ Category?: string[] | undefined; } /** - *

Specifies minimal information for the solution offered to solve the customer's - * business problem.

+ *

Specifies minimal information for the solution offered to solve the customer's business problem.

* @public */ export interface SolutionBase { /** - *

Specifies the catalog in which the solution is hosted, either AWS or - * Sandbox. This helps partners differentiate between live solutions and - * those in testing environments.

+ *

Specifies the catalog in which the solution is hosted, either AWS or Sandbox. This helps partners differentiate between live solutions and those in testing environments.

* @public */ Catalog: string | undefined; @@ -7072,23 +5487,13 @@ export interface SolutionBase { Name: string | undefined; /** - *

Specifies the solution's current status, which indicates its state in the system. - * Valid values: Active | Inactive | Draft. The - * status helps partners and Amazon Web Services track the solution's lifecycle and - * availability. Filter for Active solutions for association to an - * opportunity.

+ *

Specifies the solution's current status, which indicates its state in the system. Valid values: Active | Inactive | Draft. The status helps partners and Amazon Web Services track the solution's lifecycle and availability. Filter for Active solutions for association to an opportunity.

* @public */ Status: SolutionStatus | undefined; /** - *

Specifies the solution category, which helps to categorize and organize the solutions - * partners offer. Valid values: Software Product | Consulting - * Service | Hardware Product | Communications Product - * | Professional Service | Managed Service | Value-Added - * Resale Amazon Web Services Service | Distribution Service | - * Training Service | Merger and Acquisition Advising - * Service.

+ *

Specifies the solution category, which helps to categorize and organize the solutions partners offer. Valid values: Software Product | Consulting Service | Hardware Product | Communications Product | Professional Service | Managed Service | Value-Added Resale Amazon Web Services Service | Distribution Service | Training Service | Merger and Acquisition Advising Service.

* @public */ Category: string | undefined; @@ -7111,9 +5516,7 @@ export interface ListSolutionsResponse { SolutionSummaries: SolutionBase[] | undefined; /** - *

A pagination token used to retrieve the next set of results in subsequent calls. This - * token is included in the response only if there are additional result pages - * available.

+ *

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

* @public */ NextToken?: string | undefined; @@ -7130,7 +5533,7 @@ export interface TagResourceRequest { ResourceArn: string | undefined; /** - *

A map of the key-value pairs of the tag or tags to assign to the resource.

+ *

A map of the key-value pairs of the tag or tags to assign.

* @public */ Tags: Tag[] | undefined; @@ -7152,8 +5555,7 @@ export interface UntagResourceRequest { ResourceArn: string | undefined; /** - *

The keys of the key-value pairs for the tag or tags you want to remove from the - * specified resource.

+ *

The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.

* @public */ TagKeys: string[] | undefined; @@ -7193,6 +5595,7 @@ export const AccountFilterSensitiveLog = (obj: Account): any => ({ */ export const AccountReceiverFilterSensitiveLog = (obj: AccountReceiver): any => ({ ...obj, + ...(obj.Alias && { Alias: SENSITIVE_STRING }), ...(obj.AwsAccountId && { AwsAccountId: SENSITIVE_STRING }), }); @@ -7298,6 +5701,7 @@ export const AwsTeamMemberFilterSensitiveLog = (obj: AwsTeamMember): any => ({ */ export const EngagementCustomerFilterSensitiveLog = (obj: EngagementCustomer): any => ({ ...obj, + ...(obj.CompanyName && { CompanyName: SENSITIVE_STRING }), ...(obj.WebsiteUrl && { WebsiteUrl: SENSITIVE_STRING }), ...(obj.CountryCode && { CountryCode: SENSITIVE_STRING }), }); @@ -7358,6 +5762,7 @@ export const GetEngagementResponseFilterSensitiveLog = (obj: GetEngagementRespon */ export const EngagementMemberFilterSensitiveLog = (obj: EngagementMember): any => ({ ...obj, + ...(obj.CompanyName && { CompanyName: SENSITIVE_STRING }), ...(obj.AccountId && { AccountId: SENSITIVE_STRING }), }); @@ -7455,6 +5860,7 @@ export const ReceiverFilterSensitiveLog = (obj: Receiver): any => { */ export const InvitationFilterSensitiveLog = (obj: Invitation): any => ({ ...obj, + ...(obj.Message && { Message: SENSITIVE_STRING }), ...(obj.Receiver && { Receiver: ReceiverFilterSensitiveLog(obj.Receiver) }), ...(obj.Payload && { Payload: PayloadFilterSensitiveLog(obj.Payload) }), }); @@ -7467,6 +5873,14 @@ export const CreateEngagementInvitationRequestFilterSensitiveLog = (obj: CreateE ...(obj.Invitation && { Invitation: InvitationFilterSensitiveLog(obj.Invitation) }), }); +/** + * @internal + */ +export const EngagementMemberSummaryFilterSensitiveLog = (obj: EngagementMemberSummary): any => ({ + ...obj, + ...(obj.CompanyName && { CompanyName: SENSITIVE_STRING }), +}); + /** * @internal */ @@ -7475,6 +5889,10 @@ export const GetEngagementInvitationResponseFilterSensitiveLog = (obj: GetEngage ...(obj.SenderAwsAccountId && { SenderAwsAccountId: SENSITIVE_STRING }), ...(obj.Receiver && { Receiver: ReceiverFilterSensitiveLog(obj.Receiver) }), ...(obj.Payload && { Payload: PayloadFilterSensitiveLog(obj.Payload) }), + ...(obj.InvitationMessage && { InvitationMessage: SENSITIVE_STRING }), + ...(obj.ExistingMembers && { + ExistingMembers: obj.ExistingMembers.map((item) => EngagementMemberSummaryFilterSensitiveLog(item)), + }), }); /** diff --git a/codegen/sdk-codegen/aws-models/partnercentral-selling.json b/codegen/sdk-codegen/aws-models/partnercentral-selling.json index 8c05892f4330b..d03ed896e654a 100644 --- a/codegen/sdk-codegen/aws-models/partnercentral-selling.json +++ b/codegen/sdk-codegen/aws-models/partnercentral-selling.json @@ -5,9 +5,15 @@ "type": "service", "version": "2022-07-26", "operations": [ + { + "target": "com.amazonaws.partnercentralselling#GetSellingSystemSettings" + }, { "target": "com.amazonaws.partnercentralselling#ListTagsForResource" }, + { + "target": "com.amazonaws.partnercentralselling#PutSellingSystemSettings" + }, { "target": "com.amazonaws.partnercentralselling#TagResource" }, @@ -37,9 +43,6 @@ { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJob" }, - { - "target": "com.amazonaws.partnercentralselling#SellingSystemSettings" - }, { "target": "com.amazonaws.partnercentralselling#Solution" } @@ -66,11 +69,26 @@ "type": "String", "relativeDocumentation": "page.html#Catalog", "documentation": "Filters access by a specific Catalog. Accepted values: [AWS, Sandbox]" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the tags that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the tags associated with the resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by the tag keys that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" } }, "aws.iam#supportedPrincipalTypes": ["Root", "IAMUser", "IAMRole", "FederatedUser"], "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "AWS Partner Central API for Selling\n

\n AWS Partner Central API for Selling Reference\n Guide\n

\n

This Amazon Web Services (AWS) Partner Central API reference is designed to help\n AWS Partners integrate\n Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can\n automate interactions with AWS Partner Central, which helps to ensure effective\n engagements in joint business activities.

\n

The API provides standard AWS API functionality. Access it by either using API Actions or by using an AWS SDK that's tailored to your programming language\n or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.

\n

\n Features offered by AWS Partner Central API\n

\n
    \n
  1. \n

    \n Opportunity management: Manages coselling\n opportunities through API actions such as CreateOpportunity,\n UpdateOpportunity, ListOpportunities,\n GetOpportunity, and AssignOpportunity.

    \n
    2. \n
  2. \n

    \n AWS referral management: Manages referrals\n shared by AWS using actions such as ListEngagementInvitations,\n GetEngagementInvitation,\n StartEngagementByAcceptingInvitation, and\n RejectEngagementInvitation.

    \n
    3. \n
  3. \n

    \n Entity association: Associates related\n entities such as AWS Products, Partner\n Solutions, and AWS Marketplace Private\n Offers with opportunities using the actions\n AssociateOpportunity, and\n DisassociateOpportunity.

    \n
    4. \n
  4. \n

    \n View AWS opportunity details: Retrieves\n real-time summaries of AWS opportunities using the\n GetAWSOpportunitySummary action.

    \n
    5. \n
  5. \n

    \n List solutions: Provides list APIs for\n listing partner offers using ListSolutions.

    \n
    6. \n
  6. \n

    \n Event subscription: Subscribe to real-time\n opportunity updates through AWS EventBridge by using actions such as\n Opportunity Created, Opportunity\n Updated, Engagement Invitation Accepted,\n Engagement Invitation Rejected, and\n Engagement Invitation Created.

    \n
    7. \n
", + "smithy.api#documentation": "AWS Partner Central API for Selling

AWS Partner Central API for Selling Reference Guide

This Amazon Web Services (AWS) Partner Central API reference is designed to help AWS Partners integrate Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can automate interactions with AWS Partner Central, which helps to ensure effective engagements in joint business activities.

The API provides standard AWS API functionality. Access it by either using API Actions or by using an AWS SDK that's tailored to your programming language or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.

Features offered by AWS Partner Central API

  1. Opportunity management: Manages coselling opportunities through API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity.

  2. AWS referral management: Manages referrals shared by AWS using actions such as ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation.

  3. Entity association: Associates related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity, and DisassociateOpportunity.

  4. View AWS opportunity details: Retrieves real-time summaries of AWS opportunities using the GetAWSOpportunitySummary action.

  5. List solutions: Provides list APIs for listing partner offers using ListSolutions.

  6. Event subscription: Subscribe to real-time opportunity updates through AWS EventBridge by using actions such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected, and Engagement Invitation Created.

", "smithy.api#title": "Partner Central Selling API", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -445,7 +463,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to accept Engagement Invitations on AWS Partner Central" }, - "smithy.api#documentation": "

Use the AcceptEngagementInvitation action to accept an engagement\n invitation shared by AWS. Accepting the invitation indicates your willingness to\n participate in the engagement, granting you access to all engagement-related\n data.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/AcceptEngagementInvitation", @@ -459,14 +477,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

The CatalogType parameter specifies the catalog associated with the\n engagement invitation. Accepted values are AWS and Sandbox,\n which determine the environment in which the engagement invitation is managed.

", + "smithy.api#documentation": "

The CatalogType parameter specifies the catalog associated with the engagement invitation. Accepted values are AWS and Sandbox, which determine the environment in which the engagement invitation is managed.

", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationArnOrIdentifier", "traits": { - "smithy.api#documentation": "

The Identifier parameter in the\n AcceptEngagementInvitationRequest specifies the unique identifier of\n the EngagementInvitation to be accepted. Providing the correct identifier\n ensures that the intended invitation is accepted.

", + "smithy.api#documentation": "

The Identifier parameter in the AcceptEngagementInvitationRequest specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier ensures that the intended invitation is accepted.

", "smithy.api#required": {} } } @@ -483,7 +501,7 @@ } }, "traits": { - "smithy.api#documentation": "

This error occurs when you don't have permission to perform the requested\n action.

\n

You don’t have access to this action or resource. Review IAM policies or contact your\n AWS administrator for assistance.

", + "smithy.api#documentation": "

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -494,13 +512,13 @@ "Industry": { "target": "com.amazonaws.partnercentralselling#Industry", "traits": { - "smithy.api#documentation": "

Specifies the industry the end Customer belongs to that's associated with\n the Opportunity. It refers to the category or sector where the customer's\n business operates. This is a required field.

" + "smithy.api#documentation": "

Specifies the industry the end Customer belongs to that's associated with the Opportunity. It refers to the category or sector where the customer's business operates. This is a required field.

" } }, "OtherIndustry": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's industry associated with the\n Opportunity, when the selected value in the Industry field\n is Other.

", + "smithy.api#documentation": "

Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other.

", "smithy.api#length": { "max": 255 } @@ -509,7 +527,7 @@ "CompanyName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's company name associated with the\n Opportunity.

", + "smithy.api#documentation": "

Specifies the end Customer's company name associated with the Opportunity.

", "smithy.api#length": { "max": 120 }, @@ -519,19 +537,19 @@ "WebsiteUrl": { "target": "com.amazonaws.partnercentralselling#WebsiteUrl", "traits": { - "smithy.api#documentation": "

Specifies the end customer's company website URL associated with the\n Opportunity. This value is crucial to map the customer within the\n Amazon Web Services CRM system. This field is required in all cases except when the\n opportunity is related to national security.

" + "smithy.api#documentation": "

Specifies the end customer's company website URL associated with the Opportunity. This value is crucial to map the customer within the Amazon Web Services CRM system. This field is required in all cases except when the opportunity is related to national security.

" } }, "AwsAccountId": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#documentation": "

Specifies the Customer\n Amazon Web Services account ID associated with the Opportunity.

" + "smithy.api#documentation": "

Specifies the Customer Amazon Web Services account ID associated with the Opportunity.

" } }, "Address": { "target": "com.amazonaws.partnercentralselling#Address", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's address details associated with the\n Opportunity.

" + "smithy.api#documentation": "

Specifies the end Customer's address details associated with the Opportunity.

" } }, "Duns": { @@ -542,7 +560,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the Customer's account details associated with the\n Opportunity.

" + "smithy.api#documentation": "

Specifies the Customer's account details associated with the Opportunity.

" } }, "com.amazonaws.partnercentralselling#AccountReceiver": { @@ -551,19 +569,19 @@ "Alias": { "target": "com.amazonaws.partnercentralselling#Alias", "traits": { - "smithy.api#documentation": "

Represents the alias of the partner account receiving the Engagement Invitation,\n making it easier to identify and track the recipient in reports or logs.

" + "smithy.api#documentation": "

Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.

" } }, "AwsAccountId": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#documentation": "

Indicates the AWS account ID of the partner who received the Engagement Invitation.\n This is a unique identifier for managing engagements with specific AWS accounts.

", + "smithy.api#documentation": "

Indicates the AWS account ID of the partner who received the Engagement Invitation. This is a unique identifier for managing engagements with specific AWS accounts.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains the account details of the partner who received the Engagement Invitation,\n including the AWS account ID and company name.

" + "smithy.api#documentation": "

Contains the account details of the partner who received the Engagement Invitation, including the AWS account ID and company name.

" } }, "com.amazonaws.partnercentralselling#AccountSummary": { @@ -572,13 +590,13 @@ "Industry": { "target": "com.amazonaws.partnercentralselling#Industry", "traits": { - "smithy.api#documentation": "

Specifies which industry the end Customer belongs to associated with the\n Opportunity. It refers to the category or sector that the customer's\n business operates in.

\n

To submit a value outside the picklist, use Other.

\n

Conditionally mandatory if Other is selected for Industry Vertical in\n LOVs.

" + "smithy.api#documentation": "

Specifies which industry the end Customer belongs to associated with the Opportunity. It refers to the category or sector that the customer's business operates in.

To submit a value outside the picklist, use Other.

Conditionally mandatory if Other is selected for Industry Vertical in LOVs.

" } }, "OtherIndustry": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's industry associated with the \n Opportunity, when the selected value in the Industry field is\n Other. This field is relevant when the customer's industry doesn't fall\n under the predefined picklist values and requires a custom description.

", + "smithy.api#documentation": "

Specifies the end Customer's industry associated with the Opportunity, when the selected value in the Industry field is Other. This field is relevant when the customer's industry doesn't fall under the predefined picklist values and requires a custom description.

", "smithy.api#length": { "max": 255 } @@ -587,7 +605,7 @@ "CompanyName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's company name associated with the\n Opportunity.

", + "smithy.api#documentation": "

Specifies the end Customer's company name associated with the Opportunity.

", "smithy.api#length": { "max": 120 }, @@ -597,13 +615,13 @@ "WebsiteUrl": { "target": "com.amazonaws.partnercentralselling#WebsiteUrl", "traits": { - "smithy.api#documentation": "

Specifies the end customer's company website URL associated with the\n Opportunity. This value is crucial to map the customer within the\n Amazon Web Services CRM system.

" + "smithy.api#documentation": "

Specifies the end customer's company website URL associated with the Opportunity. This value is crucial to map the customer within the Amazon Web Services CRM system.

" } }, "Address": { "target": "com.amazonaws.partnercentralselling#AddressSummary", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's address details associated with the\n Opportunity.

" + "smithy.api#documentation": "

Specifies the end Customer's address details associated with the Opportunity.

" } } }, @@ -617,7 +635,7 @@ "City": { "target": "com.amazonaws.partnercentralselling#AddressPart", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's city associated with the\n Opportunity.

", + "smithy.api#documentation": "

Specifies the end Customer's city associated with the Opportunity.

", "smithy.api#length": { "max": 255 } @@ -626,7 +644,7 @@ "PostalCode": { "target": "com.amazonaws.partnercentralselling#AddressPart", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's postal code associated with the\n Opportunity.

", + "smithy.api#documentation": "

Specifies the end Customer's postal code associated with the Opportunity.

", "smithy.api#length": { "max": 20 } @@ -635,19 +653,19 @@ "StateOrRegion": { "target": "com.amazonaws.partnercentralselling#AddressPart", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's state or region associated with the\n Opportunity.

\n

Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas |\n California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated\n States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois |\n Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland\n | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska\n | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina |\n North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau |\n Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota |\n Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West\n Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP\n

" + "smithy.api#documentation": "

Specifies the end Customer's state or region associated with the Opportunity.

Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

" } }, "CountryCode": { "target": "com.amazonaws.partnercentralselling#CountryCode", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's country associated with the\n Opportunity.

" + "smithy.api#documentation": "

Specifies the end Customer's country associated with the Opportunity.

" } }, "StreetAddress": { "target": "com.amazonaws.partnercentralselling#AddressPart", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's street address associated with the\n Opportunity.

", + "smithy.api#documentation": "

Specifies the end Customer's street address associated with the Opportunity.

", "smithy.api#length": { "max": 255 } @@ -655,7 +673,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies the end Customer's address details associated with the\n Opportunity.

" + "smithy.api#documentation": "

Specifies the end Customer's address details associated with the Opportunity.

" } }, "com.amazonaws.partnercentralselling#AddressPart": { @@ -670,7 +688,7 @@ "City": { "target": "com.amazonaws.partnercentralselling#AddressPart", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's city associated with the\n Opportunity.

", + "smithy.api#documentation": "

Specifies the end Customer's city associated with the Opportunity.

", "smithy.api#length": { "max": 255 } @@ -679,7 +697,7 @@ "PostalCode": { "target": "com.amazonaws.partnercentralselling#AddressPart", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's postal code associated with the\n Opportunity.

", + "smithy.api#documentation": "

Specifies the end Customer's postal code associated with the Opportunity.

", "smithy.api#length": { "max": 20 } @@ -688,13 +706,13 @@ "StateOrRegion": { "target": "com.amazonaws.partnercentralselling#AddressPart", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's state or region associated with the\n Opportunity.

\n

Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas |\n California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated\n States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois |\n Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland\n | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska\n | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina |\n North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau |\n Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota |\n Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West\n Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP\n

" + "smithy.api#documentation": "

Specifies the end Customer's state or region associated with the Opportunity.

Valid values: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

" } }, "CountryCode": { "target": "com.amazonaws.partnercentralselling#CountryCode", "traits": { - "smithy.api#documentation": "

Specifies the end Customer's country associated with the\n Opportunity.

" + "smithy.api#documentation": "

Specifies the end Customer's country associated with the Opportunity.

" } } }, @@ -709,7 +727,7 @@ "min": 0, "max": 80 }, - "smithy.api#pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}]+$" + "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#ApnPrograms": { @@ -748,7 +766,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to assign Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "

Enables you to reassign an existing Opportunity to another user within\n your Partner Central account. The specified user receives the opportunity, and it\n appears on their Partner Central dashboard, allowing them to take necessary actions or\n proceed with the opportunity.

\n

This is useful for distributing opportunities to the appropriate team members or\n departments within your organization, ensuring that each opportunity is handled by the\n right person. By default, the opportunity owner is the one who creates it. Currently,\n there's no API to enumerate the list of available users.

", + "smithy.api#documentation": "

Enables 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 who creates it. Currently, there's no API to enumerate the list of available users.

", "smithy.api#http": { "method": "POST", "uri": "/AssignOpportunity", @@ -762,14 +780,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity is assigned in. Use AWS to assign real\n opportunities in the Amazon Web Services catalog, and Sandbox for testing in\n secure, isolated environments.

", + "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is assigned in. Use AWS to assign real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "

Requires the Opportunity's unique identifier when you want to assign it\n to another user. Provide the correct identifier so the intended opportunity is\n reassigned.

", + "smithy.api#documentation": "

Requires the Opportunity's unique identifier when you want to assign it to another user. Provide the correct identifier so the intended opportunity is reassigned.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } @@ -777,7 +795,7 @@ "Assignee": { "target": "com.amazonaws.partnercentralselling#AssigneeContact", "traits": { - "smithy.api#documentation": "

Specifies the user or team member responsible for managing the assigned opportunity.\n This field identifies the Assignee based on the partner's internal\n team structure. Ensure that the email address is associated with a registered user in\n your Partner Central account.

", + "smithy.api#documentation": "

Specifies the user or team member responsible for managing the assigned opportunity. This field identifies the Assignee based on the partner's internal team structure. Ensure that the email address is associated with a registered user in your Partner Central account.

", "smithy.api#required": {} } } @@ -792,14 +810,14 @@ "Email": { "target": "com.amazonaws.partnercentralselling#Email", "traits": { - "smithy.api#documentation": "

Provides the email address of the assignee. This email is used for communications and\n notifications related to the opportunity.

", + "smithy.api#documentation": "

Provides the email address of the assignee. This email is used for communications and notifications related to the opportunity.

", "smithy.api#required": {} } }, "FirstName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { - "smithy.api#documentation": "

Specifies the first name of the assignee managing the opportunity. The system\n automatically retrieves this value from the user profile by referencing the associated\n email address.

", + "smithy.api#documentation": "

Specifies the first name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.

", "smithy.api#length": { "max": 80 }, @@ -809,7 +827,7 @@ "LastName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { - "smithy.api#documentation": "

Specifies the last name of the assignee managing the opportunity. The system\n automatically retrieves this value from the user profile by referencing the associated\n email address.

", + "smithy.api#documentation": "

Specifies the last name of the assignee managing the opportunity. The system automatically retrieves this value from the user profile by referencing the associated email address.

", "smithy.api#length": { "max": 80 }, @@ -819,13 +837,13 @@ "BusinessTitle": { "target": "com.amazonaws.partnercentralselling#JobTitle", "traits": { - "smithy.api#documentation": "

Specifies the business title of the assignee managing the opportunity. This helps\n clarify the individual's role and responsibilities within the organization. Use the\n value PartnerAccountManager to update details of the opportunity\n owner.

", + "smithy.api#documentation": "

Specifies the business title of the assignee managing the opportunity. This helps clarify the individual's role and responsibilities within the organization. Use the value PartnerAccountManager to update details of the opportunity owner.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Represents the contact details of the individual assigned to manage the opportunity\n within the partner organization. This helps to ensure that there is a point of contact\n for the opportunity's progress.

" + "smithy.api#documentation": "

Represents the contact details of the individual assigned to manage the opportunity within the partner organization. This helps to ensure that there is a point of contact for the opportunity's progress.

" } }, "com.amazonaws.partnercentralselling#AssociateOpportunity": { @@ -858,7 +876,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to associate Opportunities on AWS Partner Central with other entities" }, - "smithy.api#documentation": "

Enables you to create a formal association between an Opportunity and\n various related entities, enriching the context and details of the opportunity for\n better collaboration and decision making. You can associate an opportunity with the\n following entity types:

\n \n

To obtain identifiers for these entities, use the following methods:

\n ", + "smithy.api#documentation": "

Enables 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:

To obtain identifiers for these entities, use the following methods:

", "smithy.api#http": { "method": "POST", "uri": "/AssociateOpportunity", @@ -872,14 +890,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity association is made in. Use AWS to\n associate opportunities in the Amazon Web Services catalog, and Sandbox for\n testing in secure, isolated environments.

", + "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

", "smithy.api#required": {} } }, "OpportunityIdentifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "

Requires the Opportunity's unique identifier when you want to associate\n it with a related entity. Provide the correct identifier so the intended opportunity is\n updated with the association.

", + "smithy.api#documentation": "

Requires the Opportunity's unique identifier when you want to associate it with a related entity. Provide the correct identifier so the intended opportunity is updated with the association.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } @@ -887,14 +905,14 @@ "RelatedEntityType": { "target": "com.amazonaws.partnercentralselling#RelatedEntityType", "traits": { - "smithy.api#documentation": "

Specifies the entity type that you're associating with the Opportunity.\n This helps to categorize and properly process the association.

", + "smithy.api#documentation": "

Specifies the entity type that you're associating with the Opportunity. This helps to categorize and properly process the association.

", "smithy.api#required": {} } }, "RelatedEntityIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Requires the related entity's unique identifier when you want to associate it with the\n Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon\n Resource Name (ARN). Use the \n Amazon Web Services Marketplace API to obtain the ARN.

", + "smithy.api#documentation": "

Requires the related entity's unique identifier when you want to associate it with the Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon Resource Name (ARN). Use the Amazon Web Services Marketplace API to obtain the ARN.

", "smithy.api#length": { "min": 1, "max": 255 @@ -1307,12 +1325,12 @@ "Contacts": { "target": "com.amazonaws.partnercentralselling#CustomerContactsList", "traits": { - "smithy.api#documentation": "

Provides a list of customer contacts involved in the opportunity. These contacts may\n include decision makers, influencers, and other stakeholders within the customer's\n organization.

" + "smithy.api#documentation": "

Provides a list of customer contacts involved in the opportunity. These contacts may include decision makers, influencers, and other stakeholders within the customer's organization.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the customer associated with the AWS opportunity. This field captures key\n details about the customer that are necessary for managing the opportunity.

" + "smithy.api#documentation": "

Represents the customer associated with the AWS opportunity. This field captures key details about the customer that are necessary for managing the opportunity.

" } }, "com.amazonaws.partnercentralselling#AwsOpportunityInsights": { @@ -1321,18 +1339,18 @@ "NextBestActions": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Provides recommendations from AWS on the next best actions to take in order to move\n the opportunity forward and increase the likelihood of success.

" + "smithy.api#documentation": "

Provides recommendations from AWS on the next best actions to take in order to move the opportunity forward and increase the likelihood of success.

" } }, "EngagementScore": { "target": "com.amazonaws.partnercentralselling#EngagementScore", "traits": { - "smithy.api#documentation": "

Represents a score assigned by AWS to indicate the level of engagement and potential\n success for the opportunity. This score helps partners prioritize their efforts.

" + "smithy.api#documentation": "

Represents a score assigned by AWS to indicate the level of engagement and potential success for the opportunity. This score helps partners prioritize their efforts.

" } } }, "traits": { - "smithy.api#documentation": "

Contains insights provided by AWS for the opportunity, offering recommendations and\n analysis that can help the partner optimize their engagement and strategy.

" + "smithy.api#documentation": "

Contains insights provided by AWS for the opportunity, offering recommendations and analysis that can help the partner optimize their engagement and strategy.

" } }, "com.amazonaws.partnercentralselling#AwsOpportunityLifeCycle": { @@ -1341,25 +1359,25 @@ "TargetCloseDate": { "target": "com.amazonaws.partnercentralselling#Date", "traits": { - "smithy.api#documentation": "

Indicates the expected date by which the opportunity is projected to close. This field\n helps in planning resources and timelines for both the partner and AWS.

" + "smithy.api#documentation": "

Indicates the expected date by which the opportunity is projected to close. This field helps in planning resources and timelines for both the partner and AWS.

" } }, "ClosedLostReason": { "target": "com.amazonaws.partnercentralselling#AwsClosedLostReason", "traits": { - "smithy.api#documentation": "

Indicates the reason why an opportunity was marked as Closed Lost. This\n helps in understanding the context behind the lost opportunity and aids in refining\n future strategies.

" + "smithy.api#documentation": "

Indicates the reason why an opportunity was marked as Closed Lost. This helps in understanding the context behind the lost opportunity and aids in refining future strategies.

" } }, "Stage": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityStage", "traits": { - "smithy.api#documentation": "

Represents the current stage of the opportunity in its lifecycle, such as\n Qualification, Validation, or Closed Won.\n This helps in understanding the opportunity's progress.

" + "smithy.api#documentation": "

Represents the current stage of the opportunity in its lifecycle, such as Qualification, Validation, or Closed Won. This helps in understanding the opportunity's progress.

" } }, "NextSteps": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { - "smithy.api#documentation": "

Specifies the immediate next steps required to progress the opportunity. These steps\n are based on AWS guidance and the current stage of the opportunity.

", + "smithy.api#documentation": "

Specifies the immediate next steps required to progress the opportunity. These steps are based on AWS guidance and the current stage of the opportunity.

", "smithy.api#length": { "max": 255 } @@ -1368,7 +1386,7 @@ "NextStepsHistory": { "target": "com.amazonaws.partnercentralselling#ProfileNextStepsHistories", "traits": { - "smithy.api#documentation": "

Provides a historical log of previous next steps that were taken to move the\n opportunity forward. This helps in tracking the decision-making process and identifying\n any delays or obstacles encountered.

", + "smithy.api#documentation": "

Provides a historical log of previous next steps that were taken to move the opportunity forward. This helps in tracking the decision-making process and identifying any delays or obstacles encountered.

", "smithy.api#length": { "max": 50 } @@ -1376,7 +1394,7 @@ } }, "traits": { - "smithy.api#documentation": "

Tracks the lifecycle of the AWS opportunity, including stages such as qualification,\n validation, and closure. This field helps partners understand the current status and\n progression of the opportunity.

" + "smithy.api#documentation": "

Tracks the lifecycle of the AWS opportunity, including stages such as qualification, validation, and closure. This field helps partners understand the current status and progression of the opportunity.

" } }, "com.amazonaws.partnercentralselling#AwsOpportunityProject": { @@ -1385,12 +1403,12 @@ "ExpectedCustomerSpend": { "target": "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList", "traits": { - "smithy.api#documentation": "

Indicates the expected spending by the customer over the course of the project. This\n value helps partners and AWS estimate the financial impact of the opportunity. Use the\n AWS Pricing Calculator to create an\n estimate of the customer’s total spend. If only annual recurring revenue (ARR) is\n available, distribute it across 12 months to provide an average monthly value.

" + "smithy.api#documentation": "

Indicates the expected spending by the customer over the course of the project. This value helps partners and AWS estimate the financial impact of the opportunity. Use the AWS Pricing Calculator to create an estimate of the customer’s total spend. If only annual recurring revenue (ARR) is available, distribute it across 12 months to provide an average monthly value.

" } } }, "traits": { - "smithy.api#documentation": "

Captures details about the project associated with the opportunity, including\n objectives, scope, and customer requirements.

" + "smithy.api#documentation": "

Captures details about the project associated with the opportunity, including objectives, scope, and customer requirements.

" } }, "com.amazonaws.partnercentralselling#AwsOpportunityRelatedEntities": { @@ -1399,18 +1417,18 @@ "AwsProducts": { "target": "com.amazonaws.partnercentralselling#AwsProductIdentifiers", "traits": { - "smithy.api#documentation": "

Specifies the AWS products associated with the opportunity. This field helps track the\n specific products that are part of the proposed solution.

" + "smithy.api#documentation": "

Specifies the AWS products associated with the opportunity. This field helps track the specific products that are part of the proposed solution.

" } }, "Solutions": { "target": "com.amazonaws.partnercentralselling#SolutionIdentifiers", "traits": { - "smithy.api#documentation": "

Specifies the partner solutions related to the opportunity. These solutions represent\n the partner's offerings that are being positioned as part of the overall AWS\n opportunity.

" + "smithy.api#documentation": "

Specifies the partner solutions related to the opportunity. These solutions represent the partner's offerings that are being positioned as part of the overall AWS opportunity.

" } } }, "traits": { - "smithy.api#documentation": "

Represents other entities related to the AWS opportunity, such as AWS products,\n partner solutions, and marketplace offers. These associations help build a complete\n picture of the solution being sold.

" + "smithy.api#documentation": "

Represents other entities related to the AWS opportunity, such as AWS products, partner solutions, and marketplace offers. These associations help build a complete picture of the solution being sold.

" } }, "com.amazonaws.partnercentralselling#AwsOpportunityStage": { @@ -1583,19 +1601,19 @@ "InvolvementType": { "target": "com.amazonaws.partnercentralselling#SalesInvolvementType", "traits": { - "smithy.api#documentation": "

Specifies the type of AWS involvement in the opportunity, such as coselling, deal\n support, or technical consultation. This helps categorize the nature of AWS\n participation.

", + "smithy.api#documentation": "

Specifies the type of AWS involvement in the opportunity, such as coselling, deal support, or technical consultation. This helps categorize the nature of AWS participation.

", "smithy.api#required": {} } }, "Visibility": { "target": "com.amazonaws.partnercentralselling#Visibility", "traits": { - "smithy.api#documentation": "

Determines who can view AWS involvement in the opportunity. Typically, this field is\n set to Full for most cases, but it may be restricted based on special\n program requirements or confidentiality needs.

" + "smithy.api#documentation": "

Determines who can view AWS involvement in the opportunity. Typically, this field is set to Full for most cases, but it may be restricted based on special program requirements or confidentiality needs.

" } } }, "traits": { - "smithy.api#documentation": "

Indicates the level of AWS involvement in the opportunity. This field helps track AWS\n participation throughout the engagement, such as providing technical support, deal\n assistance, and sales support.

" + "smithy.api#documentation": "

Indicates the level of AWS involvement in the opportunity. This field helps track AWS participation throughout the engagement, such as providing technical support, deal assistance, and sales support.

" } }, "com.amazonaws.partnercentralselling#AwsTeamMember": { @@ -1628,12 +1646,12 @@ "BusinessTitle": { "target": "com.amazonaws.partnercentralselling#AwsMemberBusinessTitle", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Web Services team member's business title and indicates their\n organizational role.

" + "smithy.api#documentation": "

Specifies the Amazon Web Services team member's business title and indicates their organizational role.

" } } }, "traits": { - "smithy.api#documentation": "

Represents an Amazon Web Services team member for the engagement. This structure\n includes details such as name, email, and business title.

" + "smithy.api#documentation": "

Represents an Amazon Web Services team member for the engagement. This structure includes details such as name, email, and business title.

" } }, "com.amazonaws.partnercentralselling#CatalogIdentifier": { @@ -1863,7 +1881,7 @@ "min": 1, "max": 120 }, - "smithy.api#pattern": "^[\\p{L}\\p{N}\\p{P}\\p{Z}]+$" + "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#CompanyWebsiteUrl": { @@ -1956,7 +1974,7 @@ } }, "traits": { - "smithy.api#documentation": "

This error occurs when the request can’t be processed due to a conflict with the\n target resource's current state, which could result from updating or deleting the\n resource.

\n

Suggested action: Fetch the latest state of the resource, verify the state, and retry\n the request.

", + "smithy.api#documentation": "

This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.

Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1991,7 +2009,7 @@ "BusinessTitle": { "target": "com.amazonaws.partnercentralselling#JobTitle", "traits": { - "smithy.api#documentation": "

The partner contact's title (job title or role) associated with the\n Opportunity. BusinessTitle supports either\n PartnerAccountManager or OpportunityOwner.

" + "smithy.api#documentation": "

The partner contact's title (job title or role) associated with the Opportunity. BusinessTitle supports either PartnerAccountManager or OpportunityOwner.

" } }, "Phone": { @@ -3540,7 +3558,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to creating engagements in AWS Partner Central" }, - "smithy.api#documentation": "

The CreateEngagement action allows you to create an\n Engagement, which serves as a collaborative space between different\n parties such as AWS Partners and AWS Sellers. This action automatically adds the\n caller's AWS account as an active member of the newly created\n Engagement.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/CreateEngagement", @@ -3582,7 +3600,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to creating engagement invitations in AWS Partner Central" }, - "smithy.api#documentation": "

This action creates an invitation from a sender to a single receiver to join an\n engagement.

", + "smithy.api#documentation": "

This action creates an invitation from a sender to a single receiver to join an engagement.

", "smithy.api#http": { "method": "POST", "uri": "/CreateEngagementInvitation", @@ -3597,14 +3615,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog related to the engagement. Accepted values are AWS\n and Sandbox, which determine the environment in which the engagement is\n managed.

", + "smithy.api#documentation": "

Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.partnercentralselling#ClientToken", "traits": { - "smithy.api#documentation": "

Specifies a unique, client-generated UUID to ensure that the request is handled\n exactly once. This token helps prevent duplicate invitation creations.

", + "smithy.api#documentation": "

Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -3612,14 +3630,14 @@ "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the Engagement associated with the invitation.\n This parameter ensures the invitation is created within the correct\n Engagement context.

", + "smithy.api#documentation": "

The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.

", "smithy.api#required": {} } }, "Invitation": { "target": "com.amazonaws.partnercentralselling#Invitation", "traits": { - "smithy.api#documentation": "

The Invitation object all information necessary to initiate an\n engagement invitation to a partner. It contains a personalized message from the sender,\n the invitation's receiver, and a payload. The Payload can be the\n OpportunityInvitation, which includes detailed structures for sender\n contacts, partner responsibilities, customer information, and project details.

", + "smithy.api#documentation": "

The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details.

", "smithy.api#required": {} } } @@ -3641,7 +3659,7 @@ "Arn": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.\n

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the engagement invitation.

", "smithy.api#required": {} } } @@ -3656,14 +3674,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

The CreateEngagementRequest$Catalog parameter specifies the catalog\n related to the engagement. Accepted values are AWS and\n Sandbox, which determine the environment in which the engagement is\n managed.

", + "smithy.api#documentation": "

The CreateEngagementRequest$Catalog parameter specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.

", "smithy.api#required": {} } }, "ClientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The CreateEngagementRequest$ClientToken parameter specifies a unique,\n case-sensitive identifier to ensure that the request is handled exactly once. The value\n must not exceed sixty-four alphanumeric characters.

", + "smithy.api#documentation": "

The CreateEngagementRequest$ClientToken parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.

", "smithy.api#idempotencyToken": {}, "smithy.api#pattern": "^[!-~]{1,64}$", "smithy.api#required": {} @@ -3686,7 +3704,7 @@ "Contexts": { "target": "com.amazonaws.partnercentralselling#EngagementContexts", "traits": { - "smithy.api#documentation": "

The Contexts field is a required array of objects, with a maximum of 5\n contexts allowed, specifying detailed information about customer projects associated\n with the Engagement. Each context object contains a Type field indicating\n the context type, which must be CustomerProject in this version, and a\n Payload field containing the CustomerProject details. The\n CustomerProject object is composed of two main components:\n Customer and Project. The Customer object\n includes information such as CompanyName, WebsiteUrl,\n Industry, and CountryCode, providing essential details\n about the customer. The Project object contains Title,\n BusinessProblem, and TargetCompletionDate, offering\n insights into the specific project associated with the customer. This structure allows\n comprehensive context to be included within the Engagement, facilitating effective\n collaboration between parties by providing relevant customer and project\n information.

" + "smithy.api#documentation": "

The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem, and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.

" } } }, @@ -3747,7 +3765,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to create new Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "

Creates an Opportunity record in Partner Central. Use this operation to\n create a potential business opportunity for submission to Amazon Web Services. Creating\n an opportunity sets Lifecycle.ReviewStatus to Pending\n Submission.

\n

To submit an opportunity, follow these steps:

\n
    \n
  1. \n

    To create the opportunity, use CreateOpportunity.

    \n
    2. \n
  2. \n

    To associate a solution with the opportunity, use\n AssociateOpportunity.

    \n
    3. \n
  3. \n

    To start the engagement with AWS, use\n StartEngagementFromOpportunity.

    \n
    4. \n
\n

After submission, you can't edit the opportunity until the review is complete. But\n opportunities in the Pending Submission state must have complete details.\n You can update the opportunity while it's in the Pending Submission\n state.

\n

There's a set of mandatory fields to create opportunities, but consider providing\n optional fields to enrich the opportunity record.

", + "smithy.api#documentation": "

Creates 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:

  1. To create the opportunity, use CreateOpportunity.

  2. To associate a solution with the opportunity, use AssociateOpportunity.

  3. To start the engagement with AWS, use StartEngagementFromOpportunity.

After submission, you can't edit the opportunity until the review is complete. But opportunities in the Pending Submission state must have complete details. You can update the opportunity while it's in the Pending Submission state.

There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.

", "smithy.api#http": { "method": "POST", "uri": "/CreateOpportunity", @@ -3762,26 +3780,26 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity is created in. Use AWS to create\n opportunities in the Amazon Web Services catalog, and Sandbox for testing in\n secure, isolated environments.

", + "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is created in. Use AWS to create opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

", "smithy.api#required": {} } }, "PrimaryNeedsFromAws": { "target": "com.amazonaws.partnercentralselling#PrimaryNeedsFromAws", "traits": { - "smithy.api#documentation": "

Identifies the type of support the partner needs from Amazon Web Services.

\n

Valid values:

\n " + "smithy.api#documentation": "

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

" } }, "NationalSecurity": { "target": "com.amazonaws.partnercentralselling#NationalSecurity", "traits": { - "smithy.api#documentation": "

Indicates whether the Opportunity pertains to a national security\n project. This field must be set to true only when the customer's industry\n is Government. Additional privacy and security measures apply\n during the review and management process for opportunities marked as\n NationalSecurity.

" + "smithy.api#documentation": "

Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.

" } }, "PartnerOpportunityIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the opportunity's unique identifier in the partner's CRM system. This value\n is essential to track and reconcile because it's included in the outbound payload to the\n partner.

\n

This field allows partners to link an opportunity to their CRM, which helps to ensure\n seamless integration and accurate synchronization between the Partner Central API and\n the partner's internal systems.

", + "smithy.api#documentation": "

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload to the partner.

This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems.

", "smithy.api#length": { "max": 64 } @@ -3802,7 +3820,7 @@ "OpportunityType": { "target": "com.amazonaws.partnercentralselling#OpportunityType", "traits": { - "smithy.api#documentation": "

Specifies the opportunity type as a renewal, new, or expansion.

\n

Opportunity types:

\n " + "smithy.api#documentation": "

Specifies the opportunity type as a renewal, new, or expansion.

Opportunity types:

" } }, "Marketing": { @@ -3814,13 +3832,13 @@ "SoftwareRevenue": { "target": "com.amazonaws.partnercentralselling#SoftwareRevenue", "traits": { - "smithy.api#documentation": "

Specifies details of a customer's procurement terms. This is required only for\n partners in eligible programs.

" + "smithy.api#documentation": "

Specifies details of a customer's procurement terms. This is required only for partners in eligible programs.

" } }, "ClientToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Required to be unique, and should be unchanging, it can be randomly generated or a\n meaningful string.

\n

Default: None

\n

Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique\n Identifier (UUID) as the ClientToken. You can use standard libraries from\n most programming languages to generate this. If you use the same client token, the API\n returns the following error: \"Conflicting client token submitted for a new request\n body.\"

", + "smithy.api#documentation": "

Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.

Default: None

Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the ClientToken. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: \"Conflicting client token submitted for a new request body.\"

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1 @@ -3837,13 +3855,13 @@ "Origin": { "target": "com.amazonaws.partnercentralselling#OpportunityOrigin", "traits": { - "smithy.api#documentation": "

Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog:\n AWS, this field must only be Partner Referral. However, when\n using Catalog: Sandbox, you can set this field to AWS Referral\n to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.

" + "smithy.api#documentation": "

Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog: AWS, this field must only be Partner Referral. However, when using Catalog: Sandbox, you can set this field to AWS Referral to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.

" } }, "OpportunityTeam": { "target": "com.amazonaws.partnercentralselling#PartnerOpportunityTeamMembersList", "traits": { - "smithy.api#documentation": "

Represents the internal team handling the opportunity. Specify collaborating members\n of this opportunity who are within the partner's organization.

" + "smithy.api#documentation": "

Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.

" } } }, @@ -3857,20 +3875,20 @@ "Id": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "

Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's used for all subsequent opportunity\n actions, such as updates, associations, and submissions. It helps to ensure that each\n opportunity is accurately tracked and managed.

", + "smithy.api#documentation": "

Read-only, system-generated Opportunity unique identifier. Amazon Web Services creates this identifier, and it's used for all subsequent opportunity actions, such as updates, associations, and submissions. It helps to ensure that each opportunity is accurately tracked and managed.

", "smithy.api#required": {} } }, "PartnerOpportunityIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the opportunity's unique identifier in the partner's CRM system. This value\n is essential to track and reconcile because it's included in the outbound payload sent\n back to the partner.

" + "smithy.api#documentation": "

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

" } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

\n DateTime when the opportunity was last modified. When the\n Opportunity is created, its value is CreatedDate.

" + "smithy.api#documentation": "

DateTime when the opportunity was last modified. When the Opportunity is created, its value is CreatedDate.

" } } }, @@ -3911,7 +3929,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to creating resource snapshots in AWS Partner Central" }, - "smithy.api#documentation": "

This action allows you to create an immutable snapshot of a specific resource, such\n as an opportunity, within the context of an engagement. The snapshot captures a subset\n of the resource's data based on the schema defined by the provided template.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/CreateResourceSnapshot", @@ -3949,10 +3967,11 @@ } ], "traits": { + "aws.iam#conditionKeys": ["partnercentral:Catalog", "aws:RequestTag/${TagKey}", "aws:TagKeys"], "aws.iam#iamAction": { "documentation": "Grants permission to creating resource snapshot jobs in AWS Partner Central" }, - "smithy.api#documentation": "

Use this action to create a job to generate a snapshot of the specified resource\n within an engagement. It initiates an asynchronous process to create a resource\n snapshot. The job creates a new snapshot only if the resource state has changed,\n adhering to the same access control and immutability rules as direct snapshot\n creation.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/CreateResourceSnapshotJob", @@ -3967,14 +3986,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog in which to create the snapshot job. Valid values are\n AWS and Sandbox.

", + "smithy.api#documentation": "

Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.partnercentralselling#ClientToken", "traits": { - "smithy.api#documentation": "

A client-generated UUID used for idempotency check. The token helps prevent duplicate\n job creations.

", + "smithy.api#documentation": "

A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.

", "smithy.api#idempotencyToken": {}, "smithy.api#pattern": "^[!-~]{1,64}$", "smithy.api#required": {} @@ -3983,21 +4002,21 @@ "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the identifier of the engagement associated with the resource to be\n snapshotted.

", + "smithy.api#documentation": "

Specifies the identifier of the engagement associated with the resource to be snapshotted.

", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { - "smithy.api#documentation": "

The type of resource for which the snapshot job is being created. Must be one of the\n supported resource types i.e. Opportunity\n

", + "smithy.api#documentation": "

The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity

", "smithy.api#required": {} } }, "ResourceIdentifier": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the identifier of the specific resource to be snapshotted. The format\n depends on the ResourceType.

", + "smithy.api#documentation": "

Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.

", "smithy.api#required": {} } }, @@ -4011,7 +4030,7 @@ "Tags": { "target": "com.amazonaws.partnercentralselling#TagList", "traits": { - "smithy.api#documentation": "A list of objects specifying each tag name and value." + "smithy.api#documentation": "

A map of the key-value pairs of the tag or tags to assign.

" } } }, @@ -4045,42 +4064,42 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog where the snapshot is created. Valid values are\n AWS and Sandbox.

", + "smithy.api#documentation": "

Specifies the catalog where the snapshot is created. Valid values are AWS and Sandbox.

", "smithy.api#required": {} } }, "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the engagement associated with this snapshot. This field\n links the snapshot to a specific engagement context.

", + "smithy.api#documentation": "

The unique identifier of the engagement associated with this snapshot. This field links the snapshot to a specific engagement context.

", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { - "smithy.api#documentation": "

Specifies the type of resource for which the snapshot is being created. This field\n determines the structure and content of the snapshot. Must be one of the supported\n resource types, such as: Opportunity.

", + "smithy.api#documentation": "

Specifies the type of resource for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: Opportunity.

", "smithy.api#required": {} } }, "ResourceIdentifier": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the specific resource to be snapshotted. The format and\n constraints of this identifier depend on the ResourceType specified. For\n example: For Opportunity type, it will be an opportunity ID.

", + "smithy.api#documentation": "

The unique identifier of the specific resource to be snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For example: For Opportunity type, it will be an opportunity ID.

", "smithy.api#required": {} } }, "ResourceSnapshotTemplateIdentifier": { "target": "com.amazonaws.partnercentralselling#ResourceTemplateName", "traits": { - "smithy.api#documentation": "

The name of the template that defines the schema for the snapshot. This template\n determines which subset of the resource data will be included in the snapshot. Must\n correspond to an existing and valid template for the specified\n ResourceType.

", + "smithy.api#documentation": "

The name of the template that defines the schema for the snapshot. This template determines which subset of the resource data will be included in the snapshot. Must correspond to an existing and valid template for the specified ResourceType.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.partnercentralselling#ClientToken", "traits": { - "smithy.api#documentation": "

Specifies a unique, client-generated UUID to ensure that the request is handled\n exactly once. This token helps prevent duplicate snapshot creations.

", + "smithy.api#documentation": "

Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations.

", "smithy.api#idempotencyToken": {}, "smithy.api#pattern": "^[!-~]{1,64}$", "smithy.api#required": {} @@ -4097,13 +4116,13 @@ "Arn": { "target": "com.amazonaws.partnercentralselling#ResourceArn", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) that uniquely identifies the snapshot\n created.

" + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) that uniquely identifies the snapshot created.

" } }, "Revision": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotRevision", "traits": { - "smithy.api#documentation": "

Specifies the revision number of the created snapshot. This field provides important\n information about the snapshot's place in the sequence of snapshots for the given\n resource.

" + "smithy.api#documentation": "

Specifies the revision number of the created snapshot. This field provides important information about the snapshot's place in the sequence of snapshots for the given resource.

" } } }, @@ -5139,12 +5158,12 @@ "Contacts": { "target": "com.amazonaws.partnercentralselling#CustomerContactsList", "traits": { - "smithy.api#documentation": "

Represents the contact details for individuals associated with the customer of the\n Opportunity. This field captures relevant contacts, including\n decision-makers, influencers, and technical stakeholders within the customer\n organization. These contacts are key to progressing the opportunity.

" + "smithy.api#documentation": "

Represents the contact details for individuals associated with the customer of the Opportunity. This field captures relevant contacts, including decision-makers, influencers, and technical stakeholders within the customer organization. These contacts are key to progressing the opportunity.

" } } }, "traits": { - "smithy.api#documentation": "

An object that contains the customer's Account and\n Contact.

" + "smithy.api#documentation": "

An object that contains the customer's Account and Contact.

" } }, "com.amazonaws.partnercentralselling#CustomerContactsList": { @@ -5167,7 +5186,7 @@ } }, "traits": { - "smithy.api#documentation": "

The CustomerProjects structure in Engagements offers a flexible framework for managing\n customer-project relationships. It supports multiple customers per Engagement and\n multiple projects per customer, while also allowing for customers without projects and\n projects without specific customers.

\n

All Engagement members have full visibility of customers and their associated\n projects, enabling the capture of relevant context even when project details are not\n fully defined. This structure also facilitates targeted invitations, allowing partners\n to focus on specific customers and their business problems when sending Engagement\n invitations.

" + "smithy.api#documentation": "

The CustomerProjects structure in Engagements offers a flexible framework for managing customer-project relationships. It supports multiple customers per Engagement and multiple projects per customer, while also allowing for customers without projects and projects without specific customers.

All Engagement members have full visibility of customers and their associated projects, enabling the capture of relevant context even when project details are not fully defined. This structure also facilitates targeted invitations, allowing partners to focus on specific customers and their business problems when sending Engagement invitations.

" } }, "com.amazonaws.partnercentralselling#CustomerSummary": { @@ -5222,10 +5241,11 @@ } ], "traits": { + "aws.iam#conditionKeys": ["partnercentral:Catalog", "aws:ResourceTag/${TagKey}", "aws:TagKeys"], "aws.iam#iamAction": { "documentation": "Grants permission to deleting resource snapshot jobs on AWS Partner Central" }, - "smithy.api#documentation": "

Use this action to deletes a previously created resource snapshot job. The job must\n be in a stopped state before it can be deleted.

", + "smithy.api#documentation": "

Use this action to deletes a previously created resource snapshot job. The job must be in a stopped state before it can be deleted.

", "smithy.api#http": { "method": "POST", "uri": "/DeleteResourceSnapshotJob", @@ -5240,7 +5260,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog from which to delete the snapshot job. Valid values are\n AWS and Sandbox.

", + "smithy.api#documentation": "

Specifies the catalog from which to delete the snapshot job. Valid values are AWS and Sandbox.

", "smithy.api#required": {} } }, @@ -5334,7 +5354,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to disassociate Opportunities on AWS Partner Central from other entities" }, - "smithy.api#documentation": "

Allows you to remove an existing association between an Opportunity and\n related entities, such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer. This operation is the counterpart to\n AssociateOpportunity, and it provides flexibility to manage\n associations as business needs change.

\n

Use this operation to update the associations of an Opportunity due to\n changes in the related entities, or if an association was made in error. Ensuring\n accurate associations helps maintain clarity and accuracy to track and manage business\n opportunities. When you replace an entity, first attach the new entity and then\n disassociate the one to be removed, especially if it's the last remaining entity that's\n required.

", + "smithy.api#documentation": "

Allows 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 associations helps maintain clarity and accuracy to track and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the one to be removed, especially if it's the last remaining entity that's required.

", "smithy.api#http": { "method": "POST", "uri": "/DisassociateOpportunity", @@ -5348,14 +5368,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity disassociation is made in. Use AWS to\n disassociate opportunities in the Amazon Web Services catalog, and Sandbox\n for testing in secure, isolated environments.

", + "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity disassociation is made in. Use AWS to disassociate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

", "smithy.api#required": {} } }, "OpportunityIdentifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "

The opportunity's unique identifier for when you want to disassociate it from related\n entities. This identifier helps to ensure that the correct opportunity is\n updated.

\n

Validation: Ensure that the provided identifier corresponds to an existing opportunity\n in the Amazon Web Services system because incorrect identifiers result in an error and no\n changes are made.

", + "smithy.api#documentation": "

The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier helps to ensure that the correct opportunity is updated.

Validation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because incorrect identifiers result in an error and no changes are made.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } @@ -5363,14 +5383,14 @@ "RelatedEntityType": { "target": "com.amazonaws.partnercentralselling#RelatedEntityType", "traits": { - "smithy.api#documentation": "

The type of the entity that you're disassociating from the opportunity. When you\n specify the entity type, it helps the system correctly process the disassociation\n request to ensure that the right connections are removed.

\n

Examples of entity types include Partner Solution, Amazon Web Services product, and\n Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity\n types.

\n

Validation: Provide a valid entity type to help ensure successful disassociation. An\n invalid or incorrect entity type results in an error.

", + "smithy.api#documentation": "

The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps the system correctly process the disassociation request to ensure that the right connections are removed.

Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.

Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.

", "smithy.api#required": {} } }, "RelatedEntityIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The related entity's identifier that you want to disassociate from the opportunity.\n Depending on the type of entity, this could be a simple identifier or an Amazon Resource\n Name (ARN) for entities managed through Amazon Web Services Marketplace.

\n

For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the\n necessary ARNs. For guidance on retrieving these ARNs, see \n Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.

\n

Validation: Ensure the identifier or ARN is valid and corresponds to an existing\n entity. An incorrect or invalid identifier results in an error.

", + "smithy.api#documentation": "

The related entity's identifier that you want to disassociate from the opportunity. Depending on the type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed through Amazon Web Services Marketplace.

For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, see Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.

Validation: Ensure the identifier or ARN is valid and corresponds to an existing entity. An incorrect or invalid identifier results in an error.

", "smithy.api#length": { "min": 1, "max": 255 @@ -5431,9 +5451,9 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "relativeDocumentation": "/working-with-engagements.html" + "relativeDocumentation": "working-with-multi-partner-opportunities.html" }, - "smithy.api#documentation": "Represents an engagement in AWS Partner Central" + "smithy.api#documentation": "Represents an engagement that is in AWS Partner Central" } }, "com.amazonaws.partnercentralselling#EngagementArn": { @@ -5472,7 +5492,7 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "engagement-by-accepting-invitation-task", - "relativeDocumentation": "/working-with-tasks.html" + "relativeDocumentation": "working-with-multi-partner-opportunities.html" }, "smithy.api#documentation": "Represents a task that starts an Engagement by accepting an Engagement Invitation in AWS Partner Central" } @@ -5483,19 +5503,19 @@ "Type": { "target": "com.amazonaws.partnercentralselling#EngagementContextType", "traits": { - "smithy.api#documentation": "

Specifies the type of Engagement context. Valid values are \"CustomerProject\" or\n \"Document\", indicating whether the context relates to a customer project or a document\n respectively.

", + "smithy.api#documentation": "

Specifies the type of Engagement context. Valid values are \"CustomerProject\" or \"Document\", indicating whether the context relates to a customer project or a document respectively.

", "smithy.api#required": {} } }, "Payload": { "target": "com.amazonaws.partnercentralselling#EngagementContextPayload", "traits": { - "smithy.api#documentation": "

Contains the specific details of the Engagement context. The structure of this payload\n varies depending on the Type field.

" + "smithy.api#documentation": "

Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.

" } } }, "traits": { - "smithy.api#documentation": "

Provides detailed context information for an Engagement. This structure allows for\n specifying the type of context and its associated payload.

" + "smithy.api#documentation": "

Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload.

" } }, "com.amazonaws.partnercentralselling#EngagementContextPayload": { @@ -5504,12 +5524,12 @@ "CustomerProject": { "target": "com.amazonaws.partnercentralselling#CustomerProjectsContext", "traits": { - "smithy.api#documentation": "

Contains detailed information about a customer project when the context type is\n \"CustomerProject\". This field is present only when the Type in EngagementContextDetails\n is set to \"CustomerProject\".

" + "smithy.api#documentation": "

Contains detailed information about a customer project when the context type is \"CustomerProject\". This field is present only when the Type in EngagementContextDetails is set to \"CustomerProject\".

" } } }, "traits": { - "smithy.api#documentation": "

Represents the payload of an Engagement context. The structure of this payload varies\n based on the context type specified in the EngagementContextDetails.

" + "smithy.api#documentation": "

Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails.

" } }, "com.amazonaws.partnercentralselling#EngagementContextType": { @@ -5540,34 +5560,34 @@ "Industry": { "target": "com.amazonaws.partnercentralselling#Industry", "traits": { - "smithy.api#documentation": "

Specifies the industry to which the customer’s company belongs. This field helps\n categorize the opportunity based on the customer’s business sector.

", + "smithy.api#documentation": "

Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.

", "smithy.api#required": {} } }, "CompanyName": { "target": "com.amazonaws.partnercentralselling#CompanyName", "traits": { - "smithy.api#documentation": "

Represents the name of the customer’s company associated with the Engagement\n Invitation. This field is used to identify the customer.

", + "smithy.api#documentation": "

Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.

", "smithy.api#required": {} } }, "WebsiteUrl": { "target": "com.amazonaws.partnercentralselling#CompanyWebsiteUrl", "traits": { - "smithy.api#documentation": "

Provides the website URL of the customer’s company. This field helps partners verify\n the legitimacy and size of the customer organization.

", + "smithy.api#documentation": "

Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.

", "smithy.api#required": {} } }, "CountryCode": { "target": "com.amazonaws.partnercentralselling#CountryCode", "traits": { - "smithy.api#documentation": "

Indicates the country in which the customer’s company operates. This field is useful\n for understanding regional requirements or compliance needs.

", + "smithy.api#documentation": "

Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains details about the customer associated with the Engagement Invitation,\n including company information and industry.

" + "smithy.api#documentation": "

Contains details about the customer associated with the Engagement Invitation, including company information and industry.

" } }, "com.amazonaws.partnercentralselling#EngagementCustomerBusinessProblem": { @@ -5607,7 +5627,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides comprehensive details about a customer project associated with an Engagement.\n This may include information such as project goals, timelines, and specific customer\n requirements.

" + "smithy.api#documentation": "

Provides comprehensive details about a customer project associated with an Engagement. This may include information such as project goals, timelines, and specific customer requirements.

" } }, "com.amazonaws.partnercentralselling#EngagementCustomerProjectTitle": { @@ -5651,7 +5671,7 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "engagement-from-opportunity-task", - "relativeDocumentation": "/working-with-tasks.html" + "relativeDocumentation": "working-with-multi-partner-opportunities.html" }, "smithy.api#documentation": "Represents a task that starts an Engagement from an Opportunity in AWS Partner Central" } @@ -5709,7 +5729,7 @@ "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "engagement-invitation", - "relativeDocumentation": "/working-with-engagement-invitations.html" + "relativeDocumentation": "working-with-multi-partner-opportunities.html" }, "smithy.api#documentation": "Represents an Engagement Invitation that allows to join an Engagement on AWS Partner Central" } @@ -5774,62 +5794,62 @@ "Arn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Engagement Invitation. The ARN is a unique\n identifier that allows partners to reference the invitation in their system and manage\n its lifecycle.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Engagement Invitation. The ARN is a unique identifier that allows partners to reference the invitation in their system and manage its lifecycle.

" } }, "PayloadType": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationPayloadType", "traits": { - "smithy.api#documentation": "

Describes the type of payload associated with the Engagement Invitation, such as\n Opportunity or MarketplaceOffer. This helps partners\n understand the nature of the engagement request from AWS.

" + "smithy.api#documentation": "

Describes the type of payload associated with the Engagement Invitation, such as Opportunity or MarketplaceOffer. This helps partners understand the nature of the engagement request from AWS.

" } }, "Id": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationArnOrIdentifier", "traits": { - "smithy.api#documentation": "

Represents the unique identifier of the Engagement Invitation. This identifier is used\n to track the invitation and to manage responses like acceptance or rejection.

", + "smithy.api#documentation": "

Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection.

", "smithy.api#required": {} } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the Engagement associated with this invitation. This links the\n invitation to its parent Engagement.

" + "smithy.api#documentation": "

The identifier of the Engagement associated with this invitation. This links the invitation to its parent Engagement.

" } }, "EngagementTitle": { "target": "com.amazonaws.partnercentralselling#EngagementTitle", "traits": { - "smithy.api#documentation": "

Provides a short title or description of the Engagement Invitation. This title helps\n partners quickly identify and differentiate between multiple engagement\n opportunities.

" + "smithy.api#documentation": "

Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities.

" } }, "Status": { "target": "com.amazonaws.partnercentralselling#InvitationStatus", "traits": { - "smithy.api#documentation": "

Represents the current status of the Engagement Invitation, such as\n Pending, Accepted, or Rejected. The status\n helps track the progress and response to the invitation.

" + "smithy.api#documentation": "

Represents the current status of the Engagement Invitation, such as Pending, Accepted, or Rejected. The status helps track the progress and response to the invitation.

" } }, "InvitationDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

Indicates the date when the Engagement Invitation was sent to the partner. This\n provides context for when the opportunity was shared and helps in tracking the timeline\n for engagement.

" + "smithy.api#documentation": "

Indicates the date when the Engagement Invitation was sent to the partner. This provides context for when the opportunity was shared and helps in tracking the timeline for engagement.

" } }, "ExpirationDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

Indicates the date and time when the Engagement Invitation will expire. After this\n date, the invitation can no longer be accepted, and the opportunity will be unavailable\n to the partner.

" + "smithy.api#documentation": "

Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will be unavailable to the partner.

" } }, "SenderAwsAccountId": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#documentation": "

Specifies the AWS account ID of the sender who initiated the Engagement Invitation.\n This allows the partner to identify the AWS entity or representative responsible for\n sharing the opportunity.

" + "smithy.api#documentation": "

Specifies the AWS account ID of the sender who initiated the Engagement Invitation. This allows the partner to identify the AWS entity or representative responsible for sharing the opportunity.

" } }, "SenderCompanyName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Indicates the name of the company or AWS division that sent the Engagement Invitation.\n This information is useful for partners to know which part of AWS is requesting\n engagement.

", + "smithy.api#documentation": "

Indicates the name of the company or AWS division that sent the Engagement Invitation. This information is useful for partners to know which part of AWS is requesting engagement.

", "smithy.api#length": { "max": 120 } @@ -5838,13 +5858,13 @@ "Receiver": { "target": "com.amazonaws.partnercentralselling#Receiver", "traits": { - "smithy.api#documentation": "

Specifies the partner company or individual that received the Engagement Invitation.\n This field is important for tracking who the invitation was sent to within the partner\n organization.

" + "smithy.api#documentation": "

Specifies the partner company or individual that received the Engagement Invitation. This field is important for tracking who the invitation was sent to within the partner organization.

" } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog in which the Engagement Invitation resides. This can be either\n the AWS or Sandbox catalog, indicating whether the opportunity\n is live or being tested.

", + "smithy.api#documentation": "

Specifies the catalog in which the Engagement Invitation resides. This can be either the AWS or Sandbox catalog, indicating whether the opportunity is live or being tested.

", "smithy.api#required": {} } }, @@ -5856,7 +5876,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides a summarized view of the Engagement Invitation, including details like the\n identifier, status, and sender. This summary helps partners track and manage AWS\n originated opportunities.

" + "smithy.api#documentation": "

Provides a summarized view of the Engagement Invitation, including details like the identifier, status, and sender. This summary helps partners track and manage AWS originated opportunities.

" } }, "com.amazonaws.partnercentralselling#EngagementInvitationsPayloadType": { @@ -5877,18 +5897,18 @@ "WebsiteUrl": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The URL of the member company's website. This offers a way to find more information\n about the member organization and serves as an additional identifier.

" + "smithy.api#documentation": "

The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier.

" } }, "AccountId": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#documentation": "

This is the unique identifier for the AWS account associated with the member\n organization. It's used for AWS-related operations and identity verification.

" + "smithy.api#documentation": "

This is the unique identifier for the AWS account associated with the member organization. It's used for AWS-related operations and identity verification.

" } } }, "traits": { - "smithy.api#documentation": "

Engagement members are the participants in an Engagement, which is likely a\n collaborative project or business opportunity within the AWS partner network. Members\n can be different partner organizations or AWS accounts that are working together on a\n specific engagement.

\n

Each member is represented by their AWS Account ID, Company Name, and associated\n details. Members have a status within the Engagement (PENDING, ACCEPTED, REJECTED, or\n WITHDRAWN), indicating their current state of participation. Only existing members of an\n Engagement can view the list of other members. This implies a level of privacy and\n access control within the Engagement structure.

" + "smithy.api#documentation": "

Engagement members are the participants in an Engagement, which is likely a collaborative project or business opportunity within the AWS partner network. Members can be different partner organizations or AWS accounts that are working together on a specific engagement.

Each member is represented by their AWS Account ID, Company Name, and associated details. Members have a status within the Engagement (PENDING, ACCEPTED, REJECTED, or WITHDRAWN), indicating their current state of participation. Only existing members of an Engagement can view the list of other members. This implies a level of privacy and access control within the Engagement structure.

" } }, "com.amazonaws.partnercentralselling#EngagementMemberSummaries": { @@ -5909,12 +5929,12 @@ "WebsiteUrl": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The URL of the member company's website. This offers a way to find more information\n about the member organization and serves as an additional identifier.

" + "smithy.api#documentation": "

The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier.

" } } }, "traits": { - "smithy.api#documentation": "

The EngagementMemberSummary provides a snapshot of essential information about\n participants in an AWS Partner Central Engagement. This compact data structure\n encapsulates key details of each member, facilitating efficient collaboration and\n management within the Engagement.

" + "smithy.api#documentation": "

The EngagementMemberSummary provides a snapshot of essential information about participants in an AWS Partner Central Engagement. This compact data structure encapsulates key details of each member, facilitating efficient collaboration and management within the Engagement.

" } }, "com.amazonaws.partnercentralselling#EngagementMembers": { @@ -5963,18 +5983,18 @@ "ResourceId": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the specific resource. Varies depending on the resource type.\n

" + "smithy.api#documentation": "

A unique identifier for the specific resource. Varies depending on the resource type.

" } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#documentation": "

The AWS account ID of the entity that owns the resource. Identifies the account\n responsible for or having primary control over the resource.

" + "smithy.api#documentation": "

The AWS account ID of the entity that owns the resource. Identifies the account responsible for or having primary control over the resource.

" } } }, "traits": { - "smithy.api#documentation": "

This provide a streamlined view of the relationships between engagements and\n resources. These summaries offer a crucial link between collaborative engagements and\n the specific resources involved, such as opportunities.These summaries are particularly\n valuable for partners navigating complex engagements with multiple resources. They\n enable quick insights into resource distribution across engagements, support efficient\n resource management, and help maintain a clear overview of collaborative activities.\n

" + "smithy.api#documentation": "

This provide a streamlined view of the relationships between engagements and resources. These summaries offer a crucial link between collaborative engagements and the specific resources involved, such as opportunities.These summaries are particularly valuable for partners navigating complex engagements with multiple resources. They enable quick insights into resource distribution across engagements, support efficient resource management, and help maintain a clear overview of collaborative activities.

" } }, "com.amazonaws.partnercentralselling#EngagementResourceAssociationSummaryList": { @@ -6104,14 +6124,14 @@ "Amount": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Represents the estimated monthly revenue that the partner expects to earn from the\n opportunity. This helps in forecasting financial returns.

", + "smithy.api#documentation": "

Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.

", "smithy.api#required": {} } }, "CurrencyCode": { "target": "com.amazonaws.partnercentralselling#CurrencyCode", "traits": { - "smithy.api#documentation": "

Indicates the currency in which the revenue estimate is provided. This helps in\n understanding the financial impact across different markets.

", + "smithy.api#documentation": "

Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.

", "smithy.api#pattern": "^USD$", "smithy.api#required": {} } @@ -6119,14 +6139,14 @@ "Frequency": { "target": "com.amazonaws.partnercentralselling#PaymentFrequency", "traits": { - "smithy.api#documentation": "

Indicates how frequently the customer is expected to spend the projected amount. This\n can include values such as Monthly, Quarterly, or\n Annually. The default value is Monthly, representing\n recurring monthly spend.

", + "smithy.api#documentation": "

Indicates how frequently the customer is expected to spend the projected amount. This can include values such as Monthly, Quarterly, or Annually. The default value is Monthly, representing recurring monthly spend.

", "smithy.api#required": {} } }, "TargetCompany": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the name of the partner company that is expected to generate revenue from\n the opportunity. This field helps track the partner’s involvement in the\n opportunity.

", + "smithy.api#documentation": "

Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity.

", "smithy.api#length": { "min": 1, "max": 80 @@ -6142,7 +6162,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides an estimate of the revenue that the partner is expected to generate from the\n opportunity. This information helps partners assess the financial value of the\n project.

" + "smithy.api#documentation": "

Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.

" } }, "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList": { @@ -6152,7 +6172,8 @@ }, "traits": { "smithy.api#length": { - "min": 1 + "min": 0, + "max": 10 } } }, @@ -6210,7 +6231,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to retrieve AWS Opportunity Summaries for Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "

Retrieves a summary of an AWS Opportunity. This summary includes high-level details\n about the opportunity sourced from AWS, such as lifecycle information, customer details,\n and involvement type. It is useful for tracking updates on the AWS opportunity\n corresponding to an opportunity in the partner's account.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/GetAwsOpportunitySummary", @@ -6225,14 +6246,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog in which the AWS Opportunity is located. Accepted values include\n AWS for production opportunities or Sandbox for testing\n purposes. The catalog determines which environment the opportunity data is pulled\n from.

", + "smithy.api#documentation": "

Specifies the catalog in which the AWS Opportunity is located. Accepted values include AWS for production opportunities or Sandbox for testing purposes. The catalog determines which environment the opportunity data is pulled from.

", "smithy.api#required": {} } }, "RelatedOpportunityIdentifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier for the related partner opportunity. Use this field to correlate\n an AWS opportunity with its corresponding partner opportunity.

", + "smithy.api#documentation": "

The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } @@ -6248,74 +6269,74 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog in which the AWS Opportunity exists. This is the environment\n (e.g., AWS or Sandbox) where the opportunity is being\n managed.

", + "smithy.api#documentation": "

Specifies the catalog in which the AWS Opportunity exists. This is the environment (e.g., AWS or Sandbox) where the opportunity is being managed.

", "smithy.api#required": {} } }, "RelatedOpportunityId": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "

Provides the unique identifier of the related partner opportunity, allowing partners\n to link the AWS Opportunity to their corresponding opportunity in their CRM\n system.

" + "smithy.api#documentation": "

Provides the unique identifier of the related partner opportunity, allowing partners to link the AWS Opportunity to their corresponding opportunity in their CRM system.

" } }, "Origin": { "target": "com.amazonaws.partnercentralselling#OpportunityOrigin", "traits": { - "smithy.api#documentation": "

Specifies whether the AWS Opportunity originated from AWS or the partner. This helps\n distinguish between opportunities that were sourced by AWS and those referred by the\n partner.

" + "smithy.api#documentation": "

Specifies whether the AWS Opportunity originated from AWS or the partner. This helps distinguish between opportunities that were sourced by AWS and those referred by the partner.

" } }, "InvolvementType": { "target": "com.amazonaws.partnercentralselling#SalesInvolvementType", "traits": { - "smithy.api#documentation": "

Specifies the type of involvement AWS has in the opportunity, such as direct cosell or\n advisory support. This field helps partners understand the role AWS plays in advancing\n the opportunity.

" + "smithy.api#documentation": "

Specifies the type of involvement AWS has in the opportunity, such as direct cosell or advisory support. This field helps partners understand the role AWS plays in advancing the opportunity.

" } }, "Visibility": { "target": "com.amazonaws.partnercentralselling#Visibility", "traits": { - "smithy.api#documentation": "

Defines the visibility level for the AWS Opportunity. Use Full visibility\n for most cases, while Limited visibility is reserved for special programs\n or sensitive opportunities.

" + "smithy.api#documentation": "

Defines the visibility level for the AWS Opportunity. Use Full visibility for most cases, while Limited visibility is reserved for special programs or sensitive opportunities.

" } }, "LifeCycle": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityLifeCycle", "traits": { - "smithy.api#documentation": "

Contains lifecycle information for the AWS Opportunity, including review status,\n stage, and target close date. This field is crucial for partners to monitor the\n progression of the opportunity.

" + "smithy.api#documentation": "

Contains lifecycle information for the AWS Opportunity, including review status, stage, and target close date. This field is crucial for partners to monitor the progression of the opportunity.

" } }, "OpportunityTeam": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityTeamMembersList", "traits": { - "smithy.api#documentation": "

Details the AWS opportunity team, including members involved. This information helps\n partners know who from AWS is engaged and what their role is.

" + "smithy.api#documentation": "

Details the AWS opportunity team, including members involved. This information helps partners know who from AWS is engaged and what their role is.

" } }, "Insights": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityInsights", "traits": { - "smithy.api#documentation": "

Provides insights into the AWS Opportunity, including engagement score and recommended\n actions that AWS suggests for the partner.

" + "smithy.api#documentation": "

Provides insights into the AWS Opportunity, including engagement score and recommended actions that AWS suggests for the partner.

" } }, "InvolvementTypeChangeReason": { "target": "com.amazonaws.partnercentralselling#InvolvementTypeChangeReason", "traits": { - "smithy.api#documentation": "

Provides a reason for any changes in the involvement type of AWS in the opportunity.\n This field is used to track why the level of AWS engagement has changed from For\n Visibility Only to Co-sell offering transparency into the\n partnership dynamics.

" + "smithy.api#documentation": "

Provides a reason for any changes in the involvement type of AWS in the opportunity. This field is used to track why the level of AWS engagement has changed from For Visibility Only to Co-sell offering transparency into the partnership dynamics.

" } }, "RelatedEntityIds": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityRelatedEntities", "traits": { - "smithy.api#documentation": "

Lists related entity identifiers, such as AWS products or partner solutions,\n associated with the AWS Opportunity. These identifiers provide additional context and\n help partners understand which AWS services are involved.

" + "smithy.api#documentation": "

Lists related entity identifiers, such as AWS products or partner solutions, associated with the AWS Opportunity. These identifiers provide additional context and help partners understand which AWS services are involved.

" } }, "Customer": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityCustomer", "traits": { - "smithy.api#documentation": "

Provides details about the customer associated with the AWS Opportunity, including\n account information, industry, and other customer data. These details help partners\n understand the business context of the opportunity.

" + "smithy.api#documentation": "

Provides details about the customer associated with the AWS Opportunity, including account information, industry, and other customer data. These details help partners understand the business context of the opportunity.

" } }, "Project": { "target": "com.amazonaws.partnercentralselling#AwsOpportunityProject", "traits": { - "smithy.api#documentation": "

Provides details about the project associated with the AWS Opportunity, including the\n customer’s business problem, expected outcomes, and project scope. This information is\n crucial for understanding the broader context of the opportunity.

" + "smithy.api#documentation": "

Provides details about the project associated with the AWS Opportunity, including the customer’s business problem, expected outcomes, and project scope. This information is crucial for understanding the broader context of the opportunity.

" } } }, @@ -6350,7 +6371,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to retrieval of engagement details in AWS Partner Central" }, - "smithy.api#documentation": "

Use this action to retrieve the engagement record for a given\n EngagementIdentifier.

", + "smithy.api#documentation": "

Use this action to retrieve the engagement record for a given EngagementIdentifier.

", "smithy.api#http": { "method": "POST", "uri": "/GetEngagement", @@ -6389,7 +6410,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to retrieve details of Engagement Invitations on AWS Partner Central" }, - "smithy.api#documentation": "

Retrieves the details of an engagement invitation shared by AWS with a partner. The\n information includes aspects such as customer, project details, and lifecycle\n information. To connect an engagement invitation with an opportunity, match the\n invitation’s Payload.Project.Title with opportunity\n Project.Title.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/GetEngagementInvitation", @@ -6404,7 +6425,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog associated with the request. The field accepts values from the\n predefined set: AWS for live operations or Sandbox for testing\n environments.

", + "smithy.api#documentation": "

Specifies the catalog associated with the request. The field accepts values from the predefined set: AWS for live operations or Sandbox for testing environments.

", "smithy.api#required": {} } }, @@ -6432,7 +6453,7 @@ "PayloadType": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationPayloadType", "traits": { - "smithy.api#documentation": "

The type of payload contained in the engagement invitation, indicating what data or\n context the payload covers.

" + "smithy.api#documentation": "

The type of payload contained in the engagement invitation, indicating what data or context the payload covers.

" } }, "Id": { @@ -6445,13 +6466,13 @@ "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the engagement associated with this invitation.This ID links the\n invitation to its corresponding engagement.

" + "smithy.api#documentation": "

The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.

" } }, "EngagementTitle": { "target": "com.amazonaws.partnercentralselling#EngagementTitle", "traits": { - "smithy.api#documentation": "

The title of the engagement invitation, summarizing the purpose or objectives of the\n opportunity shared by AWS.

" + "smithy.api#documentation": "

The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.

" } }, "Status": { @@ -6469,13 +6490,13 @@ "ExpirationDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

Indicates the date on which the engagement invitation will expire if not accepted by\n the partner.

" + "smithy.api#documentation": "

Indicates the date on which the engagement invitation will expire if not accepted by the partner.

" } }, "SenderAwsAccountId": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#documentation": "

Specifies the AWS Account ID of the sender, which identifies the AWS team responsible\n for sharing the engagement invitation.

" + "smithy.api#documentation": "

Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.

" } }, "SenderCompanyName": { @@ -6490,26 +6511,26 @@ "Receiver": { "target": "com.amazonaws.partnercentralselling#Receiver", "traits": { - "smithy.api#documentation": "

Information about the partner organization or team that received the engagement\n invitation, including contact details and identifiers.

" + "smithy.api#documentation": "

Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.

" } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Indicates the catalog from which the engagement invitation details are retrieved. This\n field helps in identifying the appropriate catalog (e.g., AWS or\n Sandbox) used in the request.

", + "smithy.api#documentation": "

Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., AWS or Sandbox) used in the request.

", "smithy.api#required": {} } }, "RejectionReason": { "target": "com.amazonaws.partnercentralselling#RejectionReasonString", "traits": { - "smithy.api#documentation": "

If the engagement invitation was rejected, this field specifies the reason provided by\n the partner for the rejection.

" + "smithy.api#documentation": "

If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.

" } }, "Payload": { "target": "com.amazonaws.partnercentralselling#Payload", "traits": { - "smithy.api#documentation": "

Details of the engagement invitation payload, including specific data relevant to the\n invitation's contents, such as customer information and opportunity insights.

" + "smithy.api#documentation": "

Details of the engagement invitation payload, including specific data relevant to the invitation's contents, such as customer information and opportunity insights.

" } }, "InvitationMessage": { @@ -6527,7 +6548,7 @@ "ExistingMembers": { "target": "com.amazonaws.partnercentralselling#EngagementMemberSummaries", "traits": { - "smithy.api#documentation": "

A list of active members currently part of the Engagement. This array contains a\n maximum of 10 members, each represented by an object with the following\n properties.

\n " + "smithy.api#documentation": "

A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties.

" } } }, @@ -6541,7 +6562,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog related to the engagement request. Valid values are\n AWS and Sandbox.

", + "smithy.api#documentation": "

Specifies the catalog related to the engagement request. Valid values are AWS and Sandbox.

", "smithy.api#required": {} } }, @@ -6575,37 +6596,37 @@ "Title": { "target": "com.amazonaws.partnercentralselling#EngagementTitle", "traits": { - "smithy.api#documentation": "

The title of the engagement. It provides a brief, descriptive name for the engagement\n that is meaningful and easily recognizable.

" + "smithy.api#documentation": "

The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.

" } }, "Description": { "target": "com.amazonaws.partnercentralselling#EngagementDescription", "traits": { - "smithy.api#documentation": "

A more detailed description of the engagement. This provides additional context or\n information about the engagement's purpose or scope.

" + "smithy.api#documentation": "

A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.

" } }, "CreatedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

The date and time when the Engagement was created, presented in ISO 8601 format (UTC).\n For example: \"2023-05-01T20:37:46Z\". This timestamp helps track the lifecycle of the\n Engagement.

" + "smithy.api#documentation": "

The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: \"2023-05-01T20:37:46Z\". This timestamp helps track the lifecycle of the Engagement.

" } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#documentation": "

The AWS account ID of the user who originally created the engagement. This field helps\n in tracking the origin of the engagement.

" + "smithy.api#documentation": "

The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.

" } }, "MemberCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Specifies the current count of members participating in the Engagement. This count\n includes all active members regardless of their roles or permissions within the\n Engagement.

" + "smithy.api#documentation": "

Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.

" } }, "Contexts": { "target": "com.amazonaws.partnercentralselling#EngagementContexts", "traits": { - "smithy.api#documentation": "

A list of context objects associated with the engagement. Each context provides\n additional information related to the Engagement, such as customer projects or\n documents.

" + "smithy.api#documentation": "

A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

" } } }, @@ -6643,7 +6664,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to retrieve details of Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "

Fetches the Opportunity record from Partner Central by a given\n Identifier.

\n

Use the ListOpportunities action or the event notification (from Amazon EventBridge) to obtain this identifier.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/GetOpportunity", @@ -6658,7 +6679,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity is fetched from. Use AWS to retrieve\n opportunities in the Amazon Web Services catalog, and Sandbox to retrieve\n opportunities in a secure, isolated testing environment.

", + "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is fetched from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure, isolated testing environment.

", "smithy.api#required": {} } }, @@ -6680,26 +6701,26 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity information is retrieved from. Use AWS to\n retrieve opportunities in the Amazon Web Services catalog, and Sandbox to\n retrieve opportunities in a secure and isolated testing environment.

", + "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity information is retrieved from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.

", "smithy.api#required": {} } }, "PrimaryNeedsFromAws": { "target": "com.amazonaws.partnercentralselling#PrimaryNeedsFromAws", "traits": { - "smithy.api#documentation": "

Identifies the type of support the partner needs from Amazon Web Services.

\n

Valid values:

\n " + "smithy.api#documentation": "

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

" } }, "NationalSecurity": { "target": "com.amazonaws.partnercentralselling#NationalSecurity", "traits": { - "smithy.api#documentation": "

Indicates whether the Opportunity pertains to a national security\n project. This field must be set to true only when the customer's industry\n is Government. Additional privacy and security measures apply\n during the review and management process for opportunities marked as\n NationalSecurity.

" + "smithy.api#documentation": "

Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.

" } }, "PartnerOpportunityIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the opportunity's unique identifier in the partner's CRM system. This value\n is essential to track and reconcile because it's included in the outbound payload sent\n back to the partner.

", + "smithy.api#documentation": "

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

", "smithy.api#length": { "max": 64 } @@ -6714,13 +6735,13 @@ "Project": { "target": "com.amazonaws.partnercentralselling#Project", "traits": { - "smithy.api#documentation": "

An object that contains project details summary for the\n Opportunity.

" + "smithy.api#documentation": "

An object that contains project details summary for the Opportunity.

" } }, "OpportunityType": { "target": "com.amazonaws.partnercentralselling#OpportunityType", "traits": { - "smithy.api#documentation": "

Specifies the opportunity type as renewal, new, or expansion.

\n

Opportunity types:

\n " + "smithy.api#documentation": "

Specifies the opportunity type as renewal, new, or expansion.

Opportunity types:

" } }, "Marketing": { @@ -6732,7 +6753,7 @@ "SoftwareRevenue": { "target": "com.amazonaws.partnercentralselling#SoftwareRevenue", "traits": { - "smithy.api#documentation": "

Specifies details of a customer's procurement terms. Required only for partners in\n eligible programs.

" + "smithy.api#documentation": "

Specifies details of a customer's procurement terms. Required only for partners in eligible programs.

" } }, "Id": { @@ -6751,21 +6772,21 @@ "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

\n DateTime when the opportunity was last modified.

", + "smithy.api#documentation": "

DateTime when the opportunity was last modified.

", "smithy.api#required": {} } }, "CreatedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

\n DateTime when the Opportunity was last created.

", + "smithy.api#documentation": "

DateTime when the Opportunity was last created.

", "smithy.api#required": {} } }, "RelatedEntityIdentifiers": { "target": "com.amazonaws.partnercentralselling#RelatedEntityIdentifiers", "traits": { - "smithy.api#documentation": "

Provides information about the associations of other entities with the opportunity.\n These entities include identifiers for AWSProducts, Partner\n Solutions, and AWSMarketplaceOffers.

", + "smithy.api#documentation": "

Provides information about the associations of other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

", "smithy.api#required": {} } }, @@ -6778,7 +6799,7 @@ "OpportunityTeam": { "target": "com.amazonaws.partnercentralselling#PartnerOpportunityTeamMembersList", "traits": { - "smithy.api#documentation": "

Represents the internal team handling the opportunity. Specify the members involved in\n collaborating on this opportunity within the partner's organization.

" + "smithy.api#documentation": "

Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.

" } } }, @@ -6845,11 +6866,11 @@ } ], "traits": { - "aws.iam#conditionKeys": ["partnercentral:Catalog"], + "aws.iam#conditionKeys": ["partnercentral:Catalog", "aws:ResourceTag/${TagKey}", "aws:TagKeys"], "aws.iam#iamAction": { "documentation": "Grants permission to retrieving resource snapshot job details in AWS Partner Central" }, - "smithy.api#documentation": "

Use this action to retrieves information about a specific resource snapshot\n job.

", + "smithy.api#documentation": "

Use this action to retrieves information about a specific resource snapshot job.

", "smithy.api#http": { "method": "POST", "uri": "/GetResourceSnapshotJob", @@ -6864,14 +6885,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

\n ", + "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

", "smithy.api#required": {} } }, "ResourceSnapshotJobIdentifier": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the resource snapshot job to be retrieved. This identifier is\n crucial for pinpointing the specific job you want to query.

", + "smithy.api#documentation": "

The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } @@ -6887,74 +6908,74 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

The catalog in which the snapshot job was created. This will match the Catalog\n specified in the request.

", + "smithy.api#documentation": "

The catalog in which the snapshot job was created. This will match the Catalog specified in the request.

", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the snapshot job. This matches the\n ResourceSnapshotJobIdentifier provided in the request.

" + "smithy.api#documentation": "

The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.

" } }, "Arn": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier\n can be used for resource-specific operations across AWS services.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.

" } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the engagement associated with this snapshot job. This links the job\n to a specific engagement context.

" + "smithy.api#documentation": "

The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context.

" } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { - "smithy.api#documentation": "

The type of resource being snapshotted. This would have \"Opportunity\" as a value as it\n is dependent on the supported resource type.

" + "smithy.api#documentation": "

The type of resource being snapshotted. This would have \"Opportunity\" as a value as it is dependent on the supported resource type.

" } }, "ResourceId": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the specific resource being snapshotted. The format might vary\n depending on the ResourceType.

" + "smithy.api#documentation": "

The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.

" } }, "ResourceArn": { "target": "com.amazonaws.partnercentralselling#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a\n globally unique identifier for the resource across AWS.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.

" } }, "ResourceSnapshotTemplateName": { "target": "com.amazonaws.partnercentralselling#ResourceTemplateName", "traits": { - "smithy.api#documentation": "

The name of the template used for creating the snapshot. This is the same as the\n template name. It defines the structure and content of the snapshot.

" + "smithy.api#documentation": "

The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.

" } }, "CreatedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

The date and time when the snapshot job was created in ISO 8601 format (UTC).\n Example: \"2023-05-01T20:37:46Z\"

" + "smithy.api#documentation": "

The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\"

" } }, "Status": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobStatus", "traits": { - "smithy.api#documentation": "

The current status of the snapshot job. Valid values:

\n " + "smithy.api#documentation": "

The current status of the snapshot job. Valid values:

" } }, "LastSuccessfulExecutionDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

The date and time of the last successful execution of the job, in ISO 8601 format\n (UTC). Example: \"2023-05-01T20:37:46Z\"

" + "smithy.api#documentation": "

The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\"

" } }, "LastFailure": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If the job has encountered any failures, this field contains the error message from\n the most recent failure. This can be useful for troubleshooting issues with the job.\n

" + "smithy.api#documentation": "

If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.

" } } }, @@ -6968,42 +6989,42 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

\n ", + "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

", "smithy.api#required": {} } }, "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the engagement associated with the snapshot. This field links\n the snapshot to a specific engagement context.

", + "smithy.api#documentation": "

The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.

", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { - "smithy.api#documentation": "

Specifies the type of resource that was snapshotted. This field determines the\n structure and content of the snapshot payload. Valid value\n includes:Opportunity: For opportunity-related data.

", + "smithy.api#documentation": "

Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.

", "smithy.api#required": {} } }, "ResourceIdentifier": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the specific resource that was snapshotted. The format and\n constraints of this identifier depend on the ResourceType specified. For\n Opportunity type, it will be an opportunity ID\n

", + "smithy.api#documentation": "

The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For Opportunity type, it will be an opportunity ID

", "smithy.api#required": {} } }, "ResourceSnapshotTemplateIdentifier": { "target": "com.amazonaws.partnercentralselling#ResourceTemplateName", "traits": { - "smithy.api#documentation": "

he name of the template that defines the schema for the snapshot. This template\n determines which subset of the resource data is included in the snapshot and must\n correspond to an existing and valid template for the specified\n ResourceType.

", + "smithy.api#documentation": "

he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified ResourceType.

", "smithy.api#required": {} } }, "Revision": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotRevision", "traits": { - "smithy.api#documentation": "

Specifies which revision of the snapshot to retrieve. If omitted returns the latest\n revision.

" + "smithy.api#documentation": "

Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.

" } } }, @@ -7017,7 +7038,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

The catalog in which the snapshot was created. Matches the Catalog specified in the\n request.

", + "smithy.api#documentation": "

The catalog in which the snapshot was created. Matches the Catalog specified in the request.

", "smithy.api#required": {} } }, @@ -7030,43 +7051,43 @@ "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#documentation": "

The AWS account ID of the principal (user or role) who created the snapshot. This\n helps in tracking the origin of the snapshot.

" + "smithy.api#documentation": "

The AWS account ID of the principal (user or role) who created the snapshot. This helps in tracking the origin of the snapshot.

" } }, "CreatedAt": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

The timestamp when the snapshot was created, in ISO 8601 format (e.g.,\n \"2023-06-01T14:30:00Z\"). This allows for precise tracking of when the snapshot was\n taken.

" + "smithy.api#documentation": "

The timestamp when the snapshot was created, in ISO 8601 format (e.g., \"2023-06-01T14:30:00Z\"). This allows for precise tracking of when the snapshot was taken.

" } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the engagement associated with this snapshot. Matches the\n EngagementIdentifier specified in the request.

" + "smithy.api#documentation": "

The identifier of the engagement associated with this snapshot. Matches the EngagementIdentifier specified in the request.

" } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { - "smithy.api#documentation": "

The type of the resource that was snapshotted. Matches the ResourceType specified in\n the request.

" + "smithy.api#documentation": "

The type of the resource that was snapshotted. Matches the ResourceType specified in the request.

" } }, "ResourceId": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the specific resource that was snapshotted. Matches the\n ResourceIdentifier specified in the request.

" + "smithy.api#documentation": "

The identifier of the specific resource that was snapshotted. Matches the ResourceIdentifier specified in the request.

" } }, "ResourceSnapshotTemplateName": { "target": "com.amazonaws.partnercentralselling#ResourceTemplateName", "traits": { - "smithy.api#documentation": "

The name of the view used for this snapshot. This is the same as the template\n name.

" + "smithy.api#documentation": "

The name of the view used for this snapshot. This is the same as the template name.

" } }, "Revision": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotRevision", "traits": { - "smithy.api#documentation": "

The revision number of this snapshot. This is a positive integer that is sequential\n and unique within the context of a resource view.

" + "smithy.api#documentation": "

The revision number of this snapshot. This is a positive integer that is sequential and unique within the context of a resource view.

" } }, "Payload": { @@ -7104,7 +7125,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to retrieving system settings settings in AWS Partner Central" }, - "smithy.api#documentation": "

Retrieves the currently set system settings, which include the IAM Role used for\n resource snapshot jobs.

", + "smithy.api#documentation": "

Retrieves the currently set system settings, which include the IAM Role used for resource snapshot jobs.

", "smithy.api#http": { "method": "POST", "uri": "/GetSellingSystemSettings", @@ -7119,7 +7140,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog in which the settings are defined. Acceptable values include\n AWS for production and Sandbox for testing\n environments.

", + "smithy.api#documentation": "

Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.

", "smithy.api#required": {} } } @@ -7134,7 +7155,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog in which the settings are defined. Acceptable values include\n AWS for production and Sandbox for testing\n environments.

", + "smithy.api#documentation": "

Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.

", "smithy.api#required": {} } }, @@ -7330,7 +7351,7 @@ } }, "traits": { - "smithy.api#documentation": "

This error occurs when the specified resource can’t be found or doesn't exist.\n Resource ID and type might be incorrect.

\n

Suggested action: This is usually a transient error. Retry after the provided retry\n delay or a short interval. If the problem persists, contact AWS support.

", + "smithy.api#documentation": "

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -7359,7 +7380,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Invitation structure represents an invitation exchanged between partners and AWS.\n It includes a message, receiver information, and a payload providing context for the\n invitation.

" + "smithy.api#documentation": "

The Invitation structure represents an invitation exchanged between partners and AWS. It includes a message, receiver information, and a payload providing context for the invitation.

" } }, "com.amazonaws.partnercentralselling#InvitationMessage": { @@ -7368,7 +7389,8 @@ "smithy.api#length": { "min": 1, "max": 255 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#InvitationStatus": { @@ -7462,18 +7484,18 @@ "AfterLastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

Specifies the date after which the opportunities were modified. Use this filter to\n retrieve only those opportunities that were modified after a given timestamp.

" + "smithy.api#documentation": "

Specifies the date after which the opportunities were modified. Use this filter to retrieve only those opportunities that were modified after a given timestamp.

" } }, "BeforeLastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

Specifies the date before which the opportunities were modified. Use this filter to\n retrieve only those opportunities that were modified before a given timestamp.

" + "smithy.api#documentation": "

Specifies the date before which the opportunities were modified. Use this filter to retrieve only those opportunities that were modified before a given timestamp.

" } } }, "traits": { - "smithy.api#documentation": "

Defines a filter to retrieve opportunities based on the last modified date. This\n filter is useful for tracking changes or updates to opportunities over time.

" + "smithy.api#documentation": "

Defines a filter to retrieve opportunities based on the last modified date. This filter is useful for tracking changes or updates to opportunities over time.

" } }, "com.amazonaws.partnercentralselling#LifeCycle": { @@ -7482,19 +7504,19 @@ "Stage": { "target": "com.amazonaws.partnercentralselling#Stage", "traits": { - "smithy.api#documentation": "

Specifies the current stage of the Opportunity's lifecycle as it maps to\n Amazon Web Services stages from the current stage in the partner CRM. This field\n provides a translated value of the stage, and offers insight into the\n Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

\n \n

A lead and a prospect must be further matured to a Qualified\n opportunity before submission. Opportunities that were closed/lost before submission\n aren't suitable for submission.

\n \n

The descriptions of each sales stage are:

\n " + "smithy.api#documentation": "

Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.

The descriptions of each sales stage are:

" } }, "ClosedLostReason": { "target": "com.amazonaws.partnercentralselling#ClosedLostReason", "traits": { - "smithy.api#documentation": "

Specifies the reason code when an opportunity is marked as Closed\n Lost. When you select an appropriate reason code, you communicate the\n context for closing the Opportunity, and aid in accurate reports and\n analysis of opportunity outcomes. The possible values are:

\n " + "smithy.api#documentation": "

Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes. The possible values are:

" } }, "NextSteps": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { - "smithy.api#documentation": "

Specifies the upcoming actions or tasks for the Opportunity. Use this\n field to communicate with Amazon Web Services about the next actions required for the\n Opportunity.

", + "smithy.api#documentation": "

Specifies the upcoming actions or tasks for the Opportunity. Use this field to communicate with Amazon Web Services about the next actions required for the Opportunity.

", "smithy.api#length": { "max": 255 } @@ -7503,31 +7525,31 @@ "TargetCloseDate": { "target": "com.amazonaws.partnercentralselling#Date", "traits": { - "smithy.api#documentation": "

Specifies the date when Amazon Web Services expects to start significant billing, when\n the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

\n

Ensure the Target Close Date isn't in the past.

" + "smithy.api#documentation": "

Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

Ensure the Target Close Date isn't in the past.

" } }, "ReviewStatus": { "target": "com.amazonaws.partnercentralselling#ReviewStatus", "traits": { - "smithy.api#documentation": "

Indicates the review status of an opportunity referred by a partner. This field is\n read-only and only applicable for partner referrals. The possible values are:

\n " + "smithy.api#documentation": "

Indicates the review status of an opportunity referred by a partner. This field is read-only and only applicable for partner referrals. The possible values are:

" } }, "ReviewComments": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Indicates why an opportunity was sent back for further details. Partners must take\n corrective action based on the ReviewComments.

" + "smithy.api#documentation": "

Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.

" } }, "ReviewStatusReason": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Indicates the reason a decision was made during the opportunity review process. This\n field combines the reasons for both disqualified and action required statuses, and\n provide clarity for why an opportunity was disqualified or requires further\n action.

" + "smithy.api#documentation": "

Indicates the reason a decision was made during the opportunity review process. This field combines the reasons for both disqualified and action required statuses, and provide clarity for why an opportunity was disqualified or requires further action.

" } }, "NextStepsHistory": { "target": "com.amazonaws.partnercentralselling#NextStepsHistories", "traits": { - "smithy.api#documentation": "

Captures a chronological record of the next steps or actions planned or taken for the\n current opportunity, along with the timestamp.

", + "smithy.api#documentation": "

Captures a chronological record of the next steps or actions planned or taken for the current opportunity, along with the timestamp.

", "smithy.api#length": { "max": 50 } @@ -7570,7 +7592,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the lifecycle view of an opportunity resource shared through a snapshot.\n

" + "smithy.api#documentation": "

Provides the lifecycle view of an opportunity resource shared through a snapshot.

" } }, "com.amazonaws.partnercentralselling#LifeCycleSummary": { @@ -7579,19 +7601,19 @@ "Stage": { "target": "com.amazonaws.partnercentralselling#Stage", "traits": { - "smithy.api#documentation": "

Specifies the current stage of the Opportunity's lifecycle as it maps to\n Amazon Web Services stages from the current stage in the partner CRM. This field\n provides a translated value of the stage, and offers insight into the\n Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

\n \n

A lead and a prospect must be further matured to a Qualified\n opportunity before submission. Opportunities that were closed/lost before submission\n aren't suitable for submission.

\n \n

The descriptions of each sales stage are:

\n " + "smithy.api#documentation": "

Specifies the current stage of the Opportunity's lifecycle as it maps to Amazon Web Services stages from the current stage in the partner CRM. This field provides a translated value of the stage, and offers insight into the Opportunity's progression in the sales cycle, according to Amazon Web Services definitions.

A lead and a prospect must be further matured to a Qualified opportunity before submission. Opportunities that were closed/lost before submission aren't suitable for submission.

The descriptions of each sales stage are:

" } }, "ClosedLostReason": { "target": "com.amazonaws.partnercentralselling#ClosedLostReason", "traits": { - "smithy.api#documentation": "

Specifies the reason code when an opportunity is marked as Closed\n Lost. When you select an appropriate reason code, you communicate the\n context for closing the Opportunity, and aid in accurate reports and\n analysis of opportunity outcomes.

" + "smithy.api#documentation": "

Specifies the reason code when an opportunity is marked as Closed Lost. When you select an appropriate reason code, you communicate the context for closing the Opportunity, and aid in accurate reports and analysis of opportunity outcomes.

" } }, "NextSteps": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { - "smithy.api#documentation": "

Specifies the upcoming actions or tasks for the Opportunity. This field\n is utilized to communicate to Amazon Web Services the next actions required for the\n Opportunity.

", + "smithy.api#documentation": "

Specifies the upcoming actions or tasks for the Opportunity. This field is utilized to communicate to Amazon Web Services the next actions required for the Opportunity.

", "smithy.api#length": { "max": 255 } @@ -7600,25 +7622,25 @@ "TargetCloseDate": { "target": "com.amazonaws.partnercentralselling#Date", "traits": { - "smithy.api#documentation": "

Specifies the date when Amazon Web Services expects to start significant billing, when\n the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

\n

Ensure the Target Close Date isn't in the past.

" + "smithy.api#documentation": "

Specifies the date when Amazon Web Services expects to start significant billing, when the project finishes, and when it moves into production. This field informs the Amazon Web Services seller about when the opportunity launches and starts to incur Amazon Web Services usage.

Ensure the Target Close Date isn't in the past.

" } }, "ReviewStatus": { "target": "com.amazonaws.partnercentralselling#ReviewStatus", "traits": { - "smithy.api#documentation": "

Indicates the review status of a partner referred opportunity. This field is read-only\n and only applicable for partner referrals. Valid values:

\n " + "smithy.api#documentation": "

Indicates the review status of a partner referred opportunity. This field is read-only and only applicable for partner referrals. Valid values:

" } }, "ReviewComments": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Indicates why an opportunity was sent back for further details. Partners must take\n corrective action based on the ReviewComments.

" + "smithy.api#documentation": "

Indicates why an opportunity was sent back for further details. Partners must take corrective action based on the ReviewComments.

" } }, "ReviewStatusReason": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Indicates the reason a specific decision was taken during the opportunity review\n process. This field combines the reasons for both disqualified and action required\n statuses, and provides clarity for why an opportunity was disqualified or required\n further action.

" + "smithy.api#documentation": "

Indicates the reason a specific decision was taken during the opportunity review process. This field combines the reasons for both disqualified and action required statuses, and provides clarity for why an opportunity was disqualified or required further action.

" } } }, @@ -7691,7 +7713,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a subset of fields associated with tasks related to accepting an engagement\n invitation.

" + "smithy.api#documentation": "

Specifies a subset of fields associated with tasks related to accepting an engagement invitation.

" } }, "com.amazonaws.partnercentralselling#ListEngagementByAcceptingInvitationTasks": { @@ -7721,7 +7743,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to listing engagements by accepting invitation tasks in AWS Partner\nCentral" }, - "smithy.api#documentation": "

Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask\n tasks that were initiated by the caller's account.

", + "smithy.api#documentation": "

Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account.

", "smithy.api#http": { "method": "POST", "uri": "/ListEngagementByAcceptingInvitationTasks", @@ -7742,7 +7764,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Use this parameter to control the number of items returned in each request, which can\n be useful for performance tuning and managing large result sets.

", + "smithy.api#documentation": "

Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

", "smithy.api#range": { "min": 1, "max": 1000 @@ -7752,7 +7774,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Use this parameter for pagination when the result set spans multiple pages. This\n value is obtained from the NextToken field in the response of a previous call to this\n API.

", + "smithy.api#documentation": "

Use this parameter for pagination when the result set spans multiple pages. This value is obtained from the NextToken field in the response of a previous call to this API.

", "smithy.api#length": { "min": 1, "max": 2048 @@ -7762,38 +7784,38 @@ "Sort": { "target": "com.amazonaws.partnercentralselling#ListTasksSortBase", "traits": { - "smithy.api#documentation": "

Specifies the sorting criteria for the returned results. This allows you to order the\n tasks based on specific attributes.

" + "smithy.api#documentation": "

Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.

" } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

\n ", + "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

", "smithy.api#required": {} } }, "TaskStatus": { "target": "com.amazonaws.partnercentralselling#TaskStatuses", "traits": { - "smithy.api#documentation": "

Filters the tasks based on their current status. This allows you to focus on tasks in\n specific states.

" + "smithy.api#documentation": "

Filters the tasks based on their current status. This allows you to focus on tasks in specific states.

" } }, "OpportunityIdentifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifiers", "traits": { - "smithy.api#documentation": "

Filters tasks by the identifiers of the opportunities they created or are associated\n with.

" + "smithy.api#documentation": "

Filters tasks by the identifiers of the opportunities they created or are associated with.

" } }, "EngagementInvitationIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationIdentifiers", "traits": { - "smithy.api#documentation": "

Filters tasks by the identifiers of the engagement invitations they are processing.\n

" + "smithy.api#documentation": "

Filters tasks by the identifiers of the engagement invitations they are processing.

" } }, "TaskIdentifier": { "target": "com.amazonaws.partnercentralselling#TaskIdentifiers", "traits": { - "smithy.api#documentation": "

Filters tasks by their unique identifiers. Use this when you want to retrieve\n information about specific tasks.

" + "smithy.api#documentation": "

Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.

" } } }, @@ -7807,13 +7829,13 @@ "TaskSummaries": { "target": "com.amazonaws.partnercentralselling#ListEngagementByAcceptingInvitationTaskSummaries", "traits": { - "smithy.api#documentation": "

An array of EngagementByAcceptingInvitationTaskSummary objects, each\n representing a task that matches the specified filters. The array may be empty if no\n tasks match the criteria.

" + "smithy.api#documentation": "

An array of EngagementByAcceptingInvitationTaskSummary objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token used for pagination to retrieve the next page of results.If there are more\n results available, this field will contain a token that can be used in a subsequent API\n call to retrieve the next page. If there are no more results, this field will be null or\n an empty string.

" + "smithy.api#documentation": "

A token used for pagination to retrieve the next page of results.If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.

" } } }, @@ -7839,13 +7861,13 @@ "TaskArn": { "target": "com.amazonaws.partnercentralselling#TaskArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN\n can be used for referencing the task in other AWS services or APIs.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.

" } }, "StartTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time\n format.

" + "smithy.api#documentation": "

The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.

" } }, "TaskStatus": { @@ -7857,31 +7879,31 @@ "Message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A detailed message providing additional information about the task, especially useful\n in case of failures. This field may contain error details or other relevant information\n about the task's execution

" + "smithy.api#documentation": "

A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution

" } }, "ReasonCode": { "target": "com.amazonaws.partnercentralselling#ReasonCode", "traits": { - "smithy.api#documentation": "

A code indicating the specific reason for a task failure. This field is populated\n when the task status is FAILED and provides a categorized reason for the failure.\n

" + "smithy.api#documentation": "

A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.

" } }, "OpportunityId": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the original Opportunity from which the Engagement is being\n created. This field helps track the source of the Engagement creation task.

" + "smithy.api#documentation": "

The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.

" } }, "ResourceSnapshotJobId": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the resource snapshot job associated with this task, if a snapshot\n was created as part of the Engagement creation process.

" + "smithy.api#documentation": "

The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.

" } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the engagement created as a result of the task. This field\n is populated when the task is completed successfully.

" + "smithy.api#documentation": "

The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.

" } }, "EngagementInvitationId": { @@ -7892,7 +7914,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides a summary of a task related to creating an engagement from an opportunity.\n This structure contains key information about the task's status, associated identifiers,\n and any failure details.

" + "smithy.api#documentation": "

Provides a summary of a task related to creating an engagement from an opportunity. This structure contains key information about the task's status, associated identifiers, and any failure details.

" } }, "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTasks": { @@ -7922,7 +7944,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to listing engagements from opportunity tasks in AWS Partner Central" }, - "smithy.api#documentation": "

Lists all in-progress, completed, or failed EngagementFromOpportunity\n tasks that were initiated by the caller's account.

", + "smithy.api#documentation": "

Lists all in-progress, completed, or failed EngagementFromOpportunity tasks that were initiated by the caller's account.

", "smithy.api#http": { "method": "POST", "uri": "/ListEngagementFromOpportunityTasks", @@ -7943,7 +7965,7 @@ "MaxResults": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "

Specifies the maximum number of results to return in a single page of the\n response.Use this parameter to control the number of items returned in each request,\n which can be useful for performance tuning and managing large result sets.

", + "smithy.api#documentation": "

Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

", "smithy.api#range": { "min": 1, "max": 1000 @@ -7953,7 +7975,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The token for requesting the next page of results. This value is obtained from the\n NextToken field in the response of a previous call to this API. Use this parameter for\n pagination when the result set spans multiple pages.

", + "smithy.api#documentation": "

The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.

", "smithy.api#length": { "min": 1, "max": 2048 @@ -7963,26 +7985,26 @@ "Sort": { "target": "com.amazonaws.partnercentralselling#ListTasksSortBase", "traits": { - "smithy.api#documentation": "

Specifies the sorting criteria for the returned results. This allows you to order the\n tasks based on specific attributes.

" + "smithy.api#documentation": "

Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.

" } }, "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

\n ", + "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

", "smithy.api#required": {} } }, "TaskStatus": { "target": "com.amazonaws.partnercentralselling#TaskStatuses", "traits": { - "smithy.api#documentation": "

Filters the tasks based on their current status. This allows you to focus on tasks in\n specific states.

" + "smithy.api#documentation": "

Filters the tasks based on their current status. This allows you to focus on tasks in specific states.

" } }, "TaskIdentifier": { "target": "com.amazonaws.partnercentralselling#TaskIdentifiers", "traits": { - "smithy.api#documentation": "

Filters tasks by their unique identifiers. Use this when you want to retrieve\n information about specific tasks.

" + "smithy.api#documentation": "

Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.

" } }, "OpportunityIdentifier": { @@ -7994,7 +8016,7 @@ "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifiers", "traits": { - "smithy.api#documentation": "

Filters tasks by the identifiers of the engagements they created or are associated\n with.

" + "smithy.api#documentation": "

Filters tasks by the identifiers of the engagements they created or are associated with.

" } } }, @@ -8008,13 +8030,13 @@ "TaskSummaries": { "target": "com.amazonaws.partnercentralselling#ListEngagementFromOpportunityTaskSummaries", "traits": { - "smithy.api#documentation": "

TaskSummaries An array of TaskSummary objects containing details about each task.\n

" + "smithy.api#documentation": "

TaskSummaries An array of TaskSummary objects containing details about each task.

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token used for pagination to retrieve the next page of results. If there are more\n results available, this field will contain a token that can be used in a subsequent API\n call to retrieve the next page. If there are no more results, this field will be null or\n an empty string.

" + "smithy.api#documentation": "

A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.

" } } }, @@ -8052,7 +8074,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to list Engagement Invitations on AWS Partner Central" }, - "smithy.api#documentation": "

Retrieves a list of engagement invitations sent to the partner. This allows partners\n to view all pending or past engagement invitations, helping them track opportunities\n shared by AWS.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/ListEngagementInvitations", @@ -8073,38 +8095,38 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog from which to list the engagement invitations. Use\n AWS for production invitations or Sandbox for testing\n environments.

", + "smithy.api#documentation": "

Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#PageSize", "traits": { - "smithy.api#documentation": "

Specifies the maximum number of engagement invitations to return in the response. If\n more results are available, a pagination token will be provided.

" + "smithy.api#documentation": "

Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A pagination token used to retrieve additional pages of results when the response to a\n previous request was truncated. Pass this token to continue listing invitations from\n where the previous call left off.

" + "smithy.api#documentation": "

A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.

" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#OpportunityEngagementInvitationSort", "traits": { - "smithy.api#documentation": "

Specifies the sorting options for listing engagement invitations. Invitations can be\n sorted by fields such as InvitationDate or Status to help\n partners view results in their preferred order.

" + "smithy.api#documentation": "

Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.

" } }, "PayloadType": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationsPayloadType", "traits": { - "smithy.api#documentation": "

Defines the type of payload associated with the engagement invitations to be listed.\n The attributes in this payload help decide on acceptance or rejection of the\n invitation.

" + "smithy.api#documentation": "

Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.

" } }, "ParticipantType": { "target": "com.amazonaws.partnercentralselling#ParticipantType", "traits": { - "smithy.api#documentation": "

Specifies the type of participant for which to list engagement invitations. Identifies\n the role of the participant.

", + "smithy.api#documentation": "

Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.

", "smithy.api#required": {} } }, @@ -8117,7 +8139,7 @@ "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifiers", "traits": { - "smithy.api#documentation": "

Retrieves a list of engagement invitation summaries based on specified filters. The\n ListEngagementInvitations operation allows you to view all invitations that you have\n sent or received. You must specify the ParticipantType to filter invitations where you\n are either the SENDER or the RECEIVER. Invitations will automatically expire if not\n accepted within 15 days.

" + "smithy.api#documentation": "

Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.

" } }, "SenderAwsAccountId": { @@ -8137,13 +8159,13 @@ "EngagementInvitationSummaries": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationSummaries", "traits": { - "smithy.api#documentation": "

An array containing summaries of engagement invitations. Each summary includes\n information such as the invitation title, invitation date, and the current status of the\n invitation.

" + "smithy.api#documentation": "

An array containing summaries of engagement invitations. Each summary includes information such as the invitation title, invitation date, and the current status of the invitation.

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A pagination token returned when there are more results available than can be returned\n in a single call. Use this token to retrieve additional pages of engagement invitation\n summaries.

" + "smithy.api#documentation": "

A pagination token returned when there are more results available than can be returned in a single call. Use this token to retrieve additional pages of engagement invitation summaries.

" } } }, @@ -8178,7 +8200,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to listing engagement members in AWS Partner Central" }, - "smithy.api#documentation": "

Retrieves the details of member partners in an Engagement. This operation can only be\n invoked by members of the Engagement. The ListEngagementMembers operation\n allows you to fetch information about the members of a specific Engagement. This action\n is restricted to members of the Engagement being queried.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/ListEngagementMembers", @@ -8241,7 +8263,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A pagination token used to retrieve the next set of results. If there are more results\n available than can be returned in a single response, this token will be present. Use\n this token in a subsequent request to retrieve the next page of results. If there are no\n more results, this value will be null.

" + "smithy.api#documentation": "

A pagination token used to retrieve the next set of results. If there are more results available than can be returned in a single response, this token will be present. Use this token in a subsequent request to retrieve the next page of results. If there are no more results, this value will be null.

" } } }, @@ -8276,7 +8298,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to listing engagement resource associations in AWS Partner Central" }, - "smithy.api#documentation": "

Lists the associations between resources and engagements where the caller is a member\n and has at least one snapshot in the engagement.

", + "smithy.api#documentation": "

Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement.

", "smithy.api#http": { "method": "POST", "uri": "/ListEngagementResourceAssociations", @@ -8297,7 +8319,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog in which to search for engagement-resource associations. Valid\n Values: \"AWS\" or \"Sandbox\"

\n ", + "smithy.api#documentation": "

Specifies the catalog in which to search for engagement-resource associations. Valid Values: \"AWS\" or \"Sandbox\"

", "smithy.api#required": {} } }, @@ -8305,7 +8327,7 @@ "target": "com.amazonaws.partnercentralselling#PageSize", "traits": { "smithy.api#default": 100, - "smithy.api#documentation": "

Limits the number of results returned in a single call. Use this to control the number\n of results returned, especially useful for pagination.

", + "smithy.api#documentation": "

Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination.

", "smithy.api#range": { "min": 1, "max": 1000 @@ -8315,31 +8337,31 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token used for pagination of results. Include this token in subsequent requests to\n retrieve the next set of results.

" + "smithy.api#documentation": "

A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results.

" } }, "EngagementIdentifier": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#documentation": "

Filters the results to include only associations related to the specified engagement.\n Use this when you want to find all resources associated with a specific\n engagement.

" + "smithy.api#documentation": "

Filters the results to include only associations related to the specified engagement. Use this when you want to find all resources associated with a specific engagement.

" } }, "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { - "smithy.api#documentation": "

Filters the results to include only associations with resources of the specified\n type.

" + "smithy.api#documentation": "

Filters the results to include only associations with resources of the specified type.

" } }, "ResourceIdentifier": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { - "smithy.api#documentation": "

Filters the results to include only associations with the specified resource. Varies\n depending on the resource type. Use this when you want to find all engagements\n associated with a specific resource.

" + "smithy.api#documentation": "

Filters the results to include only associations with the specified resource. Varies depending on the resource type. Use this when you want to find all engagements associated with a specific resource.

" } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#documentation": "

Filters the response to include only snapshots of resources owned by the specified\n AWS account ID. Use this when you want to find associations related to resources owned\n by a particular account.

" + "smithy.api#documentation": "

Filters the response to include only snapshots of resources owned by the specified AWS account ID. Use this when you want to find associations related to resources owned by a particular account.

" } } }, @@ -8360,7 +8382,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A token to retrieve the next set of results. Use this token in a subsequent request\n to retrieve additional results if the response was truncated.

" + "smithy.api#documentation": "

A token to retrieve the next set of results. Use this token in a subsequent request to retrieve additional results if the response was truncated.

" } } }, @@ -8395,7 +8417,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to listing engagements in AWS Partner Central" }, - "smithy.api#documentation": "

This action allows users to retrieve a list of Engagement records from Partner\n Central. This action can be used to manage and track various engagements across\n different stages of the partner selling process.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/ListEngagements", @@ -8423,20 +8445,17 @@ "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccountList", "traits": { - "smithy.api#documentation": "

A list of AWS account IDs. When specified, the response includes engagements created\n by these accounts. This filter is useful for finding engagements created by specific\n team members.

" + "smithy.api#documentation": "

A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.

" } }, "ExcludeCreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccountList", "traits": { - "smithy.api#documentation": "

An array of strings representing AWS Account IDs. Use this to exclude engagements\n created by specific users.

" + "smithy.api#documentation": "

An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.

" } }, "Sort": { - "target": "com.amazonaws.partnercentralselling#EngagementSort", - "traits": { - "smithy.api#documentation": "

\n An object that specifies the sort order of the results.\n

" - } + "target": "com.amazonaws.partnercentralselling#EngagementSort" }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#EngagementPageSize", @@ -8448,7 +8467,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The token for the next set of results. This value is returned from a previous\n call.

" + "smithy.api#documentation": "

The token for the next set of results. This value is returned from a previous call.

" } }, "EngagementIdentifier": { @@ -8475,7 +8494,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. This field will be null if there are no\n more results.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. This field will be null if there are no more results.

" } } }, @@ -8513,7 +8532,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to list Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "

This request accepts a list of filters that retrieve opportunity subsets as well as\n sort options. This feature is available to partners from Partner Central using the\n ListOpportunities API action.

\n

To synchronize your system with Amazon Web Services, only list the opportunities that\n were newly created or updated. We recommend you rely on events emitted by the service\n into your Amazon Web Services account’s Amazon EventBridge default event bus, you can\n also use the ListOpportunities action.

\n

We recommend the following approach:

\n
    \n
  1. \n

    Find the latest LastModifiedDate that you stored, and only use\n the values that came from Amazon Web Services. Don’t use values generated by your\n system.

    \n
    2. \n
  2. \n

    When you send a ListOpportunities request, submit the date in ISO\n 8601 format in the AfterLastModifiedDate filter.

    \n
    3. \n
  3. \n

    Amazon Web Services only returns opportunities created or updated on or after\n that date and time. Use NextToken to iterate over all pages.

    \n
    4. \n
", + "smithy.api#documentation": "

This 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, only list 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 recommend the following approach:

  1. Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don’t use values generated by your system.

  2. When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter.

  3. Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.

", "smithy.api#http": { "method": "POST", "uri": "/ListOpportunities", @@ -8551,38 +8570,38 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunities are listed in. Use AWS for listing real\n opportunities in the Amazon Web Services catalog, and Sandbox for testing in\n secure, isolated environments.

", + "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunities are listed in. Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#PageSize", "traits": { - "smithy.api#documentation": "

Specifies the maximum number of results to return in a single call. This limits the\n number of opportunities returned in the response to avoid providing too many results at\n once.

\n

Default: 20

" + "smithy.api#documentation": "

Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.

Default: 20

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A pagination token used to retrieve the next set of results in subsequent calls. This\n token is included in the response only if there are additional result pages\n available.

" + "smithy.api#documentation": "

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#OpportunitySort", "traits": { - "smithy.api#documentation": "

An object that specifies how the response is sorted. The default\n Sort.SortBy value is LastModifiedDate.

" + "smithy.api#documentation": "

An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate.

" } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#LastModifiedDate", "traits": { - "smithy.api#documentation": "

Filters the opportunities based on their last modified date. This filter helps\n retrieve opportunities that were updated after the specified date, allowing partners to\n track recent changes or updates.

" + "smithy.api#documentation": "

Filters the opportunities based on their last modified date. This filter helps retrieve opportunities that were updated after the specified date, allowing partners to track recent changes or updates.

" } }, "Identifier": { "target": "com.amazonaws.partnercentralselling#FilterIdentifier", "traits": { - "smithy.api#documentation": "

Filters the opportunities based on the opportunity identifier. This allows partners to\n retrieve specific opportunities by providing their unique identifiers, ensuring precise\n results.

", + "smithy.api#documentation": "

Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results.

", "smithy.api#length": { "max": 20 } @@ -8591,7 +8610,7 @@ "LifeCycleStage": { "target": "com.amazonaws.partnercentralselling#FilterLifeCycleStage", "traits": { - "smithy.api#documentation": "

Filters the opportunities based on their lifecycle stage. This filter allows partners\n to retrieve opportunities at various stages in the sales cycle, such as\n Qualified, Technical Validation, Business\n Validation, or Closed Won.

", + "smithy.api#documentation": "

Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.

", "smithy.api#length": { "max": 10 } @@ -8600,7 +8619,7 @@ "LifeCycleReviewStatus": { "target": "com.amazonaws.partnercentralselling#FilterLifeCycleReviewStatus", "traits": { - "smithy.api#documentation": "

Filters the opportunities based on their current lifecycle approval status. Use this\n filter to retrieve opportunities with statuses such as Pending Submission,\n In Review, Action Required, or\n Approved.

", + "smithy.api#documentation": "

Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as Pending Submission, In Review, Action Required, or Approved.

", "smithy.api#length": { "max": 10 } @@ -8609,7 +8628,7 @@ "CustomerCompanyName": { "target": "com.amazonaws.partnercentralselling#StringList", "traits": { - "smithy.api#documentation": "

Filters the opportunities based on the customer's company name. This allows partners\n to search for opportunities associated with a specific customer by matching the provided\n company name string.

", + "smithy.api#documentation": "

Filters the opportunities based on the customer's company name. This allows partners to search for opportunities associated with a specific customer by matching the provided company name string.

", "smithy.api#length": { "max": 10 } @@ -8626,14 +8645,14 @@ "OpportunitySummaries": { "target": "com.amazonaws.partnercentralselling#OpportunitySummaries", "traits": { - "smithy.api#documentation": "

An array that contains minimal details for opportunities that match the request\n criteria. This summary view provides a quick overview of relevant opportunities.

", + "smithy.api#documentation": "

An array that contains minimal details for opportunities that match the request criteria. This summary view provides a quick overview of relevant opportunities.

", "smithy.api#required": {} } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A pagination token used to retrieve the next set of results in subsequent calls. This\n token is included in the response only if there are additional result pages\n available.

" + "smithy.api#documentation": "

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

" } } }, @@ -8668,7 +8687,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to listing resource snapshot jobs in AWS Partner Central" }, - "smithy.api#documentation": "

Lists resource snapshot jobs owned by the customer. This operation supports various\n filtering scenarios, including listing all jobs owned by the caller, jobs for a specific\n engagement, jobs with a specific status, or any combination of these filters.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/ListResourceSnapshotJobs", @@ -8697,7 +8716,7 @@ "target": "com.amazonaws.partnercentralselling#PageSize", "traits": { "smithy.api#default": 100, - "smithy.api#documentation": "

The maximum number of results to return in a single call. If omitted, defaults to 50.\n

", + "smithy.api#documentation": "

The maximum number of results to return in a single call. If omitted, defaults to 50.

", "smithy.api#range": { "min": 1, "max": 1000 @@ -8725,7 +8744,7 @@ "Sort": { "target": "com.amazonaws.partnercentralselling#SortObject", "traits": { - "smithy.api#documentation": "

Configures the sorting of the response. If omitted, results are sorted by\n CreatedDate in descending order.

" + "smithy.api#documentation": "

Configures the sorting of the response. If omitted, results are sorted by CreatedDate in descending order.

" } } }, @@ -8746,7 +8765,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. If there are no additional results,\n this value is null.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. If there are no additional results, this value is null.

" } } }, @@ -8781,7 +8800,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to listing resource snapshots in AWS Partner Central" }, - "smithy.api#documentation": "

Retrieves a list of resource view snapshots based on specified criteria. This\n operation supports various use cases, including:

\n ", + "smithy.api#documentation": "

Retrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including:

", "smithy.api#http": { "method": "POST", "uri": "/ListResourceSnapshots", @@ -8833,7 +8852,7 @@ "ResourceType": { "target": "com.amazonaws.partnercentralselling#ResourceType", "traits": { - "smithy.api#documentation": "

Filters the response to include only snapshots of the specified resource type.\n

" + "smithy.api#documentation": "

Filters the response to include only snapshots of the specified resource type.

" } }, "ResourceIdentifier": { @@ -8845,13 +8864,13 @@ "ResourceSnapshotTemplateIdentifier": { "target": "com.amazonaws.partnercentralselling#ResourceTemplateName", "traits": { - "smithy.api#documentation": "

Filters the response to include only snapshots created using the specified\n template.

" + "smithy.api#documentation": "

Filters the response to include only snapshots created using the specified template.

" } }, "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#documentation": "

Filters the response to include only snapshots of resources owned by the specified\n AWS account.

" + "smithy.api#documentation": "

Filters the response to include only snapshots of resources owned by the specified AWS account.

" } } }, @@ -8872,7 +8891,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The token to retrieve the next set of results. If there are no additional results,\n this value is null.

" + "smithy.api#documentation": "

The token to retrieve the next set of results. If there are no additional results, this value is null.

" } } }, @@ -8907,7 +8926,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to list Solutions on AWS Partner Central" }, - "smithy.api#documentation": "

Retrieves a list of Partner Solutions that the partner registered on Partner Central.\n This API is used to generate a list of solutions that an end user selects from for\n association with an opportunity.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/ListSolutions", @@ -8928,32 +8947,32 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the solutions are listed in. Use AWS to list solutions in\n the Amazon Web Services catalog, and Sandbox to list solutions in a secure\n and isolated testing environment.

", + "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the solutions are listed in. Use AWS to list solutions in the Amazon Web Services catalog, and Sandbox to list solutions in a secure and isolated testing environment.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.partnercentralselling#PageSize", "traits": { - "smithy.api#documentation": "

The maximum number of results returned by a single call. This value must be provided\n in the next call to retrieve the next set of results.

\n

Default: 20

" + "smithy.api#documentation": "

The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results.

Default: 20

" } }, "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A pagination token used to retrieve the next set of results in subsequent calls. This\n token is included in the response only if there are additional result pages\n available.

" + "smithy.api#documentation": "

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

" } }, "Sort": { "target": "com.amazonaws.partnercentralselling#SolutionSort", "traits": { - "smithy.api#documentation": "

Object that configures sorting done on the response. Default Sort.SortBy\n is Identifier.

" + "smithy.api#documentation": "

Object that configures sorting done on the response. Default Sort.SortBy is Identifier.

" } }, "Status": { "target": "com.amazonaws.partnercentralselling#FilterStatus", "traits": { - "smithy.api#documentation": "

Filters solutions based on their status. This filter helps partners manage their\n solution portfolios effectively.

", + "smithy.api#documentation": "

Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.

", "smithy.api#length": { "max": 10 } @@ -8962,7 +8981,7 @@ "Identifier": { "target": "com.amazonaws.partnercentralselling#SolutionIdentifiers", "traits": { - "smithy.api#documentation": "

Filters the solutions based on their unique identifier. Use this filter to retrieve\n specific solutions by providing the solution's identifier for accurate results.

", + "smithy.api#documentation": "

Filters the solutions based on their unique identifier. Use this filter to retrieve specific solutions by providing the solution's identifier for accurate results.

", "smithy.api#length": { "max": 20 } @@ -8971,7 +8990,7 @@ "Category": { "target": "com.amazonaws.partnercentralselling#StringList", "traits": { - "smithy.api#documentation": "

Filters the solutions based on the category to which they belong. This allows partners\n to search for solutions within specific categories, such as Software,\n Consulting, or Managed Services.

", + "smithy.api#documentation": "

Filters the solutions based on the category to which they belong. This allows partners to search for solutions within specific categories, such as Software, Consulting, or Managed Services.

", "smithy.api#length": { "max": 10 } @@ -8995,7 +9014,7 @@ "NextToken": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A pagination token used to retrieve the next set of results in subsequent calls. This\n token is included in the response only if there are additional result pages\n available.

" + "smithy.api#documentation": "

A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

" } } }, @@ -9029,6 +9048,10 @@ } ], "traits": { + "aws.iam#conditionKeys": ["partnercentral:Catalog", "aws:ResourceTag/${TagKey}", "aws:TagKeys"], + "aws.iam#iamAction": { + "documentation": "Grants permission to add lists tags to a resource. Supported resource: ResourceSnapshotJob" + }, "smithy.api#documentation": "

Returns a list of tags for a resource.

", "smithy.api#http": { "method": "POST", @@ -9044,7 +9067,7 @@ "ResourceArn": { "target": "com.amazonaws.partnercentralselling#TaggableResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which you want to retrieve\n tags.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.

", "smithy.api#required": {} } } @@ -9087,7 +9110,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the sorting parameters for listing tasks. This structure allows for\n specifying the field to sort by and the order of sorting.

" + "smithy.api#documentation": "

Defines the sorting parameters for listing tasks. This structure allows for specifying the field to sort by and the order of sorting.

" } }, "com.amazonaws.partnercentralselling#ListTasksSortName": { @@ -9107,31 +9130,31 @@ "CampaignName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the Opportunity marketing campaign code. The Amazon Web Services\n campaign code is a reference to specific marketing initiatives, promotions, or\n activities. This field captures the identifier used to track and categorize the\n Opportunity within marketing campaigns. If you don't have a campaign\n code, contact your Amazon Web Services point of contact to obtain one.

" + "smithy.api#documentation": "

Specifies the Opportunity marketing campaign code. The Amazon Web Services campaign code is a reference to specific marketing initiatives, promotions, or activities. This field captures the identifier used to track and categorize the Opportunity within marketing campaigns. If you don't have a campaign code, contact your Amazon Web Services point of contact to obtain one.

" } }, "Source": { "target": "com.amazonaws.partnercentralselling#MarketingSource", "traits": { - "smithy.api#documentation": "

Indicates if the Opportunity was sourced from an Amazon Web Services\n marketing activity. Use the value Marketing Activity. Use None\n if it's not associated with an Amazon Web Services marketing activity. This field helps\n Amazon Web Services track the return on marketing investments and enables better\n distribution of marketing budgets among partners.

" + "smithy.api#documentation": "

Indicates if the Opportunity was sourced from an Amazon Web Services marketing activity. Use the value Marketing Activity. Use None if it's not associated with an Amazon Web Services marketing activity. This field helps Amazon Web Services track the return on marketing investments and enables better distribution of marketing budgets among partners.

" } }, "UseCases": { "target": "com.amazonaws.partnercentralselling#UseCases", "traits": { - "smithy.api#documentation": "

Specifies the marketing activity use case or purpose that led to the\n Opportunity's creation or contact. This field captures the context or\n marketing activity's execution's intention and the direct correlation to the generated\n opportunity or contact. Must be empty when Marketing.AWSFundingUsed =\n No.

\n

Valid values: AI/ML | Analytics | Application Integration | Blockchain |\n Business Applications | Cloud Financial Management | Compute | Containers | Customer\n Engagement | Databases | Developer Tools | End User Computing | Front End Web &\n Mobile | Game Tech | IoT | Management & Governance | Media Services | Migration\n & Transfer | Networking & Content Delivery | Quantum Technologies | Robotics\n | Satellite | Security | Serverless | Storage | VR & AR\n

" + "smithy.api#documentation": "

Specifies the marketing activity use case or purpose that led to the Opportunity's creation or contact. This field captures the context or marketing activity's execution's intention and the direct correlation to the generated opportunity or contact. Must be empty when Marketing.AWSFundingUsed = No.

Valid values: AI/ML | Analytics | Application Integration | Blockchain | Business Applications | Cloud Financial Management | Compute | Containers | Customer Engagement | Databases | Developer Tools | End User Computing | Front End Web & Mobile | Game Tech | IoT | Management & Governance | Media Services | Migration & Transfer | Networking & Content Delivery | Quantum Technologies | Robotics | Satellite | Security | Serverless | Storage | VR & AR

" } }, "Channels": { "target": "com.amazonaws.partnercentralselling#Channels", "traits": { - "smithy.api#documentation": "

Specifies the Opportunity's channel that the marketing activity is\n associated with or was contacted through. This field provides information about the\n specific marketing channel that contributed to the generation of the lead or\n contact.

" + "smithy.api#documentation": "

Specifies the Opportunity's channel that the marketing activity is associated with or was contacted through. This field provides information about the specific marketing channel that contributed to the generation of the lead or contact.

" } }, "AwsFundingUsed": { "target": "com.amazonaws.partnercentralselling#AwsFundingUsed", "traits": { - "smithy.api#documentation": "

Indicates if the Opportunity is a marketing development fund (MDF) funded\n activity.

" + "smithy.api#documentation": "

Indicates if the Opportunity is a marketing development fund (MDF) funded activity.

" } } }, @@ -9162,7 +9185,8 @@ "smithy.api#length": { "min": 1, "max": 120 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.partnercentralselling#MemberPageSize": { @@ -9249,7 +9273,7 @@ } }, "traits": { - "smithy.api#documentation": "

Read-only; shows the last 50 values and change dates for the NextSteps\n field.

" + "smithy.api#documentation": "

Read-only; shows the last 50 values and change dates for the NextSteps field.

" } }, "com.amazonaws.partnercentralselling#Opportunity": { @@ -9297,7 +9321,7 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "relativeDocumentation": "/working-with-your-opportunities.html" + "relativeDocumentation": "working-with-your-opportunities.html" }, "smithy.api#documentation": "Represents an Opportunity that captures deal details in AWS Partner Central" } @@ -9314,20 +9338,20 @@ "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { - "smithy.api#documentation": "

Defines the order in which the Engagement Invitations are sorted. The values can be\n ASC (ascending) or DESC (descending).

", + "smithy.api#documentation": "

Defines the order in which the Engagement Invitations are sorted. The values can be ASC (ascending) or DESC (descending).

", "smithy.api#required": {} } }, "SortBy": { "target": "com.amazonaws.partnercentralselling#OpportunityEngagementInvitationSortName", "traits": { - "smithy.api#documentation": "

Specifies the field by which the Engagement Invitations are sorted. Common values\n include InvitationDate and Status.

", + "smithy.api#documentation": "

Specifies the field by which the Engagement Invitations are sorted. Common values include InvitationDate and Status.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Defines sorting options for retrieving Engagement Invitations. Sorting can be done\n based on various criteria like the invitation date or status.

" + "smithy.api#documentation": "

Defines sorting options for retrieving Engagement Invitations. Sorting can be done based on various criteria like the invitation date or status.

" } }, "com.amazonaws.partnercentralselling#OpportunityEngagementInvitationSortName": { @@ -9365,33 +9389,33 @@ "SenderContacts": { "target": "com.amazonaws.partnercentralselling#SenderContactList", "traits": { - "smithy.api#documentation": "

Represents the contact details of the AWS representatives involved in sending the\n Engagement Invitation. These contacts are opportunity stakeholders.

" + "smithy.api#documentation": "

Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders.

" } }, "ReceiverResponsibilities": { "target": "com.amazonaws.partnercentralselling#ReceiverResponsibilityList", "traits": { - "smithy.api#documentation": "

Outlines the responsibilities or expectations of the receiver in the context of the\n invitation.

", + "smithy.api#documentation": "

Outlines the responsibilities or expectations of the receiver in the context of the invitation.

", "smithy.api#required": {} } }, "Customer": { "target": "com.amazonaws.partnercentralselling#EngagementCustomer", "traits": { - "smithy.api#documentation": "

Contains information about the customer related to the opportunity in the Engagement\n Invitation. This data helps partners understand the customer’s profile and\n requirements.

", + "smithy.api#documentation": "

Contains information about the customer related to the opportunity in the Engagement Invitation. This data helps partners understand the customer’s profile and requirements.

", "smithy.api#required": {} } }, "Project": { "target": "com.amazonaws.partnercentralselling#ProjectDetails", "traits": { - "smithy.api#documentation": "

Describes the project details associated with the opportunity, including the\n customer’s needs and the scope of work expected to be performed.

", + "smithy.api#documentation": "

Describes the project details associated with the opportunity, including the customer’s needs and the scope of work expected to be performed.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Represents the data payload of an Engagement Invitation for a specific opportunity.\n This contains detailed information that partners use to evaluate the engagement.

" + "smithy.api#documentation": "

Represents the data payload of an Engagement Invitation for a specific opportunity. This contains detailed information that partners use to evaluate the engagement.

" } }, "com.amazonaws.partnercentralselling#OpportunityOrigin": { @@ -9417,7 +9441,7 @@ "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { - "smithy.api#documentation": "

Sort order.

\n

Default: Descending\n

", + "smithy.api#documentation": "

Sort order.

Default: Descending

", "smithy.api#required": {} } }, @@ -9468,7 +9492,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog associated with the opportunity, either AWS or\n Sandbox. This indicates the environment in which the opportunity is\n managed.

", + "smithy.api#documentation": "

Specifies the catalog associated with the opportunity, either AWS or Sandbox. This indicates the environment in which the opportunity is managed.

", "smithy.api#required": {} } }, @@ -9481,31 +9505,31 @@ "Arn": { "target": "com.amazonaws.partnercentralselling#OpportunityArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the opportunity. This globally unique identifier\n can be used for IAM policies and cross-service references.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the opportunity. This globally unique identifier can be used for IAM policies and cross-service references.

" } }, "PartnerOpportunityIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the Opportunity's unique identifier in the partner's CRM\n system. This value is essential to track and reconcile because it's included in the\n outbound payload sent back to the partner. It allows partners to link an opportunity to\n their CRM.

" + "smithy.api#documentation": "

Specifies the Opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner. It allows partners to link an opportunity to their CRM.

" } }, "OpportunityType": { "target": "com.amazonaws.partnercentralselling#OpportunityType", "traits": { - "smithy.api#documentation": "

Specifies opportunity type as a renewal, new, or expansion.

\n

Opportunity types:

\n " + "smithy.api#documentation": "

Specifies opportunity type as a renewal, new, or expansion.

Opportunity types:

" } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

\n DateTime when the Opportunity was last modified.

" + "smithy.api#documentation": "

DateTime when the Opportunity was last modified.

" } }, "CreatedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

\n DateTime when the Opportunity was last created.

" + "smithy.api#documentation": "

DateTime when the Opportunity was last created.

" } }, "LifeCycle": { @@ -9543,13 +9567,13 @@ "Lifecycle": { "target": "com.amazonaws.partnercentralselling#LifeCycleForView", "traits": { - "smithy.api#documentation": "

Contains information about the opportunity's lifecycle, including its current stage,\n status, and important dates such as creation and last modification times.

" + "smithy.api#documentation": "

Contains information about the opportunity's lifecycle, including its current stage, status, and important dates such as creation and last modification times.

" } }, "OpportunityTeam": { "target": "com.amazonaws.partnercentralselling#PartnerOpportunityTeamMembersList", "traits": { - "smithy.api#documentation": "

Represents the internal team handling the opportunity. Specify the members involved\n in collaborating on an opportunity within the partner's organization.

" + "smithy.api#documentation": "

Represents the internal team handling the opportunity. Specify the members involved in collaborating on an opportunity within the partner's organization.

" } }, "PrimaryNeedsFromAws": { @@ -9564,7 +9588,7 @@ "Project": { "target": "com.amazonaws.partnercentralselling#ProjectView", "traits": { - "smithy.api#documentation": "

Contains summary information about the project associated with the opportunity,\n including project name, description, timeline, and other relevant details.

" + "smithy.api#documentation": "

Contains summary information about the project associated with the opportunity, including project name, description, timeline, and other relevant details.

" } }, "RelatedEntityIdentifiers": { @@ -9572,7 +9596,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides a comprehensive view of an opportunity summary, including lifecycle\n information, team details, opportunity type, primary needs from AWS, and associated\n project information.

" + "smithy.api#documentation": "

Provides a comprehensive view of an opportunity summary, including lifecycle information, team details, opportunity type, primary needs from AWS, and associated project information.

" } }, "com.amazonaws.partnercentralselling#OpportunityType": { @@ -9641,12 +9665,12 @@ "OpportunityInvitation": { "target": "com.amazonaws.partnercentralselling#OpportunityInvitationPayload", "traits": { - "smithy.api#documentation": "

Specifies the details of the opportunity invitation within the Engagement Invitation\n payload. This data helps partners understand the context, scope, and expected\n involvement for the opportunity from AWS.

" + "smithy.api#documentation": "

Specifies the details of the opportunity invitation within the Engagement Invitation payload. This data helps partners understand the context, scope, and expected involvement for the opportunity from AWS.

" } } }, "traits": { - "smithy.api#documentation": "

Contains the data payload associated with the Engagement Invitation. This payload\n includes essential details related to the AWS opportunity and is used by partners to\n evaluate whether to accept or reject the engagement.

" + "smithy.api#documentation": "

Contains the data payload associated with the Engagement Invitation. This payload includes essential details related to the AWS opportunity and is used by partners to evaluate whether to accept or reject the engagement.

" } }, "com.amazonaws.partnercentralselling#PaymentFrequency": { @@ -9747,20 +9771,20 @@ "Value": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Represents the details of the next step recorded, such as follow-up actions or\n decisions made. This field helps in tracking progress and ensuring alignment with\n project goals.

", + "smithy.api#documentation": "

Represents the details of the next step recorded, such as follow-up actions or decisions made. This field helps in tracking progress and ensuring alignment with project goals.

", "smithy.api#required": {} } }, "Time": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

Indicates the date and time when a particular next step was recorded or planned. This\n helps in managing the timeline for the opportunity.

", + "smithy.api#documentation": "

Indicates the date and time when a particular next step was recorded or planned. This helps in managing the timeline for the opportunity.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Tracks the history of next steps associated with the opportunity. This field captures\n the actions planned for the future and their timeline.

" + "smithy.api#documentation": "

Tracks the history of next steps associated with the opportunity. This field captures the actions planned for the future and their timeline.

" } }, "com.amazonaws.partnercentralselling#Project": { @@ -9769,13 +9793,13 @@ "DeliveryModels": { "target": "com.amazonaws.partnercentralselling#DeliveryModels", "traits": { - "smithy.api#documentation": "

Specifies the deployment or consumption model for your solution or service in the\n Opportunity's context. You can select multiple options.

\n

Options' descriptions from the Delivery Model field are:

\n " + "smithy.api#documentation": "

Specifies the deployment or consumption model for your solution or service in the Opportunity's context. You can select multiple options.

Options' descriptions from the Delivery Model field are:

" } }, "ExpectedCustomerSpend": { "target": "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList", "traits": { - "smithy.api#documentation": "

Represents the estimated amount that the customer is expected to spend on AWS services\n related to the opportunity. This helps in evaluating the potential financial value of\n the opportunity for AWS.

" + "smithy.api#documentation": "

Represents the estimated amount that the customer is expected to spend on AWS services related to the opportunity. This helps in evaluating the potential financial value of the opportunity for AWS.

" } }, "Title": { @@ -9790,13 +9814,13 @@ "ApnPrograms": { "target": "com.amazonaws.partnercentralselling#ApnPrograms", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Partner Network (APN) program that influenced the\n Opportunity. APN programs refer to specific partner programs or\n initiatives that can impact the Opportunity.

\n

Valid values: APN Immersion Days | APN Solution Space | ATO (Authority to\n Operate) | AWS Marketplace Campaign | IS Immersion Day SFID Program | ISV Workload\n Migration | Migration Acceleration Program | P3 | Partner Launch Initiative |\n Partner Opportunity Acceleration Funded | The Next Smart | VMware Cloud on AWS |\n Well-Architected | Windows | Workspaces/AppStream Accelerator Program | WWPS\n NDPP\n

" + "smithy.api#documentation": "

Specifies the Amazon Partner Network (APN) program that influenced the Opportunity. APN programs refer to specific partner programs or initiatives that can impact the Opportunity.

Valid values: APN Immersion Days | APN Solution Space | ATO (Authority to Operate) | AWS Marketplace Campaign | IS Immersion Day SFID Program | ISV Workload Migration | Migration Acceleration Program | P3 | Partner Launch Initiative | Partner Opportunity Acceleration Funded | The Next Smart | VMware Cloud on AWS | Well-Architected | Windows | Workspaces/AppStream Accelerator Program | WWPS NDPP

" } }, "CustomerBusinessProblem": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { - "smithy.api#documentation": "

Describes the problem the end customer has, and how the partner is helping. Utilize\n this field to provide a concise narrative that outlines the customer's business\n challenge or issue. Elaborate on how the partner's solution or offerings align to\n resolve the customer's business problem. Include relevant information about the\n partner's value proposition, unique selling points, and expertise to tackle the issue.\n Offer insights on how the proposed solution meets the customer's needs and provides\n value. Use concise language and precise descriptions to convey the context and\n significance of the Opportunity. The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic\n fit of the partner's solution.

", + "smithy.api#documentation": "

Describes the problem the end customer has, and how the partner is helping. Utilize this field to provide a concise narrative that outlines the customer's business challenge or issue. Elaborate on how the partner's solution or offerings align to resolve the customer's business problem. Include relevant information about the partner's value proposition, unique selling points, and expertise to tackle the issue. Offer insights on how the proposed solution meets the customer's needs and provides value. Use concise language and precise descriptions to convey the context and significance of the Opportunity. The content in this field helps Amazon Web Services understand the nature of the Opportunity and the strategic fit of the partner's solution.

", "smithy.api#length": { "min": 20, "max": 2000 @@ -9806,7 +9830,7 @@ "CustomerUseCase": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the proposed solution focus or type of workload for the Opportunity. This\n field captures the primary use case or objective of the proposed solution, and provides\n context and clarity to the addressed workload.

\n

Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data\n Warehouse/Data Integration/ETL/Data Lake/BI | Blockchain | Business Applications:\n Mainframe Modernization | Business Applications & Contact Center | Business\n Applications & SAP Production | Centralized Operations Management | Cloud\n Management Tools | Cloud Management Tools & DevOps with Continuous Integration\n & Continuous Delivery (CICD) | Configuration, Compliance & Auditing |\n Connected Services | Containers & Serverless | Content Delivery & Edge\n Services | Database | Edge Computing/End User Computing | Energy | Enterprise\n Governance & Controls | Enterprise Resource Planning | Financial Services |\n Healthcare and Life Sciences | High Performance Computing | Hybrid Application\n Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations |\n Media & High performance computing (HPC) | Migration/Database Migration |\n Monitoring, logging and performance | Monitoring & Observability | Networking |\n Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC |\n VMWare | Web development & DevOps\n

" + "smithy.api#documentation": "

Specifies the proposed solution focus or type of workload for the Opportunity. This field captures the primary use case or objective of the proposed solution, and provides context and clarity to the addressed workload.

Valid values: AI Machine Learning and Analytics | Archiving | Big Data: Data Warehouse/Data Integration/ETL/Data Lake/BI | Blockchain | Business Applications: Mainframe Modernization | Business Applications & Contact Center | Business Applications & SAP Production | Centralized Operations Management | Cloud Management Tools | Cloud Management Tools & DevOps with Continuous Integration & Continuous Delivery (CICD) | Configuration, Compliance & Auditing | Connected Services | Containers & Serverless | Content Delivery & Edge Services | Database | Edge Computing/End User Computing | Energy | Enterprise Governance & Controls | Enterprise Resource Planning | Financial Services | Healthcare and Life Sciences | High Performance Computing | Hybrid Application Platform | Industrial Software | IOT | Manufacturing, Supply Chain and Operations | Media & High performance computing (HPC) | Migration/Database Migration | Monitoring, logging and performance | Monitoring & Observability | Networking | Outpost | SAP | Security & Compliance | Storage & Backup | Training | VMC | VMWare | Web development & DevOps

" } }, "RelatedOpportunityIdentifier": { @@ -9818,13 +9842,13 @@ "SalesActivities": { "target": "com.amazonaws.partnercentralselling#SalesActivities", "traits": { - "smithy.api#documentation": "

Specifies the Opportunity's sales activities conducted with the end\n customer. These activities help drive Amazon Web Services assignment priority.

\n

Valid values:

\n " + "smithy.api#documentation": "

Specifies the Opportunity's sales activities conducted with the end customer. These activities help drive Amazon Web Services assignment priority.

Valid values:

" } }, "CompetitorName": { "target": "com.amazonaws.partnercentralselling#CompetitorName", "traits": { - "smithy.api#documentation": "

Name of the Opportunity's competitor (if any). Use Other to\n submit a value not in the picklist.

" + "smithy.api#documentation": "

Name of the Opportunity's competitor (if any). Use Other to submit a value not in the picklist.

" } }, "OtherCompetitorNames": { @@ -9839,7 +9863,7 @@ "OtherSolutionDescription": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { - "smithy.api#documentation": "

Specifies the offered solution for the customer's business problem when the \n RelatedEntityIdentifiers.Solutions field value is Other.

", + "smithy.api#documentation": "

Specifies the offered solution for the customer's business problem when the RelatedEntityIdentifiers.Solutions field value is Other.

", "smithy.api#length": { "max": 255 } @@ -9848,7 +9872,7 @@ "AdditionalComments": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Captures additional comments or information for the Opportunity that\n weren't captured in other fields.

", + "smithy.api#documentation": "

Captures additional comments or information for the Opportunity that weren't captured in other fields.

", "smithy.api#length": { "min": 1, "max": 255 @@ -9866,14 +9890,14 @@ "BusinessProblem": { "target": "com.amazonaws.partnercentralselling#EngagementCustomerBusinessProblem", "traits": { - "smithy.api#documentation": "

Describes the business problem that the project aims to solve. This information is\n crucial for understanding the project’s goals and objectives.

", + "smithy.api#documentation": "

Describes the business problem that the project aims to solve. This information is crucial for understanding the project’s goals and objectives.

", "smithy.api#required": {} } }, "Title": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the title of the project. This title helps partners quickly identify and\n understand the focus of the project.

", + "smithy.api#documentation": "

Specifies the title of the project. This title helps partners quickly identify and understand the focus of the project.

", "smithy.api#length": { "min": 1, "max": 255 @@ -9884,20 +9908,20 @@ "TargetCompletionDate": { "target": "com.amazonaws.partnercentralselling#Date", "traits": { - "smithy.api#documentation": "

Specifies the estimated date of project completion. This field helps track the project\n timeline and manage expectations.

", + "smithy.api#documentation": "

Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations.

", "smithy.api#required": {} } }, "ExpectedCustomerSpend": { "target": "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList", "traits": { - "smithy.api#documentation": "

Contains revenue estimates for the partner related to the project. This field provides\n an idea of the financial potential of the opportunity for the partner.

", + "smithy.api#documentation": "

Contains revenue estimates for the partner related to the project. This field provides an idea of the financial potential of the opportunity for the partner.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains details about the project associated with the Engagement Invitation,\n including the business problem and expected outcomes.

" + "smithy.api#documentation": "

Contains details about the project associated with the Engagement Invitation, including the business problem and expected outcomes.

" } }, "com.amazonaws.partnercentralselling#ProjectSummary": { @@ -9906,13 +9930,13 @@ "DeliveryModels": { "target": "com.amazonaws.partnercentralselling#DeliveryModels", "traits": { - "smithy.api#documentation": "

Specifies your solution or service's deployment or consumption model in the\n Opportunity's context. You can select multiple options.

\n

Options' descriptions from the Delivery Model field are:

\n " + "smithy.api#documentation": "

Specifies your solution or service's deployment or consumption model in the Opportunity's context. You can select multiple options.

Options' descriptions from the Delivery Model field are:

" } }, "ExpectedCustomerSpend": { "target": "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList", "traits": { - "smithy.api#documentation": "

Provides a summary of the expected customer spend for the project, offering a\n high-level view of the potential financial impact.

" + "smithy.api#documentation": "

Provides a summary of the expected customer spend for the project, offering a high-level view of the potential financial impact.

" } } }, @@ -9926,13 +9950,13 @@ "DeliveryModels": { "target": "com.amazonaws.partnercentralselling#DeliveryModels", "traits": { - "smithy.api#documentation": "

Describes the deployment or consumption model for the partner solution or offering.\n This field indicates how the project's solution will be delivered or implemented for the\n customer.

" + "smithy.api#documentation": "

Describes the deployment or consumption model for the partner solution or offering. This field indicates how the project's solution will be delivered or implemented for the customer.

" } }, "ExpectedCustomerSpend": { "target": "com.amazonaws.partnercentralselling#ExpectedCustomerSpendList", "traits": { - "smithy.api#documentation": "

Provides information about the anticipated customer spend related to this project.\n This may include details such as amount, frequency, and currency of expected\n expenditure.

" + "smithy.api#documentation": "

Provides information about the anticipated customer spend related to this project. This may include details such as amount, frequency, and currency of expected expenditure.

" } }, "CustomerUseCase": { @@ -9944,13 +9968,13 @@ "SalesActivities": { "target": "com.amazonaws.partnercentralselling#SalesActivities", "traits": { - "smithy.api#documentation": "

Lists the pre-sales activities that have occurred with the end-customer related to\n the opportunity. This field is conditionally mandatory when the project is qualified for\n Co-Sell and helps drive assignment priority on the AWS side. It provides insight into\n the engagement level with the customer.

" + "smithy.api#documentation": "

Lists the pre-sales activities that have occurred with the end-customer related to the opportunity. This field is conditionally mandatory when the project is qualified for Co-Sell and helps drive assignment priority on the AWS side. It provides insight into the engagement level with the customer.

" } }, "OtherSolutionDescription": { "target": "com.amazonaws.partnercentralselling#PiiString", "traits": { - "smithy.api#documentation": "

Offers a description of other solutions if the standard solutions do not adequately\n cover the project's scope.

", + "smithy.api#documentation": "

Offers a description of other solutions if the standard solutions do not adequately cover the project's scope.

", "smithy.api#length": { "max": 255 } @@ -9958,7 +9982,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the project view of an opportunity resource shared through a snapshot.\n

" + "smithy.api#documentation": "

Provides the project view of an opportunity resource shared through a snapshot.

" } }, "com.amazonaws.partnercentralselling#PutSellingSystemSettings": { @@ -9987,7 +10011,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to put system settings settings in AWS Partner Central" }, - "smithy.api#documentation": "

Updates the currently set system settings, which include the IAM Role used for\n resource snapshot jobs.

", + "smithy.api#documentation": "

Updates the currently set system settings, which include the IAM Role used for resource snapshot jobs.

", "smithy.api#http": { "method": "POST", "uri": "/PutSellingSystemSettings", @@ -10002,7 +10026,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog in which the settings will be updated. Acceptable values include\n AWS for production and Sandbox for testing\n environments.

", + "smithy.api#documentation": "

Specifies the catalog in which the settings will be updated. Acceptable values include AWS for production and Sandbox for testing environments.

", "smithy.api#required": {} } }, @@ -10023,7 +10047,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog in which the settings are defined. Acceptable values include\n AWS for production and Sandbox for testing\n environments.

", + "smithy.api#documentation": "

Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.

", "smithy.api#required": {} } }, @@ -10163,12 +10187,12 @@ "Account": { "target": "com.amazonaws.partnercentralselling#AccountReceiver", "traits": { - "smithy.api#documentation": "

Specifies the AWS account of the partner who received the Engagement Invitation. This\n field is used to track the invitation recipient within the AWS ecosystem.

" + "smithy.api#documentation": "

Specifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.

" } } }, "traits": { - "smithy.api#documentation": "

Represents the entity that received the Engagement Invitation, including account and\n company details. This field is essential for tracking the partner who is being invited\n to collaborate.

" + "smithy.api#documentation": "

Represents the entity that received the Engagement Invitation, including account and company details. This field is essential for tracking the partner who is being invited to collaborate.

" } }, "com.amazonaws.partnercentralselling#ReceiverResponsibility": { @@ -10269,7 +10293,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to reject Engagement Invitations on AWS Partner Central" }, - "smithy.api#documentation": "

This action rejects an EngagementInvitation that AWS shared. Rejecting an\n invitation indicates that the partner doesn't want to pursue the opportunity, and all\n related data will become inaccessible thereafter.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/RejectEngagementInvitation", @@ -10283,21 +10307,21 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

This is the catalog that's associated with the engagement invitation. Acceptable\n values are AWS or Sandbox, and these values determine the\n environment in which the opportunity is managed.

", + "smithy.api#documentation": "

This is the catalog that's associated with the engagement invitation. Acceptable values are AWS or Sandbox, and these values determine the environment in which the opportunity is managed.

", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationArnOrIdentifier", "traits": { - "smithy.api#documentation": "

This is the unique identifier of the rejected EngagementInvitation.\n Providing the correct identifier helps to ensure that the intended invitation is\n rejected.

", + "smithy.api#documentation": "

This is the unique identifier of the rejected EngagementInvitation. Providing the correct identifier helps to ensure that the intended invitation is rejected.

", "smithy.api#required": {} } }, "RejectionReason": { "target": "com.amazonaws.partnercentralselling#RejectionReasonString", "traits": { - "smithy.api#documentation": "

This describes the reason for rejecting the engagement invitation, which helps AWS\n track usage patterns. Acceptable values include the following:

\n " + "smithy.api#documentation": "

This describes the reason for rejecting the engagement invitation, which helps AWS track usage patterns. Acceptable values include the following:

" } } }, @@ -10317,24 +10341,24 @@ "AwsMarketplaceOffers": { "target": "com.amazonaws.partnercentralselling#AwsMarketplaceOfferIdentifiers", "traits": { - "smithy.api#documentation": "

Takes one value per opportunity. Each value is an Amazon Resource Name (ARN), in this\n format: \"offers\":\n [\"arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/Offer/offer-sampleOffer32\"].

\n

Use the ListEntities action in the Marketplace Catalog APIs for a list of offers in\n the associated Marketplace seller account.

" + "smithy.api#documentation": "

Takes one value per opportunity. Each value is an Amazon Resource Name (ARN), in this format: \"offers\": [\"arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/Offer/offer-sampleOffer32\"].

Use the ListEntities action in the Marketplace Catalog APIs for a list of offers in the associated Marketplace seller account.

" } }, "Solutions": { "target": "com.amazonaws.partnercentralselling#SolutionIdentifiers", "traits": { - "smithy.api#documentation": "

Enables partner solutions or offerings' association with an opportunity. To associate\n a solution, provide the solution's unique identifier, which you can obtain with the\n ListSolutions operation.

\n

If the specific solution identifier is not available, you can use the value\n Other and provide details about the solution in the\n otherSolutionOffered field. But when the opportunity reaches the\n Committed stage or beyond, the Other value cannot be used,\n and a valid solution identifier must be provided.

\n

By associating the relevant solutions with the opportunity, you can communicate the\n offerings that are being considered or implemented to address the customer's business\n problem.

" + "smithy.api#documentation": "

Enables partner solutions or offerings' association with an opportunity. To associate a solution, provide the solution's unique identifier, which you can obtain with the ListSolutions operation.

If the specific solution identifier is not available, you can use the value Other and provide details about the solution in the otherSolutionOffered field. But when the opportunity reaches the Committed stage or beyond, the Other value cannot be used, and a valid solution identifier must be provided.

By associating the relevant solutions with the opportunity, you can communicate the offerings that are being considered or implemented to address the customer's business problem.

" } }, "AwsProducts": { "target": "com.amazonaws.partnercentralselling#AwsProductIdentifiers", "traits": { - "smithy.api#documentation": "

Enables the association of specific Amazon Web Services products with the\n Opportunity. Partners can indicate the relevant Amazon Web Services\n products for the Opportunity's solution and align with the customer's\n needs. Returns multiple values separated by commas. For example, \"AWSProducts\" :\n [\"AmazonRedshift\", \"AWSAppFabric\", \"AWSCleanRooms\"].

\n

Use the file with the list of Amazon Web Services products hosted on GitHub: \n Amazon Web Services products.

" + "smithy.api#documentation": "

Enables the association of specific Amazon Web Services products with the Opportunity. Partners can indicate the relevant Amazon Web Services products for the Opportunity's solution and align with the customer's needs. Returns multiple values separated by commas. For example, \"AWSProducts\" : [\"AmazonRedshift\", \"AWSAppFabric\", \"AWSCleanRooms\"].

Use the file with the list of Amazon Web Services products hosted on GitHub: Amazon Web Services products.

" } } }, "traits": { - "smithy.api#documentation": "

This field provides the associations' information for other entities with the\n opportunity. These entities include identifiers for AWSProducts,\n Partner Solutions, and AWSMarketplaceOffers.

" + "smithy.api#documentation": "

This field provides the associations' information for other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

" } }, "com.amazonaws.partnercentralselling#RelatedEntityType": { @@ -10380,7 +10404,7 @@ } }, "traits": { - "smithy.api#documentation": "

This error occurs when the specified resource can't be found. The resource might not\n exist, or isn't visible with the current credentials.

\n

Suggested action: Verify that the resource ID is correct and the resource is in the\n expected AWS region. Check IAM permissions for accessing the resource.

", + "smithy.api#documentation": "

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -10404,9 +10428,9 @@ "traits": { "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "relativeDocumentation": "page.html#my-resource" + "relativeDocumentation": "working-with-multi-partner-opportunities.html" }, - "smithy.api#documentation": "Represents snapshot of a resource in AWS Partner Central" + "smithy.api#documentation": "Represents a snapshot of a resource that is in AWS Partner Central" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotArn": { @@ -10451,10 +10475,10 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "relativeDocumentation": "page.html#my-resource", + "relativeDocumentation": "working-with-multi-partner-opportunities.html", "name": "resource-snapshot-job" }, - "smithy.api#documentation": "Represents a job of snapshot resource in AWS Partner Central" + "smithy.api#documentation": "Represents a job that captures snapshot resource in AWS Partner Central" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotJobArn": { @@ -10510,7 +10534,7 @@ "Id": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier for the resource snapshot job within the AWS Partner Central\n system. This ID is used for direct references to the job within the service.

" + "smithy.api#documentation": "

The unique identifier for the resource snapshot job within the AWS Partner Central system. This ID is used for direct references to the job within the service.

" } }, "Arn": { @@ -10528,12 +10552,12 @@ "Status": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobStatus", "traits": { - "smithy.api#documentation": "

The current status of the snapshot job.

\n

Valid values:

\n " + "smithy.api#documentation": "

The current status of the snapshot job.

Valid values:

" } } }, "traits": { - "smithy.api#documentation": "

An object that contains a Resource Snapshot Job's subset of fields.\n

" + "smithy.api#documentation": "

An object that contains a Resource Snapshot Job's subset of fields.

" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotJobSummaryList": { @@ -10553,7 +10577,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the payload of a resource snapshot. This structure is designed to\n accommodate different types of resource snapshots, currently supporting opportunity\n summaries.

" + "smithy.api#documentation": "

Represents the payload of a resource snapshot. This structure is designed to accommodate different types of resource snapshots, currently supporting opportunity summaries.

" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotRevision": { @@ -10570,13 +10594,13 @@ "Arn": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can\n be used for cross-service references and in IAM policies.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can be used for cross-service references and in IAM policies.

" } }, "Revision": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotRevision", "traits": { - "smithy.api#documentation": "

The revision number of the snapshot. This integer value is incremented each time the\n snapshot is updated, allowing for version tracking of the resource snapshot.

" + "smithy.api#documentation": "

The revision number of the snapshot. This integer value is incremented each time the snapshot is updated, allowing for version tracking of the resource snapshot.

" } }, "ResourceType": { @@ -10588,7 +10612,7 @@ "ResourceId": { "target": "com.amazonaws.partnercentralselling#ResourceIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the specific resource snapshotted. The format might vary depending\n on the ResourceType.

" + "smithy.api#documentation": "

The identifier of the specific resource snapshotted. The format might vary depending on the ResourceType.

" } }, "ResourceSnapshotTemplateName": { @@ -10600,12 +10624,12 @@ "CreatedBy": { "target": "com.amazonaws.partnercentralselling#AwsAccount", "traits": { - "smithy.api#documentation": "

The AWS account ID of the entity that owns the resource from which the snapshot was\n created.

" + "smithy.api#documentation": "

The AWS account ID of the entity that owns the resource from which the snapshot was created.

" } } }, "traits": { - "smithy.api#documentation": "

Provides a concise summary of a resource snapshot, including its unique identifier\n and version information. This structure is used to quickly reference and identify\n specific versions of resource snapshots.

" + "smithy.api#documentation": "

Provides a concise summary of a resource snapshot, including its unique identifier and version information. This structure is used to quickly reference and identify specific versions of resource snapshots.

" } }, "com.amazonaws.partnercentralselling#ResourceSnapshotSummaryList": { @@ -10771,68 +10795,43 @@ } } }, - "com.amazonaws.partnercentralselling#SellingSystemSettings": { - "type": "resource", - "identifiers": { - "Catalog": { - "target": "com.amazonaws.partnercentralselling#CatalogIdentifier" - } - }, - "read": { - "target": "com.amazonaws.partnercentralselling#GetSellingSystemSettings" - }, - "update": { - "target": "com.amazonaws.partnercentralselling#PutSellingSystemSettings" - }, - "traits": { - "aws.api#arn": { - "template": "catalog/{Catalog}/selling-system-settings" - }, - "aws.iam#disableConditionKeyInference": {}, - "aws.iam#iamResource": { - "relativeDocumentation": "page.html#my-resource", - "name": "selling-system-settings" - }, - "smithy.api#documentation": "Represents a partner selling system settings in AWS Partner Central" - } - }, "com.amazonaws.partnercentralselling#SenderContact": { "type": "structure", "members": { "Email": { "target": "com.amazonaws.partnercentralselling#SenderContactEmail", "traits": { - "smithy.api#documentation": "

The sender-provided contact's email address associated with the\n EngagementInvitation.

", + "smithy.api#documentation": "

The sender-provided contact's email address associated with the EngagementInvitation.

", "smithy.api#required": {} } }, "FirstName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { - "smithy.api#documentation": "

The sender-provided contact's last name associated with the\n EngagementInvitation.

" + "smithy.api#documentation": "

The sender-provided contact's last name associated with the EngagementInvitation.

" } }, "LastName": { "target": "com.amazonaws.partnercentralselling#Name", "traits": { - "smithy.api#documentation": "

The sender-provided contact's first name associated with the\n EngagementInvitation.

" + "smithy.api#documentation": "

The sender-provided contact's first name associated with the EngagementInvitation.

" } }, "BusinessTitle": { "target": "com.amazonaws.partnercentralselling#JobTitle", "traits": { - "smithy.api#documentation": "

The sender-provided contact's title (job title or role) associated with the\n EngagementInvitation.

" + "smithy.api#documentation": "

The sender-provided contact's title (job title or role) associated with the EngagementInvitation.

" } }, "Phone": { "target": "com.amazonaws.partnercentralselling#PhoneNumber", "traits": { - "smithy.api#documentation": "

The sender-provided contact's phone number associated with the\n EngagementInvitation.

" + "smithy.api#documentation": "

The sender-provided contact's phone number associated with the EngagementInvitation.

" } } }, "traits": { - "smithy.api#documentation": "

An object that contains the details of the sender-provided contact person for the\n EngagementInvitation.

" + "smithy.api#documentation": "

An object that contains the details of the sender-provided contact person for the EngagementInvitation.

" } }, "com.amazonaws.partnercentralselling#SenderContactEmail": { @@ -10865,7 +10864,7 @@ } }, "traits": { - "smithy.api#documentation": "

This error occurs when the request would cause a service quota to be exceeded. Service\n quotas represent the maximum allowed use of a specific resource, and this error\n indicates that the request would surpass that limit.

\n

Suggested action: Review the Quotas for the\n resource, and either reduce usage or request a quota increase.

", + "smithy.api#documentation": "

This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.

Suggested action: Review the Quotas for the resource, and either reduce usage or request a quota increase.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -10876,7 +10875,7 @@ "DeliveryModel": { "target": "com.amazonaws.partnercentralselling#RevenueModel", "traits": { - "smithy.api#documentation": "

Specifies the customer's intended payment type agreement or procurement method to\n acquire the solution or service outlined in the Opportunity.

" + "smithy.api#documentation": "

Specifies the customer's intended payment type agreement or procurement method to acquire the solution or service outlined in the Opportunity.

" } }, "Value": { @@ -10888,18 +10887,18 @@ "EffectiveDate": { "target": "com.amazonaws.partnercentralselling#Date", "traits": { - "smithy.api#documentation": "

Specifies the Opportunity's customer engagement start date for the\n contract's effectiveness.

" + "smithy.api#documentation": "

Specifies the Opportunity's customer engagement start date for the contract's effectiveness.

" } }, "ExpirationDate": { "target": "com.amazonaws.partnercentralselling#Date", "traits": { - "smithy.api#documentation": "

Specifies the expiration date for the contract between the customer and Amazon Web Services partner. It signifies the termination date of the agreed-upon engagement\n period between both parties.

" + "smithy.api#documentation": "

Specifies the expiration date for the contract between the customer and Amazon Web Services partner. It signifies the termination date of the agreed-upon engagement period between both parties.

" } } }, "traits": { - "smithy.api#documentation": "

Specifies a customer's procurement terms details. Required only for partners in\n eligible programs.

" + "smithy.api#documentation": "

Specifies a customer's procurement terms details. Required only for partners in eligible programs.

" } }, "com.amazonaws.partnercentralselling#Solution": { @@ -10921,7 +10920,7 @@ }, "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { - "relativeDocumentation": "/working-with-solutions.html" + "relativeDocumentation": "API_ListSolutions.html" }, "smithy.api#documentation": "Represents a Solution that is listed on AWS Partner Central" } @@ -10938,7 +10937,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog in which the solution is hosted, either AWS or\n Sandbox. This helps partners differentiate between live solutions and\n those in testing environments.

", + "smithy.api#documentation": "

Specifies the catalog in which the solution is hosted, either AWS or Sandbox. This helps partners differentiate between live solutions and those in testing environments.

", "smithy.api#required": {} } }, @@ -10965,14 +10964,14 @@ "Status": { "target": "com.amazonaws.partnercentralselling#SolutionStatus", "traits": { - "smithy.api#documentation": "

Specifies the solution's current status, which indicates its state in the system.\n Valid values: Active | Inactive | Draft. The\n status helps partners and Amazon Web Services track the solution's lifecycle and\n availability. Filter for Active solutions for association to an\n opportunity.

", + "smithy.api#documentation": "

Specifies the solution's current status, which indicates its state in the system. Valid values: Active | Inactive | Draft. The status helps partners and Amazon Web Services track the solution's lifecycle and availability. Filter for Active solutions for association to an opportunity.

", "smithy.api#required": {} } }, "Category": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the solution category, which helps to categorize and organize the solutions\n partners offer. Valid values: Software Product | Consulting\n Service | Hardware Product | Communications Product\n | Professional Service | Managed Service | Value-Added\n Resale Amazon Web Services Service | Distribution Service |\n Training Service | Merger and Acquisition Advising\n Service.

", + "smithy.api#documentation": "

Specifies the solution category, which helps to categorize and organize the solutions partners offer. Valid values: Software Product | Consulting Service | Hardware Product | Communications Product | Professional Service | Managed Service | Value-Added Resale Amazon Web Services Service | Distribution Service | Training Service | Merger and Acquisition Advising Service.

", "smithy.api#required": {} } }, @@ -10985,7 +10984,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies minimal information for the solution offered to solve the customer's\n business problem.

" + "smithy.api#documentation": "

Specifies minimal information for the solution offered to solve the customer's business problem.

" } }, "com.amazonaws.partnercentralselling#SolutionIdentifier": { @@ -11012,20 +11011,20 @@ "SortOrder": { "target": "com.amazonaws.partnercentralselling#SortOrder", "traits": { - "smithy.api#documentation": "

Specifies the sorting order, either Ascending or Descending.\n The default is Descending.

", + "smithy.api#documentation": "

Specifies the sorting order, either Ascending or Descending. The default is Descending.

", "smithy.api#required": {} } }, "SortBy": { "target": "com.amazonaws.partnercentralselling#SolutionSortName", "traits": { - "smithy.api#documentation": "

Specifies the attribute to sort by, such as Name,\n CreatedDate, or Status.

", + "smithy.api#documentation": "

Specifies the attribute to sort by, such as Name, CreatedDate, or Status.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Configures the solutions' response sorting that enables partners to order solutions\n based on specified attributes.

" + "smithy.api#documentation": "

Configures the solutions' response sorting that enables partners to order solutions based on specified attributes.

" } }, "com.amazonaws.partnercentralselling#SolutionSortName": { @@ -11114,7 +11113,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines the sorting parameters for listing resource snapshot jobs. This structure\n allows you to specify the field to sort by and the order of sorting.

" + "smithy.api#documentation": "

Defines the sorting parameters for listing resource snapshot jobs. This structure allows you to specify the field to sort by and the order of sorting.

" } }, "com.amazonaws.partnercentralselling#SortOrder": { @@ -11213,7 +11212,7 @@ } ], "traits": { - "aws.iam#conditionKeys": ["partnercentral:Catalog"], + "aws.iam#conditionKeys": ["partnercentral:Catalog", "aws:RequestTag/${TagKey}", "aws:TagKeys"], "aws.iam#iamAction": { "requiredActions": [ "partnercentral:CreateOpportunity", @@ -11225,7 +11224,7 @@ ], "documentation": "Grants permission to initiate tasks that start Engagements on AWS Partner Central by accepting an Engagement Invitation" }, - "smithy.api#documentation": "

This action starts the engagement by accepting an EngagementInvitation.\n The task is asynchronous and involves the following steps: accepting the invitation,\n creating an opportunity in the partner’s account from the AWS opportunity, and copying\n details for tracking. When completed, an Opportunity Created event is\n generated, indicating that the opportunity has been successfully created in the\n partner's account.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/StartEngagementByAcceptingInvitationTask", @@ -11239,14 +11238,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog related to the task. Use AWS for production\n engagements and Sandbox for testing scenarios.

", + "smithy.api#documentation": "

Specifies the catalog related to the task. Use AWS for production engagements and Sandbox for testing scenarios.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.partnercentralselling#ClientToken", "traits": { - "smithy.api#documentation": "

A unique, case-sensitive identifier provided by the client that helps to ensure the\n idempotency of the request. This can be a random or meaningful string but must be unique\n for each request.

", + "smithy.api#documentation": "

A unique, case-sensitive identifier provided by the client that helps to ensure the idempotency of the request. This can be a random or meaningful string but must be unique for each request.

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1 @@ -11257,14 +11256,14 @@ "Identifier": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationArnOrIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the unique identifier of the EngagementInvitation to be\n accepted. Providing the correct identifier helps ensure that the correct engagement is\n processed.

", + "smithy.api#documentation": "

Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.partnercentralselling#TagList", "traits": { - "smithy.api#documentation": "A list of objects specifying each tag name and value." + "smithy.api#documentation": "

A map of the key-value pairs of the tag or tags to assign.

" } } }, @@ -11284,13 +11283,13 @@ "TaskArn": { "target": "com.amazonaws.partnercentralselling#TaskArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task, used for tracking and managing the task\n within AWS.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.

" } }, "StartTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

The timestamp indicating when the task was initiated. The format follows RFC 3339\n section 5.6.

" + "smithy.api#documentation": "

The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.

" } }, "TaskStatus": { @@ -11302,7 +11301,7 @@ "Message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If the task fails, this field contains a detailed message describing the failure and\n possible recovery steps.

" + "smithy.api#documentation": "

If the task fails, this field contains a detailed message describing the failure and possible recovery steps.

" } }, "ReasonCode": { @@ -11314,7 +11313,7 @@ "OpportunityId": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "

Returns the original opportunity identifier passed in the request. This is the unique\n identifier for the opportunity.

" + "smithy.api#documentation": "

Returns the original opportunity identifier passed in the request. This is the unique identifier for the opportunity.

" } }, "ResourceSnapshotJobId": { @@ -11326,7 +11325,7 @@ "EngagementInvitationId": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationIdentifier", "traits": { - "smithy.api#documentation": "

Returns the identifier of the engagement invitation that was accepted and used to\n create the opportunity.

" + "smithy.api#documentation": "

Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.

" } } }, @@ -11366,7 +11365,7 @@ } ], "traits": { - "aws.iam#conditionKeys": ["partnercentral:Catalog"], + "aws.iam#conditionKeys": ["partnercentral:Catalog", "aws:RequestTag/${TagKey}", "aws:TagKeys"], "aws.iam#iamAction": { "requiredActions": [ "partnercentral:CreateEngagement", @@ -11378,7 +11377,7 @@ ], "documentation": "Grants permission to initiate tasks that start Engagements from Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "

This action initiates the engagement process from an existing opportunity by accepting\n the engagement invitation and creating a corresponding opportunity in the partner’s\n system. Similar to StartEngagementByAcceptingInvitationTask, this action is\n asynchronous and performs multiple steps before completion.

", + "smithy.api#documentation": "

This action initiates the engagement process from an existing opportunity by accepting the engagement invitation and creating a corresponding opportunity in the partner’s system. Similar to StartEngagementByAcceptingInvitationTask, this action is asynchronous and performs multiple steps before completion.

", "smithy.api#http": { "method": "POST", "uri": "/StartEngagementFromOpportunityTask", @@ -11392,14 +11391,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog in which the engagement is tracked. Acceptable values include\n AWS for production and Sandbox for testing\n environments.

", + "smithy.api#documentation": "

Specifies the catalog in which the engagement is tracked. Acceptable values include AWS for production and Sandbox for testing environments.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.partnercentralselling#ClientToken", "traits": { - "smithy.api#documentation": "

A unique token provided by the client to help ensure the idempotency of the request.\n It helps prevent the same task from being performed multiple times.

", + "smithy.api#documentation": "

A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1 @@ -11410,7 +11409,7 @@ "Identifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the opportunity from which the engagement task is to be\n initiated. This helps ensure that the task is applied to the correct opportunity.

", + "smithy.api#documentation": "

The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.

", "smithy.api#required": {} } }, @@ -11423,7 +11422,7 @@ "Tags": { "target": "com.amazonaws.partnercentralselling#TagList", "traits": { - "smithy.api#documentation": "A list of objects specifying each tag name and value." + "smithy.api#documentation": "

A map of the key-value pairs of the tag or tags to assign.

" } } }, @@ -11437,31 +11436,31 @@ "TaskId": { "target": "com.amazonaws.partnercentralselling#TaskIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the task, used to track the task’s progress. This value\n follows a specific pattern: ^oit-[0-9a-z]{13}$.

" + "smithy.api#documentation": "

The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: ^oit-[0-9a-z]{13}$.

" } }, "TaskArn": { "target": "com.amazonaws.partnercentralselling#TaskArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task, used for tracking and managing the task\n within AWS.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.

" } }, "StartTime": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

The timestamp indicating when the task was initiated. The format follows RFC 3339\n section 5.6.

" + "smithy.api#documentation": "

The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.

" } }, "TaskStatus": { "target": "com.amazonaws.partnercentralselling#TaskStatus", "traits": { - "smithy.api#documentation": "

Indicates the current status of the task. Valid values include\n IN_PROGRESS, COMPLETE, and FAILED.

" + "smithy.api#documentation": "

Indicates the current status of the task. Valid values include IN_PROGRESS, COMPLETE, and FAILED.

" } }, "Message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If the task fails, this field contains a detailed message describing the failure and\n possible recovery steps.

" + "smithy.api#documentation": "

If the task fails, this field contains a detailed message describing the failure and possible recovery steps.

" } }, "ReasonCode": { @@ -11473,25 +11472,25 @@ "OpportunityId": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "

Returns the original opportunity identifier passed in the request, which is the unique\n identifier for the opportunity created in the partner’s system.

" + "smithy.api#documentation": "

Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.

" } }, "ResourceSnapshotJobId": { "target": "com.amazonaws.partnercentralselling#ResourceSnapshotJobIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the resource snapshot job created to add the opportunity resource\n snapshot to the Engagement. Only populated if TaskStatus is COMPLETE

" + "smithy.api#documentation": "

The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE

" } }, "EngagementId": { "target": "com.amazonaws.partnercentralselling#EngagementIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the newly created Engagement. Only populated if TaskStatus is\n COMPLETE.

" + "smithy.api#documentation": "

The identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.

" } }, "EngagementInvitationId": { "target": "com.amazonaws.partnercentralselling#EngagementInvitationIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the new Engagement invitation. Only populated if TaskStatus is\n COMPLETE.

" + "smithy.api#documentation": "

The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.

" } } }, @@ -11522,6 +11521,7 @@ } ], "traits": { + "aws.iam#conditionKeys": ["partnercentral:Catalog", "aws:ResourceTag/${TagKey}", "aws:TagKeys"], "aws.iam#iamAction": { "documentation": "Grants permission to starting resource snapshot jobs in AWS Partner Central" }, @@ -11540,7 +11540,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

\n ", + "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

", "smithy.api#required": {} } }, @@ -11580,6 +11580,7 @@ } ], "traits": { + "aws.iam#conditionKeys": ["partnercentral:Catalog", "aws:ResourceTag/${TagKey}", "aws:TagKeys"], "aws.iam#iamAction": { "documentation": "Grants permission to stopping resource snapshot jobs in AWS Partner Central" }, @@ -11598,7 +11599,7 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

\n ", + "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

", "smithy.api#required": {} } }, @@ -11651,7 +11652,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to submit Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "

Use this action to submit an Opportunity that was previously created by partner for\n AWS review. After you perform this action, the Opportunity becomes non-editable until it\n is reviewed by AWS and has LifeCycle.ReviewStatus as either\n Approved or Action Required.

", + "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "POST", "uri": "/SubmitOpportunity", @@ -11665,14 +11666,14 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

\n ", + "smithy.api#documentation": "

Specifies the catalog related to the request. Valid values are:

", "smithy.api#required": {} } }, "Identifier": { "target": "com.amazonaws.partnercentralselling#OpportunityIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of the Opportunity previously created by partner and needs to be\n submitted.

", + "smithy.api#documentation": "

The identifier of the Opportunity previously created by partner and needs to be submitted.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "Identifier" } @@ -11680,14 +11681,14 @@ "InvolvementType": { "target": "com.amazonaws.partnercentralselling#SalesInvolvementType", "traits": { - "smithy.api#documentation": "

Specifies the level of AWS sellers' involvement on the opportunity. Valid\n values:

\n ", + "smithy.api#documentation": "

Specifies the level of AWS sellers' involvement on the opportunity. Valid values:

", "smithy.api#required": {} } }, "Visibility": { "target": "com.amazonaws.partnercentralselling#Visibility", "traits": { - "smithy.api#documentation": "

Determines whether to restrict visibility of the opportunity from AWS sales. Default\n value is Full. Valid values:

\n " + "smithy.api#documentation": "

Determines whether to restrict visibility of the opportunity from AWS sales. Default value is Full. Valid values:

" } } }, @@ -11780,8 +11781,14 @@ } ], "traits": { + "aws.iam#conditionKeys": [ + "partnercentral:Catalog", + "aws:ResourceTag/${TagKey}", + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], "aws.iam#iamAction": { - "documentation": "Allows users to add new tags to a resource. Supported resource: ResourceSnapshotJob" + "documentation": "Grants permission to add new tags to a resource. Supported resource: ResourceSnapshotJob" }, "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified resource.

", "smithy.api#http": { @@ -11805,7 +11812,7 @@ "Tags": { "target": "com.amazonaws.partnercentralselling#TagList", "traits": { - "smithy.api#documentation": "

A map of the key-value pairs of the tag or tags to assign to the resource.

", + "smithy.api#documentation": "

A map of the key-value pairs of the tag or tags to assign.

", "smithy.api#required": {} } } @@ -11913,7 +11920,7 @@ } }, "traits": { - "smithy.api#documentation": "

This error occurs when there are too many requests sent. Review the provided quotas\n and adapt your usage to avoid throttling.

\n

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

", + "smithy.api#documentation": "

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -11947,6 +11954,10 @@ } ], "traits": { + "aws.iam#conditionKeys": ["partnercentral:Catalog", "aws:ResourceTag/${TagKey}", "aws:TagKeys"], + "aws.iam#iamAction": { + "documentation": "Grants permission to remove tags from a resource. Supported resource: ResourceSnapshotJob" + }, "smithy.api#documentation": "

Removes a tag or tags from a resource.

", "smithy.api#http": { "method": "POST", @@ -11969,7 +11980,7 @@ "TagKeys": { "target": "com.amazonaws.partnercentralselling#TagKeyList", "traits": { - "smithy.api#documentation": "

The keys of the key-value pairs for the tag or tags you want to remove from the\n specified resource.

", + "smithy.api#documentation": "

The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.

", "smithy.api#required": {} } } @@ -12018,7 +12029,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to update Opportunities on AWS Partner Central" }, - "smithy.api#documentation": "

Updates the Opportunity record identified by a given\n Identifier. This operation allows you to modify the details of an\n existing opportunity to reflect the latest information and progress. Use this action to\n keep the opportunity record up-to-date and accurate.

\n

When you perform updates, include the entire payload with each request. If any field\n is omitted, the API assumes that the field is set to null. The best\n practice is to always perform a GetOpportunity to retrieve the latest\n values, then send the complete payload with the updated values to be changed.

", + "smithy.api#documentation": "

Updates 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 send the complete payload with the updated values to be changed.

", "smithy.api#http": { "method": "POST", "uri": "/UpdateOpportunity", @@ -12032,26 +12043,26 @@ "Catalog": { "target": "com.amazonaws.partnercentralselling#CatalogIdentifier", "traits": { - "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value\n from a predefined list: AWS or Sandbox. The catalog determines\n which environment the opportunity is updated in. Use AWS to update real\n opportunities in the production environment, and Sandbox for testing in\n secure, isolated environments. When you use the Sandbox catalog, it allows\n you to simulate and validate your interactions with Amazon Web Services services without\n affecting live data or operations.

", + "smithy.api#documentation": "

Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is updated in. Use AWS to update real opportunities in the production environment, and Sandbox for testing in secure, isolated environments. When you use the Sandbox catalog, it allows you to simulate and validate your interactions with Amazon Web Services services without affecting live data or operations.

", "smithy.api#required": {} } }, "PrimaryNeedsFromAws": { "target": "com.amazonaws.partnercentralselling#PrimaryNeedsFromAws", "traits": { - "smithy.api#documentation": "

Identifies the type of support the partner needs from Amazon Web Services.

\n

Valid values:

\n " + "smithy.api#documentation": "

Identifies the type of support the partner needs from Amazon Web Services.

Valid values:

" } }, "NationalSecurity": { "target": "com.amazonaws.partnercentralselling#NationalSecurity", "traits": { - "smithy.api#documentation": "

Specifies if the opportunity is associated with national security concerns. This flag\n is only applicable when the industry is Government. For\n national-security-related opportunities, validation and compliance rules may apply,\n impacting the opportunity's visibility and processing.

" + "smithy.api#documentation": "

Specifies if the opportunity is associated with national security concerns. This flag is only applicable when the industry is Government. For national-security-related opportunities, validation and compliance rules may apply, impacting the opportunity's visibility and processing.

" } }, "PartnerOpportunityIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the opportunity's unique identifier in the partner's CRM system. This value\n is essential to track and reconcile because it's included in the outbound payload sent\n back to the partner.

", + "smithy.api#documentation": "

Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

", "smithy.api#length": { "max": 64 } @@ -12066,13 +12077,13 @@ "Project": { "target": "com.amazonaws.partnercentralselling#Project", "traits": { - "smithy.api#documentation": "

An object that contains project details summary for the\n Opportunity.

" + "smithy.api#documentation": "

An object that contains project details summary for the Opportunity.

" } }, "OpportunityType": { "target": "com.amazonaws.partnercentralselling#OpportunityType", "traits": { - "smithy.api#documentation": "

Specifies the opportunity type as a renewal, new, or expansion.

\n

Opportunity types:

\n " + "smithy.api#documentation": "

Specifies the opportunity type as a renewal, new, or expansion.

Opportunity types:

" } }, "Marketing": { @@ -12084,13 +12095,13 @@ "SoftwareRevenue": { "target": "com.amazonaws.partnercentralselling#SoftwareRevenue", "traits": { - "smithy.api#documentation": "

Specifies details of a customer's procurement terms. Required only for partners in\n eligible programs.

" + "smithy.api#documentation": "

Specifies details of a customer's procurement terms. Required only for partners in eligible programs.

" } }, "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

\n DateTime when the opportunity was last modified.

", + "smithy.api#documentation": "

DateTime when the opportunity was last modified.

", "smithy.api#required": {} } }, @@ -12125,7 +12136,7 @@ "LastModifiedDate": { "target": "com.amazonaws.partnercentralselling#DateTime", "traits": { - "smithy.api#documentation": "

\n DateTime when the opportunity was last modified.

", + "smithy.api#documentation": "

DateTime when the opportunity was last modified.

", "smithy.api#required": {} } } @@ -12152,19 +12163,19 @@ "Reason": { "target": "com.amazonaws.partnercentralselling#ValidationExceptionReason", "traits": { - "smithy.api#documentation": "

The primary reason for this validation exception to occur.

\n ", + "smithy.api#documentation": "

The primary reason for this validation exception to occur.

", "smithy.api#required": {} } }, "ErrorList": { "target": "com.amazonaws.partnercentralselling#ValidationExceptionErrorList", "traits": { - "smithy.api#documentation": "

A list of issues that were discovered in the submitted request or the resource\n state.

" + "smithy.api#documentation": "

A list of issues that were discovered in the submitted request or the resource state.

" } } }, "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by the service or business\n validation rules.

\n

Suggested action: Review the error message, including the failed fields and reasons,\n to correct the request payload.

", + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -12194,7 +12205,7 @@ } }, "traits": { - "smithy.api#documentation": "

Indicates an invalid value for a field.

\n " + "smithy.api#documentation": "

Indicates an invalid value for a field.

" } }, "com.amazonaws.partnercentralselling#ValidationExceptionErrorCode": { From b9f691a5bacc61a12b266eabd9fb2848aee6708c Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 21 May 2025 18:10:37 +0000 Subject: [PATCH 3/8] feat(client-ec2): Release of Dualstack and Ipv6-only EC2 Public DNS hostnames --- clients/client-ec2/README.md | 8 + clients/client-ec2/src/EC2.ts | 23 +++ clients/client-ec2/src/EC2Client.ts | 6 + .../commands/CreateNetworkInterfaceCommand.ts | 8 + .../DescribeLaunchTemplatesCommand.ts | 3 +- .../DescribeNetworkInterfacesCommand.ts | 8 + .../commands/DescribeVpnGatewaysCommand.ts | 3 +- .../commands/DisassociateAddressCommand.ts | 12 ++ .../ModifyPublicIpDnsNameOptionsCommand.ts | 97 ++++++++++ ...aceIamInstanceProfileAssociationCommand.ts | 2 +- ...eCriteriaInAllowedImagesSettingsCommand.ts | 6 +- .../src/commands/TerminateInstancesCommand.ts | 8 +- clients/client-ec2/src/commands/index.ts | 1 + clients/client-ec2/src/models/models_2.ts | 65 +++++-- clients/client-ec2/src/models/models_3.ts | 29 +-- clients/client-ec2/src/models/models_4.ts | 41 ++--- clients/client-ec2/src/models/models_5.ts | 93 ++-------- clients/client-ec2/src/models/models_6.ts | 98 +++++++--- clients/client-ec2/src/models/models_7.ts | 173 +++++++++--------- clients/client-ec2/src/models/models_8.ts | 81 ++++++++ clients/client-ec2/src/protocols/Aws_ec2.ts | 132 ++++++++++++- codegen/sdk-codegen/aws-models/ec2.json | 154 +++++++++++++++- 22 files changed, 793 insertions(+), 258 deletions(-) create mode 100644 clients/client-ec2/src/commands/ModifyPublicIpDnsNameOptionsCommand.ts diff --git a/clients/client-ec2/README.md b/clients/client-ec2/README.md index 98522f1035880..c18a5742f9a69 100644 --- a/clients/client-ec2/README.md +++ b/clients/client-ec2/README.md @@ -4789,6 +4789,14 @@ ModifyPrivateDnsNameOptions [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/command/ModifyPrivateDnsNameOptionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ec2/Interface/ModifyPrivateDnsNameOptionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ec2/Interface/ModifyPrivateDnsNameOptionsCommandOutput/) + +
+ +ModifyPublicIpDnsNameOptions + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ec2/command/ModifyPublicIpDnsNameOptionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ec2/Interface/ModifyPublicIpDnsNameOptionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ec2/Interface/ModifyPublicIpDnsNameOptionsCommandOutput/) +
diff --git a/clients/client-ec2/src/EC2.ts b/clients/client-ec2/src/EC2.ts index d3a44ce73c67c..686105bb6b9c9 100644 --- a/clients/client-ec2/src/EC2.ts +++ b/clients/client-ec2/src/EC2.ts @@ -2799,6 +2799,11 @@ import { ModifyPrivateDnsNameOptionsCommandInput, ModifyPrivateDnsNameOptionsCommandOutput, } from "./commands/ModifyPrivateDnsNameOptionsCommand"; +import { + ModifyPublicIpDnsNameOptionsCommand, + ModifyPublicIpDnsNameOptionsCommandInput, + ModifyPublicIpDnsNameOptionsCommandOutput, +} from "./commands/ModifyPublicIpDnsNameOptionsCommand"; import { ModifyReservedInstancesCommand, ModifyReservedInstancesCommandInput, @@ -3930,6 +3935,7 @@ const commands = { ModifyManagedPrefixListCommand, ModifyNetworkInterfaceAttributeCommand, ModifyPrivateDnsNameOptionsCommand, + ModifyPublicIpDnsNameOptionsCommand, ModifyReservedInstancesCommand, ModifyRouteServerCommand, ModifySecurityGroupRulesCommand, @@ -13669,6 +13675,23 @@ export interface EC2 { cb: (err: any, data?: ModifyPrivateDnsNameOptionsCommandOutput) => void ): void; + /** + * @see {@link ModifyPublicIpDnsNameOptionsCommand} + */ + modifyPublicIpDnsNameOptions( + args: ModifyPublicIpDnsNameOptionsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + modifyPublicIpDnsNameOptions( + args: ModifyPublicIpDnsNameOptionsCommandInput, + cb: (err: any, data?: ModifyPublicIpDnsNameOptionsCommandOutput) => void + ): void; + modifyPublicIpDnsNameOptions( + args: ModifyPublicIpDnsNameOptionsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ModifyPublicIpDnsNameOptionsCommandOutput) => void + ): void; + /** * @see {@link ModifyReservedInstancesCommand} */ diff --git a/clients/client-ec2/src/EC2Client.ts b/clients/client-ec2/src/EC2Client.ts index 33f59d8cb4607..3b94339039587 100644 --- a/clients/client-ec2/src/EC2Client.ts +++ b/clients/client-ec2/src/EC2Client.ts @@ -2021,6 +2021,10 @@ import { ModifyPrivateDnsNameOptionsCommandInput, ModifyPrivateDnsNameOptionsCommandOutput, } from "./commands/ModifyPrivateDnsNameOptionsCommand"; +import { + ModifyPublicIpDnsNameOptionsCommandInput, + ModifyPublicIpDnsNameOptionsCommandOutput, +} from "./commands/ModifyPublicIpDnsNameOptionsCommand"; import { ModifyReservedInstancesCommandInput, ModifyReservedInstancesCommandOutput, @@ -2984,6 +2988,7 @@ export type ServiceInputTypes = | ModifyManagedPrefixListCommandInput | ModifyNetworkInterfaceAttributeCommandInput | ModifyPrivateDnsNameOptionsCommandInput + | ModifyPublicIpDnsNameOptionsCommandInput | ModifyReservedInstancesCommandInput | ModifyRouteServerCommandInput | ModifySecurityGroupRulesCommandInput @@ -3673,6 +3678,7 @@ export type ServiceOutputTypes = | ModifyManagedPrefixListCommandOutput | ModifyNetworkInterfaceAttributeCommandOutput | ModifyPrivateDnsNameOptionsCommandOutput + | ModifyPublicIpDnsNameOptionsCommandOutput | ModifyReservedInstancesCommandOutput | ModifyRouteServerCommandOutput | ModifySecurityGroupRulesCommandOutput diff --git a/clients/client-ec2/src/commands/CreateNetworkInterfaceCommand.ts b/clients/client-ec2/src/commands/CreateNetworkInterfaceCommand.ts index 28f1ca8fbfcd7..b38f115bb3b77 100644 --- a/clients/client-ec2/src/commands/CreateNetworkInterfaceCommand.ts +++ b/clients/client-ec2/src/commands/CreateNetworkInterfaceCommand.ts @@ -143,6 +143,7 @@ export interface CreateNetworkInterfaceCommandOutput extends CreateNetworkInterf * // Ipv6Addresses: [ // NetworkInterfaceIpv6AddressesList * // { // NetworkInterfaceIpv6Address * // Ipv6Address: "STRING_VALUE", + * // PublicIpv6DnsName: "STRING_VALUE", * // IsPrimaryIpv6: true || false, * // }, * // ], @@ -151,6 +152,13 @@ export interface CreateNetworkInterfaceCommandOutput extends CreateNetworkInterf * // OutpostArn: "STRING_VALUE", * // OwnerId: "STRING_VALUE", * // PrivateDnsName: "STRING_VALUE", + * // PublicDnsName: "STRING_VALUE", + * // PublicIpDnsNameOptions: { // PublicIpDnsNameOptions + * // DnsHostnameType: "STRING_VALUE", + * // PublicIpv4DnsName: "STRING_VALUE", + * // PublicIpv6DnsName: "STRING_VALUE", + * // PublicDualStackDnsName: "STRING_VALUE", + * // }, * // PrivateIpAddress: "STRING_VALUE", * // PrivateIpAddresses: [ // NetworkInterfacePrivateIpAddressList * // { // NetworkInterfacePrivateIpAddress diff --git a/clients/client-ec2/src/commands/DescribeLaunchTemplatesCommand.ts b/clients/client-ec2/src/commands/DescribeLaunchTemplatesCommand.ts index 3595260a78bd5..118759ab435f8 100644 --- a/clients/client-ec2/src/commands/DescribeLaunchTemplatesCommand.ts +++ b/clients/client-ec2/src/commands/DescribeLaunchTemplatesCommand.ts @@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeLaunchTemplatesRequest, DescribeLaunchTemplatesResult } from "../models/models_4"; +import { DescribeLaunchTemplatesRequest } from "../models/models_4"; +import { DescribeLaunchTemplatesResult } from "../models/models_5"; import { de_DescribeLaunchTemplatesCommand, se_DescribeLaunchTemplatesCommand } from "../protocols/Aws_ec2"; /** diff --git a/clients/client-ec2/src/commands/DescribeNetworkInterfacesCommand.ts b/clients/client-ec2/src/commands/DescribeNetworkInterfacesCommand.ts index 7d4e4be1cb354..aa8db8bfab268 100644 --- a/clients/client-ec2/src/commands/DescribeNetworkInterfacesCommand.ts +++ b/clients/client-ec2/src/commands/DescribeNetworkInterfacesCommand.ts @@ -108,6 +108,7 @@ export interface DescribeNetworkInterfacesCommandOutput extends DescribeNetworkI * // Ipv6Addresses: [ // NetworkInterfaceIpv6AddressesList * // { // NetworkInterfaceIpv6Address * // Ipv6Address: "STRING_VALUE", + * // PublicIpv6DnsName: "STRING_VALUE", * // IsPrimaryIpv6: true || false, * // }, * // ], @@ -116,6 +117,13 @@ export interface DescribeNetworkInterfacesCommandOutput extends DescribeNetworkI * // OutpostArn: "STRING_VALUE", * // OwnerId: "STRING_VALUE", * // PrivateDnsName: "STRING_VALUE", + * // PublicDnsName: "STRING_VALUE", + * // PublicIpDnsNameOptions: { // PublicIpDnsNameOptions + * // DnsHostnameType: "STRING_VALUE", + * // PublicIpv4DnsName: "STRING_VALUE", + * // PublicIpv6DnsName: "STRING_VALUE", + * // PublicDualStackDnsName: "STRING_VALUE", + * // }, * // PrivateIpAddress: "STRING_VALUE", * // PrivateIpAddresses: [ // NetworkInterfacePrivateIpAddressList * // { // NetworkInterfacePrivateIpAddress diff --git a/clients/client-ec2/src/commands/DescribeVpnGatewaysCommand.ts b/clients/client-ec2/src/commands/DescribeVpnGatewaysCommand.ts index 855ac16c436a7..c0eb6ad4ce796 100644 --- a/clients/client-ec2/src/commands/DescribeVpnGatewaysCommand.ts +++ b/clients/client-ec2/src/commands/DescribeVpnGatewaysCommand.ts @@ -6,8 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DescribeVpnGatewaysRequest } from "../models/models_5"; -import { DescribeVpnGatewaysResult } from "../models/models_6"; +import { DescribeVpnGatewaysRequest, DescribeVpnGatewaysResult } from "../models/models_6"; import { de_DescribeVpnGatewaysCommand, se_DescribeVpnGatewaysCommand } from "../protocols/Aws_ec2"; /** diff --git a/clients/client-ec2/src/commands/DisassociateAddressCommand.ts b/clients/client-ec2/src/commands/DisassociateAddressCommand.ts index 864539dc16966..cfc1d319a7558 100644 --- a/clients/client-ec2/src/commands/DisassociateAddressCommand.ts +++ b/clients/client-ec2/src/commands/DisassociateAddressCommand.ts @@ -30,6 +30,18 @@ export interface DisassociateAddressCommandOutput extends __MetadataBearer {} /** *

Disassociates 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 address

    + *
    • + *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/ModifyPublicIpDnsNameOptionsCommand.ts b/clients/client-ec2/src/commands/ModifyPublicIpDnsNameOptionsCommand.ts new file mode 100644 index 0000000000000..a01e22d7b0d75 --- /dev/null +++ b/clients/client-ec2/src/commands/ModifyPublicIpDnsNameOptionsCommand.ts @@ -0,0 +1,97 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ModifyPublicIpDnsNameOptionsRequest, ModifyPublicIpDnsNameOptionsResult } from "../models/models_7"; +import { de_ModifyPublicIpDnsNameOptionsCommand, se_ModifyPublicIpDnsNameOptionsCommand } from "../protocols/Aws_ec2"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ModifyPublicIpDnsNameOptionsCommand}. + */ +export interface ModifyPublicIpDnsNameOptionsCommandInput extends ModifyPublicIpDnsNameOptionsRequest {} +/** + * @public + * + * The output of {@link ModifyPublicIpDnsNameOptionsCommand}. + */ +export interface ModifyPublicIpDnsNameOptionsCommandOutput + extends ModifyPublicIpDnsNameOptionsResult, + __MetadataBearer {} + +/** + *

Modify public hostname options for a network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyPublicIpDnsNameOptionsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyPublicIpDnsNameOptionsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const input = { // ModifyPublicIpDnsNameOptionsRequest + * NetworkInterfaceId: "STRING_VALUE", // required + * HostnameType: "public-dual-stack-dns-name" || "public-ipv4-dns-name" || "public-ipv6-dns-name", // required + * DryRun: true || false, + * }; + * const command = new ModifyPublicIpDnsNameOptionsCommand(input); + * const response = await client.send(command); + * // { // ModifyPublicIpDnsNameOptionsResult + * // Successful: true || false, + * // }; + * + * ``` + * + * @param ModifyPublicIpDnsNameOptionsCommandInput - {@link ModifyPublicIpDnsNameOptionsCommandInput} + * @returns {@link ModifyPublicIpDnsNameOptionsCommandOutput} + * @see {@link ModifyPublicIpDnsNameOptionsCommandInput} for command's `input` shape. + * @see {@link ModifyPublicIpDnsNameOptionsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape. + * + * @throws {@link EC2ServiceException} + *

Base exception class for all service exceptions from EC2 service.

+ * + * + * @public + */ +export class ModifyPublicIpDnsNameOptionsCommand extends $Command + .classBuilder< + ModifyPublicIpDnsNameOptionsCommandInput, + ModifyPublicIpDnsNameOptionsCommandOutput, + EC2ClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: EC2ClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonEC2", "ModifyPublicIpDnsNameOptions", {}) + .n("EC2Client", "ModifyPublicIpDnsNameOptionsCommand") + .f(void 0, void 0) + .ser(se_ModifyPublicIpDnsNameOptionsCommand) + .de(de_ModifyPublicIpDnsNameOptionsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ModifyPublicIpDnsNameOptionsRequest; + output: ModifyPublicIpDnsNameOptionsResult; + }; + sdk: { + input: ModifyPublicIpDnsNameOptionsCommandInput; + output: ModifyPublicIpDnsNameOptionsCommandOutput; + }; + }; +} diff --git a/clients/client-ec2/src/commands/ReplaceIamInstanceProfileAssociationCommand.ts b/clients/client-ec2/src/commands/ReplaceIamInstanceProfileAssociationCommand.ts index 65c6948d0cfac..3c3c929d6be8b 100644 --- a/clients/client-ec2/src/commands/ReplaceIamInstanceProfileAssociationCommand.ts +++ b/clients/client-ec2/src/commands/ReplaceIamInstanceProfileAssociationCommand.ts @@ -9,7 +9,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { ReplaceIamInstanceProfileAssociationRequest, ReplaceIamInstanceProfileAssociationResult, -} from "../models/models_7"; +} from "../models/models_8"; import { de_ReplaceIamInstanceProfileAssociationCommand, se_ReplaceIamInstanceProfileAssociationCommand, diff --git a/clients/client-ec2/src/commands/ReplaceImageCriteriaInAllowedImagesSettingsCommand.ts b/clients/client-ec2/src/commands/ReplaceImageCriteriaInAllowedImagesSettingsCommand.ts index e824147dc860f..1933c2ddcc446 100644 --- a/clients/client-ec2/src/commands/ReplaceImageCriteriaInAllowedImagesSettingsCommand.ts +++ b/clients/client-ec2/src/commands/ReplaceImageCriteriaInAllowedImagesSettingsCommand.ts @@ -6,8 +6,10 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ReplaceImageCriteriaInAllowedImagesSettingsRequest } from "../models/models_7"; -import { ReplaceImageCriteriaInAllowedImagesSettingsResult } from "../models/models_8"; +import { + ReplaceImageCriteriaInAllowedImagesSettingsRequest, + ReplaceImageCriteriaInAllowedImagesSettingsResult, +} from "../models/models_8"; import { de_ReplaceImageCriteriaInAllowedImagesSettingsCommand, se_ReplaceImageCriteriaInAllowedImagesSettingsCommand, diff --git a/clients/client-ec2/src/commands/TerminateInstancesCommand.ts b/clients/client-ec2/src/commands/TerminateInstancesCommand.ts index aefb50247b258..7e26fbf45ee6f 100644 --- a/clients/client-ec2/src/commands/TerminateInstancesCommand.ts +++ b/clients/client-ec2/src/commands/TerminateInstancesCommand.ts @@ -84,10 +84,10 @@ export interface TerminateInstancesCommandOutput extends TerminateInstancesResul * devices attached to the instance persist. When you terminate an instance, any attached * EBS volumes with the DeleteOnTermination block device mapping parameter set * to true are automatically deleted. For more information about the - * differences between stopping and terminating instances, see Amazon EC2 - * instance state changes in the Amazon EC2 User Guide.

- *

For information about troubleshooting, see Troubleshooting terminating your instance in the - * Amazon EC2 User Guide.

+ * differences between stopping and terminating instances, see Instance lifecycle + * in the Amazon EC2 User Guide.

+ *

For more information about troubleshooting, see Troubleshooting terminating your instance in the + * Amazon EC2 User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ec2/src/commands/index.ts b/clients/client-ec2/src/commands/index.ts index 23869d5692182..37803642e86de 100644 --- a/clients/client-ec2/src/commands/index.ts +++ b/clients/client-ec2/src/commands/index.ts @@ -572,6 +572,7 @@ export * from "./ModifyLocalGatewayRouteCommand"; export * from "./ModifyManagedPrefixListCommand"; export * from "./ModifyNetworkInterfaceAttributeCommand"; export * from "./ModifyPrivateDnsNameOptionsCommand"; +export * from "./ModifyPublicIpDnsNameOptionsCommand"; export * from "./ModifyReservedInstancesCommand"; export * from "./ModifyRouteServerCommand"; export * from "./ModifySecurityGroupRulesCommand"; diff --git a/clients/client-ec2/src/models/models_2.ts b/clients/client-ec2/src/models/models_2.ts index 6b6299e685e7a..2ff81d213e549 100644 --- a/clients/client-ec2/src/models/models_2.ts +++ b/clients/client-ec2/src/models/models_2.ts @@ -3296,6 +3296,12 @@ export interface NetworkInterfaceIpv6Address { */ Ipv6Address?: string | undefined; + /** + *

An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

+ * @public + */ + PublicIpv6DnsName?: string | undefined; + /** *

Determines if an IPv6 address associated with a network interface is the primary IPv6 * address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA @@ -3350,6 +3356,36 @@ export interface NetworkInterfacePrivateIpAddress { PrivateIpAddress?: string | undefined; } +/** + *

Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

+ * @public + */ +export interface PublicIpDnsNameOptions { + /** + *

The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

+ * @public + */ + DnsHostnameType?: string | undefined; + + /** + *

An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.

+ * @public + */ + PublicIpv4DnsName?: string | undefined; + + /** + *

An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.

+ * @public + */ + PublicIpv6DnsName?: string | undefined; + + /** + *

A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.

+ * @public + */ + PublicDualStackDnsName?: string | undefined; +} + /** * @public * @enum @@ -3449,11 +3485,23 @@ export interface NetworkInterface { OwnerId?: string | undefined; /** - *

The private DNS name.

+ *

The private hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

* @public */ PrivateDnsName?: string | undefined; + /** + *

A public hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

+ * @public + */ + PublicDnsName?: string | undefined; + + /** + *

Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

+ * @public + */ + PublicIpDnsNameOptions?: PublicIpDnsNameOptions | undefined; + /** *

The IPv4 address of the network interface within the subnet.

* @public @@ -10965,21 +11013,6 @@ export interface CreateVpcEndpointConnectionNotificationRequest { ClientToken?: string | undefined; } -/** - * @public - * @enum - */ -export const ConnectionNotificationState = { - Disabled: "Disabled", - Enabled: "Enabled", -} as const; - -/** - * @public - */ -export type ConnectionNotificationState = - (typeof ConnectionNotificationState)[keyof typeof ConnectionNotificationState]; - /** * @internal */ diff --git a/clients/client-ec2/src/models/models_3.ts b/clients/client-ec2/src/models/models_3.ts index 7d354f1cb4813..4a79b78a994ea 100644 --- a/clients/client-ec2/src/models/models_3.ts +++ b/clients/client-ec2/src/models/models_3.ts @@ -48,7 +48,6 @@ import { } from "./models_1"; import { - ConnectionNotificationState, GroupIdentifier, LocalGatewayRoute, LocalGatewayRouteTable, @@ -75,6 +74,21 @@ import { VpcBlockPublicAccessExclusion, } from "./models_2"; +/** + * @public + * @enum + */ +export const ConnectionNotificationState = { + Disabled: "Disabled", + Enabled: "Enabled", +} as const; + +/** + * @public + */ +export type ConnectionNotificationState = + (typeof ConnectionNotificationState)[keyof typeof ConnectionNotificationState]; + /** * @public * @enum @@ -7551,19 +7565,6 @@ export interface DescribeClientVpnEndpointsRequest { DryRun?: boolean | undefined; } -/** - * @public - * @enum - */ -export const AssociatedNetworkType = { - vpc: "vpc", -} as const; - -/** - * @public - */ -export type AssociatedNetworkType = (typeof AssociatedNetworkType)[keyof typeof AssociatedNetworkType]; - /** * @internal */ diff --git a/clients/client-ec2/src/models/models_4.ts b/clients/client-ec2/src/models/models_4.ts index 0dc21f7af8feb..c713828f71c68 100644 --- a/clients/client-ec2/src/models/models_4.ts +++ b/clients/client-ec2/src/models/models_4.ts @@ -55,7 +55,6 @@ import { IpamResourceDiscovery, IpamScope, KeyType, - LaunchTemplate, LaunchTemplateAndOverridesResponse, LogDestinationType, OperatorResponse, @@ -70,14 +69,20 @@ import { import { GroupIdentifier, NetworkInterfaceStatus, StateReason } from "./models_2"; -import { - AssociatedNetworkType, - Byoasn, - Filter, - FleetStateCode, - IdFormat, - InstanceTagNotificationAttribute, -} from "./models_3"; +import { Byoasn, Filter, FleetStateCode, IdFormat, InstanceTagNotificationAttribute } from "./models_3"; + +/** + * @public + * @enum + */ +export const AssociatedNetworkType = { + vpc: "vpc", +} as const; + +/** + * @public + */ +export type AssociatedNetworkType = (typeof AssociatedNetworkType)[keyof typeof AssociatedNetworkType]; /** *

Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.

@@ -11963,24 +11968,6 @@ export interface DescribeLaunchTemplatesRequest { MaxResults?: number | undefined; } -/** - * @public - */ -export interface DescribeLaunchTemplatesResult { - /** - *

Information about the launch templates.

- * @public - */ - LaunchTemplates?: LaunchTemplate[] | undefined; - - /** - *

The token to use to retrieve the next page of results. This value is null - * when there are no more results to return.

- * @public - */ - NextToken?: string | undefined; -} - /** * @internal */ diff --git a/clients/client-ec2/src/models/models_5.ts b/clients/client-ec2/src/models/models_5.ts index b00719fdb17ca..dd7848713363f 100644 --- a/clients/client-ec2/src/models/models_5.ts +++ b/clients/client-ec2/src/models/models_5.ts @@ -45,6 +45,7 @@ import { InstanceRequirements, Ipv4PrefixSpecificationRequest, Ipv6PrefixSpecificationRequest, + LaunchTemplate, MacModificationTask, PrivateIpAddressSpecification, SpotInstanceType, @@ -119,6 +120,24 @@ import { import { AttributeBooleanValue, EventInformation, PermissionGroup, ProductCode } from "./models_4"; +/** + * @public + */ +export interface DescribeLaunchTemplatesResult { + /** + *

Information about the launch templates.

+ * @public + */ + LaunchTemplates?: LaunchTemplate[] | undefined; + + /** + *

The token to use to retrieve the next page of results. This value is null + * when there are no more results to return.

+ * @public + */ + NextToken?: string | undefined; +} + /** * @public */ @@ -12853,80 +12872,6 @@ export interface DescribeVpnConnectionsResult { VpnConnections?: VpnConnection[] | undefined; } -/** - *

Contains the parameters for DescribeVpnGateways.

- * @public - */ -export interface DescribeVpnGatewaysRequest { - /** - *

One or more filters.

- *
    - *
  • - *

    - * amazon-side-asn - The Autonomous System Number (ASN) for the - * Amazon side of the gateway.

    - *
    • - *
  • - *

    - * attachment.state - The current state of the attachment between - * the gateway and the VPC (attaching | attached | - * detaching | detached).

    - *
    • - *
  • - *

    - * attachment.vpc-id - The ID of an attached VPC.

    - *
    • - *
  • - *

    - * availability-zone - The Availability Zone for the virtual private - * gateway (if applicable).

    - *
    • - *
  • - *

    - * state - The state of the virtual private gateway - * (pending | available | deleting | - * deleted).

    - *
    • - *
  • - *

    - * tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. - * For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    - *
    • - *
  • - *

    - * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    - *
    • - *
  • - *

    - * type - The type of virtual private gateway. Currently the only - * supported type is ipsec.1.

    - *
    • - *
  • - *

    - * vpn-gateway-id - The ID of the virtual private gateway.

    - *
    • - *
- * @public - */ - Filters?: Filter[] | undefined; - - /** - *

One or more virtual private gateway IDs.

- *

Default: Describes all your virtual private gateways.

- * @public - */ - VpnGatewayIds?: string[] | undefined; - - /** - *

Checks whether you have the required permissions for the action, without actually - * making the request, and provides an error response. If you have the required - * permissions, the error response is DryRunOperation. Otherwise, it is - * UnauthorizedOperation.

- * @public - */ - DryRun?: boolean | undefined; -} - /** * @internal */ diff --git a/clients/client-ec2/src/models/models_6.ts b/clients/client-ec2/src/models/models_6.ts index 9d952f6d55fd8..ed9753db50585 100644 --- a/clients/client-ec2/src/models/models_6.ts +++ b/clients/client-ec2/src/models/models_6.ts @@ -70,6 +70,80 @@ import { import { AnalysisStatus, ManagedBy } from "./models_5"; +/** + *

Contains the parameters for DescribeVpnGateways.

+ * @public + */ +export interface DescribeVpnGatewaysRequest { + /** + *

One or more filters.

+ *
    + *
  • + *

    + * amazon-side-asn - The Autonomous System Number (ASN) for the + * Amazon side of the gateway.

    + *
    • + *
  • + *

    + * attachment.state - The current state of the attachment between + * the gateway and the VPC (attaching | attached | + * detaching | detached).

    + *
    • + *
  • + *

    + * attachment.vpc-id - The ID of an attached VPC.

    + *
    • + *
  • + *

    + * availability-zone - The Availability Zone for the virtual private + * gateway (if applicable).

    + *
    • + *
  • + *

    + * state - The state of the virtual private gateway + * (pending | available | deleting | + * deleted).

    + *
    • + *
  • + *

    + * tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. + * For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    + *
    • + *
  • + *

    + * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    + *
    • + *
  • + *

    + * type - The type of virtual private gateway. Currently the only + * supported type is ipsec.1.

    + *
    • + *
  • + *

    + * vpn-gateway-id - The ID of the virtual private gateway.

    + *
    • + *
+ * @public + */ + Filters?: Filter[] | undefined; + + /** + *

One or more virtual private gateway IDs.

+ *

Default: Describes all your virtual private gateways.

+ * @public + */ + VpnGatewayIds?: string[] | undefined; + + /** + *

Checks whether you have the required permissions for the action, without actually + * making the request, and provides an error response. If you have the required + * permissions, the error response is DryRunOperation. Otherwise, it is + * UnauthorizedOperation.

+ * @public + */ + DryRun?: boolean | undefined; +} + /** *

Contains the output of DescribeVpnGateways.

* @public @@ -7638,30 +7712,6 @@ export interface TransitGatewayPolicyRule { MetaData?: TransitGatewayPolicyRuleMetaData | undefined; } -/** - *

Describes a transit gateway policy table entry

- * @public - */ -export interface TransitGatewayPolicyTableEntry { - /** - *

The rule number for the transit gateway policy table entry.

- * @public - */ - PolicyRuleNumber?: string | undefined; - - /** - *

The policy rule associated with the transit gateway policy table.

- * @public - */ - PolicyRule?: TransitGatewayPolicyRule | undefined; - - /** - *

The ID of the target route table.

- * @public - */ - TargetRouteTableId?: string | undefined; -} - /** * @internal */ diff --git a/clients/client-ec2/src/models/models_7.ts b/clients/client-ec2/src/models/models_7.ts index 0f3fff70d62ba..9bb4981fbf04e 100644 --- a/clients/client-ec2/src/models/models_7.ts +++ b/clients/client-ec2/src/models/models_7.ts @@ -16,8 +16,6 @@ import { EnaSrdSpecification, HostMaintenance, HostRecovery, - IamInstanceProfileAssociation, - IamInstanceProfileSpecification, InstanceEventWindow, Ipv6SupportValue, SecurityGroupReferencingSupportValue, @@ -168,11 +166,35 @@ import { InstanceFamilyCreditSpecification, IpamResourceCidr, Purchase, - TransitGatewayPolicyTableEntry, + TransitGatewayPolicyRule, TransitGatewayPropagationState, UnlimitedSupportedInstanceFamily, } from "./models_6"; +/** + *

Describes a transit gateway policy table entry

+ * @public + */ +export interface TransitGatewayPolicyTableEntry { + /** + *

The rule number for the transit gateway policy table entry.

+ * @public + */ + PolicyRuleNumber?: string | undefined; + + /** + *

The policy rule associated with the transit gateway policy table.

+ * @public + */ + PolicyRule?: TransitGatewayPolicyRule | undefined; + + /** + *

The ID of the target route table.

+ * @public + */ + TargetRouteTableId?: string | undefined; +} + /** * @public */ @@ -4858,6 +4880,71 @@ export interface ModifyPrivateDnsNameOptionsResult { Return?: boolean | undefined; } +/** + * @public + * @enum + */ +export const PublicIpDnsOption = { + public_dual_stack_dns_name: "public-dual-stack-dns-name", + public_ipv4_dns_name: "public-ipv4-dns-name", + public_ipv6_dns_name: "public-ipv6-dns-name", +} as const; + +/** + * @public + */ +export type PublicIpDnsOption = (typeof PublicIpDnsOption)[keyof typeof PublicIpDnsOption]; + +/** + * @public + */ +export interface ModifyPublicIpDnsNameOptionsRequest { + /** + *

A network interface ID.

+ * @public + */ + NetworkInterfaceId: string | undefined; + + /** + *

The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

+ *
    + *
  • + *

    + * public-dual-stack-dns-name: A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.

    + *
    • + *
  • + *

    + * public-ipv4-dns-name: An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.

    + *
    • + *
  • + *

    + * public-ipv6-dns-name: An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.

    + *
    • + *
+ * @public + */ + HostnameType: PublicIpDnsOption | undefined; + + /** + *

Checks whether you have the required permissions for the operation, without actually making the + * request, and provides an error response. If you have the required permissions, the error response is + * DryRunOperation. Otherwise, it is UnauthorizedOperation.

+ * @public + */ + DryRun?: boolean | undefined; +} + +/** + * @public + */ +export interface ModifyPublicIpDnsNameOptionsResult { + /** + *

Whether or not the request was successful.

+ * @public + */ + Successful?: boolean | undefined; +} + /** *

Contains the parameters for ModifyReservedInstances.

* @public @@ -9304,86 +9391,6 @@ export interface ReleaseIpamPoolAllocationResult { Success?: boolean | undefined; } -/** - * @public - */ -export interface ReplaceIamInstanceProfileAssociationRequest { - /** - *

The IAM instance profile.

- * @public - */ - IamInstanceProfile: IamInstanceProfileSpecification | undefined; - - /** - *

The ID of the existing IAM instance profile association.

- * @public - */ - AssociationId: string | undefined; -} - -/** - * @public - */ -export interface ReplaceIamInstanceProfileAssociationResult { - /** - *

Information about the IAM instance profile association.

- * @public - */ - IamInstanceProfileAssociation?: IamInstanceProfileAssociation | undefined; -} - -/** - *

The list of criteria that are evaluated to determine whch AMIs are discoverable and usable - * in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be - * specified are AMI providers.

- *

Up to 10 imageCriteria objects can be specified, and up to a total of 200 - * values for all imageProviders. For more information, see JSON - * configuration for the Allowed AMIs criteria in the - * Amazon EC2 User Guide.

- * @public - */ -export interface ImageCriterionRequest { - /** - *

A list of image providers whose AMIs are discoverable and useable in the account. Up to a - * total of 200 values can be specified.

- *

Possible values:

- *

- * amazon: Allow AMIs created by Amazon Web Services.

- *

- * aws-marketplace: Allow AMIs created by verified providers in the Amazon Web Services - * Marketplace.

- *

- * aws-backup-vault: Allow AMIs created by Amazon Web Services Backup.

- *

12-digit account ID: Allow AMIs created by this account. One or more account IDs can be - * specified.

- *

- * none: Allow AMIs created by your own account only. When none is - * specified, no other values can be specified.

- * @public - */ - ImageProviders?: string[] | undefined; -} - -/** - * @public - */ -export interface ReplaceImageCriteriaInAllowedImagesSettingsRequest { - /** - *

The list of criteria that are evaluated to determine whether AMIs are discoverable and - * usable in the account in the specified Amazon Web Services Region.

- * @public - */ - ImageCriteria?: ImageCriterionRequest[] | undefined; - - /** - *

Checks whether you have the required permissions for the action, without actually making the request, - * and provides an error response. If you have the required permissions, the error response is - * DryRunOperation. Otherwise, it is UnauthorizedOperation.

- * @public - */ - DryRun?: boolean | undefined; -} - /** * @internal */ diff --git a/clients/client-ec2/src/models/models_8.ts b/clients/client-ec2/src/models/models_8.ts index 43f18ad233984..8be7b434ead5c 100644 --- a/clients/client-ec2/src/models/models_8.ts +++ b/clients/client-ec2/src/models/models_8.ts @@ -6,6 +6,7 @@ import { AddressAttributeName, ByoipCidr, ClientVpnAuthorizationRuleStatus, + IamInstanceProfileAssociation, IamInstanceProfileSpecification, IpPermission, NatGatewayAddress, @@ -69,6 +70,86 @@ import { import { CapacityReservationSpecification, InstanceMonitoring, Status } from "./models_7"; +/** + * @public + */ +export interface ReplaceIamInstanceProfileAssociationRequest { + /** + *

The IAM instance profile.

+ * @public + */ + IamInstanceProfile: IamInstanceProfileSpecification | undefined; + + /** + *

The ID of the existing IAM instance profile association.

+ * @public + */ + AssociationId: string | undefined; +} + +/** + * @public + */ +export interface ReplaceIamInstanceProfileAssociationResult { + /** + *

Information about the IAM instance profile association.

+ * @public + */ + IamInstanceProfileAssociation?: IamInstanceProfileAssociation | undefined; +} + +/** + *

The list of criteria that are evaluated to determine whch AMIs are discoverable and usable + * in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be + * specified are AMI providers.

+ *

Up to 10 imageCriteria objects can be specified, and up to a total of 200 + * values for all imageProviders. For more information, see JSON + * configuration for the Allowed AMIs criteria in the + * Amazon EC2 User Guide.

+ * @public + */ +export interface ImageCriterionRequest { + /** + *

A list of image providers whose AMIs are discoverable and useable in the account. Up to a + * total of 200 values can be specified.

+ *

Possible values:

+ *

+ * amazon: Allow AMIs created by Amazon Web Services.

+ *

+ * aws-marketplace: Allow AMIs created by verified providers in the Amazon Web Services + * Marketplace.

+ *

+ * aws-backup-vault: Allow AMIs created by Amazon Web Services Backup.

+ *

12-digit account ID: Allow AMIs created by this account. One or more account IDs can be + * specified.

+ *

+ * none: Allow AMIs created by your own account only. When none is + * specified, no other values can be specified.

+ * @public + */ + ImageProviders?: string[] | undefined; +} + +/** + * @public + */ +export interface ReplaceImageCriteriaInAllowedImagesSettingsRequest { + /** + *

The list of criteria that are evaluated to determine whether AMIs are discoverable and + * usable in the account in the specified Amazon Web Services Region.

+ * @public + */ + ImageCriteria?: ImageCriterionRequest[] | undefined; + + /** + *

Checks whether you have the required permissions for the action, without actually making the request, + * and provides an error response. If you have the required permissions, the error response is + * DryRunOperation. Otherwise, it is UnauthorizedOperation.

+ * @public + */ + DryRun?: boolean | undefined; +} + /** * @public */ diff --git a/clients/client-ec2/src/protocols/Aws_ec2.ts b/clients/client-ec2/src/protocols/Aws_ec2.ts index c9ce7b3593c8c..28f7cbcaf4143 100644 --- a/clients/client-ec2/src/protocols/Aws_ec2.ts +++ b/clients/client-ec2/src/protocols/Aws_ec2.ts @@ -1992,6 +1992,10 @@ import { ModifyPrivateDnsNameOptionsCommandInput, ModifyPrivateDnsNameOptionsCommandOutput, } from "../commands/ModifyPrivateDnsNameOptionsCommand"; +import { + ModifyPublicIpDnsNameOptionsCommandInput, + ModifyPublicIpDnsNameOptionsCommandOutput, +} from "../commands/ModifyPublicIpDnsNameOptionsCommand"; import { ModifyReservedInstancesCommandInput, ModifyReservedInstancesCommandOutput, @@ -3004,6 +3008,7 @@ import { PriceScheduleSpecification, PropagatingVgw, ProvisionedBandwidth, + PublicIpDnsNameOptions, ReplaceRootVolumeTask, RequestFilterPortRange, ResponseLaunchTemplateData, @@ -3466,7 +3471,6 @@ import { DescribeKeyPairsRequest, DescribeKeyPairsResult, DescribeLaunchTemplatesRequest, - DescribeLaunchTemplatesResult, DestinationOptionsResponse, DirectoryServiceAuthentication, DiskImageDescription, @@ -3591,6 +3595,7 @@ import { ClassicLoadBalancer, ClassicLoadBalancersConfig, CreateVolumePermission, + DescribeLaunchTemplatesResult, DescribeLaunchTemplateVersionsRequest, DescribeLaunchTemplateVersionsResult, DescribeLocalGatewayRouteTablesRequest, @@ -3781,7 +3786,6 @@ import { DescribeVpcsResult, DescribeVpnConnectionsRequest, DescribeVpnConnectionsResult, - DescribeVpnGatewaysRequest, HistoryRecord, InstanceNetworkInterfaceSpecification, LaunchSpecification, @@ -3868,6 +3872,7 @@ import { CoipAddressUsage, DataQuery, DataResponse, + DescribeVpnGatewaysRequest, DescribeVpnGatewaysResult, DetachClassicLinkVpcRequest, DetachClassicLinkVpcResult, @@ -4132,7 +4137,6 @@ import { TransitGatewayMulticastDomainAssociation, TransitGatewayPolicyRule, TransitGatewayPolicyRuleMetaData, - TransitGatewayPolicyTableEntry, TransitGatewayPropagation, VerifiedAccessInstanceOpenVpnClientConfiguration, VerifiedAccessInstanceOpenVpnClientConfigurationRoute, @@ -4168,7 +4172,6 @@ import { GetVpnConnectionDeviceTypesResult, GetVpnTunnelReplacementStatusRequest, GetVpnTunnelReplacementStatusResult, - ImageCriterionRequest, ImageDiskContainer, ImageRecycleBinInfo, ImportClientVpnClientCertificateRevocationListRequest, @@ -4262,6 +4265,8 @@ import { ModifyNetworkInterfaceAttributeRequest, ModifyPrivateDnsNameOptionsRequest, ModifyPrivateDnsNameOptionsResult, + ModifyPublicIpDnsNameOptionsRequest, + ModifyPublicIpDnsNameOptionsResult, ModifyReservedInstancesRequest, ModifyReservedInstancesResult, ModifyRouteServerRequest, @@ -4401,9 +4406,6 @@ import { RemoveIpamOperatingRegion, RemoveIpamOrganizationalUnitExclusion, RemovePrefixListEntry, - ReplaceIamInstanceProfileAssociationRequest, - ReplaceIamInstanceProfileAssociationResult, - ReplaceImageCriteriaInAllowedImagesSettingsRequest, ReservedInstanceLimitPrice, SecurityGroupRuleRequest, SecurityGroupRuleUpdate, @@ -4414,6 +4416,7 @@ import { TrafficMirrorSessionField, TransitGatewayMulticastRegisteredGroupMembers, TransitGatewayMulticastRegisteredGroupSources, + TransitGatewayPolicyTableEntry, TransitGatewayRouteTableAssociation, TransitGatewayRouteTablePropagation, UnsuccessfulInstanceCreditSpecificationItem, @@ -4433,6 +4436,7 @@ import { ElasticInferenceAccelerator, EnclaveOptionsRequest, HibernationOptionsRequest, + ImageCriterionRequest, InstanceMaintenanceOptionsRequest, InstanceMarketOptionsRequest, InstanceMetadataOptionsRequest, @@ -4441,6 +4445,9 @@ import { LaunchTemplateSpecification, LicenseConfigurationRequest, PrivateDnsNameOptionsRequest, + ReplaceIamInstanceProfileAssociationRequest, + ReplaceIamInstanceProfileAssociationResult, + ReplaceImageCriteriaInAllowedImagesSettingsRequest, ReplaceImageCriteriaInAllowedImagesSettingsResult, ReplaceNetworkAclAssociationRequest, ReplaceNetworkAclAssociationResult, @@ -14283,6 +14290,23 @@ export const se_ModifyPrivateDnsNameOptionsCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +/** + * serializeAws_ec2ModifyPublicIpDnsNameOptionsCommand + */ +export const se_ModifyPublicIpDnsNameOptionsCommand = async ( + input: ModifyPublicIpDnsNameOptionsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = SHARED_HEADERS; + let body: any; + body = buildFormUrlencodedString({ + ...se_ModifyPublicIpDnsNameOptionsRequest(input, context), + [_A]: _MPIDNO, + [_V]: _, + }); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + /** * serializeAws_ec2ModifyReservedInstancesCommand */ @@ -27516,6 +27540,26 @@ export const de_ModifyPrivateDnsNameOptionsCommand = async ( return response; }; +/** + * deserializeAws_ec2ModifyPublicIpDnsNameOptionsCommand + */ +export const de_ModifyPublicIpDnsNameOptionsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode >= 300) { + return de_CommandError(output, context); + } + const data: any = await parseBody(output.body, context); + let contents: any = {}; + contents = de_ModifyPublicIpDnsNameOptionsResult(data, context); + const response: ModifyPublicIpDnsNameOptionsCommandOutput = { + $metadata: deserializeMetadata(output), + ...contents, + }; + return response; +}; + /** * deserializeAws_ec2ModifyReservedInstancesCommand */ @@ -50893,6 +50937,26 @@ const se_ModifyPrivateDnsNameOptionsRequest = ( return entries; }; +/** + * serializeAws_ec2ModifyPublicIpDnsNameOptionsRequest + */ +const se_ModifyPublicIpDnsNameOptionsRequest = ( + input: ModifyPublicIpDnsNameOptionsRequest, + context: __SerdeContext +): any => { + const entries: any = {}; + if (input[_NII] != null) { + entries[_NII] = input[_NII]; + } + if (input[_HTo] != null) { + entries[_HTo] = input[_HTo]; + } + if (input[_DRr] != null) { + entries[_DRr] = input[_DRr]; + } + return entries; +}; + /** * serializeAws_ec2ModifyReservedInstancesRequest */ @@ -79034,6 +79098,20 @@ const de_ModifyPrivateDnsNameOptionsResult = ( return contents; }; +/** + * deserializeAws_ec2ModifyPublicIpDnsNameOptionsResult + */ +const de_ModifyPublicIpDnsNameOptionsResult = ( + output: any, + context: __SerdeContext +): ModifyPublicIpDnsNameOptionsResult => { + const contents: any = {}; + if (output[_suc] != null) { + contents[_Suc] = __parseBoolean(output[_suc]); + } + return contents; +}; + /** * deserializeAws_ec2ModifyReservedInstancesResult */ @@ -80244,6 +80322,12 @@ const de_NetworkInterface = (output: any, context: __SerdeContext): NetworkInter if (output[_pDN] != null) { contents[_PDN] = __expectString(output[_pDN]); } + if (output[_pDNu] != null) { + contents[_PDNu] = __expectString(output[_pDNu]); + } + if (output[_pIDNO] != null) { + contents[_PIDNO] = de_PublicIpDnsNameOptions(output[_pIDNO], context); + } if (output[_pIA] != null) { contents[_PIAr] = __expectString(output[_pIA]); } @@ -80400,6 +80484,9 @@ const de_NetworkInterfaceIpv6Address = (output: any, context: __SerdeContext): N if (output[_iApv] != null) { contents[_IApv] = __expectString(output[_iApv]); } + if (output[_pIDN] != null) { + contents[_PIDN] = __expectString(output[_pIDN]); + } if (output[_iPI] != null) { contents[_IPIs] = __parseBoolean(output[_iPI]); } @@ -81806,6 +81893,26 @@ const de_PtrUpdateStatus = (output: any, context: __SerdeContext): PtrUpdateStat return contents; }; +/** + * deserializeAws_ec2PublicIpDnsNameOptions + */ +const de_PublicIpDnsNameOptions = (output: any, context: __SerdeContext): PublicIpDnsNameOptions => { + const contents: any = {}; + if (output[_dHT] != null) { + contents[_DHT] = __expectString(output[_dHT]); + } + if (output[_pIDNu] != null) { + contents[_PIDNu] = __expectString(output[_pIDNu]); + } + if (output[_pIDN] != null) { + contents[_PIDN] = __expectString(output[_pIDN]); + } + if (output[_pDSDN] != null) { + contents[_PDSDN] = __expectString(output[_pDSDN]); + } + return contents; +}; + /** * deserializeAws_ec2PublicIpv4Pool */ @@ -91245,6 +91352,7 @@ const _DHI = "DedicatedHostIds"; const _DHR = "DescribeHostReservations"; const _DHRO = "DescribeHostReservationOfferings"; const _DHS = "DedicatedHostsSupported"; +const _DHT = "DnsHostnameType"; const _DI = "DeleteIpam"; const _DIA = "DescribeImageAttribute"; const _DIAe = "DescribeInstanceAttribute"; @@ -92302,6 +92410,7 @@ const _MOSLSV = "MacOSLatestSupportedVersions"; const _MOa = "MaintenanceOptions"; const _MP = "MatchPaths"; const _MPDNO = "ModifyPrivateDnsNameOptions"; +const _MPIDNO = "ModifyPublicIpDnsNameOptions"; const _MPIOL = "MapPublicIpOnLaunch"; const _MPL = "MaxParallelLaunches"; const _MPa = "MaxPrice"; @@ -92558,6 +92667,7 @@ const _PDNr = "PrivateDnsNames"; const _PDNu = "PublicDnsName"; const _PDOFIRE = "PrivateDnsOnlyForInboundResolverEndpoint"; const _PDRTI = "PropagationDefaultRouteTableId"; +const _PDSDN = "PublicDualStackDnsName"; const _PDSI = "PublicDefaultScopeId"; const _PDSIr = "PrivateDefaultScopeId"; const _PDa = "PasswordData"; @@ -92590,6 +92700,9 @@ const _PIAha = "Phase2IntegrityAlgorithms"; const _PIAr = "PrivateIpAddress"; const _PIAu = "PublicIpAddress"; const _PIB = "ProvisionIpamByoasn"; +const _PIDN = "PublicIpv6DnsName"; +const _PIDNO = "PublicIpDnsNameOptions"; +const _PIDNu = "PublicIpv4DnsName"; const _PIP = "PublicIpv4Pool"; const _PIPC = "ProvisionIpamPoolCidr"; const _PIPI = "PublicIpv4PoolId"; @@ -93781,6 +93894,7 @@ const _dES = "dnsEntrySet"; const _dFA = "defaultForAz"; const _dHIS = "dedicatedHostIdSet"; const _dHS = "dedicatedHostsSupported"; +const _dHT = "dnsHostnameType"; const _dI = "directoryId"; const _dICB = "destinationIpv6CidrBlock"; const _dIF = "diskImageFormat"; @@ -94581,6 +94695,7 @@ const _pDNu = "publicDnsName"; const _pDOFIRE = "privateDnsOnlyForInboundResolverEndpoint"; const _pDRTI = "propagationDefaultRouteTableId"; const _pDS = "pricingDetailsSet"; +const _pDSDN = "publicDualStackDnsName"; const _pDSI = "publicDefaultScopeId"; const _pDSIr = "privateDefaultScopeId"; const _pDa = "paymentDue"; @@ -94605,6 +94720,9 @@ const _pIA = "privateIpAddress"; const _pIAS = "privateIpAddressesSet"; const _pIASh = "phase1IntegrityAlgorithmSet"; const _pIASha = "phase2IntegrityAlgorithmSet"; +const _pIDN = "publicIpv6DnsName"; +const _pIDNO = "publicIpDnsNameOptions"; +const _pIDNu = "publicIpv4DnsName"; const _pIP = "publicIpv4Pool"; const _pIPI = "publicIpv4PoolId"; const _pIPS = "publicIpv4PoolSet"; diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 78b9e65d0fa2e..6060544eeaa35 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -3992,6 +3992,9 @@ { "target": "com.amazonaws.ec2#ModifyPrivateDnsNameOptions" }, + { + "target": "com.amazonaws.ec2#ModifyPublicIpDnsNameOptions" + }, { "target": "com.amazonaws.ec2#ModifyReservedInstances" }, @@ -48276,7 +48279,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "

Disassociates an Elastic IP address from the instance or network interface it's associated with.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

", + "smithy.api#documentation": "

Disassociates an Elastic IP address from the instance or network interface it's associated with.

\n

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

\n

An address cannot be disassociated if the all of the following conditions are met:

\n
    \n
  • \n

    Network interface has a publicDualStackDnsName publicDnsName

    \n
    • \n
  • \n

    Public IPv4 address is the primary public IPv4 address

    \n
    • \n
  • \n

    Network interface only has one remaining public IPv4 address

    \n
    • \n
", "smithy.api#examples": [ { "title": "To disassociate an Elastic IP address", @@ -84280,6 +84283,64 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#ModifyPublicIpDnsNameOptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#ModifyPublicIpDnsNameOptionsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#ModifyPublicIpDnsNameOptionsResult" + }, + "traits": { + "smithy.api#documentation": "

Modify public hostname options for a network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#ModifyPublicIpDnsNameOptionsRequest": { + "type": "structure", + "members": { + "NetworkInterfaceId": { + "target": "com.amazonaws.ec2#NetworkInterfaceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

A network interface ID.

", + "smithy.api#required": {} + } + }, + "HostnameType": { + "target": "com.amazonaws.ec2#PublicIpDnsOption", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

\n
    \n
  • \n

    \n public-dual-stack-dns-name: A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.

    \n
    • \n
  • \n

    \n public-ipv4-dns-name: An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.

    \n
    • \n
  • \n

    \n public-ipv6-dns-name: An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "

Checks whether you have the required permissions for the operation, without actually making the \n request, and provides an error response. If you have the required permissions, the error response is \n DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#ModifyPublicIpDnsNameOptionsResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Successful", + "smithy.api#documentation": "

Whether or not the request was successful.

", + "smithy.api#xmlName": "successful" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#ModifyReservedInstances": { "type": "operation", "input": { @@ -89366,10 +89427,26 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "PrivateDnsName", - "smithy.api#documentation": "

The private DNS name.

", + "smithy.api#documentation": "

The private hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

", "smithy.api#xmlName": "privateDnsName" } }, + "PublicDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicDnsName", + "smithy.api#documentation": "

A public hostname. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "publicDnsName" + } + }, + "PublicIpDnsNameOptions": { + "target": "com.amazonaws.ec2#PublicIpDnsNameOptions", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpDnsNameOptions", + "smithy.api#documentation": "

Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "publicIpDnsNameOptions" + } + }, "PrivateIpAddress": { "target": "com.amazonaws.ec2#String", "traits": { @@ -89826,6 +89903,14 @@ "smithy.api#xmlName": "ipv6Address" } }, + "PublicIpv6DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv6DnsName", + "smithy.api#documentation": "

An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "publicIpv6DnsName" + } + }, "IsPrimaryIpv6": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -93555,6 +93640,69 @@ "com.amazonaws.ec2#PublicIpAddress": { "type": "string" }, + "com.amazonaws.ec2#PublicIpDnsNameOptions": { + "type": "structure", + "members": { + "DnsHostnameType": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsHostnameType", + "smithy.api#documentation": "

The public hostname type. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

", + "smithy.api#xmlName": "dnsHostnameType" + } + }, + "PublicIpv4DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv4DnsName", + "smithy.api#documentation": "

An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface.

", + "smithy.api#xmlName": "publicIpv4DnsName" + } + }, + "PublicIpv6DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicIpv6DnsName", + "smithy.api#documentation": "

An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface.

", + "smithy.api#xmlName": "publicIpv6DnsName" + } + }, + "PublicDualStackDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PublicDualStackDnsName", + "smithy.api#documentation": "

A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface.

", + "smithy.api#xmlName": "publicDualStackDnsName" + } + } + }, + "traits": { + "smithy.api#documentation": "

Public hostname type options. For more information, see EC2 instance hostnames, DNS names, and domains in the Amazon EC2 User Guide.

" + } + }, + "com.amazonaws.ec2#PublicIpDnsOption": { + "type": "enum", + "members": { + "public_dual_stack_dns_name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public-dual-stack-dns-name" + } + }, + "public_ipv4_dns_name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public-ipv4-dns-name" + } + }, + "public_ipv6_dns_name": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "public-ipv6-dns-name" + } + } + } + }, "com.amazonaws.ec2#PublicIpStringList": { "type": "list", "member": { @@ -109177,7 +109325,7 @@ "target": "com.amazonaws.ec2#TerminateInstancesResult" }, "traits": { - "smithy.api#documentation": "

Shuts down the specified instances. This operation is idempotent; if you\n terminate an instance more than once, each call succeeds.

\n

If you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.

\n

If you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:

\n
    \n
  • \n

    The specified instances that are in the same Availability Zone as the\n protected instance are not terminated.

    \n
    • \n
  • \n

    The specified instances that are in different Availability Zones, where no\n other specified instances are protected, are successfully terminated.

    \n
    • \n
\n

For example, say you have the following instances:

\n
    \n
  • \n

    Instance A: us-east-1a; Not protected

    \n
    • \n
  • \n

    Instance B: us-east-1a; Not protected

    \n
    • \n
  • \n

    Instance C: us-east-1b; Protected

    \n
    • \n
  • \n

    Instance D: us-east-1b; not protected

    \n
    • \n
\n

If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:

\n
    \n
  • \n

    Instance A and Instance B are successfully terminated because none of the\n specified instances in us-east-1a are enabled for termination\n protection.

    \n
    • \n
  • \n

    Instance C and Instance D fail to terminate because at least one of the\n specified instances in us-east-1b (Instance C) is enabled for\n termination protection.

    \n
    • \n
\n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Amazon EC2\n instance state changes in the Amazon EC2 User Guide.

\n

For information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.

", + "smithy.api#documentation": "

Shuts down the specified instances. This operation is idempotent; if you\n terminate an instance more than once, each call succeeds.

\n

If you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.

\n

If you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:

\n
    \n
  • \n

    The specified instances that are in the same Availability Zone as the\n protected instance are not terminated.

    \n
    • \n
  • \n

    The specified instances that are in different Availability Zones, where no\n other specified instances are protected, are successfully terminated.

    \n
    • \n
\n

For example, say you have the following instances:

\n
    \n
  • \n

    Instance A: us-east-1a; Not protected

    \n
    • \n
  • \n

    Instance B: us-east-1a; Not protected

    \n
    • \n
  • \n

    Instance C: us-east-1b; Protected

    \n
    • \n
  • \n

    Instance D: us-east-1b; not protected

    \n
    • \n
\n

If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:

\n
    \n
  • \n

    Instance A and Instance B are successfully terminated because none of the\n specified instances in us-east-1a are enabled for termination\n protection.

    \n
    • \n
  • \n

    Instance C and Instance D fail to terminate because at least one of the\n specified instances in us-east-1b (Instance C) is enabled for\n termination protection.

    \n
    • \n
\n

Terminated instances remain visible after termination (for approximately one\n hour).

\n

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.

\n

You can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.

\n

For more information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.

", "smithy.api#examples": [ { "title": "To terminate an EC2 instance", From 0eed8726267e154755d45f5545a2e008a7af689b Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 21 May 2025 18:10:37 +0000 Subject: [PATCH 4/8] feat(client-cloudwatch): Adds support for setting up Contributor Insight rules on logs transformed via Logs Transformation feature. --- .../src/commands/DeleteAlarmsCommand.ts | 4 +- .../src/commands/DeleteDashboardsCommand.ts | 3 + .../commands/DescribeInsightRulesCommand.ts | 1 + .../src/commands/PutDashboardCommand.ts | 3 + .../src/commands/PutInsightRuleCommand.ts | 1 + .../src/commands/TagResourceCommand.ts | 3 + .../src/commands/UntagResourceCommand.ts | 3 + .../client-cloudwatch/src/models/models_0.ts | 85 ++++++++++++++----- .../src/protocols/Aws_query.ts | 35 ++++++++ .../sdk-codegen/aws-models/cloudwatch.json | 64 +++++++++++--- 10 files changed, 167 insertions(+), 35 deletions(-) diff --git a/clients/client-cloudwatch/src/commands/DeleteAlarmsCommand.ts b/clients/client-cloudwatch/src/commands/DeleteAlarmsCommand.ts index 2c1b62e894c85..07de8d575c495 100644 --- a/clients/client-cloudwatch/src/commands/DeleteAlarmsCommand.ts +++ b/clients/client-cloudwatch/src/commands/DeleteAlarmsCommand.ts @@ -32,8 +32,8 @@ export interface DeleteAlarmsCommandOutput extends __MetadataBearer {} * 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 an incorrect alarm name or make any other error in the operation, - * no alarms are deleted. To confirm that alarms were deleted successfully, you can use the + *

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 deleted successfully, you can use the * DescribeAlarms operation after using DeleteAlarms.

* *

It is possible to create a loop or cycle of composite alarms, where composite diff --git a/clients/client-cloudwatch/src/commands/DeleteDashboardsCommand.ts b/clients/client-cloudwatch/src/commands/DeleteDashboardsCommand.ts index f11d0472792e8..209b5533eb48b 100644 --- a/clients/client-cloudwatch/src/commands/DeleteDashboardsCommand.ts +++ b/clients/client-cloudwatch/src/commands/DeleteDashboardsCommand.ts @@ -53,6 +53,9 @@ export interface DeleteDashboardsCommandOutput extends DeleteDashboardsOutput, _ * @see {@link DeleteDashboardsCommandOutput} for command's `response` shape. * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. * + * @throws {@link ConflictException} (client fault) + *

This operation attempted to create a resource that already exists.

+ * * @throws {@link DashboardNotFoundError} (client fault) *

The specified dashboard does not exist.

* diff --git a/clients/client-cloudwatch/src/commands/DescribeInsightRulesCommand.ts b/clients/client-cloudwatch/src/commands/DescribeInsightRulesCommand.ts index 2309a95582317..5e4d9b0752315 100644 --- a/clients/client-cloudwatch/src/commands/DescribeInsightRulesCommand.ts +++ b/clients/client-cloudwatch/src/commands/DescribeInsightRulesCommand.ts @@ -52,6 +52,7 @@ export interface DescribeInsightRulesCommandOutput extends DescribeInsightRulesO * // Schema: "STRING_VALUE", // required * // Definition: "STRING_VALUE", // required * // ManagedRule: true || false, + * // ApplyOnTransformedLogs: true || false, * // }, * // ], * // }; diff --git a/clients/client-cloudwatch/src/commands/PutDashboardCommand.ts b/clients/client-cloudwatch/src/commands/PutDashboardCommand.ts index e557f71f83ebc..8948242207491 100644 --- a/clients/client-cloudwatch/src/commands/PutDashboardCommand.ts +++ b/clients/client-cloudwatch/src/commands/PutDashboardCommand.ts @@ -73,6 +73,9 @@ export interface PutDashboardCommandOutput extends PutDashboardOutput, __Metadat * @see {@link PutDashboardCommandOutput} for command's `response` shape. * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape. * + * @throws {@link ConflictException} (client fault) + *

This operation attempted to create a resource that already exists.

+ * * @throws {@link DashboardInvalidInputError} (client fault) *

Some part of the dashboard data is invalid.

* diff --git a/clients/client-cloudwatch/src/commands/PutInsightRuleCommand.ts b/clients/client-cloudwatch/src/commands/PutInsightRuleCommand.ts index ac9f8be2a150f..874ea27712364 100644 --- a/clients/client-cloudwatch/src/commands/PutInsightRuleCommand.ts +++ b/clients/client-cloudwatch/src/commands/PutInsightRuleCommand.ts @@ -50,6 +50,7 @@ export interface PutInsightRuleCommandOutput extends PutInsightRuleOutput, __Met * Value: "STRING_VALUE", // required * }, * ], + * ApplyOnTransformedLogs: true || false, * }; * const command = new PutInsightRuleCommand(input); * const response = await client.send(command); diff --git a/clients/client-cloudwatch/src/commands/TagResourceCommand.ts b/clients/client-cloudwatch/src/commands/TagResourceCommand.ts index 07b44762be36a..e3bb830e15172 100644 --- a/clients/client-cloudwatch/src/commands/TagResourceCommand.ts +++ b/clients/client-cloudwatch/src/commands/TagResourceCommand.ts @@ -72,6 +72,9 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB * @throws {@link ConcurrentModificationException} (client fault) *

More than one process tried to modify a resource at the same time.

* + * @throws {@link ConflictException} (client fault) + *

This operation attempted to create a resource that already exists.

+ * * @throws {@link InternalServiceFault} (server fault) *

Request processing has failed due to some unknown error, exception, or * failure.

diff --git a/clients/client-cloudwatch/src/commands/UntagResourceCommand.ts b/clients/client-cloudwatch/src/commands/UntagResourceCommand.ts index 223434861fb88..014b973abcfda 100644 --- a/clients/client-cloudwatch/src/commands/UntagResourceCommand.ts +++ b/clients/client-cloudwatch/src/commands/UntagResourceCommand.ts @@ -56,6 +56,9 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad * @throws {@link ConcurrentModificationException} (client fault) *

More than one process tried to modify a resource at the same time.

* + * @throws {@link ConflictException} (client fault) + *

This operation attempted to create a resource that already exists.

+ * * @throws {@link InternalServiceFault} (server fault) *

Request processing has failed due to some unknown error, exception, or * failure.

diff --git a/clients/client-cloudwatch/src/models/models_0.ts b/clients/client-cloudwatch/src/models/models_0.ts index 0f8d0a2c8d940..6224755ea69a8 100644 --- a/clients/client-cloudwatch/src/models/models_0.ts +++ b/clients/client-cloudwatch/src/models/models_0.ts @@ -261,7 +261,7 @@ export interface MetricStat { *

The granularity, in seconds, of the returned data points. For metrics with regular * resolution, a period can be as short as one minute (60 seconds) and must be a multiple * of 60. For high-resolution metrics that are collected at intervals of less than one - * minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution + * minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution * metrics are those metrics stored by a PutMetricData call that includes a * StorageResolution of 1 second.

*

If the StartTime parameter specifies a time stamp that is greater than @@ -401,7 +401,7 @@ export interface MetricDataQuery { *

The granularity, in seconds, of the returned data points. For metrics with regular * resolution, a period can be as short as one minute (60 seconds) and must be a multiple * of 60. For high-resolution metrics that are collected at intervals of less than one - * minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution + * minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution * metrics are those metrics stored by a PutMetricData operation that includes * a StorageResolution of 1 second.

* @public @@ -825,6 +825,28 @@ export class ConcurrentModificationException extends __BaseException { } } +/** + *

This operation attempted to create a resource that already exists.

+ * @public + */ +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; + readonly $fault: "client" = "client"; + Message?: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "ConflictException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, ConflictException.prototype); + this.Message = opts.Message; + } +} + /** *

Represents a specific dashboard.

* @public @@ -1950,6 +1972,13 @@ export interface InsightRule { * @public */ ManagedRule?: boolean | undefined; + + /** + *

Displays whether the rule is evaluated on the transformed versions of logs, for log groups + * that have Log transformation enabled. If this is false, log events are evaluated before they are transformed.

+ * @public + */ + ApplyOnTransformedLogs?: boolean | undefined; } /** @@ -2615,8 +2644,8 @@ export interface GetMetricDataInput { * clock interval. For example, 12:32:34 is rounded down to 12:00:00.

* * - *

If you set Period to 5, 10, or 30, the start time of your request is - * rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second + *

If you set Period to 5, 10, 20, or 30, the start time of your request is + * rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second * divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the * previous 10-second period, the start time of your request is rounded down and you * receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous @@ -2851,8 +2880,8 @@ export interface GetMetricStatisticsInput { * clock interval. For example, 12:32:34 is rounded down to 12:00:00.

* * - *

If you set Period to 5, 10, or 30, the start time of your request is - * rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second + *

If you set Period to 5, 10, 20, or 30, the start time of your request is + * rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second * divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the * previous 10-second period, the start time of your request is rounded down and you * receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous @@ -2875,7 +2904,7 @@ export interface GetMetricStatisticsInput { *

The granularity, in seconds, of the returned data points. For metrics with regular * resolution, a period can be as short as one minute (60 seconds) and must be a multiple * of 60. For high-resolution metrics that are collected at intervals of less than one - * minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution + * minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution * metrics are those metrics stored by a PutMetricData call that includes a * StorageResolution of 1 second.

*

If the StartTime parameter specifies a time stamp that is greater than @@ -3386,8 +3415,8 @@ export interface ListMetricsInput { MetricName?: string | undefined; /** - *

The dimensions to filter against. Only the dimensions that match exactly will be - * returned.

+ *

The dimensions to filter against. Only the dimension with names that match exactly will be + * returned. If you specify one dimension name and a metric has that dimension and also other dimensions, it will be returned.

* @public */ Dimensions?: DimensionFilter[] | undefined; @@ -3803,7 +3832,7 @@ export interface PutCompositeAlarmInput { * Start a Amazon Q Developer operational investigation *

*

- * arn:aws:aiops:region:account-id:investigation-group:ingestigation-group-id + * arn:aws:aiops:region:account-id:investigation-group:investigation-group-id * *

* @public @@ -4099,6 +4128,22 @@ export interface PutInsightRuleInput { * @public */ Tags?: Tag[] | undefined; + + /** + *

Specify true to have this rule evalute log events after they have been transformed by + * Log transformation. If you specify true, then the log events in log groups that have transformers will + * be evaluated by Contributor Insights after being transformed. Log groups that don't have + * transformers will still have their original log events evaluated by Contributor Insights.

+ *

The default is false + *

+ * + *

If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by + * Contributor Insights. For information about investigating log transformation failures, see + * Transformation metrics and errors.

+ * + * @public + */ + ApplyOnTransformedLogs?: boolean | undefined; } /** @@ -4420,7 +4465,7 @@ export interface PutMetricAlarmInput { * Start a Amazon Q Developer operational investigation *

*

- * arn:aws:aiops:region:account-id:investigation-group:ingestigation-group-id + * arn:aws:aiops:region:account-id:investigation-group:investigation-group-id * *

* @public @@ -4647,24 +4692,24 @@ export interface PutMetricAlarmInput { /** *

The length, in seconds, used each time the metric specified in - * MetricName is evaluated. Valid values are 10, 30, and any multiple of + * MetricName is evaluated. Valid values are 10, 20, 30, and any multiple of * 60.

*

* Period is required for alarms based on static thresholds. If you are * creating an alarm based on a metric math expression, you specify the period for each * metric within the objects in the Metrics array.

- *

Be sure to specify 10 or 30 only for metrics that are stored by a + *

Be sure to specify 10, 20, or 30 only for metrics that are stored by a * PutMetricData call with a StorageResolution of 1. If you - * specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the + * specify a period of 10, 20, or 30 for a metric that does not have sub-minute resolution, the * alarm still attempts to gather data at the period rate that you specify. In this case, * it does not receive data for the attempts that do not correspond to a one-minute data - * resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10 + * resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10, 20, * or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than * other alarms. For more information about pricing, see Amazon CloudWatch * Pricing.

- *

An alarm's total current evaluation period can be no longer than one day, so - * Period multiplied by EvaluationPeriods cannot be more than - * 86,400 seconds.

+ *

An alarm's total current evaluation period can be no longer than seven days, so + * Period multiplied by EvaluationPeriods can't be more than + * 604,800 seconds. For alarms with a period of less than one hour (3,600 seconds), the total evaluation period can't be longer than one day (86,400 seconds).

* @public */ Period?: number | undefined; @@ -4695,8 +4740,6 @@ export interface PutMetricAlarmInput { * you are setting an alarm that requires that a number of consecutive data points be * breaching to trigger the alarm, this value specifies that number. If you are setting an * "M out of N" alarm, this value is the N.

- *

An alarm's total current evaluation period can be no longer than one day, so this - * number multiplied by Period cannot be more than 86,400 seconds.

* @public */ EvaluationPeriods: number | undefined; @@ -4887,7 +4930,7 @@ export interface PutMetricDataInput { * * *

For details of the requirements for specifying an entity, see - * How + * How * to add related information to telemetry in the * CloudWatch User Guide.

* diff --git a/clients/client-cloudwatch/src/protocols/Aws_query.ts b/clients/client-cloudwatch/src/protocols/Aws_query.ts index 49a1828351234..9de378728c1c1 100644 --- a/clients/client-cloudwatch/src/protocols/Aws_query.ts +++ b/clients/client-cloudwatch/src/protocols/Aws_query.ts @@ -110,6 +110,7 @@ import { AnomalyDetectorType, CompositeAlarm, ConcurrentModificationException, + ConflictException, DashboardEntry, DashboardInvalidInputError, DashboardValidationMessage, @@ -1639,6 +1640,9 @@ const de_CommandError = async (output: __HttpResponse, context: __SerdeContext): case "ResourceNotFoundException": case "com.amazonaws.cloudwatch#ResourceNotFoundException": throw await de_ResourceNotFoundExceptionRes(parsedOutput, context); + case "ConflictException": + case "com.amazonaws.cloudwatch#ConflictException": + throw await de_ConflictExceptionRes(parsedOutput, context); case "InvalidNextToken": case "com.amazonaws.cloudwatch#InvalidNextToken": throw await de_InvalidNextTokenRes(parsedOutput, context); @@ -1683,6 +1687,19 @@ const de_ConcurrentModificationExceptionRes = async ( return __decorateServiceException(exception, body); }; +/** + * deserializeAws_queryConflictExceptionRes + */ +const de_ConflictExceptionRes = async (parsedOutput: any, context: __SerdeContext): Promise => { + const body = parsedOutput.body; + const deserialized: any = de_ConflictException(body.Error, context); + const exception = new ConflictException({ + $metadata: deserializeMetadata(parsedOutput), + ...deserialized, + }); + return __decorateServiceException(exception, body); +}; + /** * deserializeAws_queryDashboardInvalidInputErrorRes */ @@ -3396,6 +3413,9 @@ const se_PutInsightRuleInput = (input: PutInsightRuleInput, context: __SerdeCont entries[loc] = value; }); } + if (input[_AOTL] != null) { + entries[_AOTL] = input[_AOTL]; + } return entries; }; @@ -4105,6 +4125,17 @@ const de_ConcurrentModificationException = (output: any, context: __SerdeContext return contents; }; +/** + * deserializeAws_queryConflictException + */ +const de_ConflictException = (output: any, context: __SerdeContext): ConflictException => { + const contents: any = {}; + if (output[_Mes] != null) { + contents[_Mes] = __expectString(output[_Mes]); + } + return contents; +}; + /** * deserializeAws_queryDashboardEntries */ @@ -4583,6 +4614,9 @@ const de_InsightRule = (output: any, context: __SerdeContext): InsightRule => { if (output[_MRana] != null) { contents[_MRana] = __parseBoolean(output[_MRana]); } + if (output[_AOTL] != null) { + contents[_AOTL] = __parseBoolean(output[_AOTL]); + } return contents; }; @@ -5676,6 +5710,7 @@ const _AI = "AccountId"; const _AN = "AlarmNames"; const _ANP = "AlarmNamePrefix"; const _ANl = "AlarmName"; +const _AOTL = "ApplyOnTransformedLogs"; const _AP = "ActionPrefix"; const _AR = "AlarmRule"; const _AS = "AdditionalStatistics"; diff --git a/codegen/sdk-codegen/aws-models/cloudwatch.json b/codegen/sdk-codegen/aws-models/cloudwatch.json index 6e81aeefba179..e5292a4f5c95f 100644 --- a/codegen/sdk-codegen/aws-models/cloudwatch.json +++ b/codegen/sdk-codegen/aws-models/cloudwatch.json @@ -600,6 +600,19 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.cloudwatch#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudwatch#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

This operation attempted to create a resource that already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.cloudwatch#Counts": { "type": "list", "member": { @@ -833,7 +846,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified alarms. You can delete up to 100 alarms in one operation.\n However, this total can include no more than one composite alarm. For example, you could\n delete 99 metric alarms and one composite alarms with one operation, but you can't\n delete two composite alarms with one operation.

\n

If you specify an incorrect alarm name or make any other error in the operation,\n no alarms are deleted. To confirm that alarms were deleted successfully, you can use the\n DescribeAlarms operation after using DeleteAlarms.

\n \n

It is possible to create a loop or cycle of composite alarms, where composite\n alarm A depends on composite alarm B, and composite alarm B also depends on\n composite alarm A. In this scenario, you can't delete any composite alarm that is\n part of the cycle because there is always still a composite alarm that depends on\n that alarm that you want to delete.

\n

To get out of such a situation, you must break the cycle by changing the rule of\n one of the composite alarms in the cycle to remove a dependency that creates the\n cycle. The simplest change to make to break a cycle is to change the\n AlarmRule of one of the alarms to false.

\n

Additionally, the evaluation of composite alarms stops if CloudWatch\n detects a cycle in the evaluation path.

\n " + "smithy.api#documentation": "

Deletes the specified alarms. You can delete up to 100 alarms in one operation.\n However, this total can include no more than one composite alarm. For example, you could\n delete 99 metric alarms and one composite alarms with one operation, but you can't\n delete two composite alarms with one operation.

\n

If you specify any incorrect alarm names, the alarms you specify with correct names are still deleted. Other syntax errors might result\n in no alarms being deleted. To confirm that alarms were deleted successfully, you can use the\n DescribeAlarms operation after using DeleteAlarms.

\n \n

It is possible to create a loop or cycle of composite alarms, where composite\n alarm A depends on composite alarm B, and composite alarm B also depends on\n composite alarm A. In this scenario, you can't delete any composite alarm that is\n part of the cycle because there is always still a composite alarm that depends on\n that alarm that you want to delete.

\n

To get out of such a situation, you must break the cycle by changing the rule of\n one of the composite alarms in the cycle to remove a dependency that creates the\n cycle. The simplest change to make to break a cycle is to change the\n AlarmRule of one of the alarms to false.

\n

Additionally, the evaluation of composite alarms stops if CloudWatch\n detects a cycle in the evaluation path.

\n " } }, "com.amazonaws.cloudwatch#DeleteAlarmsInput": { @@ -953,6 +966,9 @@ "target": "com.amazonaws.cloudwatch#DeleteDashboardsOutput" }, "errors": [ + { + "target": "com.amazonaws.cloudwatch#ConflictException" + }, { "target": "com.amazonaws.cloudwatch#DashboardNotFoundError" }, @@ -2218,7 +2234,7 @@ "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The time stamp indicating the earliest data to be returned.

\n

The value specified is inclusive; results include data points with the specified\n time stamp.

\n

CloudWatch rounds the specified time stamp as follows:

\n
    \n
  • \n

    Start time less than 15 days ago - Round down to the nearest whole minute.\n For example, 12:32:34 is rounded down to 12:32:00.

    \n
    • \n
  • \n

    Start time between 15 and 63 days ago - Round down to the nearest 5-minute\n clock interval. For example, 12:32:34 is rounded down to 12:30:00.

    \n
    • \n
  • \n

    Start time greater than 63 days ago - Round down to the nearest 1-hour\n clock interval. For example, 12:32:34 is rounded down to 12:00:00.

    \n
    • \n
\n

If you set Period to 5, 10, or 30, the start time of your request is\n rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second\n divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the\n previous 10-second period, the start time of your request is rounded down and you\n receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous\n 5 minutes of data, using a period of 5 seconds, you receive data timestamped between\n 15:02:15 and 15:07:15.

\n

For better performance, specify StartTime and EndTime values\n that align with the value of the metric's Period and sync up with the\n beginning and end of an hour. For example, if the Period of a metric is 5\n minutes, specifying 12:05 or 12:30 as StartTime can get a faster response\n from CloudWatch than setting 12:07 or 12:29 as the StartTime.

", + "smithy.api#documentation": "

The time stamp indicating the earliest data to be returned.

\n

The value specified is inclusive; results include data points with the specified\n time stamp.

\n

CloudWatch rounds the specified time stamp as follows:

\n
    \n
  • \n

    Start time less than 15 days ago - Round down to the nearest whole minute.\n For example, 12:32:34 is rounded down to 12:32:00.

    \n
    • \n
  • \n

    Start time between 15 and 63 days ago - Round down to the nearest 5-minute\n clock interval. For example, 12:32:34 is rounded down to 12:30:00.

    \n
    • \n
  • \n

    Start time greater than 63 days ago - Round down to the nearest 1-hour\n clock interval. For example, 12:32:34 is rounded down to 12:00:00.

    \n
    • \n
\n

If you set Period to 5, 10, 20, or 30, the start time of your request is\n rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second\n divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the\n previous 10-second period, the start time of your request is rounded down and you\n receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous\n 5 minutes of data, using a period of 5 seconds, you receive data timestamped between\n 15:02:15 and 15:07:15.

\n

For better performance, specify StartTime and EndTime values\n that align with the value of the metric's Period and sync up with the\n beginning and end of an hour. For example, if the Period of a metric is 5\n minutes, specifying 12:05 or 12:30 as StartTime can get a faster response\n from CloudWatch than setting 12:07 or 12:29 as the StartTime.

", "smithy.api#required": {} } }, @@ -2346,7 +2362,7 @@ "target": "com.amazonaws.cloudwatch#Timestamp", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The time stamp that determines the first data point to return. Start times are\n evaluated relative to the time that CloudWatch receives the request.

\n

The value specified is inclusive; results include data points with the specified\n time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for\n example, 2016-10-03T23:00:00Z).

\n

CloudWatch rounds the specified time stamp as follows:

\n
    \n
  • \n

    Start time less than 15 days ago - Round down to the nearest whole minute.\n For example, 12:32:34 is rounded down to 12:32:00.

    \n
    • \n
  • \n

    Start time between 15 and 63 days ago - Round down to the nearest 5-minute\n clock interval. For example, 12:32:34 is rounded down to 12:30:00.

    \n
    • \n
  • \n

    Start time greater than 63 days ago - Round down to the nearest 1-hour\n clock interval. For example, 12:32:34 is rounded down to 12:00:00.

    \n
    • \n
\n

If you set Period to 5, 10, or 30, the start time of your request is\n rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second\n divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the\n previous 10-second period, the start time of your request is rounded down and you\n receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous\n 5 minutes of data, using a period of 5 seconds, you receive data timestamped between\n 15:02:15 and 15:07:15.

", + "smithy.api#documentation": "

The time stamp that determines the first data point to return. Start times are\n evaluated relative to the time that CloudWatch receives the request.

\n

The value specified is inclusive; results include data points with the specified\n time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for\n example, 2016-10-03T23:00:00Z).

\n

CloudWatch rounds the specified time stamp as follows:

\n
    \n
  • \n

    Start time less than 15 days ago - Round down to the nearest whole minute.\n For example, 12:32:34 is rounded down to 12:32:00.

    \n
    • \n
  • \n

    Start time between 15 and 63 days ago - Round down to the nearest 5-minute\n clock interval. For example, 12:32:34 is rounded down to 12:30:00.

    \n
    • \n
  • \n

    Start time greater than 63 days ago - Round down to the nearest 1-hour\n clock interval. For example, 12:32:34 is rounded down to 12:00:00.

    \n
    • \n
\n

If you set Period to 5, 10, 20, or 30, the start time of your request is\n rounded down to the nearest time that corresponds to even 5-, 10-, 20-, or 30-second\n divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the\n previous 10-second period, the start time of your request is rounded down and you\n receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous\n 5 minutes of data, using a period of 5 seconds, you receive data timestamped between\n 15:02:15 and 15:07:15.

", "smithy.api#required": {} } }, @@ -2362,7 +2378,7 @@ "target": "com.amazonaws.cloudwatch#Period", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular\n resolution, a period can be as short as one minute (60 seconds) and must be a multiple\n of 60. For high-resolution metrics that are collected at intervals of less than one\n minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution\n metrics are those metrics stored by a PutMetricData call that includes a\n StorageResolution of 1 second.

\n

If the StartTime parameter specifies a time stamp that is greater than\n 3 hours ago, you must specify the period as follows or no data points in that time range\n is returned:

\n
    \n
  • \n

    Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds\n (1 minute).

    \n
    • \n
  • \n

    Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5\n minutes).

    \n
    • \n
  • \n

    Start time greater than 63 days ago - Use a multiple of 3600 seconds (1\n hour).

    \n
    • \n
", + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular\n resolution, a period can be as short as one minute (60 seconds) and must be a multiple\n of 60. For high-resolution metrics that are collected at intervals of less than one\n minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution\n metrics are those metrics stored by a PutMetricData call that includes a\n StorageResolution of 1 second.

\n

If the StartTime parameter specifies a time stamp that is greater than\n 3 hours ago, you must specify the period as follows or no data points in that time range\n is returned:

\n
    \n
  • \n

    Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds\n (1 minute).

    \n
    • \n
  • \n

    Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5\n minutes).

    \n
    • \n
  • \n

    Start time greater than 63 days ago - Use a multiple of 3600 seconds (1\n hour).

    \n
    • \n
", "smithy.api#required": {} } }, @@ -3825,6 +3841,12 @@ "traits": { "smithy.api#documentation": "

An optional built-in rule that Amazon Web Services manages.

" } + }, + "ApplyOnTransformedLogs": { + "target": "com.amazonaws.cloudwatch#InsightRuleOnTransformedLogs", + "traits": { + "smithy.api#documentation": "

Displays whether the rule is evaluated on the transformed versions of logs, for log groups\n that have Log transformation enabled. If this is false, log events are evaluated before they are transformed.

" + } } }, "traits": { @@ -4038,6 +4060,9 @@ "target": "com.amazonaws.cloudwatch#InsightRuleName" } }, + "com.amazonaws.cloudwatch#InsightRuleOnTransformedLogs": { + "type": "boolean" + }, "com.amazonaws.cloudwatch#InsightRuleOrderBy": { "type": "string", "traits": { @@ -4508,7 +4533,7 @@ "Dimensions": { "target": "com.amazonaws.cloudwatch#DimensionFilters", "traits": { - "smithy.api#documentation": "

The dimensions to filter against. Only the dimensions that match exactly will be\n returned.

" + "smithy.api#documentation": "

The dimensions to filter against. Only the dimension with names that match exactly will be\n returned. If you specify one dimension name and a metric has that dimension and also other dimensions, it will be returned.

" } }, "NextToken": { @@ -5035,7 +5060,7 @@ "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular\n resolution, a period can be as short as one minute (60 seconds) and must be a multiple\n of 60. For high-resolution metrics that are collected at intervals of less than one\n minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution\n metrics are those metrics stored by a PutMetricData operation that includes\n a StorageResolution of 1 second.

" + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular\n resolution, a period can be as short as one minute (60 seconds) and must be a multiple\n of 60. For high-resolution metrics that are collected at intervals of less than one\n minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution\n metrics are those metrics stored by a PutMetricData operation that includes\n a StorageResolution of 1 second.

" } }, "AccountId": { @@ -5228,7 +5253,7 @@ "target": "com.amazonaws.cloudwatch#Period", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular\n resolution, a period can be as short as one minute (60 seconds) and must be a multiple\n of 60. For high-resolution metrics that are collected at intervals of less than one\n minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution\n metrics are those metrics stored by a PutMetricData call that includes a\n StorageResolution of 1 second.

\n

If the StartTime parameter specifies a time stamp that is greater than\n 3 hours ago, you must specify the period as follows or no data points in that time range\n is returned:

\n
    \n
  • \n

    Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds\n (1 minute).

    \n
    • \n
  • \n

    Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5\n minutes).

    \n
    • \n
  • \n

    Start time greater than 63 days ago - Use a multiple of 3600 seconds (1\n hour).

    \n
    • \n
", + "smithy.api#documentation": "

The granularity, in seconds, of the returned data points. For metrics with regular\n resolution, a period can be as short as one minute (60 seconds) and must be a multiple\n of 60. For high-resolution metrics that are collected at intervals of less than one\n minute, the period can be 1, 5, 10, 20, 30, 60, or any multiple of 60. High-resolution\n metrics are those metrics stored by a PutMetricData call that includes a\n StorageResolution of 1 second.

\n

If the StartTime parameter specifies a time stamp that is greater than\n 3 hours ago, you must specify the period as follows or no data points in that time range\n is returned:

\n
    \n
  • \n

    Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds\n (1 minute).

    \n
    • \n
  • \n

    Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5\n minutes).

    \n
    • \n
  • \n

    Start time greater than 63 days ago - Use a multiple of 3600 seconds (1\n hour).

    \n
    • \n
", "smithy.api#required": {} } }, @@ -5685,7 +5710,7 @@ "AlarmActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state\n from any other state. Each action is specified as an Amazon Resource Name\n (ARN).

\n

Valid Values: ]

\n

\n Amazon SNS actions:\n

\n

\n arn:aws:sns:region:account-id:sns-topic-name\n \n

\n

\n Lambda actions:\n

\n
    \n
  • \n

    Invoke the latest version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name\n \n

    \n
    • \n
  • \n

    Invoke a specific version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:version-number\n \n

    \n
    • \n
  • \n

    Invoke a function by using an alias Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n

    \n
    • \n
\n

\n Systems Manager actions:\n

\n

\n arn:aws:ssm:region:account-id:opsitem:severity\n \n

\n

\n Start a Amazon Q Developer operational investigation\n

\n

\n arn:aws:aiops:region:account-id:investigation-group:ingestigation-group-id\n \n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state\n from any other state. Each action is specified as an Amazon Resource Name\n (ARN).

\n

Valid Values: ]

\n

\n Amazon SNS actions:\n

\n

\n arn:aws:sns:region:account-id:sns-topic-name\n \n

\n

\n Lambda actions:\n

\n
    \n
  • \n

    Invoke the latest version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name\n \n

    \n
    • \n
  • \n

    Invoke a specific version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:version-number\n \n

    \n
    • \n
  • \n

    Invoke a function by using an alias Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n

    \n
    • \n
\n

\n Systems Manager actions:\n

\n

\n arn:aws:ssm:region:account-id:opsitem:severity\n \n

\n

\n Start a Amazon Q Developer operational investigation\n

\n

\n arn:aws:aiops:region:account-id:investigation-group:investigation-group-id\n \n

" } }, "AlarmDescription": { @@ -5760,6 +5785,9 @@ "target": "com.amazonaws.cloudwatch#PutDashboardOutput" }, "errors": [ + { + "target": "com.amazonaws.cloudwatch#ConflictException" + }, { "target": "com.amazonaws.cloudwatch#DashboardInvalidInputError" }, @@ -5862,6 +5890,12 @@ "traits": { "smithy.api#documentation": "

A list of key-value pairs to associate with the Contributor Insights rule. You can\n associate as many as 50 tags with a rule.

\n

Tags can help you organize and categorize your resources. You can also use them to\n scope user permissions, by granting a user permission to access or change only the\n resources that have certain tag values.

\n

To be able to associate tags with a rule, you must have the\n cloudwatch:TagResource permission in addition to the\n cloudwatch:PutInsightRule permission.

\n

If you are using this operation to update an existing Contributor Insights rule, any\n tags you specify in this parameter are ignored. To change the tags of an existing rule,\n use TagResource.

" } + }, + "ApplyOnTransformedLogs": { + "target": "com.amazonaws.cloudwatch#InsightRuleOnTransformedLogs", + "traits": { + "smithy.api#documentation": "

Specify true to have this rule evalute log events after they have been transformed by \n Log transformation. If you specify true, then the log events in log groups that have transformers will \n be evaluated by Contributor Insights after being transformed. Log groups that don't have\n transformers will still have their original log events evaluated by Contributor Insights.

\n

The default is false\n

\n \n

If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by\n Contributor Insights. For information about investigating log transformation failures, see\n Transformation metrics and errors.

\n " + } } }, "traits": { @@ -5974,7 +6008,7 @@ "AlarmActions": { "target": "com.amazonaws.cloudwatch#ResourceList", "traits": { - "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state\n from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid\n values:

\n

\n EC2 actions:\n

\n
    \n
  • \n

    \n arn:aws:automate:region:ec2:stop\n

    \n
    • \n
  • \n

    \n arn:aws:automate:region:ec2:terminate\n

    \n
    • \n
  • \n

    \n arn:aws:automate:region:ec2:reboot\n

    \n
    • \n
  • \n

    \n arn:aws:automate:region:ec2:recover\n

    \n
    • \n
  • \n

    \n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n

    \n
    • \n
  • \n

    \n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n

    \n
    • \n
  • \n

    \n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n

    \n
    • \n
  • \n

    \n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n

    \n
    • \n
\n

\n Autoscaling action:\n

\n
    \n
  • \n

    \n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

    \n
    • \n
\n

\n Lambda actions:\n

\n
    \n
  • \n

    Invoke the latest version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name\n \n

    \n
    • \n
  • \n

    Invoke a specific version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:version-number\n \n

    \n
    • \n
  • \n

    Invoke a function by using an alias Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n

    \n
    • \n
\n

\n SNS notification action:\n

\n
    \n
  • \n

    \n arn:aws:sns:region:account-id:sns-topic-name\n \n

    \n
    • \n
\n

\n SSM integration actions:\n

\n
    \n
  • \n

    \n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n

    \n
    • \n
  • \n

    \n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n

    \n
    • \n
\n

\n Start a Amazon Q Developer operational investigation\n

\n

\n arn:aws:aiops:region:account-id:investigation-group:ingestigation-group-id\n \n

" + "smithy.api#documentation": "

The actions to execute when this alarm transitions to the ALARM state\n from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid\n values:

\n

\n EC2 actions:\n

\n
    \n
  • \n

    \n arn:aws:automate:region:ec2:stop\n

    \n
    • \n
  • \n

    \n arn:aws:automate:region:ec2:terminate\n

    \n
    • \n
  • \n

    \n arn:aws:automate:region:ec2:reboot\n

    \n
    • \n
  • \n

    \n arn:aws:automate:region:ec2:recover\n

    \n
    • \n
  • \n

    \n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n

    \n
    • \n
  • \n

    \n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n

    \n
    • \n
  • \n

    \n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n

    \n
    • \n
  • \n

    \n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n

    \n
    • \n
\n

\n Autoscaling action:\n

\n
    \n
  • \n

    \n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n

    \n
    • \n
\n

\n Lambda actions:\n

\n
    \n
  • \n

    Invoke the latest version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name\n \n

    \n
    • \n
  • \n

    Invoke a specific version of a Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:version-number\n \n

    \n
    • \n
  • \n

    Invoke a function by using an alias Lambda function:\n arn:aws:lambda:region:account-id:function:function-name:alias-name\n \n

    \n
    • \n
\n

\n SNS notification action:\n

\n
    \n
  • \n

    \n arn:aws:sns:region:account-id:sns-topic-name\n \n

    \n
    • \n
\n

\n SSM integration actions:\n

\n
    \n
  • \n

    \n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n

    \n
    • \n
  • \n

    \n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n

    \n
    • \n
\n

\n Start a Amazon Q Developer operational investigation\n

\n

\n arn:aws:aiops:region:account-id:investigation-group:investigation-group-id\n \n

" } }, "InsufficientDataActions": { @@ -6016,7 +6050,7 @@ "Period": { "target": "com.amazonaws.cloudwatch#Period", "traits": { - "smithy.api#documentation": "

The length, in seconds, used each time the metric specified in\n MetricName is evaluated. Valid values are 10, 30, and any multiple of\n 60.

\n

\n Period is required for alarms based on static thresholds. If you are\n creating an alarm based on a metric math expression, you specify the period for each\n metric within the objects in the Metrics array.

\n

Be sure to specify 10 or 30 only for metrics that are stored by a\n PutMetricData call with a StorageResolution of 1. If you\n specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the\n alarm still attempts to gather data at the period rate that you specify. In this case,\n it does not receive data for the attempts that do not correspond to a one-minute data\n resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10\n or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than\n other alarms. For more information about pricing, see Amazon CloudWatch\n Pricing.

\n

An alarm's total current evaluation period can be no longer than one day, so\n Period multiplied by EvaluationPeriods cannot be more than\n 86,400 seconds.

" + "smithy.api#documentation": "

The length, in seconds, used each time the metric specified in\n MetricName is evaluated. Valid values are 10, 20, 30, and any multiple of\n 60.

\n

\n Period is required for alarms based on static thresholds. If you are\n creating an alarm based on a metric math expression, you specify the period for each\n metric within the objects in the Metrics array.

\n

Be sure to specify 10, 20, or 30 only for metrics that are stored by a\n PutMetricData call with a StorageResolution of 1. If you\n specify a period of 10, 20, or 30 for a metric that does not have sub-minute resolution, the\n alarm still attempts to gather data at the period rate that you specify. In this case,\n it does not receive data for the attempts that do not correspond to a one-minute data\n resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10, 20,\n or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than\n other alarms. For more information about pricing, see Amazon CloudWatch\n Pricing.

\n

An alarm's total current evaluation period can be no longer than seven days, so\n Period multiplied by EvaluationPeriods can't be more than\n 604,800 seconds. For alarms with a period of less than one hour (3,600 seconds), the total evaluation period can't be longer than one day (86,400 seconds).

" } }, "Unit": { @@ -6029,7 +6063,7 @@ "target": "com.amazonaws.cloudwatch#EvaluationPeriods", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold. If\n you are setting an alarm that requires that a number of consecutive data points be\n breaching to trigger the alarm, this value specifies that number. If you are setting an\n \"M out of N\" alarm, this value is the N.

\n

An alarm's total current evaluation period can be no longer than one day, so this\n number multiplied by Period cannot be more than 86,400 seconds.

", + "smithy.api#documentation": "

The number of periods over which data is compared to the specified threshold. If\n you are setting an alarm that requires that a number of consecutive data points be\n breaching to trigger the alarm, this value specifies that number. If you are setting an\n \"M out of N\" alarm, this value is the N.

", "smithy.api#required": {} } }, @@ -6143,7 +6177,7 @@ "StrictEntityValidation": { "target": "com.amazonaws.cloudwatch#StrictEntityValidation", "traits": { - "smithy.api#documentation": "

Whether to accept valid metric data when an invalid entity is sent.

\n
    \n
  • \n

    When set to true: Any validation error (for entity or metric \n data) will fail the entire request, and no data will be ingested. The failed \n operation will return a 400 result with the error.

    \n
    • \n
  • \n

    When set to false: Validation errors in the entity will not \n associate the metric with the entity, but the metric data will still be \n accepted and ingested. Validation errors in the metric data will fail the \n entire request, and no data will be ingested.

    \n

    In the case of an invalid entity, the operation will return a \n 200 status, but an additional response header will contain \n information about the validation errors. The new header, \n X-Amzn-Failure-Message is an enumeration of the following \n values:

    \n
      \n
    • \n

      \n InvalidEntity - The provided entity is invalid.

      \n
      • \n
    • \n

      \n InvalidKeyAttributes - The provided\n KeyAttributes of an entity is invalid.

      \n
      • \n
    • \n

      \n InvalidAttributes - The provided Attributes\n of an entity is invalid.

      \n
      • \n
    • \n

      \n InvalidTypeValue - The provided Type in the\n KeyAttributes of an entity is invalid.

      \n
      • \n
    • \n

      \n EntitySizeTooLarge - The number of \n EntityMetricData objects allowed is 2.

      \n
      • \n
    • \n

      \n MissingRequiredFields - There are missing required \n fields in the KeyAttributes for the provided\n Type.

      \n
      • \n
    \n

    For details of the requirements for specifying an entity, see \n How \n to add related information to telemetry in the \n CloudWatch User Guide.

    \n
    • \n
\n

This parameter is required when EntityMetricData is\n included.

" + "smithy.api#documentation": "

Whether to accept valid metric data when an invalid entity is sent.

\n
    \n
  • \n

    When set to true: Any validation error (for entity or metric \n data) will fail the entire request, and no data will be ingested. The failed \n operation will return a 400 result with the error.

    \n
    • \n
  • \n

    When set to false: Validation errors in the entity will not \n associate the metric with the entity, but the metric data will still be \n accepted and ingested. Validation errors in the metric data will fail the \n entire request, and no data will be ingested.

    \n

    In the case of an invalid entity, the operation will return a \n 200 status, but an additional response header will contain \n information about the validation errors. The new header, \n X-Amzn-Failure-Message is an enumeration of the following \n values:

    \n
      \n
    • \n

      \n InvalidEntity - The provided entity is invalid.

      \n
      • \n
    • \n

      \n InvalidKeyAttributes - The provided\n KeyAttributes of an entity is invalid.

      \n
      • \n
    • \n

      \n InvalidAttributes - The provided Attributes\n of an entity is invalid.

      \n
      • \n
    • \n

      \n InvalidTypeValue - The provided Type in the\n KeyAttributes of an entity is invalid.

      \n
      • \n
    • \n

      \n EntitySizeTooLarge - The number of \n EntityMetricData objects allowed is 2.

      \n
      • \n
    • \n

      \n MissingRequiredFields - There are missing required \n fields in the KeyAttributes for the provided\n Type.

      \n
      • \n
    \n

    For details of the requirements for specifying an entity, see \n How \n to add related information to telemetry in the \n CloudWatch User Guide.

    \n
    • \n
\n

This parameter is required when EntityMetricData is\n included.

" } } }, @@ -6978,6 +7012,9 @@ { "target": "com.amazonaws.cloudwatch#ConcurrentModificationException" }, + { + "target": "com.amazonaws.cloudwatch#ConflictException" + }, { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, @@ -7075,6 +7112,9 @@ { "target": "com.amazonaws.cloudwatch#ConcurrentModificationException" }, + { + "target": "com.amazonaws.cloudwatch#ConflictException" + }, { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, From 1076a5e639b214aa067f42bbf1020d04d84d2805 Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 21 May 2025 18:10:37 +0000 Subject: [PATCH 5/8] docs(client-application-auto-scaling): Doc only update that addresses a customer reported issue. --- .../src/models/models_0.ts | 144 + .../aws-models/application-auto-scaling.json | 9188 ++++++++--------- 2 files changed, 4737 insertions(+), 4595 deletions(-) diff --git a/clients/client-application-auto-scaling/src/models/models_0.ts b/clients/client-application-auto-scaling/src/models/models_0.ts index e88b39c971699..f77427aae349d 100644 --- a/clients/client-application-auto-scaling/src/models/models_0.ts +++ b/clients/client-application-auto-scaling/src/models/models_0.ts @@ -2397,6 +2397,54 @@ export interface PredictiveScalingCustomizedMetricSpecification { *

When returned in the output of DescribePolicies, it indicates that a * predictive scaling policy uses individually specified load and scaling metrics instead * of a metric pair.

+ *

The following predefined metrics are available for predictive scaling:

+ *
    + *
  • + *

    + * ECSServiceAverageCPUUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceAverageMemoryUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceCPUUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceMemoryUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceTotalCPUUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceTotalMemoryUtilization + *

    + *
    • + *
  • + *

    + * ALBRequestCount + *

    + *
    • + *
  • + *

    + * ALBRequestCountPerTarget + *

    + *
    • + *
  • + *

    + * TotalALBRequestCount + *

    + *
    • + *
* @public */ export interface PredictiveScalingPredefinedLoadMetricSpecification { @@ -2421,6 +2469,54 @@ export interface PredictiveScalingPredefinedLoadMetricSpecification { *

* Represents a metric pair for a predictive scaling policy. *

+ *

The following predefined metrics are available for predictive scaling:

+ *
    + *
  • + *

    + * ECSServiceAverageCPUUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceAverageMemoryUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceCPUUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceMemoryUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceTotalCPUUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceTotalMemoryUtilization + *

    + *
    • + *
  • + *

    + * ALBRequestCount + *

    + *
    • + *
  • + *

    + * ALBRequestCountPerTarget + *

    + *
    • + *
  • + *

    + * TotalALBRequestCount + *

    + *
    • + *
* @public */ export interface PredictiveScalingPredefinedMetricPairSpecification { @@ -2450,6 +2546,54 @@ export interface PredictiveScalingPredefinedMetricPairSpecification { *

When returned in the output of DescribePolicies, it indicates that a * predictive scaling policy uses individually specified load and scaling metrics instead * of a metric pair.

+ *

The following predefined metrics are available for predictive scaling:

+ *
    + *
  • + *

    + * ECSServiceAverageCPUUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceAverageMemoryUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceCPUUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceMemoryUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceTotalCPUUtilization + *

    + *
    • + *
  • + *

    + * ECSServiceTotalMemoryUtilization + *

    + *
    • + *
  • + *

    + * ALBRequestCount + *

    + *
    • + *
  • + *

    + * ALBRequestCountPerTarget + *

    + *
    • + *
  • + *

    + * TotalALBRequestCount + *

    + *
    • + *
* @public */ export interface PredictiveScalingPredefinedScalingMetricSpecification { diff --git a/codegen/sdk-codegen/aws-models/application-auto-scaling.json b/codegen/sdk-codegen/aws-models/application-auto-scaling.json index 3441b2e3ae3a0..f8479fcc24d47 100644 --- a/codegen/sdk-codegen/aws-models/application-auto-scaling.json +++ b/codegen/sdk-codegen/aws-models/application-auto-scaling.json @@ -1,4748 +1,4746 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.applicationautoscaling#AdjustmentType": { + "type": "enum", + "members": { + "ChangeInCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ChangeInCapacity" + } + }, + "PercentChangeInCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PercentChangeInCapacity" + } + }, + "ExactCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ExactCapacity" + } + } + } }, - "shapes": { - "com.amazonaws.applicationautoscaling#AdjustmentType": { - "type": "enum", - "members": { - "ChangeInCapacity": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ChangeInCapacity" - } - }, - "PercentChangeInCapacity": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PercentChangeInCapacity" - } - }, - "ExactCapacity": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ExactCapacity" - } - } - } + "com.amazonaws.applicationautoscaling#Alarm": { + "type": "structure", + "members": { + "AlarmName": { + "target": "com.amazonaws.applicationautoscaling#ResourceId", + "traits": { + "smithy.api#documentation": "

The name of the alarm.

", + "smithy.api#required": {} + } + }, + "AlarmARN": { + "target": "com.amazonaws.applicationautoscaling#ResourceId", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a CloudWatch alarm associated with a scaling policy.

" + } + }, + "com.amazonaws.applicationautoscaling#Alarms": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#Alarm" + } + }, + "com.amazonaws.applicationautoscaling#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:.+:application-autoscaling:.+:[0-9]+:scalable-target\\/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.applicationautoscaling#AnyScaleFrontendService": { + "type": "service", + "version": "2016-02-06", + "operations": [ + { + "target": "com.amazonaws.applicationautoscaling#DeleteScalingPolicy" }, - "com.amazonaws.applicationautoscaling#Alarm": { - "type": "structure", - "members": { - "AlarmName": { - "target": "com.amazonaws.applicationautoscaling#ResourceId", - "traits": { - "smithy.api#documentation": "

The name of the alarm.

", - "smithy.api#required": {} - } - }, - "AlarmARN": { - "target": "com.amazonaws.applicationautoscaling#ResourceId", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the alarm.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a CloudWatch alarm associated with a scaling policy.

" - } + { + "target": "com.amazonaws.applicationautoscaling#DeleteScheduledAction" }, - "com.amazonaws.applicationautoscaling#Alarms": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#Alarm" - } + { + "target": "com.amazonaws.applicationautoscaling#DeregisterScalableTarget" }, - "com.amazonaws.applicationautoscaling#AmazonResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1011 - }, - "smithy.api#pattern": "^arn:.+:application-autoscaling:.+:[0-9]+:scalable-target\\/[a-zA-Z0-9-]+$" - } + { + "target": "com.amazonaws.applicationautoscaling#DescribeScalableTargets" }, - "com.amazonaws.applicationautoscaling#AnyScaleFrontendService": { - "type": "service", - "version": "2016-02-06", - "operations": [ - { - "target": "com.amazonaws.applicationautoscaling#DeleteScalingPolicy" - }, - { - "target": "com.amazonaws.applicationautoscaling#DeleteScheduledAction" - }, - { - "target": "com.amazonaws.applicationautoscaling#DeregisterScalableTarget" - }, - { - "target": "com.amazonaws.applicationautoscaling#DescribeScalableTargets" - }, - { - "target": "com.amazonaws.applicationautoscaling#DescribeScalingActivities" - }, - { - "target": "com.amazonaws.applicationautoscaling#DescribeScalingPolicies" - }, - { - "target": "com.amazonaws.applicationautoscaling#DescribeScheduledActions" - }, - { - "target": "com.amazonaws.applicationautoscaling#GetPredictiveScalingForecast" - }, - { - "target": "com.amazonaws.applicationautoscaling#ListTagsForResource" - }, + { + "target": "com.amazonaws.applicationautoscaling#DescribeScalingActivities" + }, + { + "target": "com.amazonaws.applicationautoscaling#DescribeScalingPolicies" + }, + { + "target": "com.amazonaws.applicationautoscaling#DescribeScheduledActions" + }, + { + "target": "com.amazonaws.applicationautoscaling#GetPredictiveScalingForecast" + }, + { + "target": "com.amazonaws.applicationautoscaling#ListTagsForResource" + }, + { + "target": "com.amazonaws.applicationautoscaling#PutScalingPolicy" + }, + { + "target": "com.amazonaws.applicationautoscaling#PutScheduledAction" + }, + { + "target": "com.amazonaws.applicationautoscaling#RegisterScalableTarget" + }, + { + "target": "com.amazonaws.applicationautoscaling#TagResource" + }, + { + "target": "com.amazonaws.applicationautoscaling#UntagResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Application Auto Scaling", + "arnNamespace": "application-autoscaling", + "cloudFormationName": "ApplicationAutoScaling", + "cloudTrailEventSource": "applicationautoscaling.amazonaws.com", + "docId": "application-autoscaling-2016-02-06", + "endpointPrefix": "application-autoscaling" + }, + "aws.auth#sigv4": { + "name": "application-autoscaling" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

With Application Auto Scaling, you can configure automatic scaling for the following\n resources:

\n
    \n
  • \n

    Amazon AppStream 2.0 fleets

    \n
    • \n
  • \n

    Amazon Aurora Replicas

    \n
    • \n
  • \n

    Amazon Comprehend document classification and entity recognizer endpoints

    \n
    • \n
  • \n

    Amazon DynamoDB tables and global secondary indexes throughput capacity

    \n
    • \n
  • \n

    Amazon ECS services

    \n
    • \n
  • \n

    Amazon ElastiCache replication groups (Redis OSS and Valkey) and Memcached clusters

    \n
    • \n
  • \n

    Amazon EMR clusters

    \n
    • \n
  • \n

    Amazon Keyspaces (for Apache Cassandra) tables

    \n
    • \n
  • \n

    Lambda function provisioned concurrency

    \n
    • \n
  • \n

    Amazon Managed Streaming for Apache Kafka broker storage

    \n
    • \n
  • \n

    Amazon Neptune clusters

    \n
    • \n
  • \n

    Amazon SageMaker endpoint variants

    \n
    • \n
  • \n

    Amazon SageMaker inference components

    \n
    • \n
  • \n

    Amazon SageMaker serverless endpoint provisioned concurrency

    \n
    • \n
  • \n

    Spot Fleets (Amazon EC2)

    \n
    • \n
  • \n

    Pool of WorkSpaces

    \n
    • \n
  • \n

    Custom resources provided by your own applications or services

    \n
    • \n
\n

To learn more about Application Auto Scaling, see the Application Auto Scaling User\n Guide.

\n

\n API Summary\n

\n

The Application Auto Scaling service API includes three key sets of actions:

\n
    \n
  • \n

    Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable\n targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and\n retrieve information on existing scalable targets.

    \n
    • \n
  • \n

    Configure and manage automatic scaling - Define scaling policies to dynamically scale\n your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions,\n and retrieve your recent scaling activity history.

    \n
    • \n
  • \n

    Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by\n calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can\n suspend and resume (individually or in combination) scale-out activities that are\n triggered by a scaling policy, scale-in activities that are triggered by a scaling policy,\n and scheduled scaling.

    \n
    • \n
", + "smithy.api#title": "Application Auto Scaling", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ { - "target": "com.amazonaws.applicationautoscaling#PutScalingPolicy" - }, + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ { - "target": "com.amazonaws.applicationautoscaling#PutScheduledAction" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, { - "target": "com.amazonaws.applicationautoscaling#RegisterScalableTarget" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" }, { - "target": "com.amazonaws.applicationautoscaling#TagResource" - }, + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ { - "target": "com.amazonaws.applicationautoscaling#UntagResource" + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] } - ], - "traits": { - "aws.api#service": { - "sdkId": "Application Auto Scaling", - "arnNamespace": "application-autoscaling", - "cloudFormationName": "ApplicationAutoScaling", - "cloudTrailEventSource": "applicationautoscaling.amazonaws.com", - "docId": "application-autoscaling-2016-02-06", - "endpointPrefix": "application-autoscaling" - }, - "aws.auth#sigv4": { - "name": "application-autoscaling" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

With Application Auto Scaling, you can configure automatic scaling for the following\n resources:

\n
    \n
  • \n

    Amazon AppStream 2.0 fleets

    \n
    • \n
  • \n

    Amazon Aurora Replicas

    \n
    • \n
  • \n

    Amazon Comprehend document classification and entity recognizer endpoints

    \n
    • \n
  • \n

    Amazon DynamoDB tables and global secondary indexes throughput capacity

    \n
    • \n
  • \n

    Amazon ECS services

    \n
    • \n
  • \n

    Amazon ElastiCache replication groups (Redis OSS and Valkey) and Memcached clusters

    \n
    • \n
  • \n

    Amazon EMR clusters

    \n
    • \n
  • \n

    Amazon Keyspaces (for Apache Cassandra) tables

    \n
    • \n
  • \n

    Lambda function provisioned concurrency

    \n
    • \n
  • \n

    Amazon Managed Streaming for Apache Kafka broker storage

    \n
    • \n
  • \n

    Amazon Neptune clusters

    \n
    • \n
  • \n

    Amazon SageMaker endpoint variants

    \n
    • \n
  • \n

    Amazon SageMaker inference components

    \n
    • \n
  • \n

    Amazon SageMaker serverless endpoint provisioned concurrency

    \n
    • \n
  • \n

    Spot Fleets (Amazon EC2)

    \n
    • \n
  • \n

    Pool of WorkSpaces

    \n
    • \n
  • \n

    Custom resources provided by your own applications or services

    \n
    • \n
\n

To learn more about Application Auto Scaling, see the Application Auto Scaling User\n Guide.

\n

\n API Summary\n

\n

The Application Auto Scaling service API includes three key sets of actions:

\n
    \n
  • \n

    Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable\n targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and\n retrieve information on existing scalable targets.

    \n
    • \n
  • \n

    Configure and manage automatic scaling - Define scaling policies to dynamically scale\n your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions,\n and retrieve your recent scaling activity history.

    \n
    • \n
  • \n

    Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by\n calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can\n suspend and resume (individually or in combination) scale-out activities that are\n triggered by a scaling policy, scale-in activities that are triggered by a scaling policy,\n and scheduled scaling.

    \n
    • \n
", - "smithy.api#title": "Application Auto Scaling", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://application-autoscaling-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - } - ], - "endpoint": { - "url": "https://application-autoscaling.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://application-autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://application-autoscaling.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://application-autoscaling.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" + "ref": "Region" } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.eu-west-2.amazonaws.com" - } + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } + true + ] }, { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.eu-west-3.amazonaws.com" - } + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, + true + ] + } + ], + "rules": [ { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.me-south-1.amazonaws.com" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] } + ] }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.sa-east-1.amazonaws.com" + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false + ] } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://application-autoscaling-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } + ], + "type": "tree" }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-west-1.amazonaws.com" - } + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, + true + ] + } + ], + "rules": [ { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling-fips.us-east-1.api.aws" + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] } + ], + "endpoint": { + "url": "https://application-autoscaling.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true + { + "conditions": [], + "endpoint": { + "url": "https://application-autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } + ], + "type": "tree" }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-east-1.api.aws" - } + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, + true + ] + } + ], + "rules": [ { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.cn-north-1.amazonaws.com.cn" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false + ] } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://application-autoscaling.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } + ], + "type": "tree" }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://application-autoscaling-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } - ], - "version": "1.0" + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://application-autoscaling.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } + ] }, - "com.amazonaws.applicationautoscaling#CapacityForecast": { - "type": "structure", - "members": { - "Timestamps": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingForecastTimestamps", - "traits": { - "smithy.api#documentation": "

\n The timestamps for the data points, in UTC format.\n

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingForecastValues", - "traits": { - "smithy.api#documentation": "

\n The values of the data points.\n

", - "smithy.api#required": {} - } + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.af-south-1.amazonaws.com" } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "

\n A GetPredictiveScalingForecast call returns the capacity forecast for a\n predictive scaling policy. This structure includes the data points for that capacity\n forecast, along with the timestamps of those data points.\n

" - } - }, - "com.amazonaws.applicationautoscaling#ConcurrentUpdateException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.applicationautoscaling#ErrorMessage" + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.ap-east-1.amazonaws.com" } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ConcurrentUpdateException", - "httpResponseCode": 500 - }, - "smithy.api#documentation": "

Concurrent updates caused an exception, for example, if you request an update to an\n Application Auto Scaling resource that already has a pending update.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.applicationautoscaling#Cooldown": { - "type": "integer" - }, - "com.amazonaws.applicationautoscaling#CustomizedMetricSpecification": { - "type": "structure", - "members": { - "MetricName": { - "target": "com.amazonaws.applicationautoscaling#MetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric. To get the exact metric name, namespace, and dimensions, inspect\n the Metric object that's returned by a call to ListMetrics.

" - } - }, - "Namespace": { - "target": "com.amazonaws.applicationautoscaling#MetricNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the metric.

" - } - }, - "Dimensions": { - "target": "com.amazonaws.applicationautoscaling#MetricDimensions", - "traits": { - "smithy.api#documentation": "

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" - } - }, - "Statistic": { - "target": "com.amazonaws.applicationautoscaling#MetricStatistic", - "traits": { - "smithy.api#documentation": "

The statistic of the metric.

" - } - }, - "Unit": { - "target": "com.amazonaws.applicationautoscaling#MetricUnit", - "traits": { - "smithy.api#documentation": "

The unit of the metric. For a complete list of the units that CloudWatch supports, see the\n MetricDatum data\n type in the Amazon CloudWatch API Reference.

" - } - }, - "Metrics": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricDataQueries", - "traits": { - "smithy.api#documentation": "

The metrics to include in the target tracking scaling policy, as a metric data query.\n This can include both raw metric and metric math expressions.

" - } + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.ap-northeast-1.amazonaws.com" } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Application Auto Scaling.

\n

For information about the available metrics for a service, see Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

\n

To create your customized metric specification:

\n
    \n
  • \n

    Add values for each required parameter from CloudWatch. You can use an existing metric,\n or a new metric that you create. To use your own metric, you must first publish the\n metric to CloudWatch. For more information, see Publish custom\n metrics in the Amazon CloudWatch User Guide.

    \n
    • \n
  • \n

    Choose a metric that changes proportionally with capacity. The value of the metric\n should increase or decrease in inverse proportion to the number of capacity units.\n That is, the value of the metric should decrease when capacity increases, and\n increase when capacity decreases.

    \n
    • \n
\n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.

" - } - }, - "com.amazonaws.applicationautoscaling#DeleteScalingPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.applicationautoscaling#DeleteScalingPolicyRequest" + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } }, - "output": { - "target": "com.amazonaws.applicationautoscaling#DeleteScalingPolicyResponse" + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InternalServiceException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ObjectNotFoundException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ValidationException" + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.ap-south-1.amazonaws.com" } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified scaling policy for an Application Auto Scaling scalable target.

\n

Deleting a step scaling policy deletes the underlying alarm action, but does not delete\n the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated\n action.

\n

For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the\n Application Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To delete a scaling policy", - "documentation": "This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster.", - "input": { - "PolicyName": "web-app-cpu-lt-25", - "ServiceNamespace": "ecs", - "ResourceId": "service/default/web-app", - "ScalableDimension": "ecs:service:DesiredCount" - }, - "output": {} - } - ] - } - }, - "com.amazonaws.applicationautoscaling#DeleteScalingPolicyRequest": { - "type": "structure", - "members": { - "PolicyName": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The name of the scaling policy.

", - "smithy.api#required": {} - } - }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", - "smithy.api#required": {} - } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.ap-southeast-1.amazonaws.com" } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#DeleteScalingPolicyResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#DeleteScheduledAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.applicationautoscaling#DeleteScheduledActionRequest" + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } }, - "output": { - "target": "com.amazonaws.applicationautoscaling#DeleteScheduledActionResponse" + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InternalServiceException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ObjectNotFoundException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ValidationException" + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.ca-central-1.amazonaws.com" } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified scheduled action for an Application Auto Scaling scalable target.

\n

For more information, see Delete a scheduled action in the Application Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To delete a scheduled action", - "documentation": "This example deletes a scheduled action for the AppStream 2.0 fleet called sample-fleet.", - "input": { - "ServiceNamespace": "appstream", - "ScheduledActionName": "my-recurring-action", - "ResourceId": "fleet/sample-fleet", - "ScalableDimension": "appstream:fleet:DesiredCapacity" - }, - "output": {} - } - ] - } - }, - "com.amazonaws.applicationautoscaling#DeleteScheduledActionRequest": { - "type": "structure", - "members": { - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", - "smithy.api#required": {} - } - }, - "ScheduledActionName": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The name of the scheduled action.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", - "smithy.api#required": {} - } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.eu-central-1.amazonaws.com" } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#DeleteScheduledActionResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#DeregisterScalableTarget": { - "type": "operation", - "input": { - "target": "com.amazonaws.applicationautoscaling#DeregisterScalableTargetRequest" + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "output": { - "target": "com.amazonaws.applicationautoscaling#DeregisterScalableTargetResponse" + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InternalServiceException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ObjectNotFoundException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ValidationException" + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.eu-west-1.amazonaws.com" } - ], - "traits": { - "smithy.api#documentation": "

Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which\n resources have been registered, use DescribeScalableTargets.

\n \n

Deregistering a scalable target deletes the scaling policies and the scheduled\n actions that are associated with it.

\n ", - "smithy.api#examples": [ - { - "title": "To deregister a scalable target", - "documentation": "This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster.", - "input": { - "ServiceNamespace": "ecs", - "ResourceId": "service/default/web-app", - "ScalableDimension": "ecs:service:DesiredCount" - }, - "output": {} - } - ] - } - }, - "com.amazonaws.applicationautoscaling#DeregisterScalableTargetRequest": { - "type": "structure", - "members": { - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", - "smithy.api#required": {} - } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.eu-west-2.amazonaws.com" } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#DeregisterScalableTargetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#DescribeScalableTargets": { - "type": "operation", - "input": { - "target": "com.amazonaws.applicationautoscaling#DescribeScalableTargetsRequest" + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } }, - "output": { - "target": "com.amazonaws.applicationautoscaling#DescribeScalableTargetsResponse" + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InternalServiceException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets information about the scalable targets in the specified namespace.

\n

You can filter the results using ResourceIds and\n ScalableDimension.

", - "smithy.api#examples": [ - { - "title": "To describe scalable targets", - "documentation": "This example describes the scalable targets for the ECS service namespace.", - "input": { - "ServiceNamespace": "ecs" - }, - "output": { - "ScalableTargets": [ - { - "ScalableDimension": "ecs:service:DesiredCount", - "ResourceId": "service/default/web-app", - "RoleARN": "arn:aws:iam::012345678910:role/aws-service-role/ecs.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_ECSService", - "CreationTime": "2019-05-06T11:21:46.199Z", - "MinCapacity": 1, - "ServiceNamespace": "ecs", - "MaxCapacity": 10, - "SuspendedState": { - "DynamicScalingInSuspended": false, - "DynamicScalingOutSuspended": false, - "ScheduledScalingSuspended": false - } - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ScalableTargets", - "pageSize": "MaxResults" - }, - "smithy.test#smokeTests": [ - { - "id": "DescribeScalableTargetsSuccess", - "params": { - "ServiceNamespace": "ec2" - }, - "vendorParams": { - "region": "us-west-2" - }, - "vendorParamsShape": "aws.test#AwsVendorParams", - "expect": { - "success": {} - } - } - ] - } - }, - "com.amazonaws.applicationautoscaling#DescribeScalableTargetsRequest": { - "type": "structure", - "members": { - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", - "smithy.api#required": {} - } - }, - "ResourceIds": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
" - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
" - } - }, - "MaxResults": { - "target": "com.amazonaws.applicationautoscaling#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of scalable targets. This value can be between 1 and\n 50. The default value is 50.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 50 results and a\n NextToken value, if applicable.

" - } - }, - "NextToken": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.sa-east-1.amazonaws.com" } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#DescribeScalableTargetsResponse": { - "type": "structure", - "members": { - "ScalableTargets": { - "target": "com.amazonaws.applicationautoscaling#ScalableTargets", - "traits": { - "smithy.api#documentation": "

The scalable targets that match the request parameters.

" - } - }, - "NextToken": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token required to get the next set of results. This value is null if\n there are no more results to return.

" - } + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-east-1.amazonaws.com" } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#DescribeScalingActivities": { - "type": "operation", - "input": { - "target": "com.amazonaws.applicationautoscaling#DescribeScalingActivitiesRequest" - }, - "output": { - "target": "com.amazonaws.applicationautoscaling#DescribeScalingActivitiesResponse" + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InternalServiceException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ValidationException" + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-west-1.amazonaws.com" } - ], - "traits": { - "smithy.api#documentation": "

Provides descriptive information about the scaling activities in the specified namespace\n from the previous six weeks.

\n

You can filter the results using ResourceId and\n ScalableDimension.

\n

For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling.

", - "smithy.api#examples": [ - { - "title": "To describe scaling activities for a scalable target", - "documentation": "This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster.", - "input": { - "ServiceNamespace": "ecs", - "ResourceId": "service/default/web-app", - "ScalableDimension": "ecs:service:DesiredCount" - }, - "output": { - "ScalingActivities": [ - { - "ScalableDimension": "ecs:service:DesiredCount", - "Description": "Setting desired count to 1.", - "ResourceId": "service/default/web-app", - "ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399", - "StartTime": "2019-05-06T16:03:58.171Z", - "ServiceNamespace": "ecs", - "EndTime": "2019-05-06T16:04:32.111Z", - "Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25", - "StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs.", - "StatusCode": "Successful" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ScalingActivities", - "pageSize": "MaxResults" + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-west-2.amazonaws.com" } - } - }, - "com.amazonaws.applicationautoscaling#DescribeScalingActivitiesRequest": { - "type": "structure", - "members": { - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
" - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
" - } - }, - "MaxResults": { - "target": "com.amazonaws.applicationautoscaling#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of scalable targets. This value can be between 1 and\n 50. The default value is 50.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 50 results and a\n NextToken value, if applicable.

" - } - }, - "NextToken": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } - }, - "IncludeNotScaledActivities": { - "target": "com.amazonaws.applicationautoscaling#IncludeNotScaledActivities", - "traits": { - "smithy.api#documentation": "

Specifies whether to include activities that aren't scaled (not scaled\n activities) in the response. Not scaled activities are activities that aren't\n completed or started for various reasons, such as preventing infinite scaling loops. For\n help interpreting the not scaled reason details in the response, see Scaling activities for Application Auto Scaling.

" - } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling-fips.us-east-1.api.aws" } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#DescribeScalingActivitiesResponse": { - "type": "structure", - "members": { - "ScalingActivities": { - "target": "com.amazonaws.applicationautoscaling#ScalingActivities", - "traits": { - "smithy.api#documentation": "

A list of scaling activity objects.

" - } - }, - "NextToken": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token required to get the next set of results. This value is null if\n there are no more results to return.

" - } + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling-fips.us-east-1.amazonaws.com" } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#DescribeScalingPolicies": { - "type": "operation", - "input": { - "target": "com.amazonaws.applicationautoscaling#DescribeScalingPoliciesRequest" + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "output": { - "target": "com.amazonaws.applicationautoscaling#DescribeScalingPoliciesResponse" + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" - }, - { - "target": "com.amazonaws.applicationautoscaling#FailedResourceAccessException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InternalServiceException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ValidationException" + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.cn-northwest-1.amazonaws.com.cn" } - ], - "traits": { - "smithy.api#documentation": "

Describes the Application Auto Scaling scaling policies for the specified service namespace.

\n

You can filter the results using ResourceId,\n ScalableDimension, and PolicyNames.

\n

For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To describe scaling policies", - "documentation": "This example describes the scaling policies for the ECS service namespace.", - "input": { - "ServiceNamespace": "ecs" - }, - "output": { - "ScalingPolicies": [ - { - "PolicyName": "web-app-cpu-gt-75", - "ScalableDimension": "ecs:service:DesiredCount", - "ResourceId": "service/default/web-app", - "CreationTime": "2019-05-06T12:11:39.230Z", - "StepScalingPolicyConfiguration": { - "Cooldown": 60, - "StepAdjustments": [ - { - "ScalingAdjustment": 200, - "MetricIntervalLowerBound": 0 - } - ], - "AdjustmentType": "PercentChangeInCapacity" - }, - "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75", - "PolicyType": "StepScaling", - "Alarms": [ - { - "AlarmName": "web-app-cpu-gt-75", - "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75" - } - ], - "ServiceNamespace": "ecs" - } - ], - "NextToken": "" - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ScalingPolicies", - "pageSize": "MaxResults" + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling-fips.cn-north-1.api.amazonwebservices.com.cn" } - } - }, - "com.amazonaws.applicationautoscaling#DescribeScalingPoliciesRequest": { - "type": "structure", - "members": { - "PolicyNames": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", - "traits": { - "smithy.api#documentation": "

The names of the scaling policies to describe.

" - } - }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
" - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
" - } - }, - "MaxResults": { - "target": "com.amazonaws.applicationautoscaling#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of scalable targets. This value can be between 1 and 10. The default\n value is 10.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 10 results and a NextToken value, if\n applicable.

" - } - }, - "NextToken": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling-fips.cn-north-1.amazonaws.com.cn" } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#DescribeScalingPoliciesResponse": { - "type": "structure", - "members": { - "ScalingPolicies": { - "target": "com.amazonaws.applicationautoscaling#ScalingPolicies", - "traits": { - "smithy.api#documentation": "

Information about the scaling policies.

" - } - }, - "NextToken": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token required to get the next set of results. This value is null if\n there are no more results to return.

" - } + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.cn-north-1.api.amazonwebservices.com.cn" } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#DescribeScheduledActions": { - "type": "operation", - "input": { - "target": "com.amazonaws.applicationautoscaling#DescribeScheduledActionsRequest" + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "output": { - "target": "com.amazonaws.applicationautoscaling#DescribeScheduledActionsResponse" + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InternalServiceException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ValidationException" + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-gov-west-1.amazonaws.com" } - ], - "traits": { - "smithy.api#documentation": "

Describes the Application Auto Scaling scheduled actions for the specified service namespace.

\n

You can filter the results using the ResourceId,\n ScalableDimension, and ScheduledActionNames parameters.

\n

For more information, see Scheduled scaling in the Application Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To describe scheduled actions", - "documentation": "This example describes the scheduled actions for the dynamodb service namespace.", - "input": { - "ServiceNamespace": "dynamodb" - }, - "output": { - "ScheduledActions": [ - { - "ScalableDimension": "dynamodb:table:WriteCapacityUnits", - "Schedule": "at(2019-05-20T18:35:00)", - "ResourceId": "table/my-table", - "CreationTime": 1.561571888361E9, - "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-first-scheduled-action", - "ScalableTargetAction": { - "MinCapacity": 15, - "MaxCapacity": 20 - }, - "ScheduledActionName": "my-first-scheduled-action", - "ServiceNamespace": "dynamodb" - }, - { - "ScalableDimension": "dynamodb:table:WriteCapacityUnits", - "Schedule": "at(2019-05-20T18:40:00)", - "ResourceId": "table/my-table", - "CreationTime": 1.561571946021E9, - "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-second-scheduled-action", - "ScalableTargetAction": { - "MinCapacity": 5, - "MaxCapacity": 10 - }, - "ScheduledActionName": "my-second-scheduled-action", - "ServiceNamespace": "dynamodb" - } - ] - } - } - ], - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ScheduledActions", - "pageSize": "MaxResults" + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-gov-west-1.amazonaws.com" } - } - }, - "com.amazonaws.applicationautoscaling#DescribeScheduledActionsRequest": { - "type": "structure", - "members": { - "ScheduledActionNames": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", - "traits": { - "smithy.api#documentation": "

The names of the scheduled actions to describe.

" - } - }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
" - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
" - } - }, - "MaxResults": { - "target": "com.amazonaws.applicationautoscaling#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of scheduled action results. This value can be between\n 1 and 50. The default value is 50.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 50 results and a\n NextToken value, if applicable.

" - } - }, - "NextToken": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token for the next set of results.

" - } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling-fips.us-gov-east-1.api.aws" } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#DescribeScheduledActionsResponse": { - "type": "structure", - "members": { - "ScheduledActions": { - "target": "com.amazonaws.applicationautoscaling#ScheduledActions", - "traits": { - "smithy.api#documentation": "

Information about the scheduled actions.

" - } - }, - "NextToken": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The token required to get the next set of results. This value is null if\n there are no more results to return.

" - } + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-gov-east-1.api.aws" } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#DisableScaleIn": { - "type": "boolean" - }, - "com.amazonaws.applicationautoscaling#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.applicationautoscaling#ExceptionMessage": { - "type": "string" - }, - "com.amazonaws.applicationautoscaling#Expression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#FailedResourceAccessException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.applicationautoscaling#ErrorMessage" + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-iso-east-1.c2s.ic.gov" } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "FailedResourceAccessException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling\n is unable to retrieve the alarms associated with a scaling policy due to a client error,\n for example, if the role ARN specified for a scalable target does not have permission to\n call the CloudWatch DescribeAlarms on your behalf.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.applicationautoscaling#GetPredictiveScalingForecast": { - "type": "operation", - "input": { - "target": "com.amazonaws.applicationautoscaling#GetPredictiveScalingForecastRequest" + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "output": { - "target": "com.amazonaws.applicationautoscaling#GetPredictiveScalingForecastResponse" + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#InternalServiceException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves the forecast data for a predictive scaling policy.

\n

Load forecasts are predictions of the hourly load values using historical load data\n from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as\n predicted values for the minimum capacity that is needed on an hourly basis, based on\n the hourly load forecast.

\n

A minimum of 24 hours of data is required to create the initial forecasts. However,\n having a full 14 days of historical data results in more accurate forecasts.

" - } - }, - "com.amazonaws.applicationautoscaling#GetPredictiveScalingForecastRequest": { - "type": "structure", - "members": { - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

\n The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead. \n

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

\n The identifier of the resource.\n

", - "smithy.api#required": {} - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

\n The scalable dimension.\n

", - "smithy.api#required": {} - } - }, - "PolicyName": { - "target": "com.amazonaws.applicationautoscaling#PolicyName", - "traits": { - "smithy.api#documentation": "

The name of the policy.

", - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

\n The inclusive start time of the time range for the forecast data to get. At most, the\n date and time can be one year before the current date and time\n

", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

\n The exclusive end time of the time range for the forecast data to get. The maximum\n time duration between the start and end time is 30 days. \n

", - "smithy.api#required": {} - } + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling-fips.us-iso-east-1.c2s.ic.gov" } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#GetPredictiveScalingForecastResponse": { - "type": "structure", - "members": { - "LoadForecast": { - "target": "com.amazonaws.applicationautoscaling#LoadForecasts", - "traits": { - "smithy.api#documentation": "

\n The load forecast.\n

" - } - }, - "CapacityForecast": { - "target": "com.amazonaws.applicationautoscaling#CapacityForecast", - "traits": { - "smithy.api#documentation": "

\n The capacity forecast.\n

" - } - }, - "UpdateTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

\n The time the forecast was made.\n

" - } - } + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#Id": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#IncludeNotScaledActivities": { - "type": "boolean" - }, - "com.amazonaws.applicationautoscaling#InternalServiceException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.applicationautoscaling#ErrorMessage" + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling.us-isob-east-1.sc2s.sgov.gov" } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InternalServiceException", - "httpResponseCode": 500 - }, - "smithy.api#documentation": "

The service encountered an internal error.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.applicationautoscaling#InvalidNextTokenException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.applicationautoscaling#ErrorMessage" - } + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidNextTokenException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The next token supplied was invalid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.applicationautoscaling#LimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.applicationautoscaling#ErrorMessage" + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://application-autoscaling-fips.us-isob-east-1.sc2s.sgov.gov" } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "LimitExceededException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.applicationautoscaling#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.applicationautoscaling#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.applicationautoscaling#ListTagsForResourceResponse" + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns all the tags on the specified Application Auto Scaling scalable target.

\n

For general information about tags, including the format and syntax, see Tagging your Amazon Web Services\n resources in the Amazon Web Services General Reference.

", - "smithy.api#examples": [ - { - "title": "To list tags for a scalable target", - "documentation": "This example lists the tag key names and values that are attached to the scalable target specified by its ARN.", - "input": { - "ResourceARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123" - }, - "output": { - "Tags": { - "environment": "production" - } - } - } - ] - } - }, - "com.amazonaws.applicationautoscaling#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceARN": { - "target": "com.amazonaws.applicationautoscaling#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

Specify the ARN of the scalable target.

\n

For example:\n arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123\n

\n

To get the ARN for a scalable target, use DescribeScalableTargets.

", - "smithy.api#required": {} - } + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.applicationautoscaling#TagMap", - "traits": { - "smithy.api#documentation": "

A list of tags. Each tag consists of a tag key and a tag value.

" - } + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#LoadForecast": { - "type": "structure", - "members": { - "Timestamps": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingForecastTimestamps", - "traits": { - "smithy.api#documentation": "

\n The timestamps for the data points, in UTC format.\n

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingForecastValues", - "traits": { - "smithy.api#documentation": "

\n The values of the data points.\n

", - "smithy.api#required": {} - } - }, - "MetricSpecification": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricSpecification", - "traits": { - "smithy.api#documentation": "

\n The metric specification for the load forecast.\n

", - "smithy.api#required": {} - } - } + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "traits": { - "smithy.api#documentation": "

\n A GetPredictiveScalingForecast call returns the load forecast for a\n predictive scaling policy. This structure includes the data points for that load\n forecast, along with the timestamps of those data points and the metric specification.\n

" - } - }, - "com.amazonaws.applicationautoscaling#LoadForecasts": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#LoadForecast" + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } - }, - "com.amazonaws.applicationautoscaling#MaxResults": { - "type": "integer" - }, - "com.amazonaws.applicationautoscaling#MetricAggregationType": { - "type": "enum", - "members": { - "Average": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Average" - } - }, - "Minimum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Minimum" - } - }, - "Maximum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Maximum" - } - } - } - }, - "com.amazonaws.applicationautoscaling#MetricDimension": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.applicationautoscaling#MetricDimensionName", - "traits": { - "smithy.api#documentation": "

The name of the dimension.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.applicationautoscaling#MetricDimensionValue", - "traits": { - "smithy.api#documentation": "

The value of the dimension.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the dimension names and values associated with a metric.

" - } - }, - "com.amazonaws.applicationautoscaling#MetricDimensionName": { - "type": "string" - }, - "com.amazonaws.applicationautoscaling#MetricDimensionValue": { - "type": "string" - }, - "com.amazonaws.applicationautoscaling#MetricDimensions": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#MetricDimension" - } - }, - "com.amazonaws.applicationautoscaling#MetricName": { - "type": "string" - }, - "com.amazonaws.applicationautoscaling#MetricNamespace": { - "type": "string" - }, - "com.amazonaws.applicationautoscaling#MetricScale": { - "type": "double" - }, - "com.amazonaws.applicationautoscaling#MetricStatistic": { - "type": "enum", - "members": { - "Average": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Average" - } - }, - "Minimum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Minimum" - } - }, - "Maximum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Maximum" - } - }, - "SampleCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SampleCount" - } - }, - "Sum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Sum" - } - } - } - }, - "com.amazonaws.applicationautoscaling#MetricType": { - "type": "enum", - "members": { - "DynamoDBReadCapacityUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DynamoDBReadCapacityUtilization" - } - }, - "DynamoDBWriteCapacityUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DynamoDBWriteCapacityUtilization" - } - }, - "ALBRequestCountPerTarget": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALBRequestCountPerTarget" - } - }, - "RDSReaderAverageCPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDSReaderAverageCPUUtilization" - } - }, - "RDSReaderAverageDatabaseConnections": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDSReaderAverageDatabaseConnections" - } - }, - "EC2SpotFleetRequestAverageCPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC2SpotFleetRequestAverageCPUUtilization" - } - }, - "EC2SpotFleetRequestAverageNetworkIn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC2SpotFleetRequestAverageNetworkIn" - } - }, - "EC2SpotFleetRequestAverageNetworkOut": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC2SpotFleetRequestAverageNetworkOut" - } - }, - "SageMakerVariantInvocationsPerInstance": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SageMakerVariantInvocationsPerInstance" - } - }, - "ECSServiceAverageCPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ECSServiceAverageCPUUtilization" - } - }, - "ECSServiceAverageMemoryUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ECSServiceAverageMemoryUtilization" - } - }, - "AppStreamAverageCapacityUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AppStreamAverageCapacityUtilization" - } - }, - "ComprehendInferenceUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ComprehendInferenceUtilization" - } - }, - "LambdaProvisionedConcurrencyUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LambdaProvisionedConcurrencyUtilization" - } - }, - "CassandraReadCapacityUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CassandraReadCapacityUtilization" - } - }, - "CassandraWriteCapacityUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CassandraWriteCapacityUtilization" - } - }, - "KafkaBrokerStorageUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KafkaBrokerStorageUtilization" - } - }, - "ElastiCacheEngineCPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ElastiCacheEngineCPUUtilization" - } - }, - "ElastiCacheDatabaseMemoryUsagePercentage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ElastiCacheDatabaseMemoryUsagePercentage" - } - }, - "ElastiCachePrimaryEngineCPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ElastiCachePrimaryEngineCPUUtilization" - } - }, - "ElastiCacheReplicaEngineCPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ElastiCacheReplicaEngineCPUUtilization" - } - }, - "ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage" - } - }, - "NeptuneReaderAverageCPUUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NeptuneReaderAverageCPUUtilization" - } - }, - "SageMakerVariantProvisionedConcurrencyUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SageMakerVariantProvisionedConcurrencyUtilization" - } - }, - "ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage" - } - }, - "SageMakerInferenceComponentInvocationsPerCopy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SageMakerInferenceComponentInvocationsPerCopy" - } - }, - "WorkSpacesAverageUserSessionsCapacityUtilization": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WorkSpacesAverageUserSessionsCapacityUtilization" - } - }, - "SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution" - } - }, - "SageMakerVariantConcurrentRequestsPerModelHighResolution": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SageMakerVariantConcurrentRequestsPerModelHighResolution" - } - } - } - }, - "com.amazonaws.applicationautoscaling#MetricUnit": { - "type": "string" - }, - "com.amazonaws.applicationautoscaling#MinAdjustmentMagnitude": { - "type": "integer" - }, - "com.amazonaws.applicationautoscaling#NotScaledReason": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A code that represents the reason for not scaling.

\n

Valid values:

\n
    \n
  • \n

    AutoScalingAnticipatedFlapping

    \n
    • \n
  • \n

    TargetServicePutResourceAsUnscalable

    \n
    • \n
  • \n

    AlreadyAtMaxCapacity

    \n
    • \n
  • \n

    AlreadyAtMinCapacity

    \n
    • \n
  • \n

    AlreadyAtDesiredCapacity

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "MaxCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", - "traits": { - "smithy.api#documentation": "

The maximum capacity.

" - } - }, - "MinCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", - "traits": { - "smithy.api#documentation": "

The minimum capacity.

" - } - }, - "CurrentCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", - "traits": { - "smithy.api#documentation": "

The current capacity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the reason for an activity that isn't scaled (not scaled\n activity), in machine-readable format. For help interpreting the not scaled\n reason details, see Scaling activities for Application Auto Scaling in the\n Application Auto Scaling User Guide.

" - } - }, - "com.amazonaws.applicationautoscaling#NotScaledReasons": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#NotScaledReason" - } - }, - "com.amazonaws.applicationautoscaling#ObjectNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.applicationautoscaling#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ObjectNotFoundException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

The specified object could not be found. For any operation that depends on the existence\n of a scalable target, this exception is thrown if the scalable target with the specified\n service namespace, resource ID, and scalable dimension does not exist. For any operation\n that deletes or deregisters a resource, this exception is thrown if the resource cannot be\n found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.applicationautoscaling#PolicyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^\\p{Print}+$" - } - }, - "com.amazonaws.applicationautoscaling#PolicyType": { - "type": "enum", - "members": { - "StepScaling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StepScaling" - } - }, - "TargetTrackingScaling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TargetTrackingScaling" - } - }, - "PredictiveScaling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PredictiveScaling" - } - } - } - }, - "com.amazonaws.applicationautoscaling#PredefinedMetricSpecification": { - "type": "structure", - "members": { - "PredefinedMetricType": { - "target": "com.amazonaws.applicationautoscaling#MetricType", - "traits": { - "smithy.api#documentation": "

The metric type. The ALBRequestCountPerTarget metric type applies only to\n Spot Fleets and ECS services.

", - "smithy.api#required": {} - } - }, - "ResourceLabel": { - "target": "com.amazonaws.applicationautoscaling#ResourceLabel", - "traits": { - "smithy.api#documentation": "

Identifies the resource associated with the metric type. You can't specify a resource\n label unless the metric type is ALBRequestCountPerTarget and there is a target\n group attached to the Spot Fleet or ECS service.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n
    \n
  • \n

    app// is the final portion of\n the load balancer ARN

    \n
    • \n
  • \n

    targetgroup// is the final portion\n of the target group ARN.

    \n
    • \n
\n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a predefined metric for a target tracking scaling policy to use with\n Application Auto Scaling.

\n

For more information, Predefined metrics for target tracking scaling policies in the\n Application Auto Scaling User Guide.

" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingCustomizedMetricSpecification": { - "type": "structure", - "members": { - "MetricDataQueries": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDataQueries", - "traits": { - "smithy.api#documentation": "

\n One or more metric data queries to provide data points for a metric specification.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Represents a CloudWatch metric of your choosing for a predictive scaling policy.\n

" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingForecastTimestamps": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#TimestampType" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingForecastValues": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#MetricScale" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMaxCapacityBreachBehavior": { - "type": "enum", - "members": { - "HonorMaxCapacity": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HonorMaxCapacity" - } - }, - "IncreaseMaxCapacity": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IncreaseMaxCapacity" - } - } - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMaxCapacityBuffer": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetric": { - "type": "structure", - "members": { - "Dimensions": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimensions", - "traits": { - "smithy.api#documentation": "

\n Describes the dimensions of the metric.\n

" - } - }, - "MetricName": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricName", - "traits": { - "smithy.api#documentation": "

\n The name of the metric.\n

" - } - }, - "Namespace": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricNamespace", - "traits": { - "smithy.api#documentation": "

\n The namespace of the metric.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes the scaling metric.\n

" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDataQueries": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDataQuery" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDataQuery": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.applicationautoscaling#Id", - "traits": { - "smithy.api#documentation": "

\n A short name that identifies the object's results in the response. This name must be\n unique among all MetricDataQuery objects specified for a single scaling\n policy. If you are performing math expressions on this set of data, this name represents\n that data and can serve as a variable in the mathematical expression. The valid\n characters are letters, numbers, and underscores. The first character must be a\n lowercase letter.\n

", - "smithy.api#required": {} - } - }, - "Expression": { - "target": "com.amazonaws.applicationautoscaling#Expression", - "traits": { - "smithy.api#documentation": "

\n The math expression to perform on the returned data, if this object is performing a\n math expression. This expression can use the Id of the other metrics to\n refer to those metrics, and can also use the Id of other expressions to use\n the result of those expressions.\n

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" - } - }, - "MetricStat": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricStat", - "traits": { - "smithy.api#documentation": "

\n Information about the metric data to return.\n

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" - } - }, - "Label": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

\n A human-readable label for this metric or expression. This is especially useful if\n this is a math expression, so that you know what the value represents.\n

" - } - }, - "ReturnData": { - "target": "com.amazonaws.applicationautoscaling#ReturnData", - "traits": { - "smithy.api#documentation": "

\n Indicates whether to return the timestamps and raw data values of this metric.\n

\n

If you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.

\n

If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned\n metric statistics to create a new time series. A time series is a series of data points,\n each of which is associated with a timestamp.\n

" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimension": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimensionName", - "traits": { - "smithy.api#documentation": "

\n The name of the dimension.\n

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimensionValue", - "traits": { - "smithy.api#documentation": "

\n The value of the dimension.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes the dimension of a metric.\n

" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimensionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimensionValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimensions": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimension" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricNamespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricSpecification": { - "type": "structure", - "members": { - "TargetValue": { - "target": "com.amazonaws.applicationautoscaling#MetricScale", - "traits": { - "smithy.api#documentation": "

\n Specifies the target utilization.\n

", - "smithy.api#required": {} - } - }, - "PredefinedMetricPairSpecification": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingPredefinedMetricPairSpecification", - "traits": { - "smithy.api#documentation": "

\n The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.\n

" - } - }, - "PredefinedScalingMetricSpecification": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingPredefinedScalingMetricSpecification", - "traits": { - "smithy.api#documentation": "

\n The predefined scaling metric specification.\n

" - } - }, - "PredefinedLoadMetricSpecification": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingPredefinedLoadMetricSpecification", - "traits": { - "smithy.api#documentation": "

\n The predefined load metric specification.\n

" - } - }, - "CustomizedScalingMetricSpecification": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingCustomizedMetricSpecification", - "traits": { - "smithy.api#documentation": "

\n The customized scaling metric specification.\n

" - } - }, - "CustomizedLoadMetricSpecification": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingCustomizedMetricSpecification", - "traits": { - "smithy.api#documentation": "

\n The customized load metric specification.\n

" - } - }, - "CustomizedCapacityMetricSpecification": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingCustomizedMetricSpecification", - "traits": { - "smithy.api#documentation": "

\n The customized capacity metric specification.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n This structure specifies the metrics and target utilization settings for a predictive\n scaling policy.\n

\n

You must specify either a metric pair, or a load metric and a scaling metric\n individually. Specifying a metric pair instead of individual metrics provides a simpler\n way to configure metrics for a scaling policy. You choose the metric pair, and the\n policy automatically knows the correct sum and average statistics to use for the load\n metric and the scaling metric.

" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricSpecifications": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricSpecification" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricStat": { - "type": "structure", - "members": { - "Metric": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetric", - "traits": { - "smithy.api#documentation": "

\n The CloudWatch metric to return, including the metric name, namespace, and dimensions. To\n get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics. \n

", - "smithy.api#required": {} - } - }, - "Stat": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

\n The statistic to return. It can include any CloudWatch statistic or extended statistic. For\n a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.\n

\n

The most commonly used metrics for predictive scaling are Average and\n Sum.

", - "smithy.api#required": {} - } - }, - "Unit": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricUnit", - "traits": { - "smithy.api#documentation": "

\n The unit to use for the returned data points. For a complete list of the units that\n CloudWatch supports, see the MetricDatum \n data type in the Amazon CloudWatch API Reference.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n This structure defines the CloudWatch metric to return, along with the statistic and unit.\n

" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMetricUnit": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1023 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingMode": { - "type": "enum", - "members": { - "ForecastOnly": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ForecastOnly" - } - }, - "ForecastAndScale": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ForecastAndScale" - } - } - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingPolicyConfiguration": { - "type": "structure", - "members": { - "MetricSpecifications": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricSpecifications", - "traits": { - "smithy.api#documentation": "

\n This structure includes the metrics and target utilization to use for predictive scaling.\n

\n

This is an array, but we currently only support a single metric specification. That\n is, you can specify a target value and a single metric pair, or a target value and one\n scaling metric and one load metric.

", - "smithy.api#required": {} - } - }, - "Mode": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMode", - "traits": { - "smithy.api#documentation": "

\n The predictive scaling mode. Defaults to ForecastOnly if not specified.\n

" - } - }, - "SchedulingBufferTime": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingSchedulingBufferTime", - "traits": { - "smithy.api#documentation": "

\n The amount of time, in seconds, that the start time can be advanced.\n

\n

The value must be less than the forecast interval duration of 3600 seconds (60\n minutes). Defaults to 300 seconds if not specified.

" - } - }, - "MaxCapacityBreachBehavior": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMaxCapacityBreachBehavior", - "traits": { - "smithy.api#documentation": "

\n Defines the behavior that should be applied if the forecast capacity approaches or\n exceeds the maximum capacity. Defaults to\n HonorMaxCapacity if not specified.\n

" - } - }, - "MaxCapacityBuffer": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMaxCapacityBuffer", - "traits": { - "smithy.api#documentation": "

\n The size of the capacity buffer to use when the forecast capacity is close to or\n exceeds the maximum capacity. The value is specified as a percentage relative to the\n forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer,\n such that if the forecast capacity is 50, and the maximum capacity is 40, then the\n effective maximum capacity is 55.\n

\n

Required if the MaxCapacityBreachBehavior property is set to\n IncreaseMaxCapacity, and cannot be used otherwise.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Represents a predictive scaling policy configuration. Predictive scaling is supported on Amazon ECS services.\n

" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingPredefinedLoadMetricSpecification": { - "type": "structure", - "members": { - "PredefinedMetricType": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricType", - "traits": { - "smithy.api#documentation": "

\n The metric type.\n

", - "smithy.api#required": {} - } - }, - "ResourceLabel": { - "target": "com.amazonaws.applicationautoscaling#ResourceLabel", - "traits": { - "smithy.api#documentation": "

\n A label that uniquely identifies a target group.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes a load metric for a predictive scaling policy.\n

\n

When returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.

" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingPredefinedMetricPairSpecification": { - "type": "structure", - "members": { - "PredefinedMetricType": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricType", - "traits": { - "smithy.api#documentation": "

\n Indicates which metrics to use. There are two different types of metrics for each\n metric type: one is a load metric and one is a scaling metric.\n

", - "smithy.api#required": {} - } - }, - "ResourceLabel": { - "target": "com.amazonaws.applicationautoscaling#ResourceLabel", - "traits": { - "smithy.api#documentation": "

\n A label that uniquely identifies a specific target group from which to determine\n the total and average request count.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Represents a metric pair for a predictive scaling policy.\n

" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingPredefinedScalingMetricSpecification": { - "type": "structure", - "members": { - "PredefinedMetricType": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricType", - "traits": { - "smithy.api#documentation": "

\n The metric type.\n

", - "smithy.api#required": {} - } - }, - "ResourceLabel": { - "target": "com.amazonaws.applicationautoscaling#ResourceLabel", - "traits": { - "smithy.api#documentation": "

\n A label that uniquely identifies a specific target group from which to determine\n the average request count. \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

\n Describes a scaling metric for a predictive scaling policy.\n

\n

When returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.

" - } - }, - "com.amazonaws.applicationautoscaling#PredictiveScalingSchedulingBufferTime": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 3600 - } - } - }, - "com.amazonaws.applicationautoscaling#PutScalingPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.applicationautoscaling#PutScalingPolicyRequest" - }, - "output": { - "target": "com.amazonaws.applicationautoscaling#PutScalingPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" - }, - { - "target": "com.amazonaws.applicationautoscaling#FailedResourceAccessException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InternalServiceException" - }, - { - "target": "com.amazonaws.applicationautoscaling#LimitExceededException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ObjectNotFoundException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates a scaling policy for an Application Auto Scaling scalable target.

\n

Each scalable target is identified by a service namespace, resource ID, and scalable\n dimension. A scaling policy applies to the scalable target identified by those three\n attributes. You cannot create a scaling policy until you have registered the resource as a\n scalable target.

\n

Multiple scaling policies can be in force at the same time for the same scalable target.\n You can have one or more target tracking scaling policies, one or more step scaling\n policies, or both. However, there is a chance that multiple policies could conflict,\n instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives\n precedence to the policy that provides the largest capacity for both scale out and scale\n in. For example, if one policy increases capacity by 3, another policy increases capacity\n by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest\n calculated capacity (200% of 10 = 20) and scales out to 30.

\n

We recommend caution, however, when using target tracking scaling policies with step\n scaling policies because conflicts between these policies can cause undesirable behavior.\n For example, if the step scaling policy initiates a scale-in activity before the target\n tracking policy is ready to scale in, the scale-in activity will not be blocked. After the\n scale-in activity completes, the target tracking policy could instruct the scalable target\n to scale out again.

\n

For more information, see Target tracking scaling policies, Step scaling policies, and Predictive scaling policies \n in the Application Auto Scaling User Guide.

\n \n

If a scalable target is deregistered, the scalable target is no longer available to\n use scaling policies. Any scaling policies that were specified for the scalable target\n are deleted.

\n ", - "smithy.api#examples": [ - { - "title": "To apply a target tracking scaling policy with a predefined metric specification", - "documentation": "The following example applies a target tracking scaling policy with a predefined metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average CPU utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds.", - "input": { - "PolicyName": "cpu75-target-tracking-scaling-policy", - "ServiceNamespace": "ecs", - "ResourceId": "service/default/web-app", - "ScalableDimension": "ecs:service:DesiredCount", - "PolicyType": "TargetTrackingScaling", - "TargetTrackingScalingPolicyConfiguration": { - "TargetValue": 75, - "PredefinedMetricSpecification": { - "PredefinedMetricType": "ECSServiceAverageCPUUtilization" - }, - "ScaleOutCooldown": 60, - "ScaleInCooldown": 60 - } - }, - "output": { - "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/cpu75-target-tracking-scaling-policy", - "Alarms": [ - { - "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca", - "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca" - }, - { - "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d", - "AlarmName": "TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d" - } - ] - } - } - ] - } - }, - "com.amazonaws.applicationautoscaling#PutScalingPolicyRequest": { - "type": "structure", - "members": { - "PolicyName": { - "target": "com.amazonaws.applicationautoscaling#PolicyName", - "traits": { - "smithy.api#documentation": "

The name of the scaling policy.

\n

You cannot change the name of a scaling policy, but you can delete the original scaling\n policy and create a new scaling policy with the same settings and a different name.

", - "smithy.api#required": {} - } - }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "PolicyType": { - "target": "com.amazonaws.applicationautoscaling#PolicyType", - "traits": { - "smithy.api#documentation": "

The scaling policy type. This parameter is required if you are creating a scaling\n policy.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling—Not supported for Amazon EMR.

\n

\n StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or\n Neptune.

\n

\n PredictiveScaling—Only supported for Amazon ECS.

\n

For more information, see Target\n tracking scaling policies, Step scaling policies, and Predictive scaling policies \n in the Application Auto Scaling User Guide.

" - } - }, - "StepScalingPolicyConfiguration": { - "target": "com.amazonaws.applicationautoscaling#StepScalingPolicyConfiguration", - "traits": { - "smithy.api#documentation": "

A step scaling policy.

\n

This parameter is required if you are creating a policy and the policy type is\n StepScaling.

" - } - }, - "TargetTrackingScalingPolicyConfiguration": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingScalingPolicyConfiguration", - "traits": { - "smithy.api#documentation": "

A target tracking scaling policy. Includes support for predefined or customized\n metrics.

\n

This parameter is required if you are creating a policy and the policy type is\n TargetTrackingScaling.

" - } - }, - "PredictiveScalingPolicyConfiguration": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingPolicyConfiguration", - "traits": { - "smithy.api#documentation": "

\n The configuration of the predictive scaling policy.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#PutScalingPolicyResponse": { - "type": "structure", - "members": { - "PolicyARN": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resulting scaling policy.

", - "smithy.api#required": {} - } - }, - "Alarms": { - "target": "com.amazonaws.applicationautoscaling#Alarms", - "traits": { - "smithy.api#documentation": "

The CloudWatch alarms created for the target tracking scaling policy.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#PutScheduledAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.applicationautoscaling#PutScheduledActionRequest" - }, - "output": { - "target": "com.amazonaws.applicationautoscaling#PutScheduledActionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InternalServiceException" - }, - { - "target": "com.amazonaws.applicationautoscaling#LimitExceededException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ObjectNotFoundException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates a scheduled action for an Application Auto Scaling scalable target.

\n

Each scalable target is identified by a service namespace, resource ID, and scalable\n dimension. A scheduled action applies to the scalable target identified by those three\n attributes. You cannot create a scheduled action until you have registered the resource as\n a scalable target.

\n

When you specify start and end times with a recurring schedule using a cron expression\n or rates, they form the boundaries for when the recurring action starts and stops.

\n

To update a scheduled action, specify the parameters that you want to change. If you\n don't specify start and end times, the old values are deleted.

\n

For more information, see Scheduled scaling in the Application Auto Scaling User Guide.

\n \n

If a scalable target is deregistered, the scalable target is no longer available to\n run scheduled actions. Any scheduled actions that were specified for the scalable target\n are deleted.

\n ", - "smithy.api#examples": [ - { - "title": "To create a recurring scheduled action", - "documentation": "This example adds a scheduled action to a DynamoDB table called TestTable to scale out on a recurring schedule. On the specified schedule (every day at 12:15pm UTC), if the current capacity is below the value specified for MinCapacity, Application Auto Scaling scales out to the value specified by MinCapacity.", - "input": { - "ServiceNamespace": "dynamodb", - "Schedule": "cron(15 12 * * ? *)", - "ScheduledActionName": "my-recurring-action", - "ResourceId": "table/TestTable", - "ScalableDimension": "dynamodb:table:WriteCapacityUnits", - "ScalableTargetAction": { - "MinCapacity": 6 - } - }, - "output": {} - } - ] - } - }, - "com.amazonaws.applicationautoscaling#PutScheduledActionRequest": { - "type": "structure", - "members": { - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", - "smithy.api#required": {} - } - }, - "Schedule": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The schedule for this action. The following formats are supported:

\n
    \n
  • \n

    At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"

    \n
    • \n
  • \n

    Rate expressions - \"rate(value\n unit)\"

    \n
    • \n
  • \n

    Cron expressions - \"cron(fields)\"

    \n
    • \n
\n

At expressions are useful for one-time schedules. Cron expressions are useful for \n scheduled actions that run periodically at a specified date and time, and rate expressions \n are useful for scheduled actions that run at a regular interval.

\n

At and cron expressions use Universal Coordinated Time (UTC) by\n default.

\n

The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].

\n

For rate expressions, value is a positive integer and unit is \n minute | minutes | hour | hours | day | days.

\n

For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.

" - } - }, - "Timezone": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

Specifies the time zone used when setting a scheduled action by using an at or cron\n expression. If a time zone is not provided, UTC is used by default.

\n

Valid values are the canonical names of the IANA time zones supported by Joda-Time (such\n as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://www.joda.org/joda-time/timezones.html.

" - } - }, - "ScheduledActionName": { - "target": "com.amazonaws.applicationautoscaling#ScheduledActionName", - "traits": { - "smithy.api#documentation": "

The name of the scheduled action. This name must be unique among all other scheduled\n actions on the specified scalable target.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time for this scheduled action to start, in UTC.

" - } - }, - "EndTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time for the recurring schedule to end, in UTC.

" - } - }, - "ScalableTargetAction": { - "target": "com.amazonaws.applicationautoscaling#ScalableTargetAction", - "traits": { - "smithy.api#documentation": "

The new minimum and maximum capacity. You can set both values or just one. At the\n scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out\n to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling\n scales in to the maximum capacity.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#PutScheduledActionResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#RegisterScalableTarget": { - "type": "operation", - "input": { - "target": "com.amazonaws.applicationautoscaling#RegisterScalableTargetRequest" - }, - "output": { - "target": "com.amazonaws.applicationautoscaling#RegisterScalableTargetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" - }, - { - "target": "com.amazonaws.applicationautoscaling#InternalServiceException" - }, - { - "target": "com.amazonaws.applicationautoscaling#LimitExceededException" - }, - { - "target": "com.amazonaws.applicationautoscaling#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers or updates a scalable target, which is the resource that you want to\n scale.

\n

Scalable targets are uniquely identified by the combination of resource ID, scalable\n dimension, and namespace, which represents some capacity dimension of the underlying\n service.

\n

When you register a new scalable target, you must specify values for the minimum and\n maximum capacity. If the specified resource is not active in the target service, this\n operation does not change the resource's current capacity. Otherwise, it changes the\n resource's current capacity to a value that is inside of this range.

\n

If you add a scaling policy, current capacity is adjustable within the specified range\n when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are\n outside of the minimum and maximum range.

\n

After you register a scalable target, you do not need to register it again to use other\n Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service\n namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can\n deregister it by using DeregisterScalableTarget.

\n

To update a scalable target, specify the parameters that you want to change. Include the\n parameters that identify the scalable target: resource ID, scalable dimension, and\n namespace. Any parameters that you don't specify are not changed by this update request.

\n \n

If you call the RegisterScalableTarget API operation to create a\n scalable target, there might be a brief delay until the operation achieves eventual\n consistency. You might become aware of this brief delay if you get unexpected\n errors when performing sequential operations. The typical strategy is to retry the\n request, and some Amazon Web Services SDKs include automatic backoff and retry logic.

\n

If you call the RegisterScalableTarget API operation to update an\n existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If\n it's below the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the\n capacity of the scalable target to place it within these bounds, even if you don't\n include the MinCapacity or MaxCapacity request\n parameters.

\n ", - "smithy.api#examples": [ - { - "title": "To register an ECS service as a scalable target", - "documentation": "This example registers a scalable target from an Amazon ECS service called web-app that is running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks.", - "input": { - "ServiceNamespace": "ecs", - "ResourceId": "service/default/web-app", - "ScalableDimension": "ecs:service:DesiredCount", - "MinCapacity": 1, - "MaxCapacity": 10 - }, - "output": { - "ScalableTargetARN": "arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123" - } - } - ] - } - }, - "com.amazonaws.applicationautoscaling#RegisterScalableTargetRequest": { - "type": "structure", - "members": { - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource that is associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "MinCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", - "traits": { - "smithy.api#documentation": "

The minimum value that you plan to scale in to. When a scaling policy is in effect,\n Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to\n changing demand. This property is required when registering a new scalable target.

\n

For the following resources, the minimum value allowed is 0.

\n
    \n
  • \n

    AppStream 2.0 fleets

    \n
    • \n
  • \n

    Aurora DB clusters

    \n
    • \n
  • \n

    ECS services

    \n
    • \n
  • \n

    EMR clusters

    \n
    • \n
  • \n

    Lambda provisioned concurrency

    \n
    • \n
  • \n

    SageMaker endpoint variants

    \n
    • \n
  • \n

    SageMaker inference components

    \n
    • \n
  • \n

    SageMaker serverless endpoint provisioned concurrency

    \n
    • \n
  • \n

    Spot Fleets

    \n
    • \n
  • \n

    custom resources

    \n
    • \n
\n

It's strongly recommended that you specify a value greater than 0. A value greater than 0\n means that data points are continuously reported to CloudWatch that scaling policies can use to\n scale on a metric like average CPU utilization.

\n

For all other resources, the minimum allowed value depends on the type of resource that\n you are using. If you provide a value that is lower than what a resource can accept, an error\n occurs. In which case, the error message will provide the minimum value that the resource can\n accept.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", - "traits": { - "smithy.api#documentation": "

The maximum value that you plan to scale out to. When a scaling policy is in effect,\n Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to\n changing demand. This property is required when registering a new scalable target.

\n

Although you can specify a large maximum capacity, note that service quotas might impose\n lower limits. Each service has its own default quotas for the maximum capacity of the\n resource. If you want to specify a higher limit, you can request an increase. For more\n information, consult the documentation for that service. For information about the default\n quotas for each service, see Service endpoints and\n quotas in the Amazon Web Services General Reference.

" - } - }, - "RoleARN": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

This parameter is required for services that do not support service-linked roles (such as\n Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable\n target on your behalf.

\n

If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which\n it creates if it does not yet exist. For more information, see How Application Auto Scaling works with IAM.

" - } - }, - "SuspendedState": { - "target": "com.amazonaws.applicationautoscaling#SuspendedState", - "traits": { - "smithy.api#documentation": "

An embedded object that contains attributes and attribute values that are used to\n suspend and resume automatic scaling. Setting the value of an attribute to\n true suspends the specified scaling activities. Setting it to\n false (default) resumes the specified scaling activities.

\n

\n Suspension Outcomes\n

\n
    \n
  • \n

    For DynamicScalingInSuspended, while a suspension is in effect, all\n scale-in activities that are triggered by a scaling policy are suspended.

    \n
    • \n
  • \n

    For DynamicScalingOutSuspended, while a suspension is in effect, all\n scale-out activities that are triggered by a scaling policy are suspended.

    \n
    • \n
  • \n

    For ScheduledScalingSuspended, while a suspension is in effect, all\n scaling activities that involve scheduled actions are suspended.

    \n
    • \n
\n

For more information, see Suspend and resume scaling in the Application Auto Scaling User\n Guide.

" - } - }, - "Tags": { - "target": "com.amazonaws.applicationautoscaling#TagMap", - "traits": { - "smithy.api#documentation": "

Assigns one or more tags to the scalable target. Use this parameter to tag the scalable\n target when it is created. To tag an existing scalable target, use the TagResource operation.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required. You cannot have more than one tag on a scalable target with the same tag\n key.

\n

Use tags to control access to a scalable target. For more information, see Tagging support\n for Application Auto Scaling in the Application Auto Scaling User Guide.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#RegisterScalableTargetResponse": { - "type": "structure", - "members": { - "ScalableTargetARN": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The ARN of the scalable target.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#ResourceCapacity": { - "type": "integer" - }, - "com.amazonaws.applicationautoscaling#ResourceId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1600 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.applicationautoscaling#ResourceLabel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1023 - } - } - }, - "com.amazonaws.applicationautoscaling#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.applicationautoscaling#ExceptionMessage" - }, - "ResourceName": { - "target": "com.amazonaws.applicationautoscaling#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Application Auto Scaling resource. This value is an Amazon Resource Name (ARN).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.applicationautoscaling#ReturnData": { - "type": "boolean" - }, - "com.amazonaws.applicationautoscaling#ScalableDimension": { - "type": "enum", - "members": { - "ECSServiceDesiredCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ecs:service:DesiredCount" - } - }, - "EC2SpotFleetRequestTargetCapacity": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ec2:spot-fleet-request:TargetCapacity" - } - }, - "EMRInstanceGroupInstanceCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "elasticmapreduce:instancegroup:InstanceCount" - } - }, - "AppstreamFleetDesiredCapacity": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "appstream:fleet:DesiredCapacity" - } - }, - "DynamoDBTableReadCapacityUnits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dynamodb:table:ReadCapacityUnits" - } - }, - "DynamoDBTableWriteCapacityUnits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dynamodb:table:WriteCapacityUnits" - } - }, - "DynamoDBIndexReadCapacityUnits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dynamodb:index:ReadCapacityUnits" - } - }, - "DynamoDBIndexWriteCapacityUnits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dynamodb:index:WriteCapacityUnits" - } - }, - "RDSClusterReadReplicaCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rds:cluster:ReadReplicaCount" - } - }, - "SageMakerVariantDesiredInstanceCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sagemaker:variant:DesiredInstanceCount" - } - }, - "CustomResourceScalableDimension": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "custom-resource:ResourceType:Property" - } - }, - "ComprehendDocClassifierEndpointInferenceUnits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "comprehend:document-classifier-endpoint:DesiredInferenceUnits" - } - }, - "ComprehendEntityRecognizerEndpointInferenceUnits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits" - } - }, - "LambdaFunctionProvisionedConcurrency": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lambda:function:ProvisionedConcurrency" - } - }, - "CassandraTableReadCapacityUnits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cassandra:table:ReadCapacityUnits" - } - }, - "CassandraTableWriteCapacityUnits": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cassandra:table:WriteCapacityUnits" - } - }, - "KafkaBrokerStorageVolumeSize": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "kafka:broker-storage:VolumeSize" - } - }, - "ElastiCacheCacheClusterNodes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "elasticache:cache-cluster:Nodes" - } - }, - "ElastiCacheReplicationGroupNodeGroups": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "elasticache:replication-group:NodeGroups" - } - }, - "ElastiCacheReplicationGroupReplicas": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "elasticache:replication-group:Replicas" - } - }, - "NeptuneClusterReadReplicaCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "neptune:cluster:ReadReplicaCount" - } - }, - "SageMakerVariantDesiredProvisionedConcurrency": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sagemaker:variant:DesiredProvisionedConcurrency" - } - }, - "SageMakerInferenceComponentDesiredCopyCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sagemaker:inference-component:DesiredCopyCount" - } - }, - "WorkSpacesWorkSpacesPoolDesiredUserSessions": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "workspaces:workspacespool:DesiredUserSessions" - } - } - } - }, - "com.amazonaws.applicationautoscaling#ScalableTarget": { - "type": "structure", - "members": { - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource, or a\n custom-resource.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "MinCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", - "traits": { - "smithy.api#documentation": "

The minimum value to scale to in response to a scale-in activity.

", - "smithy.api#required": {} - } - }, - "MaxCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", - "traits": { - "smithy.api#documentation": "

The maximum value to scale to in response to a scale-out activity.

", - "smithy.api#required": {} - } - }, - "PredictedCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", - "traits": { - "smithy.api#documentation": "

\n The predicted capacity of the scalable target.\n

" - } - }, - "RoleARN": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your\n behalf.

", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the scalable target was created.

", - "smithy.api#required": {} - } - }, - "SuspendedState": { - "target": "com.amazonaws.applicationautoscaling#SuspendedState", - "traits": { - "smithy.api#documentation": "

Specifies whether the scaling activities for a scalable target are in a suspended\n state.

" - } - }, - "ScalableTargetARN": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The ARN of the scalable target.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a scalable target.

" - } - }, - "com.amazonaws.applicationautoscaling#ScalableTargetAction": { - "type": "structure", - "members": { - "MinCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", - "traits": { - "smithy.api#documentation": "

The minimum capacity.

\n

When the scheduled action runs, the resource will have at least this much capacity, but it\n might have more depending on other settings, such as the target utilization level of a target\n tracking scaling policy.

" - } - }, - "MaxCapacity": { - "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", - "traits": { - "smithy.api#documentation": "

The maximum capacity.

\n

Although you can specify a large maximum capacity, note that service quotas may impose\n lower limits. Each service has its own default quotas for the maximum capacity of the\n resource. If you want to specify a higher limit, you can request an increase. For more\n information, consult the documentation for that service. For information about the default\n quotas for each service, see Service endpoints and\n quotas in the Amazon Web Services General Reference.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents the minimum and maximum capacity for a scheduled action.

" - } - }, - "com.amazonaws.applicationautoscaling#ScalableTargets": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#ScalableTarget" - } - }, - "com.amazonaws.applicationautoscaling#ScalingActivities": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#ScalingActivity" - } - }, - "com.amazonaws.applicationautoscaling#ScalingActivity": { - "type": "structure", - "members": { - "ActivityId": { - "target": "com.amazonaws.applicationautoscaling#ResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the scaling activity.

", - "smithy.api#required": {} - } - }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource, or a\n custom-resource.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A simple description of what action the scaling activity intends to accomplish.

", - "smithy.api#required": {} - } - }, - "Cause": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A simple description of what caused the scaling activity to happen.

", - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the scaling activity began.

", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the scaling activity ended.

" - } - }, - "StatusCode": { - "target": "com.amazonaws.applicationautoscaling#ScalingActivityStatusCode", - "traits": { - "smithy.api#documentation": "

Indicates the status of the scaling activity.

", - "smithy.api#required": {} - } - }, - "StatusMessage": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A simple message about the current status of the scaling activity.

" - } - }, - "Details": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The details about the scaling activity.

" - } - }, - "NotScaledReasons": { - "target": "com.amazonaws.applicationautoscaling#NotScaledReasons", - "traits": { - "smithy.api#documentation": "

Machine-readable data that describes the reason for a not scaled activity. Only\n available when DescribeScalingActivities includes not scaled activities.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a scaling activity.

" - } - }, - "com.amazonaws.applicationautoscaling#ScalingActivityStatusCode": { - "type": "enum", - "members": { - "Pending": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Pending" - } - }, - "InProgress": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "Successful": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Successful" - } - }, - "Overridden": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Overridden" - } - }, - "Unfulfilled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unfulfilled" - } - }, - "Failed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - } - } - }, - "com.amazonaws.applicationautoscaling#ScalingAdjustment": { - "type": "integer" - }, - "com.amazonaws.applicationautoscaling#ScalingPolicies": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#ScalingPolicy" - } - }, - "com.amazonaws.applicationautoscaling#ScalingPolicy": { - "type": "structure", - "members": { - "PolicyARN": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scaling policy.

", - "smithy.api#required": {} - } - }, - "PolicyName": { - "target": "com.amazonaws.applicationautoscaling#PolicyName", - "traits": { - "smithy.api#documentation": "

The name of the scaling policy.

", - "smithy.api#required": {} - } - }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource, or a\n custom-resource.

", - "smithy.api#required": {} - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "PolicyType": { - "target": "com.amazonaws.applicationautoscaling#PolicyType", - "traits": { - "smithy.api#documentation": "

The scaling policy type.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling—Not supported for Amazon EMR

\n

\n StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or\n Neptune.

\n

\n PredictiveScaling—Only supported for Amazon ECS

", - "smithy.api#required": {} - } - }, - "StepScalingPolicyConfiguration": { - "target": "com.amazonaws.applicationautoscaling#StepScalingPolicyConfiguration", - "traits": { - "smithy.api#documentation": "

A step scaling policy.

" - } - }, - "TargetTrackingScalingPolicyConfiguration": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingScalingPolicyConfiguration", - "traits": { - "smithy.api#documentation": "

A target tracking scaling policy.

" - } - }, - "PredictiveScalingPolicyConfiguration": { - "target": "com.amazonaws.applicationautoscaling#PredictiveScalingPolicyConfiguration", - "traits": { - "smithy.api#documentation": "

\n The predictive scaling policy configuration.\n

" - } - }, - "Alarms": { - "target": "com.amazonaws.applicationautoscaling#Alarms", - "traits": { - "smithy.api#documentation": "

The CloudWatch alarms associated with the scaling policy.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the scaling policy was created.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a scaling policy to use with Application Auto Scaling.

\n

For more information about configuring scaling policies for a specific service, see\n Amazon Web Services services\n that you can use with Application Auto Scaling in the\n Application Auto Scaling User Guide.

" - } - }, - "com.amazonaws.applicationautoscaling#ScalingSuspended": { - "type": "boolean" - }, - "com.amazonaws.applicationautoscaling#ScheduledAction": { - "type": "structure", - "members": { - "ScheduledActionName": { - "target": "com.amazonaws.applicationautoscaling#ScheduledActionName", - "traits": { - "smithy.api#documentation": "

The name of the scheduled action.

", - "smithy.api#required": {} - } - }, - "ScheduledActionARN": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scheduled action.

", - "smithy.api#required": {} - } - }, - "ServiceNamespace": { - "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource, or a\n custom-resource.

", - "smithy.api#required": {} - } - }, - "Schedule": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The schedule for this action. The following formats are supported:

\n
    \n
  • \n

    At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"

    \n
    • \n
  • \n

    Rate expressions - \"rate(value\n unit)\"

    \n
    • \n
  • \n

    Cron expressions - \"cron(fields)\"

    \n
    • \n
\n

At expressions are useful for one-time schedules. Cron expressions are useful for \n scheduled actions that run periodically at a specified date and time, and rate expressions \n are useful for scheduled actions that run at a regular interval.

\n

At and cron expressions use Universal Coordinated Time (UTC) by\n default.

\n

The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].

\n

For rate expressions, value is a positive integer and unit is \n minute | minutes | hour | hours | day | days.

\n

For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.

", - "smithy.api#required": {} - } - }, - "Timezone": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The time zone used when referring to the date and time of a scheduled action, when the\n scheduled action uses an at or cron expression.

" - } - }, - "ResourceId": { - "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", - "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", - "smithy.api#required": {} - } - }, - "ScalableDimension": { - "target": "com.amazonaws.applicationautoscaling#ScalableDimension", - "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
" - } - }, - "StartTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time that the action is scheduled to begin, in UTC.

" - } - }, - "EndTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time that the action is scheduled to end, in UTC.

" - } - }, - "ScalableTargetAction": { - "target": "com.amazonaws.applicationautoscaling#ScalableTargetAction", - "traits": { - "smithy.api#documentation": "

The new minimum and maximum capacity. You can set both values or just one. At the\n scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out\n to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling\n scales in to the maximum capacity.

" - } - }, - "CreationTime": { - "target": "com.amazonaws.applicationautoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "

The date and time that the scheduled action was created.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a scheduled action.

" - } - }, - "com.amazonaws.applicationautoscaling#ScheduledActionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^(?!((^[ ]+.*)|(.*([\\u0000-\\u001f]|[\\u007f-\\u009f]|[:/|])+.*)|(.*[ ]+$))).+$" - } - }, - "com.amazonaws.applicationautoscaling#ScheduledActions": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#ScheduledAction" - } - }, - "com.amazonaws.applicationautoscaling#ServiceNamespace": { - "type": "enum", - "members": { - "ECS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ecs" - } - }, - "EMR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "elasticmapreduce" - } - }, - "EC2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ec2" - } - }, - "APPSTREAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "appstream" - } - }, - "DYNAMODB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "dynamodb" - } - }, - "RDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rds" - } - }, - "SAGEMAKER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sagemaker" - } - }, - "CUSTOM_RESOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "custom-resource" - } - }, - "COMPREHEND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "comprehend" - } - }, - "LAMBDA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lambda" - } - }, - "CASSANDRA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cassandra" - } - }, - "KAFKA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "kafka" - } - }, - "ELASTICACHE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "elasticache" - } - }, - "NEPTUNE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "neptune" - } - }, - "WORKSPACES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "workspaces" - } - } - } - }, - "com.amazonaws.applicationautoscaling#StepAdjustment": { - "type": "structure", - "members": { - "MetricIntervalLowerBound": { - "target": "com.amazonaws.applicationautoscaling#MetricScale", - "traits": { - "smithy.api#documentation": "

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the lower bound is inclusive (the metric\n must be greater than or equal to the threshold plus the lower bound). Otherwise, it's\n exclusive (the metric must be greater than the threshold plus the lower bound). A null\n value indicates negative infinity.

" - } - }, - "MetricIntervalUpperBound": { - "target": "com.amazonaws.applicationautoscaling#MetricScale", - "traits": { - "smithy.api#documentation": "

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the upper bound is exclusive (the metric\n must be less than the threshold plus the upper bound). Otherwise, it's inclusive (the\n metric must be less than or equal to the threshold plus the upper bound). A null value\n indicates positive infinity.

\n

The upper bound must be greater than the lower bound.

" - } - }, - "ScalingAdjustment": { - "target": "com.amazonaws.applicationautoscaling#ScalingAdjustment", - "traits": { - "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity. For\n exact capacity, you must specify a non-negative value.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference\n between the value of the aggregated CloudWatch metric and the breach threshold that you've\n defined for the alarm.

\n

For the following examples, suppose that you have an alarm with a breach threshold of\n 50:

\n
    \n
  • \n

    To initiate the adjustment when the metric is greater than or equal to 50 and less\n than 60, specify a lower bound of 0 and an upper bound of\n 10.

    \n
    • \n
  • \n

    To initiate the adjustment when the metric is greater than 40 and less than or\n equal to 50, specify a lower bound of -10 and an upper bound of\n 0.

    \n
    • \n
\n

There are a few rules for the step adjustments for your step policy:

\n
    \n
  • \n

    The ranges of your step adjustments can't overlap or have a gap.

    \n
    • \n
  • \n

    At most one step adjustment can have a null lower bound. If one step adjustment\n has a negative lower bound, then there must be a step adjustment with a null lower\n bound.

    \n
    • \n
  • \n

    At most one step adjustment can have a null upper bound. If one step adjustment\n has a positive upper bound, then there must be a step adjustment with a null upper\n bound.

    \n
    • \n
  • \n

    The upper and lower bound can't be null in the same step adjustment.

    \n
    • \n
" - } - }, - "com.amazonaws.applicationautoscaling#StepAdjustments": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#StepAdjustment" - } - }, - "com.amazonaws.applicationautoscaling#StepScalingPolicyConfiguration": { - "type": "structure", - "members": { - "AdjustmentType": { - "target": "com.amazonaws.applicationautoscaling#AdjustmentType", - "traits": { - "smithy.api#documentation": "

Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a\n percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

\n

\n AdjustmentType is required if you are adding a new step scaling policy\n configuration.

" - } - }, - "StepAdjustments": { - "target": "com.amazonaws.applicationautoscaling#StepAdjustments", - "traits": { - "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

\n

At least one step adjustment is required if you are adding a new step scaling policy\n configuration.

" - } - }, - "MinAdjustmentMagnitude": { - "target": "com.amazonaws.applicationautoscaling#MinAdjustmentMagnitude", - "traits": { - "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity. For example, suppose that you create a step\n scaling policy to scale out an Amazon ECS service by 25 percent and you specify a\n MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling\n policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2\n tasks.

" - } - }, - "Cooldown": { - "target": "com.amazonaws.applicationautoscaling#Cooldown", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scaling activity to take effect. If\n not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.

" - } - }, - "MetricAggregationType": { - "target": "com.amazonaws.applicationautoscaling#MetricAggregationType", - "traits": { - "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. Valid values are Minimum,\n Maximum, and Average. If the aggregation type is null, the\n value is treated as Average.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a step scaling policy configuration to use with Application Auto Scaling.

\n

For more information, see Step scaling policies in the Application Auto Scaling User Guide.

" - } - }, - "com.amazonaws.applicationautoscaling#SuspendedState": { - "type": "structure", - "members": { - "DynamicScalingInSuspended": { - "target": "com.amazonaws.applicationautoscaling#ScalingSuspended", - "traits": { - "smithy.api#documentation": "

Whether scale in by a target tracking scaling policy or a step scaling policy is\n suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity\n when a scaling policy is triggered. The default is false.

" - } - }, - "DynamicScalingOutSuspended": { - "target": "com.amazonaws.applicationautoscaling#ScalingSuspended", - "traits": { - "smithy.api#documentation": "

Whether scale out by a target tracking scaling policy or a step scaling policy is\n suspended. Set the value to true if you don't want Application Auto Scaling to add capacity\n when a scaling policy is triggered. The default is false.

" - } - }, - "ScheduledScalingSuspended": { - "target": "com.amazonaws.applicationautoscaling#ScalingSuspended", - "traits": { - "smithy.api#documentation": "

Whether scheduled scaling is suspended. Set the value to true if you don't\n want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is\n false.

" - } - } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.applicationautoscaling#CapacityForecast": { + "type": "structure", + "members": { + "Timestamps": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingForecastTimestamps", + "traits": { + "smithy.api#documentation": "

\n The timestamps for the data points, in UTC format.\n

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingForecastValues", + "traits": { + "smithy.api#documentation": "

\n The values of the data points.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A GetPredictiveScalingForecast call returns the capacity forecast for a\n predictive scaling policy. This structure includes the data points for that capacity\n forecast, along with the timestamps of those data points.\n

" + } + }, + "com.amazonaws.applicationautoscaling#ConcurrentUpdateException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.applicationautoscaling#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConcurrentUpdateException", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "

Concurrent updates caused an exception, for example, if you request an update to an\n Application Auto Scaling resource that already has a pending update.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.applicationautoscaling#Cooldown": { + "type": "integer" + }, + "com.amazonaws.applicationautoscaling#CustomizedMetricSpecification": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.applicationautoscaling#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric. To get the exact metric name, namespace, and dimensions, inspect\n the Metric object that's returned by a call to ListMetrics.

" + } + }, + "Namespace": { + "target": "com.amazonaws.applicationautoscaling#MetricNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the metric.

" + } + }, + "Dimensions": { + "target": "com.amazonaws.applicationautoscaling#MetricDimensions", + "traits": { + "smithy.api#documentation": "

The dimensions of the metric.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" + } + }, + "Statistic": { + "target": "com.amazonaws.applicationautoscaling#MetricStatistic", + "traits": { + "smithy.api#documentation": "

The statistic of the metric.

" + } + }, + "Unit": { + "target": "com.amazonaws.applicationautoscaling#MetricUnit", + "traits": { + "smithy.api#documentation": "

The unit of the metric. For a complete list of the units that CloudWatch supports, see the\n MetricDatum data\n type in the Amazon CloudWatch API Reference.

" + } + }, + "Metrics": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricDataQueries", + "traits": { + "smithy.api#documentation": "

The metrics to include in the target tracking scaling policy, as a metric data query.\n This can include both raw metric and metric math expressions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Application Auto Scaling.

\n

For information about the available metrics for a service, see Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

\n

To create your customized metric specification:

\n
    \n
  • \n

    Add values for each required parameter from CloudWatch. You can use an existing metric,\n or a new metric that you create. To use your own metric, you must first publish the\n metric to CloudWatch. For more information, see Publish custom\n metrics in the Amazon CloudWatch User Guide.

    \n
    • \n
  • \n

    Choose a metric that changes proportionally with capacity. The value of the metric\n should increase or decrease in inverse proportion to the number of capacity units.\n That is, the value of the metric should decrease when capacity increases, and\n increase when capacity decreases.

    \n
    • \n
\n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.

" + } + }, + "com.amazonaws.applicationautoscaling#DeleteScalingPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#DeleteScalingPolicyRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#DeleteScalingPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InternalServiceException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ObjectNotFoundException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified scaling policy for an Application Auto Scaling scalable target.

\n

Deleting a step scaling policy deletes the underlying alarm action, but does not delete\n the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated\n action.

\n

For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the\n Application Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a scaling policy", + "documentation": "This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster.", + "input": { + "PolicyName": "web-app-cpu-lt-25", + "ServiceNamespace": "ecs", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount" }, - "traits": { - "smithy.api#documentation": "

Specifies whether the scaling activities for a scalable target are in a suspended state.\n

" - } - }, - "com.amazonaws.applicationautoscaling#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.applicationautoscaling#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#TagKey" + "output": {} + } + ] + } + }, + "com.amazonaws.applicationautoscaling#DeleteScalingPolicyRequest": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The name of the scaling policy.

", + "smithy.api#required": {} + } + }, + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#DeleteScalingPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#DeleteScheduledAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#DeleteScheduledActionRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#DeleteScheduledActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InternalServiceException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ObjectNotFoundException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified scheduled action for an Application Auto Scaling scalable target.

\n

For more information, see Delete a scheduled action in the Application Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To delete a scheduled action", + "documentation": "This example deletes a scheduled action for the AppStream 2.0 fleet called sample-fleet.", + "input": { + "ServiceNamespace": "appstream", + "ScheduledActionName": "my-recurring-action", + "ResourceId": "fleet/sample-fleet", + "ScalableDimension": "appstream:fleet:DesiredCapacity" }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.applicationautoscaling#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.applicationautoscaling#TagKey" + "output": {} + } + ] + } + }, + "com.amazonaws.applicationautoscaling#DeleteScheduledActionRequest": { + "type": "structure", + "members": { + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} + } + }, + "ScheduledActionName": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The name of the scheduled action.

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#DeleteScheduledActionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#DeregisterScalableTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#DeregisterScalableTargetRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#DeregisterScalableTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InternalServiceException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ObjectNotFoundException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which\n resources have been registered, use DescribeScalableTargets.

\n \n

Deregistering a scalable target deletes the scaling policies and the scheduled\n actions that are associated with it.

\n ", + "smithy.api#examples": [ + { + "title": "To deregister a scalable target", + "documentation": "This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster.", + "input": { + "ServiceNamespace": "ecs", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount" }, - "value": { - "target": "com.amazonaws.applicationautoscaling#TagValue" - } - }, - "com.amazonaws.applicationautoscaling#TagResource": { - "type": "operation", + "output": {} + } + ] + } + }, + "com.amazonaws.applicationautoscaling#DeregisterScalableTargetRequest": { + "type": "structure", + "members": { + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#DeregisterScalableTargetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#DescribeScalableTargets": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#DescribeScalableTargetsRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#DescribeScalableTargetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InternalServiceException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about the scalable targets in the specified namespace.

\n

You can filter the results using ResourceIds and\n ScalableDimension.

", + "smithy.api#examples": [ + { + "title": "To describe scalable targets", + "documentation": "This example describes the scalable targets for the ECS service namespace.", "input": { - "target": "com.amazonaws.applicationautoscaling#TagResourceRequest" + "ServiceNamespace": "ecs" }, "output": { - "target": "com.amazonaws.applicationautoscaling#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.applicationautoscaling#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.applicationautoscaling#TooManyTagsException" - }, + "ScalableTargets": [ { - "target": "com.amazonaws.applicationautoscaling#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds or edits tags on an Application Auto Scaling scalable target.

\n

Each tag consists of a tag key and a tag value, which are both case-sensitive strings.\n To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag\n key and a new tag value.

\n

You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a\n scaling policy or scheduled action.

\n

You can also add tags to an Application Auto Scaling scalable target while creating it\n (RegisterScalableTarget).

\n

For general information about tags, including the format and syntax, see Tagging your Amazon Web Services\n resources in the Amazon Web Services General Reference.

\n

Use tags to control access to a scalable target. For more information, see Tagging support\n for Application Auto Scaling in the Application Auto Scaling User Guide.

", - "smithy.api#examples": [ - { - "title": "To add a tag to a scalable target", - "documentation": "This example adds a tag with the key name \"environment\" and the value \"production\" to the scalable target specified by its ARN.", - "input": { - "ResourceARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123", - "Tags": { - "environment": "production" - } - }, - "output": {} - } - ] - } - }, - "com.amazonaws.applicationautoscaling#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceARN": { - "target": "com.amazonaws.applicationautoscaling#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

Identifies the Application Auto Scaling scalable target that you want to apply tags to.

\n

For example:\n arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123\n

\n

To get the ARN for a scalable target, use DescribeScalableTargets.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.applicationautoscaling#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services\n resource.

\n

Each tag consists of a tag key and a tag value.

\n

You cannot have more than one tag on an Application Auto Scaling scalable target with the same tag key.\n If you specify an existing tag key with a different tag value, Application Auto Scaling replaces the\n current tag value with the specified one.

\n

For information about the rules that apply to tag keys and tag values, see User-defined tag\n restrictions in the Amazon Web Services Billing User Guide.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.applicationautoscaling#TargetTrackingMetric": { - "type": "structure", - "members": { - "Dimensions": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimensions", - "traits": { - "smithy.api#documentation": "

The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services\n documentation available from the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" - } - }, - "MetricName": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricName", - "traits": { - "smithy.api#documentation": "

The name of the metric.

" - } - }, - "Namespace": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricNamespace", - "traits": { - "smithy.api#documentation": "

The namespace of the metric. For more information, see the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

" - } + "ScalableDimension": "ecs:service:DesiredCount", + "ResourceId": "service/default/web-app", + "RoleARN": "arn:aws:iam::012345678910:role/aws-service-role/ecs.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_ECSService", + "CreationTime": "2019-05-06T11:21:46.199Z", + "MinCapacity": 1, + "ServiceNamespace": "ecs", + "MaxCapacity": 10, + "SuspendedState": { + "DynamicScalingInSuspended": false, + "DynamicScalingOutSuspended": false, + "ScheduledScalingSuspended": false + } } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScalableTargets", + "pageSize": "MaxResults" + }, + "smithy.test#smokeTests": [ + { + "id": "DescribeScalableTargetsSuccess", + "params": { + "ServiceNamespace": "ec2" }, - "traits": { - "smithy.api#documentation": "

Represents a specific metric.

\n

Metric is a property of the TargetTrackingMetricStat object.

" - } - }, - "com.amazonaws.applicationautoscaling#TargetTrackingMetricDataQueries": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricDataQuery" - } - }, - "com.amazonaws.applicationautoscaling#TargetTrackingMetricDataQuery": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.applicationautoscaling#Expression", - "traits": { - "smithy.api#documentation": "

The math expression to perform on the returned data, if this object is performing a math\n expression. This expression can use the Id of the other metrics to refer to\n those metrics, and can also use the Id of other expressions to use the result\n of those expressions.

\n

Conditional: Within each TargetTrackingMetricDataQuery object, you must\n specify either Expression or MetricStat, but not both.

" - } - }, - "Id": { - "target": "com.amazonaws.applicationautoscaling#Id", - "traits": { - "smithy.api#documentation": "

A short name that identifies the object's results in the response. This name must be\n unique among all MetricDataQuery objects specified for a single scaling\n policy. If you are performing math expressions on this set of data, this name represents\n that data and can serve as a variable in the mathematical expression. The valid characters\n are letters, numbers, and underscores. The first character must be a lowercase letter.\n

", - "smithy.api#required": {} - } - }, - "Label": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful if this\n is a math expression, so that you know what the value represents.

" - } - }, - "MetricStat": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricStat", - "traits": { - "smithy.api#documentation": "

Information about the metric data to return.

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" - } - }, - "ReturnData": { - "target": "com.amazonaws.applicationautoscaling#ReturnData", - "traits": { - "smithy.api#documentation": "

Indicates whether to return the timestamps and raw data values of this metric.

\n

If you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and expressions\n used in the metric specification.

\n

If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).

" - } - } + "vendorParams": { + "region": "us-west-2" }, - "traits": { - "smithy.api#documentation": "

The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned metric\n statistics to create a new time series. A time series is a series of data points, each of\n which is associated with a timestamp.

\n

For more information and examples, see Create a target tracking scaling policy for Application Auto Scaling using metric math in the\n Application Auto Scaling User Guide.

" + "vendorParamsShape": "aws.test#AwsVendorParams", + "expect": { + "success": {} } - }, - "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimension": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimensionName", - "traits": { - "smithy.api#documentation": "

The name of the dimension.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimensionValue", - "traits": { - "smithy.api#documentation": "

The value of the dimension.

", - "smithy.api#required": {} - } - } + } + ] + } + }, + "com.amazonaws.applicationautoscaling#DescribeScalableTargetsRequest": { + "type": "structure", + "members": { + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} + } + }, + "ResourceIds": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
" + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
" + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationautoscaling#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of scalable targets. This value can be between 1 and\n 50. The default value is 50.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 50 results and a\n NextToken value, if applicable.

" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#DescribeScalableTargetsResponse": { + "type": "structure", + "members": { + "ScalableTargets": { + "target": "com.amazonaws.applicationautoscaling#ScalableTargets", + "traits": { + "smithy.api#documentation": "

The scalable targets that match the request parameters.

" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token required to get the next set of results. This value is null if\n there are no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#DescribeScalingActivities": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#DescribeScalingActivitiesRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#DescribeScalingActivitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InternalServiceException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides descriptive information about the scaling activities in the specified namespace\n from the previous six weeks.

\n

You can filter the results using ResourceId and\n ScalableDimension.

\n

For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling.

", + "smithy.api#examples": [ + { + "title": "To describe scaling activities for a scalable target", + "documentation": "This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster.", + "input": { + "ServiceNamespace": "ecs", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount" }, - "traits": { - "smithy.api#documentation": "

Describes the dimension of a metric.

" - } - }, - "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimensionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimensionValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimensions": { - "type": "list", - "member": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimension" - } - }, - "com.amazonaws.applicationautoscaling#TargetTrackingMetricName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#TargetTrackingMetricNamespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#TargetTrackingMetricStat": { - "type": "structure", - "members": { - "Metric": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetric", - "traits": { - "smithy.api#documentation": "

The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get\n the exact metric name, namespace, and dimensions, inspect the Metric object that is\n returned by a call to ListMetrics.

", - "smithy.api#required": {} - } - }, - "Stat": { - "target": "com.amazonaws.applicationautoscaling#XmlString", - "traits": { - "smithy.api#documentation": "

The statistic to return. It can include any CloudWatch statistic or extended statistic. For a\n list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

\n

The most commonly used metric for scaling is Average.

", - "smithy.api#required": {} - } - }, - "Unit": { - "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricUnit", - "traits": { - "smithy.api#documentation": "

The unit to use for the returned data points. For a complete list of the units that CloudWatch\n supports, see the MetricDatum data\n type in the Amazon CloudWatch API Reference.

" - } + "output": { + "ScalingActivities": [ + { + "ScalableDimension": "ecs:service:DesiredCount", + "Description": "Setting desired count to 1.", + "ResourceId": "service/default/web-app", + "ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399", + "StartTime": "2019-05-06T16:03:58.171Z", + "ServiceNamespace": "ecs", + "EndTime": "2019-05-06T16:04:32.111Z", + "Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25", + "StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs.", + "StatusCode": "Successful" } - }, - "traits": { - "smithy.api#documentation": "

This structure defines the CloudWatch metric to return, along with the statistic and\n unit.

\n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.

" - } - }, - "com.amazonaws.applicationautoscaling#TargetTrackingMetricUnit": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1023 - }, - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" - } - }, - "com.amazonaws.applicationautoscaling#TargetTrackingScalingPolicyConfiguration": { - "type": "structure", - "members": { - "TargetValue": { - "target": "com.amazonaws.applicationautoscaling#MetricScale", - "traits": { - "smithy.api#documentation": "

The target value for the metric. Although this property accepts numbers of type Double,\n it won't accept values that are either too small or too large. Values must be in the range\n of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For\n example, if the metric is CPU utilization, then the target value is a percent value that\n represents how much of the CPU can be used before scaling out.

\n \n

If the scaling policy specifies the ALBRequestCountPerTarget predefined\n metric, specify the target utilization as the optimal average request count per target\n during any one-minute interval.

\n ", - "smithy.api#required": {} - } - }, - "PredefinedMetricSpecification": { - "target": "com.amazonaws.applicationautoscaling#PredefinedMetricSpecification", - "traits": { - "smithy.api#documentation": "

A predefined metric. You can specify either a predefined metric or a customized\n metric.

" - } - }, - "CustomizedMetricSpecification": { - "target": "com.amazonaws.applicationautoscaling#CustomizedMetricSpecification", - "traits": { - "smithy.api#documentation": "

A customized metric. You can specify either a predefined metric or a customized\n metric.

" - } - }, - "ScaleOutCooldown": { - "target": "com.amazonaws.applicationautoscaling#Cooldown", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scale-out activity to take effect.\n For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

" - } - }, - "ScaleInCooldown": { - "target": "com.amazonaws.applicationautoscaling#Cooldown", - "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scale-in activity completes before another\n scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

" - } - }, - "DisableScaleIn": { - "target": "com.amazonaws.applicationautoscaling#DisableScaleIn", - "traits": { - "smithy.api#documentation": "

Indicates whether scale in by the target tracking scaling policy is disabled. If the\n value is true, scale in is disabled and the target tracking scaling policy\n won't remove capacity from the scalable target. Otherwise, scale in is enabled and the\n target tracking scaling policy can remove capacity from the scalable target. The default\n value is false.

" + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScalingActivities", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.applicationautoscaling#DescribeScalingActivitiesRequest": { + "type": "structure", + "members": { + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
" + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
" + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationautoscaling#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of scalable targets. This value can be between 1 and\n 50. The default value is 50.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 50 results and a\n NextToken value, if applicable.

" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" + } + }, + "IncludeNotScaledActivities": { + "target": "com.amazonaws.applicationautoscaling#IncludeNotScaledActivities", + "traits": { + "smithy.api#documentation": "

Specifies whether to include activities that aren't scaled (not scaled\n activities) in the response. Not scaled activities are activities that aren't\n completed or started for various reasons, such as preventing infinite scaling loops. For\n help interpreting the not scaled reason details in the response, see Scaling activities for Application Auto Scaling.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#DescribeScalingActivitiesResponse": { + "type": "structure", + "members": { + "ScalingActivities": { + "target": "com.amazonaws.applicationautoscaling#ScalingActivities", + "traits": { + "smithy.api#documentation": "

A list of scaling activity objects.

" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token required to get the next set of results. This value is null if\n there are no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#DescribeScalingPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#DescribeScalingPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#DescribeScalingPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" + }, + { + "target": "com.amazonaws.applicationautoscaling#FailedResourceAccessException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InternalServiceException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the Application Auto Scaling scaling policies for the specified service namespace.

\n

You can filter the results using ResourceId,\n ScalableDimension, and PolicyNames.

\n

For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe scaling policies", + "documentation": "This example describes the scaling policies for the ECS service namespace.", + "input": { + "ServiceNamespace": "ecs" + }, + "output": { + "ScalingPolicies": [ + { + "PolicyName": "web-app-cpu-gt-75", + "ScalableDimension": "ecs:service:DesiredCount", + "ResourceId": "service/default/web-app", + "CreationTime": "2019-05-06T12:11:39.230Z", + "StepScalingPolicyConfiguration": { + "Cooldown": 60, + "StepAdjustments": [ + { + "ScalingAdjustment": 200, + "MetricIntervalLowerBound": 0 + } + ], + "AdjustmentType": "PercentChangeInCapacity" + }, + "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75", + "PolicyType": "StepScaling", + "Alarms": [ + { + "AlarmName": "web-app-cpu-gt-75", + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75" } + ], + "ServiceNamespace": "ecs" } + ], + "NextToken": "" + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScalingPolicies", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.applicationautoscaling#DescribeScalingPoliciesRequest": { + "type": "structure", + "members": { + "PolicyNames": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", + "traits": { + "smithy.api#documentation": "

The names of the scaling policies to describe.

" + } + }, + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
" + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
" + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationautoscaling#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of scalable targets. This value can be between 1 and 10. The default\n value is 10.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 10 results and a NextToken value, if\n applicable.

" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#DescribeScalingPoliciesResponse": { + "type": "structure", + "members": { + "ScalingPolicies": { + "target": "com.amazonaws.applicationautoscaling#ScalingPolicies", + "traits": { + "smithy.api#documentation": "

Information about the scaling policies.

" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token required to get the next set of results. This value is null if\n there are no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#DescribeScheduledActions": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#DescribeScheduledActionsRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#DescribeScheduledActionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InternalServiceException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the Application Auto Scaling scheduled actions for the specified service namespace.

\n

You can filter the results using the ResourceId,\n ScalableDimension, and ScheduledActionNames parameters.

\n

For more information, see Scheduled scaling in the Application Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To describe scheduled actions", + "documentation": "This example describes the scheduled actions for the dynamodb service namespace.", + "input": { + "ServiceNamespace": "dynamodb" }, - "traits": { - "smithy.api#documentation": "

Represents a target tracking scaling policy configuration to use with Application Auto Scaling.

\n

For more information, see Target tracking scaling policies in the\n Application Auto Scaling User Guide.

" - } - }, - "com.amazonaws.applicationautoscaling#TimestampType": { - "type": "timestamp" - }, - "com.amazonaws.applicationautoscaling#TooManyTagsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.applicationautoscaling#ExceptionMessage" + "output": { + "ScheduledActions": [ + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Schedule": "at(2019-05-20T18:35:00)", + "ResourceId": "table/my-table", + "CreationTime": 1.561571888361e9, + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-first-scheduled-action", + "ScalableTargetAction": { + "MinCapacity": 15, + "MaxCapacity": 20 + }, + "ScheduledActionName": "my-first-scheduled-action", + "ServiceNamespace": "dynamodb" }, - "ResourceName": { - "target": "com.amazonaws.applicationautoscaling#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

The name of the Application Auto Scaling resource. This value is an Amazon Resource Name (ARN).

" - } + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Schedule": "at(2019-05-20T18:40:00)", + "ResourceId": "table/my-table", + "CreationTime": 1.561571946021e9, + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-second-scheduled-action", + "ScalableTargetAction": { + "MinCapacity": 5, + "MaxCapacity": 10 + }, + "ScheduledActionName": "my-second-scheduled-action", + "ServiceNamespace": "dynamodb" } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ScheduledActions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.applicationautoscaling#DescribeScheduledActionsRequest": { + "type": "structure", + "members": { + "ScheduledActionNames": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", + "traits": { + "smithy.api#documentation": "

The names of the scheduled actions to describe.

" + } + }, + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
" + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
" + } + }, + "MaxResults": { + "target": "com.amazonaws.applicationautoscaling#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of scheduled action results. This value can be between\n 1 and 50. The default value is 50.

\n

If this parameter is used, the operation returns up to MaxResults results\n at a time, along with a NextToken value. To get the next set of results,\n include the NextToken value in a subsequent call. If this parameter is not\n used, the operation returns up to 50 results and a\n NextToken value, if applicable.

" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token for the next set of results.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#DescribeScheduledActionsResponse": { + "type": "structure", + "members": { + "ScheduledActions": { + "target": "com.amazonaws.applicationautoscaling#ScheduledActions", + "traits": { + "smithy.api#documentation": "

Information about the scheduled actions.

" + } + }, + "NextToken": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The token required to get the next set of results. This value is null if\n there are no more results to return.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#DisableScaleIn": { + "type": "boolean" + }, + "com.amazonaws.applicationautoscaling#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.applicationautoscaling#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.applicationautoscaling#Expression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#FailedResourceAccessException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.applicationautoscaling#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "FailedResourceAccessException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling\n is unable to retrieve the alarms associated with a scaling policy due to a client error,\n for example, if the role ARN specified for a scalable target does not have permission to\n call the CloudWatch DescribeAlarms on your behalf.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.applicationautoscaling#GetPredictiveScalingForecast": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#GetPredictiveScalingForecastRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#GetPredictiveScalingForecastResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#InternalServiceException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the forecast data for a predictive scaling policy.

\n

Load forecasts are predictions of the hourly load values using historical load data\n from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as\n predicted values for the minimum capacity that is needed on an hourly basis, based on\n the hourly load forecast.

\n

A minimum of 24 hours of data is required to create the initial forecasts. However,\n having a full 14 days of historical data results in more accurate forecasts.

" + } + }, + "com.amazonaws.applicationautoscaling#GetPredictiveScalingForecastRequest": { + "type": "structure", + "members": { + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

\n The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead. \n

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

\n The identifier of the resource.\n

", + "smithy.api#required": {} + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

\n The scalable dimension.\n

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.applicationautoscaling#PolicyName", + "traits": { + "smithy.api#documentation": "

The name of the policy.

", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

\n The inclusive start time of the time range for the forecast data to get. At most, the\n date and time can be one year before the current date and time\n

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

\n The exclusive end time of the time range for the forecast data to get. The maximum\n time duration between the start and end time is 30 days. \n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#GetPredictiveScalingForecastResponse": { + "type": "structure", + "members": { + "LoadForecast": { + "target": "com.amazonaws.applicationautoscaling#LoadForecasts", + "traits": { + "smithy.api#documentation": "

\n The load forecast.\n

" + } + }, + "CapacityForecast": { + "target": "com.amazonaws.applicationautoscaling#CapacityForecast", + "traits": { + "smithy.api#documentation": "

\n The capacity forecast.\n

" + } + }, + "UpdateTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

\n The time the forecast was made.\n

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#Id": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#IncludeNotScaledActivities": { + "type": "boolean" + }, + "com.amazonaws.applicationautoscaling#InternalServiceException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.applicationautoscaling#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InternalServiceException", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "

The service encountered an internal error.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.applicationautoscaling#InvalidNextTokenException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.applicationautoscaling#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidNextTokenException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The next token supplied was invalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.applicationautoscaling#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.applicationautoscaling#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceededException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.applicationautoscaling#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns all the tags on the specified Application Auto Scaling scalable target.

\n

For general information about tags, including the format and syntax, see Tagging your Amazon Web Services\n resources in the Amazon Web Services General Reference.

", + "smithy.api#examples": [ + { + "title": "To list tags for a scalable target", + "documentation": "This example lists the tag key names and values that are attached to the scalable target specified by its ARN.", + "input": { + "ResourceARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123" }, - "traits": { - "smithy.api#documentation": "

The request contains too many tags. Try the request again with fewer tags.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "output": { + "Tags": { + "environment": "production" + } } - }, - "com.amazonaws.applicationautoscaling#UntagResource": { - "type": "operation", + } + ] + } + }, + "com.amazonaws.applicationautoscaling#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.applicationautoscaling#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

Specify the ARN of the scalable target.

\n

For example:\n arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123\n

\n

To get the ARN for a scalable target, use DescribeScalableTargets.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.applicationautoscaling#TagMap", + "traits": { + "smithy.api#documentation": "

A list of tags. Each tag consists of a tag key and a tag value.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#LoadForecast": { + "type": "structure", + "members": { + "Timestamps": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingForecastTimestamps", + "traits": { + "smithy.api#documentation": "

\n The timestamps for the data points, in UTC format.\n

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingForecastValues", + "traits": { + "smithy.api#documentation": "

\n The values of the data points.\n

", + "smithy.api#required": {} + } + }, + "MetricSpecification": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricSpecification", + "traits": { + "smithy.api#documentation": "

\n The metric specification for the load forecast.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n A GetPredictiveScalingForecast call returns the load forecast for a\n predictive scaling policy. This structure includes the data points for that load\n forecast, along with the timestamps of those data points and the metric specification.\n

" + } + }, + "com.amazonaws.applicationautoscaling#LoadForecasts": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#LoadForecast" + } + }, + "com.amazonaws.applicationautoscaling#MaxResults": { + "type": "integer" + }, + "com.amazonaws.applicationautoscaling#MetricAggregationType": { + "type": "enum", + "members": { + "Average": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "Minimum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + }, + "Maximum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + } + } + }, + "com.amazonaws.applicationautoscaling#MetricDimension": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.applicationautoscaling#MetricDimensionName", + "traits": { + "smithy.api#documentation": "

The name of the dimension.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.applicationautoscaling#MetricDimensionValue", + "traits": { + "smithy.api#documentation": "

The value of the dimension.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the dimension names and values associated with a metric.

" + } + }, + "com.amazonaws.applicationautoscaling#MetricDimensionName": { + "type": "string" + }, + "com.amazonaws.applicationautoscaling#MetricDimensionValue": { + "type": "string" + }, + "com.amazonaws.applicationautoscaling#MetricDimensions": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#MetricDimension" + } + }, + "com.amazonaws.applicationautoscaling#MetricName": { + "type": "string" + }, + "com.amazonaws.applicationautoscaling#MetricNamespace": { + "type": "string" + }, + "com.amazonaws.applicationautoscaling#MetricScale": { + "type": "double" + }, + "com.amazonaws.applicationautoscaling#MetricStatistic": { + "type": "enum", + "members": { + "Average": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "Minimum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + }, + "Maximum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + }, + "SampleCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SampleCount" + } + }, + "Sum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sum" + } + } + } + }, + "com.amazonaws.applicationautoscaling#MetricType": { + "type": "enum", + "members": { + "DynamoDBReadCapacityUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DynamoDBReadCapacityUtilization" + } + }, + "DynamoDBWriteCapacityUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DynamoDBWriteCapacityUtilization" + } + }, + "ALBRequestCountPerTarget": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALBRequestCountPerTarget" + } + }, + "RDSReaderAverageCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDSReaderAverageCPUUtilization" + } + }, + "RDSReaderAverageDatabaseConnections": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDSReaderAverageDatabaseConnections" + } + }, + "EC2SpotFleetRequestAverageCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2SpotFleetRequestAverageCPUUtilization" + } + }, + "EC2SpotFleetRequestAverageNetworkIn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2SpotFleetRequestAverageNetworkIn" + } + }, + "EC2SpotFleetRequestAverageNetworkOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2SpotFleetRequestAverageNetworkOut" + } + }, + "SageMakerVariantInvocationsPerInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SageMakerVariantInvocationsPerInstance" + } + }, + "ECSServiceAverageCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECSServiceAverageCPUUtilization" + } + }, + "ECSServiceAverageMemoryUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECSServiceAverageMemoryUtilization" + } + }, + "AppStreamAverageCapacityUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AppStreamAverageCapacityUtilization" + } + }, + "ComprehendInferenceUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ComprehendInferenceUtilization" + } + }, + "LambdaProvisionedConcurrencyUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LambdaProvisionedConcurrencyUtilization" + } + }, + "CassandraReadCapacityUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CassandraReadCapacityUtilization" + } + }, + "CassandraWriteCapacityUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CassandraWriteCapacityUtilization" + } + }, + "KafkaBrokerStorageUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KafkaBrokerStorageUtilization" + } + }, + "ElastiCacheEngineCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ElastiCacheEngineCPUUtilization" + } + }, + "ElastiCacheDatabaseMemoryUsagePercentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ElastiCacheDatabaseMemoryUsagePercentage" + } + }, + "ElastiCachePrimaryEngineCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ElastiCachePrimaryEngineCPUUtilization" + } + }, + "ElastiCacheReplicaEngineCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ElastiCacheReplicaEngineCPUUtilization" + } + }, + "ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage" + } + }, + "NeptuneReaderAverageCPUUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NeptuneReaderAverageCPUUtilization" + } + }, + "SageMakerVariantProvisionedConcurrencyUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SageMakerVariantProvisionedConcurrencyUtilization" + } + }, + "ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage" + } + }, + "SageMakerInferenceComponentInvocationsPerCopy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SageMakerInferenceComponentInvocationsPerCopy" + } + }, + "WorkSpacesAverageUserSessionsCapacityUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WorkSpacesAverageUserSessionsCapacityUtilization" + } + }, + "SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution" + } + }, + "SageMakerVariantConcurrentRequestsPerModelHighResolution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SageMakerVariantConcurrentRequestsPerModelHighResolution" + } + } + } + }, + "com.amazonaws.applicationautoscaling#MetricUnit": { + "type": "string" + }, + "com.amazonaws.applicationautoscaling#MinAdjustmentMagnitude": { + "type": "integer" + }, + "com.amazonaws.applicationautoscaling#NotScaledReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A code that represents the reason for not scaling.

\n

Valid values:

\n
    \n
  • \n

    AutoScalingAnticipatedFlapping

    \n
    • \n
  • \n

    TargetServicePutResourceAsUnscalable

    \n
    • \n
  • \n

    AlreadyAtMaxCapacity

    \n
    • \n
  • \n

    AlreadyAtMinCapacity

    \n
    • \n
  • \n

    AlreadyAtDesiredCapacity

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MaxCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "traits": { + "smithy.api#documentation": "

The maximum capacity.

" + } + }, + "MinCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "traits": { + "smithy.api#documentation": "

The minimum capacity.

" + } + }, + "CurrentCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "traits": { + "smithy.api#documentation": "

The current capacity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the reason for an activity that isn't scaled (not scaled\n activity), in machine-readable format. For help interpreting the not scaled\n reason details, see Scaling activities for Application Auto Scaling in the\n Application Auto Scaling User Guide.

" + } + }, + "com.amazonaws.applicationautoscaling#NotScaledReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#NotScaledReason" + } + }, + "com.amazonaws.applicationautoscaling#ObjectNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.applicationautoscaling#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ObjectNotFoundException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The specified object could not be found. For any operation that depends on the existence\n of a scalable target, this exception is thrown if the scalable target with the specified\n service namespace, resource ID, and scalable dimension does not exist. For any operation\n that deletes or deregisters a resource, this exception is thrown if the resource cannot be\n found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.applicationautoscaling#PolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^\\p{Print}+$" + } + }, + "com.amazonaws.applicationautoscaling#PolicyType": { + "type": "enum", + "members": { + "StepScaling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StepScaling" + } + }, + "TargetTrackingScaling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TargetTrackingScaling" + } + }, + "PredictiveScaling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PredictiveScaling" + } + } + } + }, + "com.amazonaws.applicationautoscaling#PredefinedMetricSpecification": { + "type": "structure", + "members": { + "PredefinedMetricType": { + "target": "com.amazonaws.applicationautoscaling#MetricType", + "traits": { + "smithy.api#documentation": "

The metric type. The ALBRequestCountPerTarget metric type applies only to\n Spot Fleets and ECS services.

", + "smithy.api#required": {} + } + }, + "ResourceLabel": { + "target": "com.amazonaws.applicationautoscaling#ResourceLabel", + "traits": { + "smithy.api#documentation": "

Identifies the resource associated with the metric type. You can't specify a resource\n label unless the metric type is ALBRequestCountPerTarget and there is a target\n group attached to the Spot Fleet or ECS service.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n
    \n
  • \n

    app// is the final portion of\n the load balancer ARN

    \n
    • \n
  • \n

    targetgroup// is the final portion\n of the target group ARN.

    \n
    • \n
\n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a predefined metric for a target tracking scaling policy to use with\n Application Auto Scaling.

\n

For more information, Predefined metrics for target tracking scaling policies in the\n Application Auto Scaling User Guide.

" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingCustomizedMetricSpecification": { + "type": "structure", + "members": { + "MetricDataQueries": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDataQueries", + "traits": { + "smithy.api#documentation": "

\n One or more metric data queries to provide data points for a metric specification.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a CloudWatch metric of your choosing for a predictive scaling policy.\n

" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingForecastTimestamps": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#TimestampType" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingForecastValues": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#MetricScale" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMaxCapacityBreachBehavior": { + "type": "enum", + "members": { + "HonorMaxCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HonorMaxCapacity" + } + }, + "IncreaseMaxCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IncreaseMaxCapacity" + } + } + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMaxCapacityBuffer": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetric": { + "type": "structure", + "members": { + "Dimensions": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimensions", + "traits": { + "smithy.api#documentation": "

\n Describes the dimensions of the metric.\n

" + } + }, + "MetricName": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricName", + "traits": { + "smithy.api#documentation": "

\n The name of the metric.\n

" + } + }, + "Namespace": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricNamespace", + "traits": { + "smithy.api#documentation": "

\n The namespace of the metric.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes the scaling metric.\n

" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDataQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDataQuery" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDataQuery": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.applicationautoscaling#Id", + "traits": { + "smithy.api#documentation": "

\n A short name that identifies the object's results in the response. This name must be\n unique among all MetricDataQuery objects specified for a single scaling\n policy. If you are performing math expressions on this set of data, this name represents\n that data and can serve as a variable in the mathematical expression. The valid\n characters are letters, numbers, and underscores. The first character must be a\n lowercase letter.\n

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.applicationautoscaling#Expression", + "traits": { + "smithy.api#documentation": "

\n The math expression to perform on the returned data, if this object is performing a\n math expression. This expression can use the Id of the other metrics to\n refer to those metrics, and can also use the Id of other expressions to use\n the result of those expressions.\n

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" + } + }, + "MetricStat": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricStat", + "traits": { + "smithy.api#documentation": "

\n Information about the metric data to return.\n

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" + } + }, + "Label": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

\n A human-readable label for this metric or expression. This is especially useful if\n this is a math expression, so that you know what the value represents.\n

" + } + }, + "ReturnData": { + "target": "com.amazonaws.applicationautoscaling#ReturnData", + "traits": { + "smithy.api#documentation": "

\n Indicates whether to return the timestamps and raw data values of this metric.\n

\n

If you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and\n expressions used in the metric specification.

\n

If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned\n metric statistics to create a new time series. A time series is a series of data points,\n each of which is associated with a timestamp.\n

" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimension": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimensionName", + "traits": { + "smithy.api#documentation": "

\n The name of the dimension.\n

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimensionValue", + "traits": { + "smithy.api#documentation": "

\n The value of the dimension.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes the dimension of a metric.\n

" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimensionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimensionValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimensions": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricDimension" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricSpecification": { + "type": "structure", + "members": { + "TargetValue": { + "target": "com.amazonaws.applicationautoscaling#MetricScale", + "traits": { + "smithy.api#documentation": "

\n Specifies the target utilization.\n

", + "smithy.api#required": {} + } + }, + "PredefinedMetricPairSpecification": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingPredefinedMetricPairSpecification", + "traits": { + "smithy.api#documentation": "

\n The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.\n

" + } + }, + "PredefinedScalingMetricSpecification": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingPredefinedScalingMetricSpecification", + "traits": { + "smithy.api#documentation": "

\n The predefined scaling metric specification.\n

" + } + }, + "PredefinedLoadMetricSpecification": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingPredefinedLoadMetricSpecification", + "traits": { + "smithy.api#documentation": "

\n The predefined load metric specification.\n

" + } + }, + "CustomizedScalingMetricSpecification": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingCustomizedMetricSpecification", + "traits": { + "smithy.api#documentation": "

\n The customized scaling metric specification.\n

" + } + }, + "CustomizedLoadMetricSpecification": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingCustomizedMetricSpecification", + "traits": { + "smithy.api#documentation": "

\n The customized load metric specification.\n

" + } + }, + "CustomizedCapacityMetricSpecification": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingCustomizedMetricSpecification", + "traits": { + "smithy.api#documentation": "

\n The customized capacity metric specification.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n This structure specifies the metrics and target utilization settings for a predictive\n scaling policy.\n

\n

You must specify either a metric pair, or a load metric and a scaling metric\n individually. Specifying a metric pair instead of individual metrics provides a simpler\n way to configure metrics for a scaling policy. You choose the metric pair, and the\n policy automatically knows the correct sum and average statistics to use for the load\n metric and the scaling metric.

" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricSpecification" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricStat": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetric", + "traits": { + "smithy.api#documentation": "

\n The CloudWatch metric to return, including the metric name, namespace, and dimensions. To\n get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics. \n

", + "smithy.api#required": {} + } + }, + "Stat": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

\n The statistic to return. It can include any CloudWatch statistic or extended statistic. For\n a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.\n

\n

The most commonly used metrics for predictive scaling are Average and\n Sum.

", + "smithy.api#required": {} + } + }, + "Unit": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricUnit", + "traits": { + "smithy.api#documentation": "

\n The unit to use for the returned data points. For a complete list of the units that\n CloudWatch supports, see the MetricDatum \n data type in the Amazon CloudWatch API Reference.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n This structure defines the CloudWatch metric to return, along with the statistic and unit.\n

" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMetricUnit": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1023 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingMode": { + "type": "enum", + "members": { + "ForecastOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ForecastOnly" + } + }, + "ForecastAndScale": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ForecastAndScale" + } + } + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingPolicyConfiguration": { + "type": "structure", + "members": { + "MetricSpecifications": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricSpecifications", + "traits": { + "smithy.api#documentation": "

\n This structure includes the metrics and target utilization to use for predictive scaling.\n

\n

This is an array, but we currently only support a single metric specification. That\n is, you can specify a target value and a single metric pair, or a target value and one\n scaling metric and one load metric.

", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMode", + "traits": { + "smithy.api#documentation": "

\n The predictive scaling mode. Defaults to ForecastOnly if not specified.\n

" + } + }, + "SchedulingBufferTime": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingSchedulingBufferTime", + "traits": { + "smithy.api#documentation": "

\n The amount of time, in seconds, that the start time can be advanced.\n

\n

The value must be less than the forecast interval duration of 3600 seconds (60\n minutes). Defaults to 300 seconds if not specified.

" + } + }, + "MaxCapacityBreachBehavior": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMaxCapacityBreachBehavior", + "traits": { + "smithy.api#documentation": "

\n Defines the behavior that should be applied if the forecast capacity approaches or\n exceeds the maximum capacity. Defaults to\n HonorMaxCapacity if not specified.\n

" + } + }, + "MaxCapacityBuffer": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMaxCapacityBuffer", + "traits": { + "smithy.api#documentation": "

\n The size of the capacity buffer to use when the forecast capacity is close to or\n exceeds the maximum capacity. The value is specified as a percentage relative to the\n forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer,\n such that if the forecast capacity is 50, and the maximum capacity is 40, then the\n effective maximum capacity is 55.\n

\n

Required if the MaxCapacityBreachBehavior property is set to\n IncreaseMaxCapacity, and cannot be used otherwise.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a predictive scaling policy configuration. Predictive scaling is supported on Amazon ECS services.\n

" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingPredefinedLoadMetricSpecification": { + "type": "structure", + "members": { + "PredefinedMetricType": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricType", + "traits": { + "smithy.api#documentation": "

\n The metric type.\n

", + "smithy.api#required": {} + } + }, + "ResourceLabel": { + "target": "com.amazonaws.applicationautoscaling#ResourceLabel", + "traits": { + "smithy.api#documentation": "

\n A label that uniquely identifies a target group.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes a load metric for a predictive scaling policy.\n

\n

When returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.

\n

The following predefined metrics are available for predictive scaling:

\n
    \n
  • \n

    \n ECSServiceAverageCPUUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceAverageMemoryUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceCPUUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceMemoryUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceTotalCPUUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceTotalMemoryUtilization\n

    \n
    • \n
  • \n

    \n ALBRequestCount\n

    \n
    • \n
  • \n

    \n ALBRequestCountPerTarget\n

    \n
    • \n
  • \n

    \n TotalALBRequestCount\n

    \n
    • \n
" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingPredefinedMetricPairSpecification": { + "type": "structure", + "members": { + "PredefinedMetricType": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricType", + "traits": { + "smithy.api#documentation": "

\n Indicates which metrics to use. There are two different types of metrics for each\n metric type: one is a load metric and one is a scaling metric.\n

", + "smithy.api#required": {} + } + }, + "ResourceLabel": { + "target": "com.amazonaws.applicationautoscaling#ResourceLabel", + "traits": { + "smithy.api#documentation": "

\n A label that uniquely identifies a specific target group from which to determine\n the total and average request count.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Represents a metric pair for a predictive scaling policy.\n

\n

The following predefined metrics are available for predictive scaling:

\n
    \n
  • \n

    \n ECSServiceAverageCPUUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceAverageMemoryUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceCPUUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceMemoryUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceTotalCPUUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceTotalMemoryUtilization\n

    \n
    • \n
  • \n

    \n ALBRequestCount\n

    \n
    • \n
  • \n

    \n ALBRequestCountPerTarget\n

    \n
    • \n
  • \n

    \n TotalALBRequestCount\n

    \n
    • \n
" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingPredefinedScalingMetricSpecification": { + "type": "structure", + "members": { + "PredefinedMetricType": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingMetricType", + "traits": { + "smithy.api#documentation": "

\n The metric type.\n

", + "smithy.api#required": {} + } + }, + "ResourceLabel": { + "target": "com.amazonaws.applicationautoscaling#ResourceLabel", + "traits": { + "smithy.api#documentation": "

\n A label that uniquely identifies a specific target group from which to determine\n the average request count. \n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Describes a scaling metric for a predictive scaling policy.\n

\n

When returned in the output of DescribePolicies, it indicates that a\n predictive scaling policy uses individually specified load and scaling metrics instead\n of a metric pair.

\n

The following predefined metrics are available for predictive scaling:

\n
    \n
  • \n

    \n ECSServiceAverageCPUUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceAverageMemoryUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceCPUUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceMemoryUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceTotalCPUUtilization\n

    \n
    • \n
  • \n

    \n ECSServiceTotalMemoryUtilization\n

    \n
    • \n
  • \n

    \n ALBRequestCount\n

    \n
    • \n
  • \n

    \n ALBRequestCountPerTarget\n

    \n
    • \n
  • \n

    \n TotalALBRequestCount\n

    \n
    • \n
" + } + }, + "com.amazonaws.applicationautoscaling#PredictiveScalingSchedulingBufferTime": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, + "com.amazonaws.applicationautoscaling#PutScalingPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#PutScalingPolicyRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#PutScalingPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" + }, + { + "target": "com.amazonaws.applicationautoscaling#FailedResourceAccessException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InternalServiceException" + }, + { + "target": "com.amazonaws.applicationautoscaling#LimitExceededException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ObjectNotFoundException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a scaling policy for an Application Auto Scaling scalable target.

\n

Each scalable target is identified by a service namespace, resource ID, and scalable\n dimension. A scaling policy applies to the scalable target identified by those three\n attributes. You cannot create a scaling policy until you have registered the resource as a\n scalable target.

\n

Multiple scaling policies can be in force at the same time for the same scalable target.\n You can have one or more target tracking scaling policies, one or more step scaling\n policies, or both. However, there is a chance that multiple policies could conflict,\n instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives\n precedence to the policy that provides the largest capacity for both scale out and scale\n in. For example, if one policy increases capacity by 3, another policy increases capacity\n by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest\n calculated capacity (200% of 10 = 20) and scales out to 30.

\n

We recommend caution, however, when using target tracking scaling policies with step\n scaling policies because conflicts between these policies can cause undesirable behavior.\n For example, if the step scaling policy initiates a scale-in activity before the target\n tracking policy is ready to scale in, the scale-in activity will not be blocked. After the\n scale-in activity completes, the target tracking policy could instruct the scalable target\n to scale out again.

\n

For more information, see Target tracking scaling policies, Step scaling policies, and Predictive scaling policies \n in the Application Auto Scaling User Guide.

\n \n

If a scalable target is deregistered, the scalable target is no longer available to\n use scaling policies. Any scaling policies that were specified for the scalable target\n are deleted.

\n ", + "smithy.api#examples": [ + { + "title": "To apply a target tracking scaling policy with a predefined metric specification", + "documentation": "The following example applies a target tracking scaling policy with a predefined metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average CPU utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds.", "input": { - "target": "com.amazonaws.applicationautoscaling#UntagResourceRequest" + "PolicyName": "cpu75-target-tracking-scaling-policy", + "ServiceNamespace": "ecs", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "PolicyType": "TargetTrackingScaling", + "TargetTrackingScalingPolicyConfiguration": { + "TargetValue": 75, + "PredefinedMetricSpecification": { + "PredefinedMetricType": "ECSServiceAverageCPUUtilization" + }, + "ScaleOutCooldown": 60, + "ScaleInCooldown": 60 + } }, "output": { - "target": "com.amazonaws.applicationautoscaling#UntagResourceResponse" - }, - "errors": [ + "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/cpu75-target-tracking-scaling-policy", + "Alarms": [ { - "target": "com.amazonaws.applicationautoscaling#ResourceNotFoundException" + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca", + "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca" }, { - "target": "com.amazonaws.applicationautoscaling#ValidationException" + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d", + "AlarmName": "TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d" } - ], - "traits": { - "smithy.api#documentation": "

Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and\n the Application Auto Scaling scalable target.

", - "smithy.api#examples": [ - { - "title": "To remove a tag from a scalable target", - "documentation": "This example removes the tag pair with the key name \"environment\" from the scalable target specified by its ARN.", - "input": { - "ResourceARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123", - "TagKeys": [ - "environment" - ] - }, - "output": {} - } - ] + ] } - }, - "com.amazonaws.applicationautoscaling#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceARN": { - "target": "com.amazonaws.applicationautoscaling#AmazonResourceName", - "traits": { - "smithy.api#documentation": "

Identifies the Application Auto Scaling scalable target from which to remove tags.

\n

For example:\n arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123\n

\n

To get the ARN for a scalable target, use DescribeScalableTargets.

", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.applicationautoscaling#TagKeyList", - "traits": { - "smithy.api#documentation": "

One or more tag keys. Specify only the tag keys, not the tag values.

", - "smithy.api#required": {} - } - } + } + ] + } + }, + "com.amazonaws.applicationautoscaling#PutScalingPolicyRequest": { + "type": "structure", + "members": { + "PolicyName": { + "target": "com.amazonaws.applicationautoscaling#PolicyName", + "traits": { + "smithy.api#documentation": "

The name of the scaling policy.

\n

You cannot change the name of a scaling policy, but you can delete the original scaling\n policy and create a new scaling policy with the same settings and a different name.

", + "smithy.api#required": {} + } + }, + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "PolicyType": { + "target": "com.amazonaws.applicationautoscaling#PolicyType", + "traits": { + "smithy.api#documentation": "

The scaling policy type. This parameter is required if you are creating a scaling\n policy.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling—Not supported for Amazon EMR.

\n

\n StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or\n Neptune.

\n

\n PredictiveScaling—Only supported for Amazon ECS.

\n

For more information, see Target\n tracking scaling policies, Step scaling policies, and Predictive scaling policies \n in the Application Auto Scaling User Guide.

" + } + }, + "StepScalingPolicyConfiguration": { + "target": "com.amazonaws.applicationautoscaling#StepScalingPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

A step scaling policy.

\n

This parameter is required if you are creating a policy and the policy type is\n StepScaling.

" + } + }, + "TargetTrackingScalingPolicyConfiguration": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingScalingPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

A target tracking scaling policy. Includes support for predefined or customized\n metrics.

\n

This parameter is required if you are creating a policy and the policy type is\n TargetTrackingScaling.

" + } + }, + "PredictiveScalingPolicyConfiguration": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

\n The configuration of the predictive scaling policy.\n

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#PutScalingPolicyResponse": { + "type": "structure", + "members": { + "PolicyARN": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resulting scaling policy.

", + "smithy.api#required": {} + } + }, + "Alarms": { + "target": "com.amazonaws.applicationautoscaling#Alarms", + "traits": { + "smithy.api#documentation": "

The CloudWatch alarms created for the target tracking scaling policy.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#PutScheduledAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#PutScheduledActionRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#PutScheduledActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InternalServiceException" + }, + { + "target": "com.amazonaws.applicationautoscaling#LimitExceededException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ObjectNotFoundException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates a scheduled action for an Application Auto Scaling scalable target.

\n

Each scalable target is identified by a service namespace, resource ID, and scalable\n dimension. A scheduled action applies to the scalable target identified by those three\n attributes. You cannot create a scheduled action until you have registered the resource as\n a scalable target.

\n

When you specify start and end times with a recurring schedule using a cron expression\n or rates, they form the boundaries for when the recurring action starts and stops.

\n

To update a scheduled action, specify the parameters that you want to change. If you\n don't specify start and end times, the old values are deleted.

\n

For more information, see Scheduled scaling in the Application Auto Scaling User Guide.

\n \n

If a scalable target is deregistered, the scalable target is no longer available to\n run scheduled actions. Any scheduled actions that were specified for the scalable target\n are deleted.

\n ", + "smithy.api#examples": [ + { + "title": "To create a recurring scheduled action", + "documentation": "This example adds a scheduled action to a DynamoDB table called TestTable to scale out on a recurring schedule. On the specified schedule (every day at 12:15pm UTC), if the current capacity is below the value specified for MinCapacity, Application Auto Scaling scales out to the value specified by MinCapacity.", + "input": { + "ServiceNamespace": "dynamodb", + "Schedule": "cron(15 12 * * ? *)", + "ScheduledActionName": "my-recurring-action", + "ResourceId": "table/TestTable", + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "ScalableTargetAction": { + "MinCapacity": 6 + } }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.applicationautoscaling#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.applicationautoscaling#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.applicationautoscaling#ErrorMessage" - } + "output": {} + } + ] + } + }, + "com.amazonaws.applicationautoscaling#PutScheduledActionRequest": { + "type": "structure", + "members": { + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The schedule for this action. The following formats are supported:

\n
    \n
  • \n

    At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"

    \n
    • \n
  • \n

    Rate expressions - \"rate(value\n unit)\"

    \n
    • \n
  • \n

    Cron expressions - \"cron(fields)\"

    \n
    • \n
\n

At expressions are useful for one-time schedules. Cron expressions are useful for \n scheduled actions that run periodically at a specified date and time, and rate expressions \n are useful for scheduled actions that run at a regular interval.

\n

At and cron expressions use Universal Coordinated Time (UTC) by\n default.

\n

The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].

\n

For rate expressions, value is a positive integer and unit is \n minute | minutes | hour | hours | day | days.

\n

For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.

" + } + }, + "Timezone": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

Specifies the time zone used when setting a scheduled action by using an at or cron\n expression. If a time zone is not provided, UTC is used by default.

\n

Valid values are the canonical names of the IANA time zones supported by Joda-Time (such\n as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://www.joda.org/joda-time/timezones.html.

" + } + }, + "ScheduledActionName": { + "target": "com.amazonaws.applicationautoscaling#ScheduledActionName", + "traits": { + "smithy.api#documentation": "

The name of the scheduled action. This name must be unique among all other scheduled\n actions on the specified scalable target.

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time for this scheduled action to start, in UTC.

" + } + }, + "EndTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time for the recurring schedule to end, in UTC.

" + } + }, + "ScalableTargetAction": { + "target": "com.amazonaws.applicationautoscaling#ScalableTargetAction", + "traits": { + "smithy.api#documentation": "

The new minimum and maximum capacity. You can set both values or just one. At the\n scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out\n to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling\n scales in to the maximum capacity.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#PutScheduledActionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#RegisterScalableTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#RegisterScalableTargetRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#RegisterScalableTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ConcurrentUpdateException" + }, + { + "target": "com.amazonaws.applicationautoscaling#InternalServiceException" + }, + { + "target": "com.amazonaws.applicationautoscaling#LimitExceededException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers or updates a scalable target, which is the resource that you want to\n scale.

\n

Scalable targets are uniquely identified by the combination of resource ID, scalable\n dimension, and namespace, which represents some capacity dimension of the underlying\n service.

\n

When you register a new scalable target, you must specify values for the minimum and\n maximum capacity. If the specified resource is not active in the target service, this\n operation does not change the resource's current capacity. Otherwise, it changes the\n resource's current capacity to a value that is inside of this range.

\n

If you add a scaling policy, current capacity is adjustable within the specified range\n when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are\n outside of the minimum and maximum range.

\n

After you register a scalable target, you do not need to register it again to use other\n Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service\n namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can\n deregister it by using DeregisterScalableTarget.

\n

To update a scalable target, specify the parameters that you want to change. Include the\n parameters that identify the scalable target: resource ID, scalable dimension, and\n namespace. Any parameters that you don't specify are not changed by this update request.

\n \n

If you call the RegisterScalableTarget API operation to create a\n scalable target, there might be a brief delay until the operation achieves eventual\n consistency. You might become aware of this brief delay if you get unexpected\n errors when performing sequential operations. The typical strategy is to retry the\n request, and some Amazon Web Services SDKs include automatic backoff and retry logic.

\n

If you call the RegisterScalableTarget API operation to update an\n existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If\n it's below the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the\n capacity of the scalable target to place it within these bounds, even if you don't\n include the MinCapacity or MaxCapacity request\n parameters.

\n ", + "smithy.api#examples": [ + { + "title": "To register an ECS service as a scalable target", + "documentation": "This example registers a scalable target from an Amazon ECS service called web-app that is running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks.", + "input": { + "ServiceNamespace": "ecs", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "MinCapacity": 1, + "MaxCapacity": 10 }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ValidationException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "

An exception was thrown for a validation issue. Review the available parameters for the\n API request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.applicationautoscaling#XmlString": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + "output": { + "ScalableTargetARN": "arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123" } + } + ] + } + }, + "com.amazonaws.applicationautoscaling#RegisterScalableTargetRequest": { + "type": "structure", + "members": { + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource that is associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MinCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "traits": { + "smithy.api#documentation": "

The minimum value that you plan to scale in to. When a scaling policy is in effect,\n Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to\n changing demand. This property is required when registering a new scalable target.

\n

For the following resources, the minimum value allowed is 0.

\n
    \n
  • \n

    AppStream 2.0 fleets

    \n
    • \n
  • \n

    Aurora DB clusters

    \n
    • \n
  • \n

    ECS services

    \n
    • \n
  • \n

    EMR clusters

    \n
    • \n
  • \n

    Lambda provisioned concurrency

    \n
    • \n
  • \n

    SageMaker endpoint variants

    \n
    • \n
  • \n

    SageMaker inference components

    \n
    • \n
  • \n

    SageMaker serverless endpoint provisioned concurrency

    \n
    • \n
  • \n

    Spot Fleets

    \n
    • \n
  • \n

    custom resources

    \n
    • \n
\n

It's strongly recommended that you specify a value greater than 0. A value greater than 0\n means that data points are continuously reported to CloudWatch that scaling policies can use to\n scale on a metric like average CPU utilization.

\n

For all other resources, the minimum allowed value depends on the type of resource that\n you are using. If you provide a value that is lower than what a resource can accept, an error\n occurs. In which case, the error message will provide the minimum value that the resource can\n accept.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "traits": { + "smithy.api#documentation": "

The maximum value that you plan to scale out to. When a scaling policy is in effect,\n Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to\n changing demand. This property is required when registering a new scalable target.

\n

Although you can specify a large maximum capacity, note that service quotas might impose\n lower limits. Each service has its own default quotas for the maximum capacity of the\n resource. If you want to specify a higher limit, you can request an increase. For more\n information, consult the documentation for that service. For information about the default\n quotas for each service, see Service endpoints and\n quotas in the Amazon Web Services General Reference.

" + } + }, + "RoleARN": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

This parameter is required for services that do not support service-linked roles (such as\n Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable\n target on your behalf.

\n

If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which\n it creates if it does not yet exist. For more information, see How Application Auto Scaling works with IAM.

" + } + }, + "SuspendedState": { + "target": "com.amazonaws.applicationautoscaling#SuspendedState", + "traits": { + "smithy.api#documentation": "

An embedded object that contains attributes and attribute values that are used to\n suspend and resume automatic scaling. Setting the value of an attribute to\n true suspends the specified scaling activities. Setting it to\n false (default) resumes the specified scaling activities.

\n

\n Suspension Outcomes\n

\n
    \n
  • \n

    For DynamicScalingInSuspended, while a suspension is in effect, all\n scale-in activities that are triggered by a scaling policy are suspended.

    \n
    • \n
  • \n

    For DynamicScalingOutSuspended, while a suspension is in effect, all\n scale-out activities that are triggered by a scaling policy are suspended.

    \n
    • \n
  • \n

    For ScheduledScalingSuspended, while a suspension is in effect, all\n scaling activities that involve scheduled actions are suspended.

    \n
    • \n
\n

For more information, see Suspend and resume scaling in the Application Auto Scaling User\n Guide.

" + } + }, + "Tags": { + "target": "com.amazonaws.applicationautoscaling#TagMap", + "traits": { + "smithy.api#documentation": "

Assigns one or more tags to the scalable target. Use this parameter to tag the scalable\n target when it is created. To tag an existing scalable target, use the TagResource operation.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required. You cannot have more than one tag on a scalable target with the same tag\n key.

\n

Use tags to control access to a scalable target. For more information, see Tagging support\n for Application Auto Scaling in the Application Auto Scaling User Guide.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#RegisterScalableTargetResponse": { + "type": "structure", + "members": { + "ScalableTargetARN": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The ARN of the scalable target.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#ResourceCapacity": { + "type": "integer" + }, + "com.amazonaws.applicationautoscaling#ResourceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.applicationautoscaling#ResourceLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1023 + } + } + }, + "com.amazonaws.applicationautoscaling#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.applicationautoscaling#ExceptionMessage" + }, + "ResourceName": { + "target": "com.amazonaws.applicationautoscaling#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Application Auto Scaling resource. This value is an Amazon Resource Name (ARN).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource doesn't exist.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.applicationautoscaling#ReturnData": { + "type": "boolean" + }, + "com.amazonaws.applicationautoscaling#ScalableDimension": { + "type": "enum", + "members": { + "ECSServiceDesiredCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ecs:service:DesiredCount" + } + }, + "EC2SpotFleetRequestTargetCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ec2:spot-fleet-request:TargetCapacity" + } + }, + "EMRInstanceGroupInstanceCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elasticmapreduce:instancegroup:InstanceCount" + } + }, + "AppstreamFleetDesiredCapacity": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "appstream:fleet:DesiredCapacity" + } + }, + "DynamoDBTableReadCapacityUnits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dynamodb:table:ReadCapacityUnits" + } + }, + "DynamoDBTableWriteCapacityUnits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dynamodb:table:WriteCapacityUnits" + } + }, + "DynamoDBIndexReadCapacityUnits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dynamodb:index:ReadCapacityUnits" + } + }, + "DynamoDBIndexWriteCapacityUnits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dynamodb:index:WriteCapacityUnits" + } + }, + "RDSClusterReadReplicaCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rds:cluster:ReadReplicaCount" + } + }, + "SageMakerVariantDesiredInstanceCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sagemaker:variant:DesiredInstanceCount" + } + }, + "CustomResourceScalableDimension": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "custom-resource:ResourceType:Property" + } + }, + "ComprehendDocClassifierEndpointInferenceUnits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "comprehend:document-classifier-endpoint:DesiredInferenceUnits" + } + }, + "ComprehendEntityRecognizerEndpointInferenceUnits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits" + } + }, + "LambdaFunctionProvisionedConcurrency": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lambda:function:ProvisionedConcurrency" + } + }, + "CassandraTableReadCapacityUnits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cassandra:table:ReadCapacityUnits" + } + }, + "CassandraTableWriteCapacityUnits": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cassandra:table:WriteCapacityUnits" + } + }, + "KafkaBrokerStorageVolumeSize": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kafka:broker-storage:VolumeSize" + } + }, + "ElastiCacheCacheClusterNodes": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elasticache:cache-cluster:Nodes" + } + }, + "ElastiCacheReplicationGroupNodeGroups": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elasticache:replication-group:NodeGroups" + } + }, + "ElastiCacheReplicationGroupReplicas": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elasticache:replication-group:Replicas" + } + }, + "NeptuneClusterReadReplicaCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "neptune:cluster:ReadReplicaCount" + } + }, + "SageMakerVariantDesiredProvisionedConcurrency": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sagemaker:variant:DesiredProvisionedConcurrency" + } + }, + "SageMakerInferenceComponentDesiredCopyCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sagemaker:inference-component:DesiredCopyCount" + } + }, + "WorkSpacesWorkSpacesPoolDesiredUserSessions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "workspaces:workspacespool:DesiredUserSessions" + } + } + } + }, + "com.amazonaws.applicationautoscaling#ScalableTarget": { + "type": "structure", + "members": { + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource, or a\n custom-resource.

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "MinCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "traits": { + "smithy.api#documentation": "

The minimum value to scale to in response to a scale-in activity.

", + "smithy.api#required": {} + } + }, + "MaxCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "traits": { + "smithy.api#documentation": "

The maximum value to scale to in response to a scale-out activity.

", + "smithy.api#required": {} + } + }, + "PredictedCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "traits": { + "smithy.api#documentation": "

\n The predicted capacity of the scalable target.\n

" + } + }, + "RoleARN": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your\n behalf.

", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for when the scalable target was created.

", + "smithy.api#required": {} + } + }, + "SuspendedState": { + "target": "com.amazonaws.applicationautoscaling#SuspendedState", + "traits": { + "smithy.api#documentation": "

Specifies whether the scaling activities for a scalable target are in a suspended\n state.

" + } + }, + "ScalableTargetARN": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The ARN of the scalable target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a scalable target.

" + } + }, + "com.amazonaws.applicationautoscaling#ScalableTargetAction": { + "type": "structure", + "members": { + "MinCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "traits": { + "smithy.api#documentation": "

The minimum capacity.

\n

When the scheduled action runs, the resource will have at least this much capacity, but it\n might have more depending on other settings, such as the target utilization level of a target\n tracking scaling policy.

" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.applicationautoscaling#ResourceCapacity", + "traits": { + "smithy.api#documentation": "

The maximum capacity.

\n

Although you can specify a large maximum capacity, note that service quotas may impose\n lower limits. Each service has its own default quotas for the maximum capacity of the\n resource. If you want to specify a higher limit, you can request an increase. For more\n information, consult the documentation for that service. For information about the default\n quotas for each service, see Service endpoints and\n quotas in the Amazon Web Services General Reference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents the minimum and maximum capacity for a scheduled action.

" + } + }, + "com.amazonaws.applicationautoscaling#ScalableTargets": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#ScalableTarget" + } + }, + "com.amazonaws.applicationautoscaling#ScalingActivities": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#ScalingActivity" + } + }, + "com.amazonaws.applicationautoscaling#ScalingActivity": { + "type": "structure", + "members": { + "ActivityId": { + "target": "com.amazonaws.applicationautoscaling#ResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the scaling activity.

", + "smithy.api#required": {} + } + }, + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource, or a\n custom-resource.

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A simple description of what action the scaling activity intends to accomplish.

", + "smithy.api#required": {} + } + }, + "Cause": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A simple description of what caused the scaling activity to happen.

", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for when the scaling activity began.

", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for when the scaling activity ended.

" + } + }, + "StatusCode": { + "target": "com.amazonaws.applicationautoscaling#ScalingActivityStatusCode", + "traits": { + "smithy.api#documentation": "

Indicates the status of the scaling activity.

", + "smithy.api#required": {} + } + }, + "StatusMessage": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A simple message about the current status of the scaling activity.

" + } + }, + "Details": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The details about the scaling activity.

" + } + }, + "NotScaledReasons": { + "target": "com.amazonaws.applicationautoscaling#NotScaledReasons", + "traits": { + "smithy.api#documentation": "

Machine-readable data that describes the reason for a not scaled activity. Only\n available when DescribeScalingActivities includes not scaled activities.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a scaling activity.

" + } + }, + "com.amazonaws.applicationautoscaling#ScalingActivityStatusCode": { + "type": "enum", + "members": { + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + }, + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "Successful": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" + } + }, + "Overridden": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Overridden" + } + }, + "Unfulfilled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unfulfilled" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } } + } + }, + "com.amazonaws.applicationautoscaling#ScalingAdjustment": { + "type": "integer" + }, + "com.amazonaws.applicationautoscaling#ScalingPolicies": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#ScalingPolicy" + } + }, + "com.amazonaws.applicationautoscaling#ScalingPolicy": { + "type": "structure", + "members": { + "PolicyARN": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scaling policy.

", + "smithy.api#required": {} + } + }, + "PolicyName": { + "target": "com.amazonaws.applicationautoscaling#PolicyName", + "traits": { + "smithy.api#documentation": "

The name of the scaling policy.

", + "smithy.api#required": {} + } + }, + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource, or a\n custom-resource.

", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "PolicyType": { + "target": "com.amazonaws.applicationautoscaling#PolicyType", + "traits": { + "smithy.api#documentation": "

The scaling policy type.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling—Not supported for Amazon EMR

\n

\n StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or\n Neptune.

\n

\n PredictiveScaling—Only supported for Amazon ECS

", + "smithy.api#required": {} + } + }, + "StepScalingPolicyConfiguration": { + "target": "com.amazonaws.applicationautoscaling#StepScalingPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

A step scaling policy.

" + } + }, + "TargetTrackingScalingPolicyConfiguration": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingScalingPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

A target tracking scaling policy.

" + } + }, + "PredictiveScalingPolicyConfiguration": { + "target": "com.amazonaws.applicationautoscaling#PredictiveScalingPolicyConfiguration", + "traits": { + "smithy.api#documentation": "

\n The predictive scaling policy configuration.\n

" + } + }, + "Alarms": { + "target": "com.amazonaws.applicationautoscaling#Alarms", + "traits": { + "smithy.api#documentation": "

The CloudWatch alarms associated with the scaling policy.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for when the scaling policy was created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a scaling policy to use with Application Auto Scaling.

\n

For more information about configuring scaling policies for a specific service, see\n Amazon Web Services services\n that you can use with Application Auto Scaling in the\n Application Auto Scaling User Guide.

" + } + }, + "com.amazonaws.applicationautoscaling#ScalingSuspended": { + "type": "boolean" + }, + "com.amazonaws.applicationautoscaling#ScheduledAction": { + "type": "structure", + "members": { + "ScheduledActionName": { + "target": "com.amazonaws.applicationautoscaling#ScheduledActionName", + "traits": { + "smithy.api#documentation": "

The name of the scheduled action.

", + "smithy.api#required": {} + } + }, + "ScheduledActionARN": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scheduled action.

", + "smithy.api#required": {} + } + }, + "ServiceNamespace": { + "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the Amazon Web Services service that provides the resource, or a\n custom-resource.

", + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The schedule for this action. The following formats are supported:

\n
    \n
  • \n

    At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"

    \n
    • \n
  • \n

    Rate expressions - \"rate(value\n unit)\"

    \n
    • \n
  • \n

    Cron expressions - \"cron(fields)\"

    \n
    • \n
\n

At expressions are useful for one-time schedules. Cron expressions are useful for \n scheduled actions that run periodically at a specified date and time, and rate expressions \n are useful for scheduled actions that run at a regular interval.

\n

At and cron expressions use Universal Coordinated Time (UTC) by\n default.

\n

The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].

\n

For rate expressions, value is a positive integer and unit is \n minute | minutes | hour | hours | day | days.

\n

For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.

", + "smithy.api#required": {} + } + }, + "Timezone": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The time zone used when referring to the date and time of a scheduled action, when the\n scheduled action uses an at or cron expression.

" + } + }, + "ResourceId": { + "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", + "traits": { + "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n
    \n
  • \n

    ECS service - The resource type is service and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service.

    \n
    • \n
  • \n

    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the \n Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

    \n
    • \n
  • \n

    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

    \n
    • \n
  • \n

    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.\n Example: fleet/sample-fleet.

    \n
    • \n
  • \n

    DynamoDB table - The resource type is table and the unique identifier is the table name. \n Example: table/my-table.

    \n
    • \n
  • \n

    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index.

    \n
    • \n
  • \n

    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster.

    \n
    • \n
  • \n

    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information\n is available in our GitHub\n repository.

    \n
    • \n
  • \n

    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

    \n
    • \n
  • \n

    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. \n Example: function:my-function:prod or function:my-function:1.

    \n
    • \n
  • \n

    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. \n Example: keyspace/mykeyspace/table/mytable.

    \n
    • \n
  • \n

    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.

    \n
    • \n
  • \n

    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.\n Example: replication-group/mycluster.

    \n
    • \n
  • \n

    Amazon ElastiCache cache cluster - The resource type is cache-cluster and the unique identifier is the cache cluster name.\n Example: cache-cluster/mycluster.

    \n
    • \n
  • \n

    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

    \n
    • \n
  • \n

    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID.\n Example: endpoint/my-end-point/variant/KMeansClustering.

    \n
    • \n
  • \n

    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component.

    \n
    • \n
  • \n

    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456.

    \n
    • \n
", + "smithy.api#required": {} + } + }, + "ScalableDimension": { + "target": "com.amazonaws.applicationautoscaling#ScalableDimension", + "traits": { + "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n
    \n
  • \n

    \n ecs:service:DesiredCount - The task count of an ECS service.

    \n
    • \n
  • \n

    \n elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

    \n
    • \n
  • \n

    \n ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

    \n
    • \n
  • \n

    \n appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.

    \n
    • \n
  • \n

    \n dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

    \n
    • \n
  • \n

    \n dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

    \n
    • \n
  • \n

    \n rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.

    \n
    • \n
  • \n

    \n custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    \n
    • \n
  • \n

    \n comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

    \n
    • \n
  • \n

    \n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

    \n
    • \n
  • \n

    \n lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

    \n
    • \n
  • \n

    \n cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

    \n
    • \n
  • \n

    \n kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

    \n
    • \n
  • \n

    \n elasticache:cache-cluster:Nodes - The number of nodes for an Amazon ElastiCache cache cluster.

    \n
    • \n
  • \n

    \n elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

    \n
    • \n
  • \n

    \n neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

    \n
    • \n
  • \n

    \n sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.

    \n
    • \n
  • \n

    \n sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.

    \n
    • \n
  • \n

    \n workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.

    \n
    • \n
" + } + }, + "StartTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time that the action is scheduled to begin, in UTC.

" + } + }, + "EndTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time that the action is scheduled to end, in UTC.

" + } + }, + "ScalableTargetAction": { + "target": "com.amazonaws.applicationautoscaling#ScalableTargetAction", + "traits": { + "smithy.api#documentation": "

The new minimum and maximum capacity. You can set both values or just one. At the\n scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out\n to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling\n scales in to the maximum capacity.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.applicationautoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "

The date and time that the scheduled action was created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a scheduled action.

" + } + }, + "com.amazonaws.applicationautoscaling#ScheduledActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^(?!((^[ ]+.*)|(.*([\\u0000-\\u001f]|[\\u007f-\\u009f]|[:/|])+.*)|(.*[ ]+$))).+$" + } + }, + "com.amazonaws.applicationautoscaling#ScheduledActions": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#ScheduledAction" + } + }, + "com.amazonaws.applicationautoscaling#ServiceNamespace": { + "type": "enum", + "members": { + "ECS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ecs" + } + }, + "EMR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elasticmapreduce" + } + }, + "EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ec2" + } + }, + "APPSTREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "appstream" + } + }, + "DYNAMODB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dynamodb" + } + }, + "RDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rds" + } + }, + "SAGEMAKER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sagemaker" + } + }, + "CUSTOM_RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "custom-resource" + } + }, + "COMPREHEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "comprehend" + } + }, + "LAMBDA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lambda" + } + }, + "CASSANDRA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cassandra" + } + }, + "KAFKA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "kafka" + } + }, + "ELASTICACHE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "elasticache" + } + }, + "NEPTUNE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "neptune" + } + }, + "WORKSPACES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "workspaces" + } + } + } + }, + "com.amazonaws.applicationautoscaling#StepAdjustment": { + "type": "structure", + "members": { + "MetricIntervalLowerBound": { + "target": "com.amazonaws.applicationautoscaling#MetricScale", + "traits": { + "smithy.api#documentation": "

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the lower bound is inclusive (the metric\n must be greater than or equal to the threshold plus the lower bound). Otherwise, it's\n exclusive (the metric must be greater than the threshold plus the lower bound). A null\n value indicates negative infinity.

" + } + }, + "MetricIntervalUpperBound": { + "target": "com.amazonaws.applicationautoscaling#MetricScale", + "traits": { + "smithy.api#documentation": "

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the upper bound is exclusive (the metric\n must be less than the threshold plus the upper bound). Otherwise, it's inclusive (the\n metric must be less than or equal to the threshold plus the upper bound). A null value\n indicates positive infinity.

\n

The upper bound must be greater than the lower bound.

" + } + }, + "ScalingAdjustment": { + "target": "com.amazonaws.applicationautoscaling#ScalingAdjustment", + "traits": { + "smithy.api#documentation": "

The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity. For\n exact capacity, you must specify a non-negative value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference\n between the value of the aggregated CloudWatch metric and the breach threshold that you've\n defined for the alarm.

\n

For the following examples, suppose that you have an alarm with a breach threshold of\n 50:

\n
    \n
  • \n

    To initiate the adjustment when the metric is greater than or equal to 50 and less\n than 60, specify a lower bound of 0 and an upper bound of\n 10.

    \n
    • \n
  • \n

    To initiate the adjustment when the metric is greater than 40 and less than or\n equal to 50, specify a lower bound of -10 and an upper bound of\n 0.

    \n
    • \n
\n

There are a few rules for the step adjustments for your step policy:

\n
    \n
  • \n

    The ranges of your step adjustments can't overlap or have a gap.

    \n
    • \n
  • \n

    At most one step adjustment can have a null lower bound. If one step adjustment\n has a negative lower bound, then there must be a step adjustment with a null lower\n bound.

    \n
    • \n
  • \n

    At most one step adjustment can have a null upper bound. If one step adjustment\n has a positive upper bound, then there must be a step adjustment with a null upper\n bound.

    \n
    • \n
  • \n

    The upper and lower bound can't be null in the same step adjustment.

    \n
    • \n
" + } + }, + "com.amazonaws.applicationautoscaling#StepAdjustments": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#StepAdjustment" + } + }, + "com.amazonaws.applicationautoscaling#StepScalingPolicyConfiguration": { + "type": "structure", + "members": { + "AdjustmentType": { + "target": "com.amazonaws.applicationautoscaling#AdjustmentType", + "traits": { + "smithy.api#documentation": "

Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a\n percentage). The valid values are ChangeInCapacity,\n ExactCapacity, and PercentChangeInCapacity.

\n

\n AdjustmentType is required if you are adding a new step scaling policy\n configuration.

" + } + }, + "StepAdjustments": { + "target": "com.amazonaws.applicationautoscaling#StepAdjustments", + "traits": { + "smithy.api#documentation": "

A set of adjustments that enable you to scale based on the size of the alarm\n breach.

\n

At least one step adjustment is required if you are adding a new step scaling policy\n configuration.

" + } + }, + "MinAdjustmentMagnitude": { + "target": "com.amazonaws.applicationautoscaling#MinAdjustmentMagnitude", + "traits": { + "smithy.api#documentation": "

The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity. For example, suppose that you create a step\n scaling policy to scale out an Amazon ECS service by 25 percent and you specify a\n MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling\n policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2\n tasks.

" + } + }, + "Cooldown": { + "target": "com.amazonaws.applicationautoscaling#Cooldown", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scaling activity to take effect. If\n not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.

" + } + }, + "MetricAggregationType": { + "target": "com.amazonaws.applicationautoscaling#MetricAggregationType", + "traits": { + "smithy.api#documentation": "

The aggregation type for the CloudWatch metrics. Valid values are Minimum,\n Maximum, and Average. If the aggregation type is null, the\n value is treated as Average.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a step scaling policy configuration to use with Application Auto Scaling.

\n

For more information, see Step scaling policies in the Application Auto Scaling User Guide.

" + } + }, + "com.amazonaws.applicationautoscaling#SuspendedState": { + "type": "structure", + "members": { + "DynamicScalingInSuspended": { + "target": "com.amazonaws.applicationautoscaling#ScalingSuspended", + "traits": { + "smithy.api#documentation": "

Whether scale in by a target tracking scaling policy or a step scaling policy is\n suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity\n when a scaling policy is triggered. The default is false.

" + } + }, + "DynamicScalingOutSuspended": { + "target": "com.amazonaws.applicationautoscaling#ScalingSuspended", + "traits": { + "smithy.api#documentation": "

Whether scale out by a target tracking scaling policy or a step scaling policy is\n suspended. Set the value to true if you don't want Application Auto Scaling to add capacity\n when a scaling policy is triggered. The default is false.

" + } + }, + "ScheduledScalingSuspended": { + "target": "com.amazonaws.applicationautoscaling#ScalingSuspended", + "traits": { + "smithy.api#documentation": "

Whether scheduled scaling is suspended. Set the value to true if you don't\n want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is\n false.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies whether the scaling activities for a scalable target are in a suspended state.\n

" + } + }, + "com.amazonaws.applicationautoscaling#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.applicationautoscaling#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.applicationautoscaling#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.applicationautoscaling#TagKey" + }, + "value": { + "target": "com.amazonaws.applicationautoscaling#TagValue" + } + }, + "com.amazonaws.applicationautoscaling#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationautoscaling#TooManyTagsException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or edits tags on an Application Auto Scaling scalable target.

\n

Each tag consists of a tag key and a tag value, which are both case-sensitive strings.\n To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag\n key and a new tag value.

\n

You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a\n scaling policy or scheduled action.

\n

You can also add tags to an Application Auto Scaling scalable target while creating it\n (RegisterScalableTarget).

\n

For general information about tags, including the format and syntax, see Tagging your Amazon Web Services\n resources in the Amazon Web Services General Reference.

\n

Use tags to control access to a scalable target. For more information, see Tagging support\n for Application Auto Scaling in the Application Auto Scaling User Guide.

", + "smithy.api#examples": [ + { + "title": "To add a tag to a scalable target", + "documentation": "This example adds a tag with the key name \"environment\" and the value \"production\" to the scalable target specified by its ARN.", + "input": { + "ResourceARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123", + "Tags": { + "environment": "production" + } + }, + "output": {} + } + ] + } + }, + "com.amazonaws.applicationautoscaling#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.applicationautoscaling#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

Identifies the Application Auto Scaling scalable target that you want to apply tags to.

\n

For example:\n arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123\n

\n

To get the ARN for a scalable target, use DescribeScalableTargets.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.applicationautoscaling#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services\n resource.

\n

Each tag consists of a tag key and a tag value.

\n

You cannot have more than one tag on an Application Auto Scaling scalable target with the same tag key.\n If you specify an existing tag key with a different tag value, Application Auto Scaling replaces the\n current tag value with the specified one.

\n

For information about the rules that apply to tag keys and tag values, see User-defined tag\n restrictions in the Amazon Web Services Billing User Guide.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.applicationautoscaling#TargetTrackingMetric": { + "type": "structure", + "members": { + "Dimensions": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimensions", + "traits": { + "smithy.api#documentation": "

The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services\n documentation available from the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

\n

Conditional: If you published your metric with dimensions, you must specify the same\n dimensions in your scaling policy.

" + } + }, + "MetricName": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric.

" + } + }, + "Namespace": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricNamespace", + "traits": { + "smithy.api#documentation": "

The namespace of the metric. For more information, see the table in Amazon Web Services\n services that publish CloudWatch metrics in the Amazon CloudWatch User\n Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a specific metric.

\n

Metric is a property of the TargetTrackingMetricStat object.

" + } + }, + "com.amazonaws.applicationautoscaling#TargetTrackingMetricDataQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricDataQuery" + } + }, + "com.amazonaws.applicationautoscaling#TargetTrackingMetricDataQuery": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.applicationautoscaling#Expression", + "traits": { + "smithy.api#documentation": "

The math expression to perform on the returned data, if this object is performing a math\n expression. This expression can use the Id of the other metrics to refer to\n those metrics, and can also use the Id of other expressions to use the result\n of those expressions.

\n

Conditional: Within each TargetTrackingMetricDataQuery object, you must\n specify either Expression or MetricStat, but not both.

" + } + }, + "Id": { + "target": "com.amazonaws.applicationautoscaling#Id", + "traits": { + "smithy.api#documentation": "

A short name that identifies the object's results in the response. This name must be\n unique among all MetricDataQuery objects specified for a single scaling\n policy. If you are performing math expressions on this set of data, this name represents\n that data and can serve as a variable in the mathematical expression. The valid characters\n are letters, numbers, and underscores. The first character must be a lowercase letter.\n

", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

A human-readable label for this metric or expression. This is especially useful if this\n is a math expression, so that you know what the value represents.

" + } + }, + "MetricStat": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricStat", + "traits": { + "smithy.api#documentation": "

Information about the metric data to return.

\n

Conditional: Within each MetricDataQuery object, you must specify either\n Expression or MetricStat, but not both.

" + } + }, + "ReturnData": { + "target": "com.amazonaws.applicationautoscaling#ReturnData", + "traits": { + "smithy.api#documentation": "

Indicates whether to return the timestamps and raw data values of this metric.

\n

If you use any math expressions, specify true for this value for only the\n final math expression that the metric specification is based on. You must specify\n false for ReturnData for all the other metrics and expressions\n used in the metric specification.

\n

If you are only retrieving metrics and not performing any math expressions, do not\n specify anything for ReturnData. This sets it to its default\n (true).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metric data to return. Also defines whether this call is returning data for one\n metric only, or whether it is performing a math expression on the values of returned metric\n statistics to create a new time series. A time series is a series of data points, each of\n which is associated with a timestamp.

\n

For more information and examples, see Create a target tracking scaling policy for Application Auto Scaling using metric math in the\n Application Auto Scaling User Guide.

" + } + }, + "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimension": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimensionName", + "traits": { + "smithy.api#documentation": "

The name of the dimension.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimensionValue", + "traits": { + "smithy.api#documentation": "

The value of the dimension.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the dimension of a metric.

" + } + }, + "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimensionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimensionValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimensions": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricDimension" + } + }, + "com.amazonaws.applicationautoscaling#TargetTrackingMetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#TargetTrackingMetricNamespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#TargetTrackingMetricStat": { + "type": "structure", + "members": { + "Metric": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetric", + "traits": { + "smithy.api#documentation": "

The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get\n the exact metric name, namespace, and dimensions, inspect the Metric object that is\n returned by a call to ListMetrics.

", + "smithy.api#required": {} + } + }, + "Stat": { + "target": "com.amazonaws.applicationautoscaling#XmlString", + "traits": { + "smithy.api#documentation": "

The statistic to return. It can include any CloudWatch statistic or extended statistic. For a\n list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

\n

The most commonly used metric for scaling is Average.

", + "smithy.api#required": {} + } + }, + "Unit": { + "target": "com.amazonaws.applicationautoscaling#TargetTrackingMetricUnit", + "traits": { + "smithy.api#documentation": "

The unit to use for the returned data points. For a complete list of the units that CloudWatch\n supports, see the MetricDatum data\n type in the Amazon CloudWatch API Reference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This structure defines the CloudWatch metric to return, along with the statistic and\n unit.

\n

For more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.

" + } + }, + "com.amazonaws.applicationautoscaling#TargetTrackingMetricUnit": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1023 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } + }, + "com.amazonaws.applicationautoscaling#TargetTrackingScalingPolicyConfiguration": { + "type": "structure", + "members": { + "TargetValue": { + "target": "com.amazonaws.applicationautoscaling#MetricScale", + "traits": { + "smithy.api#documentation": "

The target value for the metric. Although this property accepts numbers of type Double,\n it won't accept values that are either too small or too large. Values must be in the range\n of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For\n example, if the metric is CPU utilization, then the target value is a percent value that\n represents how much of the CPU can be used before scaling out.

\n \n

If the scaling policy specifies the ALBRequestCountPerTarget predefined\n metric, specify the target utilization as the optimal average request count per target\n during any one-minute interval.

\n ", + "smithy.api#required": {} + } + }, + "PredefinedMetricSpecification": { + "target": "com.amazonaws.applicationautoscaling#PredefinedMetricSpecification", + "traits": { + "smithy.api#documentation": "

A predefined metric. You can specify either a predefined metric or a customized\n metric.

" + } + }, + "CustomizedMetricSpecification": { + "target": "com.amazonaws.applicationautoscaling#CustomizedMetricSpecification", + "traits": { + "smithy.api#documentation": "

A customized metric. You can specify either a predefined metric or a customized\n metric.

" + } + }, + "ScaleOutCooldown": { + "target": "com.amazonaws.applicationautoscaling#Cooldown", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scale-out activity to take effect.\n For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

" + } + }, + "ScaleInCooldown": { + "target": "com.amazonaws.applicationautoscaling#Cooldown", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, after a scale-in activity completes before another\n scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

" + } + }, + "DisableScaleIn": { + "target": "com.amazonaws.applicationautoscaling#DisableScaleIn", + "traits": { + "smithy.api#documentation": "

Indicates whether scale in by the target tracking scaling policy is disabled. If the\n value is true, scale in is disabled and the target tracking scaling policy\n won't remove capacity from the scalable target. Otherwise, scale in is enabled and the\n target tracking scaling policy can remove capacity from the scalable target. The default\n value is false.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a target tracking scaling policy configuration to use with Application Auto Scaling.

\n

For more information, see Target tracking scaling policies in the\n Application Auto Scaling User Guide.

" + } + }, + "com.amazonaws.applicationautoscaling#TimestampType": { + "type": "timestamp" + }, + "com.amazonaws.applicationautoscaling#TooManyTagsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.applicationautoscaling#ExceptionMessage" + }, + "ResourceName": { + "target": "com.amazonaws.applicationautoscaling#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The name of the Application Auto Scaling resource. This value is an Amazon Resource Name (ARN).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The request contains too many tags. Try the request again with fewer tags.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.applicationautoscaling#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.applicationautoscaling#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.applicationautoscaling#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.applicationautoscaling#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.applicationautoscaling#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and\n the Application Auto Scaling scalable target.

", + "smithy.api#examples": [ + { + "title": "To remove a tag from a scalable target", + "documentation": "This example removes the tag pair with the key name \"environment\" from the scalable target specified by its ARN.", + "input": { + "ResourceARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123", + "TagKeys": ["environment"] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.applicationautoscaling#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.applicationautoscaling#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

Identifies the Application Auto Scaling scalable target from which to remove tags.

\n

For example:\n arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123\n

\n

To get the ARN for a scalable target, use DescribeScalableTargets.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.applicationautoscaling#TagKeyList", + "traits": { + "smithy.api#documentation": "

One or more tag keys. Specify only the tag keys, not the tag values.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.applicationautoscaling#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.applicationautoscaling#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.applicationautoscaling#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ValidationException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

An exception was thrown for a validation issue. Review the available parameters for the\n API request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.applicationautoscaling#XmlString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" + } } + } } From 9128be8e9151dd7c6392c522cb056cb351462bfe Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 21 May 2025 18:10:37 +0000 Subject: [PATCH 6/8] feat(client-bedrock-agent-runtime): Amazon Bedrock introduces asynchronous flows (in preview), which let you run flows for longer durations and yield control so that your application can perform other tasks and you don't have to actively monitor the flow's progress. --- .../client-bedrock-agent-runtime/README.md | 48 + .../src/BedrockAgentRuntime.ts | 138 + .../src/BedrockAgentRuntimeClient.ts | 24 + .../src/commands/CreateInvocationCommand.ts | 2 +- .../src/commands/CreateSessionCommand.ts | 2 +- .../src/commands/DeleteSessionCommand.ts | 2 +- .../src/commands/EndSessionCommand.ts | 2 +- .../GetExecutionFlowSnapshotCommand.ts | 119 + .../src/commands/GetFlowExecutionCommand.ts | 127 + .../src/commands/GetInvocationStepCommand.ts | 2 +- .../src/commands/GetSessionCommand.ts | 2 +- .../ListFlowExecutionEventsCommand.ts | 193 + .../src/commands/ListFlowExecutionsCommand.ts | 126 + .../commands/ListInvocationStepsCommand.ts | 2 +- .../src/commands/ListInvocationsCommand.ts | 2 +- .../src/commands/ListSessionsCommand.ts | 3 +- .../src/commands/PutInvocationStepCommand.ts | 2 +- .../RetrieveAndGenerateStreamCommand.ts | 6 +- .../src/commands/RetrieveCommand.ts | 8 +- .../src/commands/StartFlowExecutionCommand.ts | 145 + .../src/commands/StopFlowExecutionCommand.ts | 124 + .../src/commands/index.ts | 6 + .../src/models/models_0.ts | 8728 ++++++++--------- .../src/models/models_1.ts | 1202 ++- .../ListFlowExecutionEventsPaginator.ts | 24 + .../pagination/ListFlowExecutionsPaginator.ts | 24 + .../src/pagination/index.ts | 2 + .../src/protocols/Aws_restJson1.ts | 595 +- .../aws-models/bedrock-agent-runtime.json | 1868 +++- 29 files changed, 8871 insertions(+), 4657 deletions(-) create mode 100644 clients/client-bedrock-agent-runtime/src/commands/GetExecutionFlowSnapshotCommand.ts create mode 100644 clients/client-bedrock-agent-runtime/src/commands/GetFlowExecutionCommand.ts create mode 100644 clients/client-bedrock-agent-runtime/src/commands/ListFlowExecutionEventsCommand.ts create mode 100644 clients/client-bedrock-agent-runtime/src/commands/ListFlowExecutionsCommand.ts create mode 100644 clients/client-bedrock-agent-runtime/src/commands/StartFlowExecutionCommand.ts create mode 100644 clients/client-bedrock-agent-runtime/src/commands/StopFlowExecutionCommand.ts create mode 100644 clients/client-bedrock-agent-runtime/src/pagination/ListFlowExecutionEventsPaginator.ts create mode 100644 clients/client-bedrock-agent-runtime/src/pagination/ListFlowExecutionsPaginator.ts diff --git a/clients/client-bedrock-agent-runtime/README.md b/clients/client-bedrock-agent-runtime/README.md index 753a1a54ca72a..c9b58803a4a3e 100644 --- a/clients/client-bedrock-agent-runtime/README.md +++ b/clients/client-bedrock-agent-runtime/README.md @@ -258,6 +258,22 @@ GetAgentMemory [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/GetAgentMemoryCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/GetAgentMemoryCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/GetAgentMemoryCommandOutput/) +
+
+ +GetExecutionFlowSnapshot + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/GetExecutionFlowSnapshotCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/GetExecutionFlowSnapshotCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/GetExecutionFlowSnapshotCommandOutput/) + +
+
+ +GetFlowExecution + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/GetFlowExecutionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/GetFlowExecutionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/GetFlowExecutionCommandOutput/) +
@@ -298,6 +314,22 @@ InvokeInlineAgent [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/InvokeInlineAgentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/InvokeInlineAgentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/InvokeInlineAgentCommandOutput/) +
+
+ +ListFlowExecutionEvents + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/ListFlowExecutionEventsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/ListFlowExecutionEventsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/ListFlowExecutionEventsCommandOutput/) + +
+
+ +ListFlowExecutions + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/ListFlowExecutionsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/ListFlowExecutionsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/ListFlowExecutionsCommandOutput/) +
@@ -378,6 +410,22 @@ RetrieveAndGenerateStream [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/RetrieveAndGenerateStreamCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/RetrieveAndGenerateStreamCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/RetrieveAndGenerateStreamCommandOutput/) +
+
+ +StartFlowExecution + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/StartFlowExecutionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/StartFlowExecutionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/StartFlowExecutionCommandOutput/) + +
+
+ +StopFlowExecution + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/command/StopFlowExecutionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/StopFlowExecutionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent-runtime/Interface/StopFlowExecutionCommandOutput/) +
diff --git a/clients/client-bedrock-agent-runtime/src/BedrockAgentRuntime.ts b/clients/client-bedrock-agent-runtime/src/BedrockAgentRuntime.ts index 08acf0d74ea24..af76e59859e9f 100644 --- a/clients/client-bedrock-agent-runtime/src/BedrockAgentRuntime.ts +++ b/clients/client-bedrock-agent-runtime/src/BedrockAgentRuntime.ts @@ -34,6 +34,16 @@ import { GetAgentMemoryCommandInput, GetAgentMemoryCommandOutput, } from "./commands/GetAgentMemoryCommand"; +import { + GetExecutionFlowSnapshotCommand, + GetExecutionFlowSnapshotCommandInput, + GetExecutionFlowSnapshotCommandOutput, +} from "./commands/GetExecutionFlowSnapshotCommand"; +import { + GetFlowExecutionCommand, + GetFlowExecutionCommandInput, + GetFlowExecutionCommandOutput, +} from "./commands/GetFlowExecutionCommand"; import { GetInvocationStepCommand, GetInvocationStepCommandInput, @@ -47,6 +57,16 @@ import { InvokeInlineAgentCommandInput, InvokeInlineAgentCommandOutput, } from "./commands/InvokeInlineAgentCommand"; +import { + ListFlowExecutionEventsCommand, + ListFlowExecutionEventsCommandInput, + ListFlowExecutionEventsCommandOutput, +} from "./commands/ListFlowExecutionEventsCommand"; +import { + ListFlowExecutionsCommand, + ListFlowExecutionsCommandInput, + ListFlowExecutionsCommandOutput, +} from "./commands/ListFlowExecutionsCommand"; import { ListInvocationsCommand, ListInvocationsCommandInput, @@ -89,6 +109,16 @@ import { RetrieveAndGenerateStreamCommandOutput, } from "./commands/RetrieveAndGenerateStreamCommand"; import { RetrieveCommand, RetrieveCommandInput, RetrieveCommandOutput } from "./commands/RetrieveCommand"; +import { + StartFlowExecutionCommand, + StartFlowExecutionCommandInput, + StartFlowExecutionCommandOutput, +} from "./commands/StartFlowExecutionCommand"; +import { + StopFlowExecutionCommand, + StopFlowExecutionCommandInput, + StopFlowExecutionCommandOutput, +} from "./commands/StopFlowExecutionCommand"; import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; import { UntagResourceCommand, @@ -109,11 +139,15 @@ const commands = { EndSessionCommand, GenerateQueryCommand, GetAgentMemoryCommand, + GetExecutionFlowSnapshotCommand, + GetFlowExecutionCommand, GetInvocationStepCommand, GetSessionCommand, InvokeAgentCommand, InvokeFlowCommand, InvokeInlineAgentCommand, + ListFlowExecutionEventsCommand, + ListFlowExecutionsCommand, ListInvocationsCommand, ListInvocationStepsCommand, ListSessionsCommand, @@ -124,6 +158,8 @@ const commands = { RetrieveCommand, RetrieveAndGenerateCommand, RetrieveAndGenerateStreamCommand, + StartFlowExecutionCommand, + StopFlowExecutionCommand, TagResourceCommand, UntagResourceCommand, UpdateSessionCommand, @@ -223,6 +259,40 @@ export interface BedrockAgentRuntime { cb: (err: any, data?: GetAgentMemoryCommandOutput) => void ): void; + /** + * @see {@link GetExecutionFlowSnapshotCommand} + */ + getExecutionFlowSnapshot( + args: GetExecutionFlowSnapshotCommandInput, + options?: __HttpHandlerOptions + ): Promise; + getExecutionFlowSnapshot( + args: GetExecutionFlowSnapshotCommandInput, + cb: (err: any, data?: GetExecutionFlowSnapshotCommandOutput) => void + ): void; + getExecutionFlowSnapshot( + args: GetExecutionFlowSnapshotCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetExecutionFlowSnapshotCommandOutput) => void + ): void; + + /** + * @see {@link GetFlowExecutionCommand} + */ + getFlowExecution( + args: GetFlowExecutionCommandInput, + options?: __HttpHandlerOptions + ): Promise; + getFlowExecution( + args: GetFlowExecutionCommandInput, + cb: (err: any, data?: GetFlowExecutionCommandOutput) => void + ): void; + getFlowExecution( + args: GetFlowExecutionCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetFlowExecutionCommandOutput) => void + ): void; + /** * @see {@link GetInvocationStepCommand} */ @@ -290,6 +360,40 @@ export interface BedrockAgentRuntime { cb: (err: any, data?: InvokeInlineAgentCommandOutput) => void ): void; + /** + * @see {@link ListFlowExecutionEventsCommand} + */ + listFlowExecutionEvents( + args: ListFlowExecutionEventsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + listFlowExecutionEvents( + args: ListFlowExecutionEventsCommandInput, + cb: (err: any, data?: ListFlowExecutionEventsCommandOutput) => void + ): void; + listFlowExecutionEvents( + args: ListFlowExecutionEventsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListFlowExecutionEventsCommandOutput) => void + ): void; + + /** + * @see {@link ListFlowExecutionsCommand} + */ + listFlowExecutions( + args: ListFlowExecutionsCommandInput, + options?: __HttpHandlerOptions + ): Promise; + listFlowExecutions( + args: ListFlowExecutionsCommandInput, + cb: (err: any, data?: ListFlowExecutionsCommandOutput) => void + ): void; + listFlowExecutions( + args: ListFlowExecutionsCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListFlowExecutionsCommandOutput) => void + ): void; + /** * @see {@link ListInvocationsCommand} */ @@ -437,6 +541,40 @@ export interface BedrockAgentRuntime { cb: (err: any, data?: RetrieveAndGenerateStreamCommandOutput) => void ): void; + /** + * @see {@link StartFlowExecutionCommand} + */ + startFlowExecution( + args: StartFlowExecutionCommandInput, + options?: __HttpHandlerOptions + ): Promise; + startFlowExecution( + args: StartFlowExecutionCommandInput, + cb: (err: any, data?: StartFlowExecutionCommandOutput) => void + ): void; + startFlowExecution( + args: StartFlowExecutionCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: StartFlowExecutionCommandOutput) => void + ): void; + + /** + * @see {@link StopFlowExecutionCommand} + */ + stopFlowExecution( + args: StopFlowExecutionCommandInput, + options?: __HttpHandlerOptions + ): Promise; + stopFlowExecution( + args: StopFlowExecutionCommandInput, + cb: (err: any, data?: StopFlowExecutionCommandOutput) => void + ): void; + stopFlowExecution( + args: StopFlowExecutionCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: StopFlowExecutionCommandOutput) => void + ): void; + /** * @see {@link TagResourceCommand} */ diff --git a/clients/client-bedrock-agent-runtime/src/BedrockAgentRuntimeClient.ts b/clients/client-bedrock-agent-runtime/src/BedrockAgentRuntimeClient.ts index cf987bfcbcebb..2a5c5fe19b029 100644 --- a/clients/client-bedrock-agent-runtime/src/BedrockAgentRuntimeClient.ts +++ b/clients/client-bedrock-agent-runtime/src/BedrockAgentRuntimeClient.ts @@ -66,11 +66,21 @@ import { DeleteSessionCommandInput, DeleteSessionCommandOutput } from "./command import { EndSessionCommandInput, EndSessionCommandOutput } from "./commands/EndSessionCommand"; import { GenerateQueryCommandInput, GenerateQueryCommandOutput } from "./commands/GenerateQueryCommand"; import { GetAgentMemoryCommandInput, GetAgentMemoryCommandOutput } from "./commands/GetAgentMemoryCommand"; +import { + GetExecutionFlowSnapshotCommandInput, + GetExecutionFlowSnapshotCommandOutput, +} from "./commands/GetExecutionFlowSnapshotCommand"; +import { GetFlowExecutionCommandInput, GetFlowExecutionCommandOutput } from "./commands/GetFlowExecutionCommand"; import { GetInvocationStepCommandInput, GetInvocationStepCommandOutput } from "./commands/GetInvocationStepCommand"; import { GetSessionCommandInput, GetSessionCommandOutput } from "./commands/GetSessionCommand"; import { InvokeAgentCommandInput, InvokeAgentCommandOutput } from "./commands/InvokeAgentCommand"; import { InvokeFlowCommandInput, InvokeFlowCommandOutput } from "./commands/InvokeFlowCommand"; import { InvokeInlineAgentCommandInput, InvokeInlineAgentCommandOutput } from "./commands/InvokeInlineAgentCommand"; +import { + ListFlowExecutionEventsCommandInput, + ListFlowExecutionEventsCommandOutput, +} from "./commands/ListFlowExecutionEventsCommand"; +import { ListFlowExecutionsCommandInput, ListFlowExecutionsCommandOutput } from "./commands/ListFlowExecutionsCommand"; import { ListInvocationsCommandInput, ListInvocationsCommandOutput } from "./commands/ListInvocationsCommand"; import { ListInvocationStepsCommandInput, @@ -93,6 +103,8 @@ import { RetrieveAndGenerateStreamCommandOutput, } from "./commands/RetrieveAndGenerateStreamCommand"; import { RetrieveCommandInput, RetrieveCommandOutput } from "./commands/RetrieveCommand"; +import { StartFlowExecutionCommandInput, StartFlowExecutionCommandOutput } from "./commands/StartFlowExecutionCommand"; +import { StopFlowExecutionCommandInput, StopFlowExecutionCommandOutput } from "./commands/StopFlowExecutionCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; import { UpdateSessionCommandInput, UpdateSessionCommandOutput } from "./commands/UpdateSessionCommand"; @@ -118,11 +130,15 @@ export type ServiceInputTypes = | EndSessionCommandInput | GenerateQueryCommandInput | GetAgentMemoryCommandInput + | GetExecutionFlowSnapshotCommandInput + | GetFlowExecutionCommandInput | GetInvocationStepCommandInput | GetSessionCommandInput | InvokeAgentCommandInput | InvokeFlowCommandInput | InvokeInlineAgentCommandInput + | ListFlowExecutionEventsCommandInput + | ListFlowExecutionsCommandInput | ListInvocationStepsCommandInput | ListInvocationsCommandInput | ListSessionsCommandInput @@ -133,6 +149,8 @@ export type ServiceInputTypes = | RetrieveAndGenerateCommandInput | RetrieveAndGenerateStreamCommandInput | RetrieveCommandInput + | StartFlowExecutionCommandInput + | StopFlowExecutionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateSessionCommandInput; @@ -148,11 +166,15 @@ export type ServiceOutputTypes = | EndSessionCommandOutput | GenerateQueryCommandOutput | GetAgentMemoryCommandOutput + | GetExecutionFlowSnapshotCommandOutput + | GetFlowExecutionCommandOutput | GetInvocationStepCommandOutput | GetSessionCommandOutput | InvokeAgentCommandOutput | InvokeFlowCommandOutput | InvokeInlineAgentCommandOutput + | ListFlowExecutionEventsCommandOutput + | ListFlowExecutionsCommandOutput | ListInvocationStepsCommandOutput | ListInvocationsCommandOutput | ListSessionsCommandOutput @@ -163,6 +185,8 @@ export type ServiceOutputTypes = | RetrieveAndGenerateCommandOutput | RetrieveAndGenerateStreamCommandOutput | RetrieveCommandOutput + | StartFlowExecutionCommandOutput + | StopFlowExecutionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateSessionCommandOutput; diff --git a/clients/client-bedrock-agent-runtime/src/commands/CreateInvocationCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/CreateInvocationCommand.ts index 4604fec18161f..8dc7e3b76ab39 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/CreateInvocationCommand.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/CreateInvocationCommand.ts @@ -10,7 +10,7 @@ import { ServiceOutputTypes, } from "../BedrockAgentRuntimeClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { CreateInvocationRequest, CreateInvocationResponse } from "../models/models_0"; +import { CreateInvocationRequest, CreateInvocationResponse } from "../models/models_1"; import { de_CreateInvocationCommand, se_CreateInvocationCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-bedrock-agent-runtime/src/commands/CreateSessionCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/CreateSessionCommand.ts index 8f4bd6d90f2c1..2e6f5f5baee15 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/CreateSessionCommand.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/CreateSessionCommand.ts @@ -10,7 +10,7 @@ import { ServiceOutputTypes, } from "../BedrockAgentRuntimeClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { CreateSessionRequest, CreateSessionResponse } from "../models/models_0"; +import { CreateSessionRequest, CreateSessionResponse } from "../models/models_1"; import { de_CreateSessionCommand, se_CreateSessionCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-bedrock-agent-runtime/src/commands/DeleteSessionCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/DeleteSessionCommand.ts index 05effed8acaeb..571998773e0b3 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/DeleteSessionCommand.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/DeleteSessionCommand.ts @@ -10,7 +10,7 @@ import { ServiceOutputTypes, } from "../BedrockAgentRuntimeClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DeleteSessionRequest, DeleteSessionResponse } from "../models/models_0"; +import { DeleteSessionRequest, DeleteSessionResponse } from "../models/models_1"; import { de_DeleteSessionCommand, se_DeleteSessionCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-bedrock-agent-runtime/src/commands/EndSessionCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/EndSessionCommand.ts index 91b3903bbcbf7..edeb78a0501a3 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/EndSessionCommand.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/EndSessionCommand.ts @@ -10,7 +10,7 @@ import { ServiceOutputTypes, } from "../BedrockAgentRuntimeClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { EndSessionRequest, EndSessionResponse } from "../models/models_0"; +import { EndSessionRequest, EndSessionResponse } from "../models/models_1"; import { de_EndSessionCommand, se_EndSessionCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-bedrock-agent-runtime/src/commands/GetExecutionFlowSnapshotCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/GetExecutionFlowSnapshotCommand.ts new file mode 100644 index 0000000000000..3e2f6ace49cf4 --- /dev/null +++ b/clients/client-bedrock-agent-runtime/src/commands/GetExecutionFlowSnapshotCommand.ts @@ -0,0 +1,119 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + BedrockAgentRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../BedrockAgentRuntimeClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetExecutionFlowSnapshotRequest, GetExecutionFlowSnapshotResponse } from "../models/models_0"; +import { de_GetExecutionFlowSnapshotCommand, se_GetExecutionFlowSnapshotCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetExecutionFlowSnapshotCommand}. + */ +export interface GetExecutionFlowSnapshotCommandInput extends GetExecutionFlowSnapshotRequest {} +/** + * @public + * + * The output of {@link GetExecutionFlowSnapshotCommand}. + */ +export interface GetExecutionFlowSnapshotCommandOutput extends GetExecutionFlowSnapshotResponse, __MetadataBearer {} + +/** + *

Retrieves the flow definition snapshot used for an asynchronous execution. The snapshot represents the flow metadata and definition as it existed at the time the asynchronous execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 + * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BedrockAgentRuntimeClient, GetExecutionFlowSnapshotCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import + * // const { BedrockAgentRuntimeClient, GetExecutionFlowSnapshotCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import + * const client = new BedrockAgentRuntimeClient(config); + * const input = { // GetExecutionFlowSnapshotRequest + * flowIdentifier: "STRING_VALUE", // required + * flowAliasIdentifier: "STRING_VALUE", // required + * executionIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetExecutionFlowSnapshotCommand(input); + * const response = await client.send(command); + * // { // GetExecutionFlowSnapshotResponse + * // flowIdentifier: "STRING_VALUE", // required + * // flowAliasIdentifier: "STRING_VALUE", // required + * // flowVersion: "STRING_VALUE", // required + * // executionRoleArn: "STRING_VALUE", // required + * // definition: "STRING_VALUE", // required + * // customerEncryptionKeyArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param GetExecutionFlowSnapshotCommandInput - {@link GetExecutionFlowSnapshotCommandInput} + * @returns {@link GetExecutionFlowSnapshotCommandOutput} + * @see {@link GetExecutionFlowSnapshotCommandInput} for command's `input` shape. + * @see {@link GetExecutionFlowSnapshotCommandOutput} for command's `response` shape. + * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

The request is denied because of missing access permissions. Check your permissions and retry your request.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal server error occurred. Retry your request.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

+ * + * @throws {@link ThrottlingException} (client fault) + *

The number of requests exceeds the limit. Resubmit your request later.

+ * + * @throws {@link ValidationException} (client fault) + *

Input validation failed. Check your request parameters and retry the request.

+ * + * @throws {@link BedrockAgentRuntimeServiceException} + *

Base exception class for all service exceptions from BedrockAgentRuntime service.

+ * + * + * @public + */ +export class GetExecutionFlowSnapshotCommand extends $Command + .classBuilder< + GetExecutionFlowSnapshotCommandInput, + GetExecutionFlowSnapshotCommandOutput, + BedrockAgentRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BedrockAgentRuntimeClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonBedrockAgentRunTimeService", "GetExecutionFlowSnapshot", {}) + .n("BedrockAgentRuntimeClient", "GetExecutionFlowSnapshotCommand") + .f(void 0, void 0) + .ser(se_GetExecutionFlowSnapshotCommand) + .de(de_GetExecutionFlowSnapshotCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetExecutionFlowSnapshotRequest; + output: GetExecutionFlowSnapshotResponse; + }; + sdk: { + input: GetExecutionFlowSnapshotCommandInput; + output: GetExecutionFlowSnapshotCommandOutput; + }; + }; +} diff --git a/clients/client-bedrock-agent-runtime/src/commands/GetFlowExecutionCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/GetFlowExecutionCommand.ts new file mode 100644 index 0000000000000..3e96a94383a96 --- /dev/null +++ b/clients/client-bedrock-agent-runtime/src/commands/GetFlowExecutionCommand.ts @@ -0,0 +1,127 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + BedrockAgentRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../BedrockAgentRuntimeClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetFlowExecutionRequest, GetFlowExecutionResponse } from "../models/models_0"; +import { de_GetFlowExecutionCommand, se_GetFlowExecutionCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetFlowExecutionCommand}. + */ +export interface GetFlowExecutionCommandInput extends GetFlowExecutionRequest {} +/** + * @public + * + * The output of {@link GetFlowExecutionCommand}. + */ +export interface GetFlowExecutionCommandOutput extends GetFlowExecutionResponse, __MetadataBearer {} + +/** + *

Retrieves details about a specific asynchronous execution of a flow, including its status, start and end times, and any errors that occurred during execution.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BedrockAgentRuntimeClient, GetFlowExecutionCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import + * // const { BedrockAgentRuntimeClient, GetFlowExecutionCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import + * const client = new BedrockAgentRuntimeClient(config); + * const input = { // GetFlowExecutionRequest + * flowIdentifier: "STRING_VALUE", // required + * flowAliasIdentifier: "STRING_VALUE", // required + * executionIdentifier: "STRING_VALUE", // required + * }; + * const command = new GetFlowExecutionCommand(input); + * const response = await client.send(command); + * // { // GetFlowExecutionResponse + * // executionArn: "STRING_VALUE", // required + * // status: "Running" || "Succeeded" || "Failed" || "TimedOut" || "Aborted", // required + * // startedAt: new Date("TIMESTAMP"), // required + * // endedAt: new Date("TIMESTAMP"), + * // errors: [ // FlowExecutionErrors + * // { // FlowExecutionError + * // nodeName: "STRING_VALUE", + * // error: "ExecutionTimedOut", + * // message: "STRING_VALUE", + * // }, + * // ], + * // flowAliasIdentifier: "STRING_VALUE", // required + * // flowIdentifier: "STRING_VALUE", // required + * // flowVersion: "STRING_VALUE", // required + * // }; + * + * ``` + * + * @param GetFlowExecutionCommandInput - {@link GetFlowExecutionCommandInput} + * @returns {@link GetFlowExecutionCommandOutput} + * @see {@link GetFlowExecutionCommandInput} for command's `input` shape. + * @see {@link GetFlowExecutionCommandOutput} for command's `response` shape. + * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

The request is denied because of missing access permissions. Check your permissions and retry your request.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal server error occurred. Retry your request.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

+ * + * @throws {@link ThrottlingException} (client fault) + *

The number of requests exceeds the limit. Resubmit your request later.

+ * + * @throws {@link ValidationException} (client fault) + *

Input validation failed. Check your request parameters and retry the request.

+ * + * @throws {@link BedrockAgentRuntimeServiceException} + *

Base exception class for all service exceptions from BedrockAgentRuntime service.

+ * + * + * @public + */ +export class GetFlowExecutionCommand extends $Command + .classBuilder< + GetFlowExecutionCommandInput, + GetFlowExecutionCommandOutput, + BedrockAgentRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BedrockAgentRuntimeClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonBedrockAgentRunTimeService", "GetFlowExecution", {}) + .n("BedrockAgentRuntimeClient", "GetFlowExecutionCommand") + .f(void 0, void 0) + .ser(se_GetFlowExecutionCommand) + .de(de_GetFlowExecutionCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetFlowExecutionRequest; + output: GetFlowExecutionResponse; + }; + sdk: { + input: GetFlowExecutionCommandInput; + output: GetFlowExecutionCommandOutput; + }; + }; +} diff --git a/clients/client-bedrock-agent-runtime/src/commands/GetInvocationStepCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/GetInvocationStepCommand.ts index d878ec7ce5743..b0d9a0ea9ad66 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/GetInvocationStepCommand.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/GetInvocationStepCommand.ts @@ -14,7 +14,7 @@ import { GetInvocationStepRequest, GetInvocationStepResponse, GetInvocationStepResponseFilterSensitiveLog, -} from "../models/models_0"; +} from "../models/models_1"; import { de_GetInvocationStepCommand, se_GetInvocationStepCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-bedrock-agent-runtime/src/commands/GetSessionCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/GetSessionCommand.ts index 5f2af1b411548..0507752e82e24 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/GetSessionCommand.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/GetSessionCommand.ts @@ -10,7 +10,7 @@ import { ServiceOutputTypes, } from "../BedrockAgentRuntimeClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetSessionRequest, GetSessionResponse } from "../models/models_0"; +import { GetSessionRequest, GetSessionResponse } from "../models/models_1"; import { de_GetSessionCommand, se_GetSessionCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-bedrock-agent-runtime/src/commands/ListFlowExecutionEventsCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/ListFlowExecutionEventsCommand.ts new file mode 100644 index 0000000000000..82bb661206906 --- /dev/null +++ b/clients/client-bedrock-agent-runtime/src/commands/ListFlowExecutionEventsCommand.ts @@ -0,0 +1,193 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + BedrockAgentRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../BedrockAgentRuntimeClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + ListFlowExecutionEventsRequest, + ListFlowExecutionEventsResponse, + ListFlowExecutionEventsResponseFilterSensitiveLog, +} from "../models/models_0"; +import { de_ListFlowExecutionEventsCommand, se_ListFlowExecutionEventsCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListFlowExecutionEventsCommand}. + */ +export interface ListFlowExecutionEventsCommandInput extends ListFlowExecutionEventsRequest {} +/** + * @public + * + * The output of {@link ListFlowExecutionEventsCommand}. + */ +export interface ListFlowExecutionEventsCommandOutput extends ListFlowExecutionEventsResponse, __MetadataBearer {} + +/** + *

Lists events that occurred during an asynchronous execution of a flow. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 + * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BedrockAgentRuntimeClient, ListFlowExecutionEventsCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import + * // const { BedrockAgentRuntimeClient, ListFlowExecutionEventsCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import + * const client = new BedrockAgentRuntimeClient(config); + * const input = { // ListFlowExecutionEventsRequest + * flowIdentifier: "STRING_VALUE", // required + * flowAliasIdentifier: "STRING_VALUE", // required + * executionIdentifier: "STRING_VALUE", // required + * maxResults: Number("int"), + * nextToken: "STRING_VALUE", + * eventType: "Node" || "Flow", // required + * }; + * const command = new ListFlowExecutionEventsCommand(input); + * const response = await client.send(command); + * // { // ListFlowExecutionEventsResponse + * // flowExecutionEvents: [ // FlowExecutionEvents // required + * // { // FlowExecutionEvent Union: only one key present + * // flowInputEvent: { // FlowExecutionInputEvent + * // nodeName: "STRING_VALUE", // required + * // timestamp: new Date("TIMESTAMP"), // required + * // fields: [ // FlowInputFields // required + * // { // FlowInputField + * // name: "STRING_VALUE", // required + * // content: { // FlowExecutionContent Union: only one key present + * // document: "DOCUMENT_VALUE", + * // }, + * // }, + * // ], + * // }, + * // flowOutputEvent: { // FlowExecutionOutputEvent + * // nodeName: "STRING_VALUE", // required + * // timestamp: new Date("TIMESTAMP"), // required + * // fields: [ // FlowOutputFields // required + * // { // FlowOutputField + * // name: "STRING_VALUE", // required + * // content: {// Union: only one key present + * // document: "DOCUMENT_VALUE", + * // }, + * // }, + * // ], + * // }, + * // nodeInputEvent: { // NodeInputEvent + * // nodeName: "STRING_VALUE", // required + * // timestamp: new Date("TIMESTAMP"), // required + * // fields: [ // NodeInputFields // required + * // { // NodeInputField + * // name: "STRING_VALUE", // required + * // content: { // NodeExecutionContent Union: only one key present + * // document: "DOCUMENT_VALUE", + * // }, + * // }, + * // ], + * // }, + * // nodeOutputEvent: { // NodeOutputEvent + * // nodeName: "STRING_VALUE", // required + * // timestamp: new Date("TIMESTAMP"), // required + * // fields: [ // NodeOutputFields // required + * // { // NodeOutputField + * // name: "STRING_VALUE", // required + * // content: {// Union: only one key present + * // document: "DOCUMENT_VALUE", + * // }, + * // }, + * // ], + * // }, + * // conditionResultEvent: { // ConditionResultEvent + * // nodeName: "STRING_VALUE", // required + * // timestamp: new Date("TIMESTAMP"), // required + * // satisfiedConditions: [ // SatisfiedConditions // required + * // { // SatisfiedCondition + * // conditionName: "STRING_VALUE", // required + * // }, + * // ], + * // }, + * // nodeFailureEvent: { // NodeFailureEvent + * // nodeName: "STRING_VALUE", // required + * // timestamp: new Date("TIMESTAMP"), // required + * // errorCode: "VALIDATION" || "DEPENDENCY_FAILED" || "BAD_GATEWAY" || "INTERNAL_SERVER", // required + * // errorMessage: "STRING_VALUE", // required + * // }, + * // flowFailureEvent: { // FlowFailureEvent + * // timestamp: new Date("TIMESTAMP"), // required + * // errorCode: "VALIDATION" || "INTERNAL_SERVER" || "NODE_EXECUTION_FAILED", // required + * // errorMessage: "STRING_VALUE", // required + * // }, + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListFlowExecutionEventsCommandInput - {@link ListFlowExecutionEventsCommandInput} + * @returns {@link ListFlowExecutionEventsCommandOutput} + * @see {@link ListFlowExecutionEventsCommandInput} for command's `input` shape. + * @see {@link ListFlowExecutionEventsCommandOutput} for command's `response` shape. + * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

The request is denied because of missing access permissions. Check your permissions and retry your request.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal server error occurred. Retry your request.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

+ * + * @throws {@link ThrottlingException} (client fault) + *

The number of requests exceeds the limit. Resubmit your request later.

+ * + * @throws {@link ValidationException} (client fault) + *

Input validation failed. Check your request parameters and retry the request.

+ * + * @throws {@link BedrockAgentRuntimeServiceException} + *

Base exception class for all service exceptions from BedrockAgentRuntime service.

+ * + * + * @public + */ +export class ListFlowExecutionEventsCommand extends $Command + .classBuilder< + ListFlowExecutionEventsCommandInput, + ListFlowExecutionEventsCommandOutput, + BedrockAgentRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BedrockAgentRuntimeClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonBedrockAgentRunTimeService", "ListFlowExecutionEvents", {}) + .n("BedrockAgentRuntimeClient", "ListFlowExecutionEventsCommand") + .f(void 0, ListFlowExecutionEventsResponseFilterSensitiveLog) + .ser(se_ListFlowExecutionEventsCommand) + .de(de_ListFlowExecutionEventsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListFlowExecutionEventsRequest; + output: ListFlowExecutionEventsResponse; + }; + sdk: { + input: ListFlowExecutionEventsCommandInput; + output: ListFlowExecutionEventsCommandOutput; + }; + }; +} diff --git a/clients/client-bedrock-agent-runtime/src/commands/ListFlowExecutionsCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/ListFlowExecutionsCommand.ts new file mode 100644 index 0000000000000..f3194375262c0 --- /dev/null +++ b/clients/client-bedrock-agent-runtime/src/commands/ListFlowExecutionsCommand.ts @@ -0,0 +1,126 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + BedrockAgentRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../BedrockAgentRuntimeClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListFlowExecutionsRequest, ListFlowExecutionsResponse } from "../models/models_0"; +import { de_ListFlowExecutionsCommand, se_ListFlowExecutionsCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListFlowExecutionsCommand}. + */ +export interface ListFlowExecutionsCommandInput extends ListFlowExecutionsRequest {} +/** + * @public + * + * The output of {@link ListFlowExecutionsCommand}. + */ +export interface ListFlowExecutionsCommandOutput extends ListFlowExecutionsResponse, __MetadataBearer {} + +/** + *

Lists all asynchronous executions for 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).

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 + * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BedrockAgentRuntimeClient, ListFlowExecutionsCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import + * // const { BedrockAgentRuntimeClient, ListFlowExecutionsCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import + * const client = new BedrockAgentRuntimeClient(config); + * const input = { // ListFlowExecutionsRequest + * flowIdentifier: "STRING_VALUE", // required + * flowAliasIdentifier: "STRING_VALUE", + * maxResults: Number("int"), + * nextToken: "STRING_VALUE", + * }; + * const command = new ListFlowExecutionsCommand(input); + * const response = await client.send(command); + * // { // ListFlowExecutionsResponse + * // flowExecutionSummaries: [ // FlowExecutionSummaries // required + * // { // FlowExecutionSummary + * // executionArn: "STRING_VALUE", // required + * // flowAliasIdentifier: "STRING_VALUE", // required + * // flowIdentifier: "STRING_VALUE", // required + * // flowVersion: "STRING_VALUE", // required + * // status: "Running" || "Succeeded" || "Failed" || "TimedOut" || "Aborted", // required + * // createdAt: new Date("TIMESTAMP"), // required + * // endedAt: new Date("TIMESTAMP"), + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListFlowExecutionsCommandInput - {@link ListFlowExecutionsCommandInput} + * @returns {@link ListFlowExecutionsCommandOutput} + * @see {@link ListFlowExecutionsCommandInput} for command's `input` shape. + * @see {@link ListFlowExecutionsCommandOutput} for command's `response` shape. + * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

The request is denied because of missing access permissions. Check your permissions and retry your request.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal server error occurred. Retry your request.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

+ * + * @throws {@link ThrottlingException} (client fault) + *

The number of requests exceeds the limit. Resubmit your request later.

+ * + * @throws {@link ValidationException} (client fault) + *

Input validation failed. Check your request parameters and retry the request.

+ * + * @throws {@link BedrockAgentRuntimeServiceException} + *

Base exception class for all service exceptions from BedrockAgentRuntime service.

+ * + * + * @public + */ +export class ListFlowExecutionsCommand extends $Command + .classBuilder< + ListFlowExecutionsCommandInput, + ListFlowExecutionsCommandOutput, + BedrockAgentRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BedrockAgentRuntimeClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonBedrockAgentRunTimeService", "ListFlowExecutions", {}) + .n("BedrockAgentRuntimeClient", "ListFlowExecutionsCommand") + .f(void 0, void 0) + .ser(se_ListFlowExecutionsCommand) + .de(de_ListFlowExecutionsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListFlowExecutionsRequest; + output: ListFlowExecutionsResponse; + }; + sdk: { + input: ListFlowExecutionsCommandInput; + output: ListFlowExecutionsCommandOutput; + }; + }; +} diff --git a/clients/client-bedrock-agent-runtime/src/commands/ListInvocationStepsCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/ListInvocationStepsCommand.ts index 8bad56f3109c2..910bee132e41a 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/ListInvocationStepsCommand.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/ListInvocationStepsCommand.ts @@ -10,7 +10,7 @@ import { ServiceOutputTypes, } from "../BedrockAgentRuntimeClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ListInvocationStepsRequest, ListInvocationStepsResponse } from "../models/models_0"; +import { ListInvocationStepsRequest, ListInvocationStepsResponse } from "../models/models_1"; import { de_ListInvocationStepsCommand, se_ListInvocationStepsCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-bedrock-agent-runtime/src/commands/ListInvocationsCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/ListInvocationsCommand.ts index 16a6534cc4969..a1f5db6ca23af 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/ListInvocationsCommand.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/ListInvocationsCommand.ts @@ -10,7 +10,7 @@ import { ServiceOutputTypes, } from "../BedrockAgentRuntimeClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ListInvocationsRequest, ListInvocationsResponse } from "../models/models_0"; +import { ListInvocationsRequest, ListInvocationsResponse } from "../models/models_1"; import { de_ListInvocationsCommand, se_ListInvocationsCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-bedrock-agent-runtime/src/commands/ListSessionsCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/ListSessionsCommand.ts index 002e52942282c..477e86ff3d39e 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/ListSessionsCommand.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/ListSessionsCommand.ts @@ -10,8 +10,7 @@ import { ServiceOutputTypes, } from "../BedrockAgentRuntimeClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ListSessionsRequest } from "../models/models_0"; -import { ListSessionsResponse } from "../models/models_1"; +import { ListSessionsRequest, ListSessionsResponse } from "../models/models_1"; import { de_ListSessionsCommand, se_ListSessionsCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-bedrock-agent-runtime/src/commands/PutInvocationStepCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/PutInvocationStepCommand.ts index 9be48267be654..b049a236a6f1c 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/PutInvocationStepCommand.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/PutInvocationStepCommand.ts @@ -14,7 +14,7 @@ import { PutInvocationStepRequest, PutInvocationStepRequestFilterSensitiveLog, PutInvocationStepResponse, -} from "../models/models_0"; +} from "../models/models_1"; import { de_PutInvocationStepCommand, se_PutInvocationStepCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-bedrock-agent-runtime/src/commands/RetrieveAndGenerateStreamCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/RetrieveAndGenerateStreamCommand.ts index aea2b0c09f1fe..5fc394c13821a 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/RetrieveAndGenerateStreamCommand.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/RetrieveAndGenerateStreamCommand.ts @@ -10,13 +10,11 @@ import { ServiceOutputTypes, } from "../BedrockAgentRuntimeClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { - RetrieveAndGenerateStreamResponse, - RetrieveAndGenerateStreamResponseFilterSensitiveLog, -} from "../models/models_0"; import { RetrieveAndGenerateStreamRequest, RetrieveAndGenerateStreamRequestFilterSensitiveLog, + RetrieveAndGenerateStreamResponse, + RetrieveAndGenerateStreamResponseFilterSensitiveLog, } from "../models/models_1"; import { de_RetrieveAndGenerateStreamCommand, se_RetrieveAndGenerateStreamCommand } from "../protocols/Aws_restJson1"; diff --git a/clients/client-bedrock-agent-runtime/src/commands/RetrieveCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/RetrieveCommand.ts index 922739b5e6fd2..c8d5b75c846fc 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/RetrieveCommand.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/RetrieveCommand.ts @@ -10,8 +10,12 @@ import { ServiceOutputTypes, } from "../BedrockAgentRuntimeClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { RetrieveResponse, RetrieveResponseFilterSensitiveLog } from "../models/models_0"; -import { RetrieveRequest, RetrieveRequestFilterSensitiveLog } from "../models/models_1"; +import { + RetrieveRequest, + RetrieveRequestFilterSensitiveLog, + RetrieveResponse, + RetrieveResponseFilterSensitiveLog, +} from "../models/models_1"; import { de_RetrieveCommand, se_RetrieveCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-bedrock-agent-runtime/src/commands/StartFlowExecutionCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/StartFlowExecutionCommand.ts new file mode 100644 index 0000000000000..9841c9f8e7b80 --- /dev/null +++ b/clients/client-bedrock-agent-runtime/src/commands/StartFlowExecutionCommand.ts @@ -0,0 +1,145 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + BedrockAgentRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../BedrockAgentRuntimeClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + StartFlowExecutionRequest, + StartFlowExecutionRequestFilterSensitiveLog, + StartFlowExecutionResponse, +} from "../models/models_0"; +import { de_StartFlowExecutionCommand, se_StartFlowExecutionCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link StartFlowExecutionCommand}. + */ +export interface StartFlowExecutionCommandInput extends StartFlowExecutionRequest {} +/** + * @public + * + * The output of {@link StartFlowExecutionCommand}. + */ +export interface StartFlowExecutionCommandOutput extends StartFlowExecutionResponse, __MetadataBearer {} + +/** + *

Starts an asynchronous execution of an Amazon Bedrock flow. Unlike synchronous flows that run until completion or time out after five minutes, you can run asynchronous flows for longer durations. Asynchronous flows 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's async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 + * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BedrockAgentRuntimeClient, StartFlowExecutionCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import + * // const { BedrockAgentRuntimeClient, StartFlowExecutionCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import + * const client = new BedrockAgentRuntimeClient(config); + * const input = { // StartFlowExecutionRequest + * flowIdentifier: "STRING_VALUE", // required + * flowAliasIdentifier: "STRING_VALUE", // required + * flowExecutionName: "STRING_VALUE", + * inputs: [ // FlowInputs // required + * { // FlowInput + * nodeName: "STRING_VALUE", // required + * nodeOutputName: "STRING_VALUE", + * content: { // FlowInputContent Union: only one key present + * document: "DOCUMENT_VALUE", + * }, + * nodeInputName: "STRING_VALUE", + * }, + * ], + * modelPerformanceConfiguration: { // ModelPerformanceConfiguration + * performanceConfig: { // PerformanceConfiguration + * latency: "standard" || "optimized", + * }, + * }, + * }; + * const command = new StartFlowExecutionCommand(input); + * const response = await client.send(command); + * // { // StartFlowExecutionResponse + * // executionArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param StartFlowExecutionCommandInput - {@link StartFlowExecutionCommandInput} + * @returns {@link StartFlowExecutionCommandOutput} + * @see {@link StartFlowExecutionCommandInput} for command's `input` shape. + * @see {@link StartFlowExecutionCommandOutput} for command's `response` shape. + * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

The request is denied because of missing access permissions. Check your permissions and retry your request.

+ * + * @throws {@link BadGatewayException} (server fault) + *

There was an issue with a dependency due to a server issue. Retry your request.

+ * + * @throws {@link ConflictException} (client fault) + *

There was a conflict performing an operation. Resolve the conflict and retry your request.

+ * + * @throws {@link DependencyFailedException} (client fault) + *

There was an issue with a dependency. Check the resource configurations and retry the request.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal server error occurred. Retry your request.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *

The number of requests exceeds the service quota. Resubmit your request later.

+ * + * @throws {@link ThrottlingException} (client fault) + *

The number of requests exceeds the limit. Resubmit your request later.

+ * + * @throws {@link ValidationException} (client fault) + *

Input validation failed. Check your request parameters and retry the request.

+ * + * @throws {@link BedrockAgentRuntimeServiceException} + *

Base exception class for all service exceptions from BedrockAgentRuntime service.

+ * + * + * @public + */ +export class StartFlowExecutionCommand extends $Command + .classBuilder< + StartFlowExecutionCommandInput, + StartFlowExecutionCommandOutput, + BedrockAgentRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BedrockAgentRuntimeClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonBedrockAgentRunTimeService", "StartFlowExecution", {}) + .n("BedrockAgentRuntimeClient", "StartFlowExecutionCommand") + .f(StartFlowExecutionRequestFilterSensitiveLog, void 0) + .ser(se_StartFlowExecutionCommand) + .de(de_StartFlowExecutionCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: StartFlowExecutionRequest; + output: StartFlowExecutionResponse; + }; + sdk: { + input: StartFlowExecutionCommandInput; + output: StartFlowExecutionCommandOutput; + }; + }; +} diff --git a/clients/client-bedrock-agent-runtime/src/commands/StopFlowExecutionCommand.ts b/clients/client-bedrock-agent-runtime/src/commands/StopFlowExecutionCommand.ts new file mode 100644 index 0000000000000..d34130ffe09b5 --- /dev/null +++ b/clients/client-bedrock-agent-runtime/src/commands/StopFlowExecutionCommand.ts @@ -0,0 +1,124 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { + BedrockAgentRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../BedrockAgentRuntimeClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { StopFlowExecutionRequest, StopFlowExecutionResponse } from "../models/models_0"; +import { de_StopFlowExecutionCommand, se_StopFlowExecutionCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link StopFlowExecutionCommand}. + */ +export interface StopFlowExecutionCommandInput extends StopFlowExecutionRequest {} +/** + * @public + * + * The output of {@link StopFlowExecutionCommand}. + */ +export interface StopFlowExecutionCommandOutput extends StopFlowExecutionResponse, __MetadataBearer {} + +/** + *

Stops an Amazon Bedrock flow's asynchronous execution. This operation prevents further processing of the flow and changes the execution status to Aborted.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BedrockAgentRuntimeClient, StopFlowExecutionCommand } from "@aws-sdk/client-bedrock-agent-runtime"; // ES Modules import + * // const { BedrockAgentRuntimeClient, StopFlowExecutionCommand } = require("@aws-sdk/client-bedrock-agent-runtime"); // CommonJS import + * const client = new BedrockAgentRuntimeClient(config); + * const input = { // StopFlowExecutionRequest + * flowIdentifier: "STRING_VALUE", // required + * flowAliasIdentifier: "STRING_VALUE", // required + * executionIdentifier: "STRING_VALUE", // required + * }; + * const command = new StopFlowExecutionCommand(input); + * const response = await client.send(command); + * // { // StopFlowExecutionResponse + * // executionArn: "STRING_VALUE", + * // status: "Running" || "Succeeded" || "Failed" || "TimedOut" || "Aborted", // required + * // }; + * + * ``` + * + * @param StopFlowExecutionCommandInput - {@link StopFlowExecutionCommandInput} + * @returns {@link StopFlowExecutionCommandOutput} + * @see {@link StopFlowExecutionCommandInput} for command's `input` shape. + * @see {@link StopFlowExecutionCommandOutput} for command's `response` shape. + * @see {@link BedrockAgentRuntimeClientResolvedConfig | config} for BedrockAgentRuntimeClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *

The request is denied because of missing access permissions. Check your permissions and retry your request.

+ * + * @throws {@link BadGatewayException} (server fault) + *

There was an issue with a dependency due to a server issue. Retry your request.

+ * + * @throws {@link ConflictException} (client fault) + *

There was a conflict performing an operation. Resolve the conflict and retry your request.

+ * + * @throws {@link DependencyFailedException} (client fault) + *

There was an issue with a dependency. Check the resource configurations and retry the request.

+ * + * @throws {@link InternalServerException} (server fault) + *

An internal server error occurred. Retry your request.

+ * + * @throws {@link ResourceNotFoundException} (client fault) + *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

+ * + * @throws {@link ThrottlingException} (client fault) + *

The number of requests exceeds the limit. Resubmit your request later.

+ * + * @throws {@link ValidationException} (client fault) + *

Input validation failed. Check your request parameters and retry the request.

+ * + * @throws {@link BedrockAgentRuntimeServiceException} + *

Base exception class for all service exceptions from BedrockAgentRuntime service.

+ * + * + * @public + */ +export class StopFlowExecutionCommand extends $Command + .classBuilder< + StopFlowExecutionCommandInput, + StopFlowExecutionCommandOutput, + BedrockAgentRuntimeClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BedrockAgentRuntimeClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonBedrockAgentRunTimeService", "StopFlowExecution", {}) + .n("BedrockAgentRuntimeClient", "StopFlowExecutionCommand") + .f(void 0, void 0) + .ser(se_StopFlowExecutionCommand) + .de(de_StopFlowExecutionCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: StopFlowExecutionRequest; + output: StopFlowExecutionResponse; + }; + sdk: { + input: StopFlowExecutionCommandInput; + output: StopFlowExecutionCommandOutput; + }; + }; +} diff --git a/clients/client-bedrock-agent-runtime/src/commands/index.ts b/clients/client-bedrock-agent-runtime/src/commands/index.ts index 16b1a36897666..d63d7dc474d4c 100644 --- a/clients/client-bedrock-agent-runtime/src/commands/index.ts +++ b/clients/client-bedrock-agent-runtime/src/commands/index.ts @@ -6,11 +6,15 @@ export * from "./DeleteSessionCommand"; export * from "./EndSessionCommand"; export * from "./GenerateQueryCommand"; export * from "./GetAgentMemoryCommand"; +export * from "./GetExecutionFlowSnapshotCommand"; +export * from "./GetFlowExecutionCommand"; export * from "./GetInvocationStepCommand"; export * from "./GetSessionCommand"; export * from "./InvokeAgentCommand"; export * from "./InvokeFlowCommand"; export * from "./InvokeInlineAgentCommand"; +export * from "./ListFlowExecutionEventsCommand"; +export * from "./ListFlowExecutionsCommand"; export * from "./ListInvocationStepsCommand"; export * from "./ListInvocationsCommand"; export * from "./ListSessionsCommand"; @@ -21,6 +25,8 @@ export * from "./RerankCommand"; export * from "./RetrieveAndGenerateCommand"; export * from "./RetrieveAndGenerateStreamCommand"; export * from "./RetrieveCommand"; +export * from "./StartFlowExecutionCommand"; +export * from "./StopFlowExecutionCommand"; export * from "./TagResourceCommand"; export * from "./UntagResourceCommand"; export * from "./UpdateSessionCommand"; diff --git a/clients/client-bedrock-agent-runtime/src/models/models_0.ts b/clients/client-bedrock-agent-runtime/src/models/models_0.ts index 537cceabb2728..a02e64287e3de 100644 --- a/clients/client-bedrock-agent-runtime/src/models/models_0.ts +++ b/clients/client-bedrock-agent-runtime/src/models/models_0.ts @@ -227,7 +227,7 @@ export interface Metadata { startTime?: Date | undefined; /** - *

In the final response, endTime is the end time time of the agent invocation operation.

+ *

In the final response, endTime is the end time of the agent invocation operation.

* @public */ endTime?: Date | undefined; @@ -1209,77 +1209,67 @@ export interface AgentCollaboratorInvocationOutput { } /** - *

There was an issue with a dependency due to a server issue. Retry your request.

* @public */ -export class BadGatewayException extends __BaseException { - readonly name: "BadGatewayException" = "BadGatewayException"; - readonly $fault: "server" = "server"; +export interface GetExecutionFlowSnapshotRequest { /** - *

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

+ *

The unique identifier of the flow.

* @public */ - resourceName?: string | undefined; + flowIdentifier: string | undefined; /** - * @internal + *

The unique identifier of the flow alias used for the async execution.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "BadGatewayException", - $fault: "server", - ...opts, - }); - Object.setPrototypeOf(this, BadGatewayException.prototype); - this.resourceName = opts.resourceName; - } -} + flowAliasIdentifier: string | undefined; -/** - *

There was a conflict performing an operation. Resolve the conflict and retry your request.

- * @public - */ -export class ConflictException extends __BaseException { - readonly name: "ConflictException" = "ConflictException"; - readonly $fault: "client" = "client"; /** - * @internal + *

The unique identifier of the async execution.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "ConflictException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, ConflictException.prototype); - } + executionIdentifier: string | undefined; } /** - *

There was an issue with a dependency. Check the resource configurations and retry the request.

* @public */ -export class DependencyFailedException extends __BaseException { - readonly name: "DependencyFailedException" = "DependencyFailedException"; - readonly $fault: "client" = "client"; +export interface GetExecutionFlowSnapshotResponse { /** - *

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

+ *

The unique identifier of the flow.

* @public */ - resourceName?: string | undefined; + flowIdentifier: string | undefined; /** - * @internal + *

The unique identifier of the flow alias used for the async execution.

+ * @public */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "DependencyFailedException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, DependencyFailedException.prototype); - this.resourceName = opts.resourceName; - } + flowAliasIdentifier: string | undefined; + + /** + *

The version of the flow used for the async execution.

+ * @public + */ + flowVersion: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the IAM service role that's used by the async execution.

+ * @public + */ + executionRoleArn: string | undefined; + + /** + *

The flow definition used for the async execution, including the nodes, connections, and configuration at the time when the execution started.

The definition returns as a string that follows the structure of a FlowDefinition object.

+ * @public + */ + definition: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot.

+ * @public + */ + customerEncryptionKeyArn?: string | undefined; } /** @@ -1310,273 +1300,337 @@ export class InternalServerException extends __BaseException { } /** - *

Contains information about an input into the flow.

+ *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

* @public */ -export type FlowInputContent = FlowInputContent.DocumentMember | FlowInputContent.$UnknownMember; +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType) { + super({ + name: "ResourceNotFoundException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, ResourceNotFoundException.prototype); + } +} /** + *

The number of requests exceeds the limit. Resubmit your request later.

* @public */ -export namespace FlowInputContent { +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; /** - *

The input to send to the prompt flow input node.

- * @public + * @internal */ - export interface DocumentMember { - document: __DocumentType; - $unknown?: never; + constructor(opts: __ExceptionOptionType) { + super({ + name: "ThrottlingException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, ThrottlingException.prototype); } +} +/** + *

Input validation failed. Check your request parameters and retry the request.

+ * @public + */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; /** - * @public + * @internal */ - export interface $UnknownMember { - document?: never; - $unknown: [string, any]; - } - - export interface Visitor { - document: (value: __DocumentType) => T; - _: (name: string, value: any) => T; + constructor(opts: __ExceptionOptionType) { + super({ + name: "ValidationException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, ValidationException.prototype); } - - export const visit = (value: FlowInputContent, visitor: Visitor): T => { - if (value.document !== undefined) return visitor.document(value.document); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; } /** - *

Contains information about an input into the prompt flow and where to send it.

* @public */ -export interface FlowInput { - /** - *

The name of the flow input node that begins the prompt flow.

- * @public - */ - nodeName: string | undefined; - +export interface GetFlowExecutionRequest { /** - *

The name of the output from the flow input node that begins the prompt flow.

+ *

The unique identifier of the flow.

* @public */ - nodeOutputName?: string | undefined; + flowIdentifier: string | undefined; /** - *

Contains information about an input into the prompt flow.

+ *

The unique identifier of the flow alias used for the execution.

* @public */ - content: FlowInputContent | undefined; + flowAliasIdentifier: string | undefined; /** - *

The name of the input from the flow input node.

+ *

The unique identifier of the async execution to retrieve.

* @public */ - nodeInputName?: string | undefined; + executionIdentifier: string | undefined; } /** * @public * @enum */ -export const PerformanceConfigLatency = { - OPTIMIZED: "optimized", - STANDARD: "standard", +export const FlowExecutionErrorType = { + TIMED_OUT: "ExecutionTimedOut", } as const; /** * @public */ -export type PerformanceConfigLatency = (typeof PerformanceConfigLatency)[keyof typeof PerformanceConfigLatency]; +export type FlowExecutionErrorType = (typeof FlowExecutionErrorType)[keyof typeof FlowExecutionErrorType]; /** - *

Performance settings for a model.

+ *

Contains information about an error that occurred during an async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export interface PerformanceConfiguration { +export interface FlowExecutionError { /** - *

To use a latency-optimized version of the model, set to optimized.

+ *

The name of the node in the flow where the error occurred (if applicable).

* @public */ - latency?: PerformanceConfigLatency | undefined; -} + nodeName?: string | undefined; -/** - *

The performance configuration for a model called with InvokeFlow.

- * @public - */ -export interface ModelPerformanceConfiguration { /** - *

The latency configuration for the model.

+ *

The error code for the type of error that occurred.

* @public */ - performanceConfig?: PerformanceConfiguration | undefined; + error?: FlowExecutionErrorType | undefined; + + /** + *

A descriptive message that provides details about the error.

+ * @public + */ + message?: string | undefined; } /** * @public + * @enum */ -export interface InvokeFlowRequest { +export const FlowExecutionStatus = { + ABORTED: "Aborted", + FAILED: "Failed", + RUNNING: "Running", + SUCCEEDED: "Succeeded", + TIMED_OUT: "TimedOut", +} as const; + +/** + * @public + */ +export type FlowExecutionStatus = (typeof FlowExecutionStatus)[keyof typeof FlowExecutionStatus]; + +/** + * @public + */ +export interface GetFlowExecutionResponse { /** - *

The unique identifier of the flow.

+ *

The Amazon Resource Name (ARN) that uniquely identifies the async execution.

* @public */ - flowIdentifier: string | undefined; + executionArn: string | undefined; /** - *

The unique identifier of the flow alias.

+ *

The current status of the async execution.

Async executions time out after 24 hours.

* @public */ - flowAliasIdentifier: string | undefined; + status: FlowExecutionStatus | undefined; /** - *

A list of objects, each containing information about an input into the flow.

+ *

The timestamp when the async execution started.

* @public */ - inputs: FlowInput[] | undefined; + startedAt: Date | undefined; /** - *

Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

+ *

The timestamp when the async execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.

* @public */ - enableTrace?: boolean | undefined; + endedAt?: Date | undefined; /** - *

Model performance settings for the request.

+ *

A list of errors that occurred during the async execution. Each error includes an error code, message, and the node where the error occurred, if applicable.

* @public */ - modelPerformanceConfiguration?: ModelPerformanceConfiguration | undefined; + errors?: FlowExecutionError[] | undefined; /** - *

The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.

+ *

The unique identifier of the flow alias used for the execution.

* @public */ - executionId?: string | undefined; + flowAliasIdentifier: string | undefined; + + /** + *

The unique identifier of the flow.

+ * @public + */ + flowIdentifier: string | undefined; + + /** + *

The version of the flow used for the execution.

+ * @public + */ + flowVersion: string | undefined; } /** * @public * @enum */ -export const FlowCompletionReason = { - INPUT_REQUIRED: "INPUT_REQUIRED", - SUCCESS: "SUCCESS", +export const FlowExecutionEventType = { + FLOW: "Flow", + NODE: "Node", } as const; /** * @public */ -export type FlowCompletionReason = (typeof FlowCompletionReason)[keyof typeof FlowCompletionReason]; +export type FlowExecutionEventType = (typeof FlowExecutionEventType)[keyof typeof FlowExecutionEventType]; /** - *

Contains information about why a flow completed.

* @public */ -export interface FlowCompletionEvent { +export interface ListFlowExecutionEventsRequest { /** - *

The reason that the flow completed.

+ *

The unique identifier of the flow.

* @public */ - completionReason: FlowCompletionReason | undefined; + flowIdentifier: string | undefined; + + /** + *

The unique identifier of the flow alias used for the execution.

+ * @public + */ + flowAliasIdentifier: string | undefined; + + /** + *

The unique identifier of the async execution.

+ * @public + */ + executionIdentifier: string | undefined; + + /** + *

The maximum number of events to return in a single response. If more events exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.

+ * @public + */ + maxResults?: number | undefined; + + /** + *

A token to retrieve the next set of results. This value is returned in the response if more results are available.

+ * @public + */ + nextToken?: string | undefined; + + /** + *

The type of events to retrieve. Specify Node for node-level events or Flow for flow-level events.

+ * @public + */ + eventType: FlowExecutionEventType | undefined; } /** - *

The content structure containing input information for multi-turn flow interactions.

+ *

Represents a condition that was satisfied during a condition node evaluation in a flow's async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export type FlowMultiTurnInputContent = - | FlowMultiTurnInputContent.DocumentMember - | FlowMultiTurnInputContent.$UnknownMember; +export interface SatisfiedCondition { + /** + *

The name of the condition that was satisfied.

+ * @public + */ + conditionName: string | undefined; +} /** + *

Contains information about a condition evaluation result during an async execution. This event is generated when a condition node in the flow evaluates its conditions.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export namespace FlowMultiTurnInputContent { +export interface ConditionResultEvent { /** - *

The requested additional input to send back to the multi-turn flow node.

+ *

The name of the condition node that evaluated the conditions.

* @public */ - export interface DocumentMember { - document: __DocumentType; - $unknown?: never; - } + nodeName: string | undefined; /** + *

The timestamp when the condition evaluation occurred.

* @public */ - export interface $UnknownMember { - document?: never; - $unknown: [string, any]; - } - - export interface Visitor { - document: (value: __DocumentType) => T; - _: (name: string, value: any) => T; - } + timestamp: Date | undefined; - export const visit = (value: FlowMultiTurnInputContent, visitor: Visitor): T => { - if (value.document !== undefined) return visitor.document(value.document); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + /** + *

A list of conditions that were satisfied during the evaluation.

+ * @public + */ + satisfiedConditions: SatisfiedCondition[] | undefined; } /** * @public * @enum */ -export const NodeType = { - CONDITION_NODE: "ConditionNode", - FLOW_INPUT_NODE: "FlowInputNode", - FLOW_OUTPUT_NODE: "FlowOutputNode", - KNOWLEDGE_BASE_NODE: "KnowledgeBaseNode", - LAMBDA_FUNCTION_NODE: "LambdaFunctionNode", - LEX_NODE: "LexNode", - PROMPT_NODE: "PromptNode", +export const FlowErrorCode = { + INTERNAL_SERVER: "INTERNAL_SERVER", + NODE_EXECUTION_FAILED: "NODE_EXECUTION_FAILED", + VALIDATION: "VALIDATION", } as const; /** * @public */ -export type NodeType = (typeof NodeType)[keyof typeof NodeType]; +export type FlowErrorCode = (typeof FlowErrorCode)[keyof typeof FlowErrorCode]; /** - *

Response object from the flow multi-turn node requesting additional information.

+ *

Contains information about a failure that occurred at the flow level during an async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export interface FlowMultiTurnInputRequestEvent { +export interface FlowFailureEvent { /** - *

The name of the node in the flow that is requesting the input.

+ *

The timestamp when the failure occurred.

* @public */ - nodeName: string | undefined; + timestamp: Date | undefined; /** - *

The type of the node in the flow that is requesting the input.

+ *

The error code that identifies the type of failure that occurred.

* @public */ - nodeType: NodeType | undefined; + errorCode: FlowErrorCode | undefined; /** - *

The content payload containing the input request details for the multi-turn interaction.

+ *

A descriptive message that provides details about the failure.

* @public */ - content: FlowMultiTurnInputContent | undefined; + errorMessage: string | undefined; } /** - *

Contains information about the content in an output from prompt flow invocation.

+ *

Contains the content of an async execution input or output field.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export type FlowOutputContent = FlowOutputContent.DocumentMember | FlowOutputContent.$UnknownMember; +export type FlowExecutionContent = FlowExecutionContent.DocumentMember | FlowExecutionContent.$UnknownMember; /** * @public */ -export namespace FlowOutputContent { +export namespace FlowExecutionContent { /** - *

The content in the output.

+ *

The document content of the field, which can contain text or structured data.

* @public */ export interface DocumentMember { @@ -1597,122 +1651,154 @@ export namespace FlowOutputContent { _: (name: string, value: any) => T; } - export const visit = (value: FlowOutputContent, visitor: Visitor): T => { + export const visit = (value: FlowExecutionContent, visitor: Visitor): T => { if (value.document !== undefined) return visitor.document(value.document); return visitor._(value.$unknown[0], value.$unknown[1]); }; } /** - *

Contains information about an output from prompt flow invoction.

+ *

Represents an input field provided to a flow during an async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export interface FlowOutputEvent { +export interface FlowInputField { /** - *

The name of the flow output node that the output is from.

+ *

The name of the input field as defined in the flow's input schema.

+ * @public + */ + name: string | undefined; + + /** + *

The content of the input field, which can contain text or structured data.

+ * @public + */ + content: FlowExecutionContent | undefined; +} + +/** + *

Contains information about the inputs provided to the flow at the start of async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 + * @public + */ +export interface FlowExecutionInputEvent { + /** + *

The name of the node that receives the inputs.

* @public */ nodeName: string | undefined; /** - *

The type of the node that the output is from.

+ *

The timestamp when the inputs are provided.

* @public */ - nodeType: NodeType | undefined; + timestamp: Date | undefined; /** - *

The content in the output.

+ *

A list of input fields provided to the flow.

* @public */ - content: FlowOutputContent | undefined; + fields: FlowInputField[] | undefined; } /** - *

Contains information about a condition that was satisfied. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

+ *

Represents an output field produced by a flow during an async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export interface FlowTraceCondition { +export interface FlowOutputField { /** - *

The name of the condition.

+ *

The name of the output field as defined in the flow's output schema.

* @public */ - conditionName: string | undefined; + name: string | undefined; + + /** + *

The content of the output field, which can contain text or structured data.

+ * @public + */ + content: FlowExecutionContent | undefined; } /** - *

Contains information about an output from a condition node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

+ *

Contains information about the outputs produced by the flow during an async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export interface FlowTraceConditionNodeResultEvent { +export interface FlowExecutionOutputEvent { /** - *

The name of the condition node.

+ *

The name of the node that produces the outputs.

* @public */ nodeName: string | undefined; /** - *

The date and time that the trace was returned.

+ *

The timestamp when the outputs are produced.

* @public */ timestamp: Date | undefined; /** - *

An array of objects containing information about the conditions that were satisfied.

+ *

A list of output fields produced by the flow.

* @public */ - satisfiedConditions: FlowTraceCondition[] | undefined; + fields: FlowOutputField[] | undefined; } /** - *

Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes, agent nodes, and Amazon Web Services Lambda nodes.

* @public + * @enum */ -export interface FlowTraceNodeActionEvent { +export const NodeErrorCode = { + BAD_GATEWAY: "BAD_GATEWAY", + DEPENDENCY_FAILED: "DEPENDENCY_FAILED", + INTERNAL_SERVER: "INTERNAL_SERVER", + VALIDATION: "VALIDATION", +} as const; + +/** + * @public + */ +export type NodeErrorCode = (typeof NodeErrorCode)[keyof typeof NodeErrorCode]; + +/** + *

Contains information about a failure that occurred at a specific node during a flow's async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 + * @public + */ +export interface NodeFailureEvent { /** - *

The name of the node that called the operation.

+ *

The name of the node where the failure occurred.

* @public */ nodeName: string | undefined; /** - *

The date and time that the operation was called.

+ *

The timestamp when the node failure occurred.

* @public */ timestamp: Date | undefined; /** - *

The ID of the request that the node made to the operation.

- * @public - */ - requestId: string | undefined; - - /** - *

The name of the service that the node called.

+ *

The error code that identifies the type of failure that occurred at the node.

* @public */ - serviceName: string | undefined; + errorCode: NodeErrorCode | undefined; /** - *

The name of the operation that the node called.

+ *

A descriptive message that provides details about the node failure.

* @public */ - operationName: string | undefined; + errorMessage: string | undefined; } /** - *

Contains the content of the node input. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

+ *

Contains the content of a flow node's input or output field for an async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export type FlowTraceNodeInputContent = - | FlowTraceNodeInputContent.DocumentMember - | FlowTraceNodeInputContent.$UnknownMember; +export type NodeExecutionContent = NodeExecutionContent.DocumentMember | NodeExecutionContent.$UnknownMember; /** * @public */ -export namespace FlowTraceNodeInputContent { +export namespace NodeExecutionContent { /** - *

The content of the node input.

+ *

The document content of the field, which can contain text or structured data.

* @public */ export interface DocumentMember { @@ -1733,196 +1819,216 @@ export namespace FlowTraceNodeInputContent { _: (name: string, value: any) => T; } - export const visit = (value: FlowTraceNodeInputContent, visitor: Visitor): T => { + export const visit = (value: NodeExecutionContent, visitor: Visitor): T => { if (value.document !== undefined) return visitor.document(value.document); return visitor._(value.$unknown[0], value.$unknown[1]); }; } /** - *

Contains information about a field in the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

+ *

Represents an input field provided to a node during a flow's async execution.

* @public */ -export interface FlowTraceNodeInputField { +export interface NodeInputField { /** - *

The name of the node input.

+ *

The name of the input field as defined in the node's input schema.

* @public */ - nodeInputName: string | undefined; + name: string | undefined; /** - *

The content of the node input.

+ *

The content of the input field, which can contain text or structured data.

* @public */ - content: FlowTraceNodeInputContent | undefined; + content: NodeExecutionContent | undefined; } /** - *

Contains information about the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

+ *

Contains information about the inputs provided to a specific node during a flow's async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export interface FlowTraceNodeInputEvent { +export interface NodeInputEvent { /** - *

The name of the node that received the input.

+ *

The name of the node that received the inputs.

* @public */ nodeName: string | undefined; /** - *

The date and time that the trace was returned.

+ *

The timestamp when the inputs were provided to the node.

* @public */ timestamp: Date | undefined; /** - *

An array of objects containing information about each field in the input.

+ *

A list of input fields provided to the node.

* @public */ - fields: FlowTraceNodeInputField[] | undefined; + fields: NodeInputField[] | undefined; } /** - *

Contains the content of the node output. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

- * @public - */ -export type FlowTraceNodeOutputContent = - | FlowTraceNodeOutputContent.DocumentMember - | FlowTraceNodeOutputContent.$UnknownMember; - -/** + *

Represents an output field produced by a node during a flow's async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export namespace FlowTraceNodeOutputContent { +export interface NodeOutputField { /** - *

The content of the node output.

+ *

The name of the output field as defined in the node's output schema.

* @public */ - export interface DocumentMember { - document: __DocumentType; - $unknown?: never; - } + name: string | undefined; /** + *

The content of the output field, which can contain text or structured data.

* @public */ - export interface $UnknownMember { - document?: never; - $unknown: [string, any]; - } - - export interface Visitor { - document: (value: __DocumentType) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: FlowTraceNodeOutputContent, visitor: Visitor): T => { - if (value.document !== undefined) return visitor.document(value.document); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + content: NodeExecutionContent | undefined; } /** - *

Contains information about a field in the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

+ *

Contains information about the outputs produced by a specific node during a flow's async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export interface FlowTraceNodeOutputField { +export interface NodeOutputEvent { /** - *

The name of the node output.

+ *

The name of the node that produced the outputs.

* @public */ - nodeOutputName: string | undefined; + nodeName: string | undefined; /** - *

The content of the node output.

+ *

The timestamp when the outputs were produced by the node.

* @public */ - content: FlowTraceNodeOutputContent | undefined; + timestamp: Date | undefined; + + /** + *

A list of output fields produced by the node.

+ * @public + */ + fields: NodeOutputField[] | undefined; } /** - *

Contains information about the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

+ *

Represents an event that occurred during an async execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 * @public */ -export interface FlowTraceNodeOutputEvent { +export type FlowExecutionEvent = + | FlowExecutionEvent.ConditionResultEventMember + | FlowExecutionEvent.FlowFailureEventMember + | FlowExecutionEvent.FlowInputEventMember + | FlowExecutionEvent.FlowOutputEventMember + | FlowExecutionEvent.NodeFailureEventMember + | FlowExecutionEvent.NodeInputEventMember + | FlowExecutionEvent.NodeOutputEventMember + | FlowExecutionEvent.$UnknownMember; + +/** + * @public + */ +export namespace FlowExecutionEvent { /** - *

The name of the node that yielded the output.

+ *

Contains information about the inputs provided to the flow at the start of execution.

* @public */ - nodeName: string | undefined; + export interface FlowInputEventMember { + flowInputEvent: FlowExecutionInputEvent; + flowOutputEvent?: never; + nodeInputEvent?: never; + nodeOutputEvent?: never; + conditionResultEvent?: never; + nodeFailureEvent?: never; + flowFailureEvent?: never; + $unknown?: never; + } /** - *

The date and time that the trace was returned.

+ *

Contains information about the outputs produced by the flow at the end of execution.

* @public */ - timestamp: Date | undefined; + export interface FlowOutputEventMember { + flowInputEvent?: never; + flowOutputEvent: FlowExecutionOutputEvent; + nodeInputEvent?: never; + nodeOutputEvent?: never; + conditionResultEvent?: never; + nodeFailureEvent?: never; + flowFailureEvent?: never; + $unknown?: never; + } /** - *

An array of objects containing information about each field in the output.

+ *

Contains information about the inputs provided to a specific node during execution.

* @public */ - fields: FlowTraceNodeOutputField[] | undefined; -} - -/** - *

Contains information about an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

- * @public - */ -export type FlowTrace = - | FlowTrace.ConditionNodeResultTraceMember - | FlowTrace.NodeActionTraceMember - | FlowTrace.NodeInputTraceMember - | FlowTrace.NodeOutputTraceMember - | FlowTrace.$UnknownMember; + export interface NodeInputEventMember { + flowInputEvent?: never; + flowOutputEvent?: never; + nodeInputEvent: NodeInputEvent; + nodeOutputEvent?: never; + conditionResultEvent?: never; + nodeFailureEvent?: never; + flowFailureEvent?: never; + $unknown?: never; + } -/** - * @public - */ -export namespace FlowTrace { /** - *

Contains information about the input into a node.

+ *

Contains information about the outputs produced by a specific node during execution.

* @public */ - export interface NodeInputTraceMember { - nodeInputTrace: FlowTraceNodeInputEvent; - nodeOutputTrace?: never; - conditionNodeResultTrace?: never; - nodeActionTrace?: never; + export interface NodeOutputEventMember { + flowInputEvent?: never; + flowOutputEvent?: never; + nodeInputEvent?: never; + nodeOutputEvent: NodeOutputEvent; + conditionResultEvent?: never; + nodeFailureEvent?: never; + flowFailureEvent?: never; $unknown?: never; } /** - *

Contains information about the output from a node.

+ *

Contains information about a condition evaluation result during the async execution. This event is generated when a condition node in the flow evaluates its conditions.

* @public */ - export interface NodeOutputTraceMember { - nodeInputTrace?: never; - nodeOutputTrace: FlowTraceNodeOutputEvent; - conditionNodeResultTrace?: never; - nodeActionTrace?: never; + export interface ConditionResultEventMember { + flowInputEvent?: never; + flowOutputEvent?: never; + nodeInputEvent?: never; + nodeOutputEvent?: never; + conditionResultEvent: ConditionResultEvent; + nodeFailureEvent?: never; + flowFailureEvent?: never; $unknown?: never; } /** - *

Contains information about an output from a condition node.

+ *

Contains information about a failure that occurred at a specific node during execution.

* @public */ - export interface ConditionNodeResultTraceMember { - nodeInputTrace?: never; - nodeOutputTrace?: never; - conditionNodeResultTrace: FlowTraceConditionNodeResultEvent; - nodeActionTrace?: never; + export interface NodeFailureEventMember { + flowInputEvent?: never; + flowOutputEvent?: never; + nodeInputEvent?: never; + nodeOutputEvent?: never; + conditionResultEvent?: never; + nodeFailureEvent: NodeFailureEvent; + flowFailureEvent?: never; $unknown?: never; } /** - *

Contains information about an action (operation) called by a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

+ *

Contains information about a failure that occurred at the flow level during execution.

* @public */ - export interface NodeActionTraceMember { - nodeInputTrace?: never; - nodeOutputTrace?: never; - conditionNodeResultTrace?: never; - nodeActionTrace: FlowTraceNodeActionEvent; + export interface FlowFailureEventMember { + flowInputEvent?: never; + flowOutputEvent?: never; + nodeInputEvent?: never; + nodeOutputEvent?: never; + conditionResultEvent?: never; + nodeFailureEvent?: never; + flowFailureEvent: FlowFailureEvent; $unknown?: never; } @@ -1930,689 +2036,602 @@ export namespace FlowTrace { * @public */ export interface $UnknownMember { - nodeInputTrace?: never; - nodeOutputTrace?: never; - conditionNodeResultTrace?: never; - nodeActionTrace?: never; + flowInputEvent?: never; + flowOutputEvent?: never; + nodeInputEvent?: never; + nodeOutputEvent?: never; + conditionResultEvent?: never; + nodeFailureEvent?: never; + flowFailureEvent?: never; $unknown: [string, any]; } export interface Visitor { - nodeInputTrace: (value: FlowTraceNodeInputEvent) => T; - nodeOutputTrace: (value: FlowTraceNodeOutputEvent) => T; - conditionNodeResultTrace: (value: FlowTraceConditionNodeResultEvent) => T; - nodeActionTrace: (value: FlowTraceNodeActionEvent) => T; + flowInputEvent: (value: FlowExecutionInputEvent) => T; + flowOutputEvent: (value: FlowExecutionOutputEvent) => T; + nodeInputEvent: (value: NodeInputEvent) => T; + nodeOutputEvent: (value: NodeOutputEvent) => T; + conditionResultEvent: (value: ConditionResultEvent) => T; + nodeFailureEvent: (value: NodeFailureEvent) => T; + flowFailureEvent: (value: FlowFailureEvent) => T; _: (name: string, value: any) => T; } - export const visit = (value: FlowTrace, visitor: Visitor): T => { - if (value.nodeInputTrace !== undefined) return visitor.nodeInputTrace(value.nodeInputTrace); - if (value.nodeOutputTrace !== undefined) return visitor.nodeOutputTrace(value.nodeOutputTrace); - if (value.conditionNodeResultTrace !== undefined) - return visitor.conditionNodeResultTrace(value.conditionNodeResultTrace); - if (value.nodeActionTrace !== undefined) return visitor.nodeActionTrace(value.nodeActionTrace); + export const visit = (value: FlowExecutionEvent, visitor: Visitor): T => { + if (value.flowInputEvent !== undefined) return visitor.flowInputEvent(value.flowInputEvent); + if (value.flowOutputEvent !== undefined) return visitor.flowOutputEvent(value.flowOutputEvent); + if (value.nodeInputEvent !== undefined) return visitor.nodeInputEvent(value.nodeInputEvent); + if (value.nodeOutputEvent !== undefined) return visitor.nodeOutputEvent(value.nodeOutputEvent); + if (value.conditionResultEvent !== undefined) return visitor.conditionResultEvent(value.conditionResultEvent); + if (value.nodeFailureEvent !== undefined) return visitor.nodeFailureEvent(value.nodeFailureEvent); + if (value.flowFailureEvent !== undefined) return visitor.flowFailureEvent(value.flowFailureEvent); return visitor._(value.$unknown[0], value.$unknown[1]); }; } /** - *

Contains information about a trace, which tracks an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

* @public */ -export interface FlowTraceEvent { +export interface ListFlowExecutionEventsResponse { /** - *

The trace object containing information about an input or output for a node in the flow.

+ *

A list of events that occurred during the async execution. Events can include node inputs and outputs, flow inputs and outputs, condition results, and failure events.

* @public */ - trace: FlowTrace | undefined; + flowExecutionEvents: FlowExecutionEvent[] | undefined; + + /** + *

A token to retrieve the next set of results. This value is returned if more results are available.

+ * @public + */ + nextToken?: string | undefined; } /** - *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

* @public */ -export class ResourceNotFoundException extends __BaseException { - readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; - readonly $fault: "client" = "client"; +export interface ListFlowExecutionsRequest { + /** + *

The unique identifier of the flow to list executions for.

+ * @public + */ + flowIdentifier: string | undefined; + + /** + *

The unique identifier of the flow alias to list executions for.

+ * @public + */ + flowAliasIdentifier?: string | undefined; + + /** + *

The maximum number of async executions to return in a single response. If more executions exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.

+ * @public + */ + maxResults?: number | undefined; + + /** + *

A token to retrieve the next set of results. This value is returned in the response if more results are available.

+ * @public + */ + nextToken?: string | undefined; +} + +/** + *

Contains summary information about a flow's async execution, including its status, timestamps, and identifiers.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

 + * @public + */ +export interface FlowExecutionSummary { + /** + *

The Amazon Resource Name (ARN) that uniquely identifies the async execution.

+ * @public + */ + executionArn: string | undefined; + + /** + *

The unique identifier of the flow alias used for the execution.

+ * @public + */ + flowAliasIdentifier: string | undefined; + + /** + *

The unique identifier of the flow.

+ * @public + */ + flowIdentifier: string | undefined; + + /** + *

The version of the flow used for the execution.

+ * @public + */ + flowVersion: string | undefined; + + /** + *

The current status of the async execution.

Async executions time out after 24 hours.

+ * @public + */ + status: FlowExecutionStatus | undefined; + + /** + *

The timestamp when the async execution was created.

+ * @public + */ + createdAt: Date | undefined; + + /** + *

The timestamp when the async execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.

+ * @public + */ + endedAt?: Date | undefined; +} + +/** + * @public + */ +export interface ListFlowExecutionsResponse { + /** + *

A list of async execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.

+ * @public + */ + flowExecutionSummaries: FlowExecutionSummary[] | undefined; + + /** + *

A token to retrieve the next set of results. This value is returned if more results are available.

+ * @public + */ + nextToken?: string | undefined; +} + +/** + *

There was an issue with a dependency due to a server issue. Retry your request.

+ * @public + */ +export class BadGatewayException extends __BaseException { + readonly name: "BadGatewayException" = "BadGatewayException"; + readonly $fault: "server" = "server"; + /** + *

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

+ * @public + */ + resourceName?: string | undefined; + /** * @internal */ - constructor(opts: __ExceptionOptionType) { + constructor(opts: __ExceptionOptionType) { super({ - name: "ResourceNotFoundException", - $fault: "client", + name: "BadGatewayException", + $fault: "server", ...opts, }); - Object.setPrototypeOf(this, ResourceNotFoundException.prototype); + Object.setPrototypeOf(this, BadGatewayException.prototype); + this.resourceName = opts.resourceName; } } /** - *

The number of requests exceeds the service quota. Resubmit your request later.

+ *

There was a conflict performing an operation. Resolve the conflict and retry your request.

* @public */ -export class ServiceQuotaExceededException extends __BaseException { - readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; readonly $fault: "client" = "client"; /** * @internal */ - constructor(opts: __ExceptionOptionType) { + constructor(opts: __ExceptionOptionType) { super({ - name: "ServiceQuotaExceededException", + name: "ConflictException", $fault: "client", ...opts, }); - Object.setPrototypeOf(this, ServiceQuotaExceededException.prototype); + Object.setPrototypeOf(this, ConflictException.prototype); } } /** - *

The number of requests exceeds the limit. Resubmit your request later.

+ *

There was an issue with a dependency. Check the resource configurations and retry the request.

* @public */ -export class ThrottlingException extends __BaseException { - readonly name: "ThrottlingException" = "ThrottlingException"; +export class DependencyFailedException extends __BaseException { + readonly name: "DependencyFailedException" = "DependencyFailedException"; readonly $fault: "client" = "client"; + /** + *

The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.

+ * @public + */ + resourceName?: string | undefined; + /** * @internal */ - constructor(opts: __ExceptionOptionType) { + constructor(opts: __ExceptionOptionType) { super({ - name: "ThrottlingException", + name: "DependencyFailedException", $fault: "client", ...opts, }); - Object.setPrototypeOf(this, ThrottlingException.prototype); + Object.setPrototypeOf(this, DependencyFailedException.prototype); + this.resourceName = opts.resourceName; } } /** - *

Input validation failed. Check your request parameters and retry the request.

+ *

The number of requests exceeds the service quota. Resubmit your request later.

* @public */ -export class ValidationException extends __BaseException { - readonly name: "ValidationException" = "ValidationException"; +export class ServiceQuotaExceededException extends __BaseException { + readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; readonly $fault: "client" = "client"; /** * @internal */ - constructor(opts: __ExceptionOptionType) { + constructor(opts: __ExceptionOptionType) { super({ - name: "ValidationException", + name: "ServiceQuotaExceededException", $fault: "client", ...opts, }); - Object.setPrototypeOf(this, ValidationException.prototype); + Object.setPrototypeOf(this, ServiceQuotaExceededException.prototype); } } /** - *

The output of the flow.

+ *

Contains information about an input into the flow.

* @public */ -export type FlowResponseStream = - | FlowResponseStream.AccessDeniedExceptionMember - | FlowResponseStream.BadGatewayExceptionMember - | FlowResponseStream.ConflictExceptionMember - | FlowResponseStream.DependencyFailedExceptionMember - | FlowResponseStream.FlowCompletionEventMember - | FlowResponseStream.FlowMultiTurnInputRequestEventMember - | FlowResponseStream.FlowOutputEventMember - | FlowResponseStream.FlowTraceEventMember - | FlowResponseStream.InternalServerExceptionMember - | FlowResponseStream.ResourceNotFoundExceptionMember - | FlowResponseStream.ServiceQuotaExceededExceptionMember - | FlowResponseStream.ThrottlingExceptionMember - | FlowResponseStream.ValidationExceptionMember - | FlowResponseStream.$UnknownMember; +export type FlowInputContent = FlowInputContent.DocumentMember | FlowInputContent.$UnknownMember; /** * @public */ -export namespace FlowResponseStream { +export namespace FlowInputContent { /** - *

Contains information about an output from flow invocation.

+ *

The input to send to the prompt flow input node.

* @public */ - export interface FlowOutputEventMember { - flowOutputEvent: FlowOutputEvent; - flowCompletionEvent?: never; - flowTraceEvent?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - flowMultiTurnInputRequestEvent?: never; + export interface DocumentMember { + document: __DocumentType; $unknown?: never; } /** - *

Contains information about why the flow completed.

* @public */ - export interface FlowCompletionEventMember { - flowOutputEvent?: never; - flowCompletionEvent: FlowCompletionEvent; - flowTraceEvent?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - flowMultiTurnInputRequestEvent?: never; - $unknown?: never; + export interface $UnknownMember { + document?: never; + $unknown: [string, any]; + } + + export interface Visitor { + document: (value: __DocumentType) => T; + _: (name: string, value: any) => T; } + export const visit = (value: FlowInputContent, visitor: Visitor): T => { + if (value.document !== undefined) return visitor.document(value.document); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + *

Contains information about an input into the prompt flow and where to send it.

+ * @public + */ +export interface FlowInput { /** - *

Contains information about a trace, which tracks an input or output for a node in the flow.

+ *

The name of the flow input node that begins the prompt flow.

* @public */ - export interface FlowTraceEventMember { - flowOutputEvent?: never; - flowCompletionEvent?: never; - flowTraceEvent: FlowTraceEvent; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - flowMultiTurnInputRequestEvent?: never; - $unknown?: never; - } + nodeName: string | undefined; /** - *

An internal server error occurred. Retry your request.

+ *

The name of the output from the flow input node that begins the prompt flow.

* @public */ - export interface InternalServerExceptionMember { - flowOutputEvent?: never; - flowCompletionEvent?: never; - flowTraceEvent?: never; - internalServerException: InternalServerException; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - flowMultiTurnInputRequestEvent?: never; - $unknown?: never; - } + nodeOutputName?: string | undefined; /** - *

Input validation failed. Check your request parameters and retry the request.

+ *

Contains information about an input into the prompt flow.

* @public */ - export interface ValidationExceptionMember { - flowOutputEvent?: never; - flowCompletionEvent?: never; - flowTraceEvent?: never; - internalServerException?: never; - validationException: ValidationException; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - flowMultiTurnInputRequestEvent?: never; - $unknown?: never; - } + content: FlowInputContent | undefined; /** - *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

+ *

The name of the input from the flow input node.

* @public */ - export interface ResourceNotFoundExceptionMember { - flowOutputEvent?: never; - flowCompletionEvent?: never; - flowTraceEvent?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException: ResourceNotFoundException; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - flowMultiTurnInputRequestEvent?: never; - $unknown?: never; - } + nodeInputName?: string | undefined; +} +/** + * @public + * @enum + */ +export const PerformanceConfigLatency = { + OPTIMIZED: "optimized", + STANDARD: "standard", +} as const; + +/** + * @public + */ +export type PerformanceConfigLatency = (typeof PerformanceConfigLatency)[keyof typeof PerformanceConfigLatency]; + +/** + *

Performance settings for a model.

+ * @public + */ +export interface PerformanceConfiguration { /** - *

The number of requests exceeds the service quota. Resubmit your request later.

+ *

To use a latency-optimized version of the model, set to optimized.

* @public */ - export interface ServiceQuotaExceededExceptionMember { - flowOutputEvent?: never; - flowCompletionEvent?: never; - flowTraceEvent?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException: ServiceQuotaExceededException; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - flowMultiTurnInputRequestEvent?: never; - $unknown?: never; - } + latency?: PerformanceConfigLatency | undefined; +} +/** + *

The performance configuration for a model called with InvokeFlow.

+ * @public + */ +export interface ModelPerformanceConfiguration { /** - *

The number of requests exceeds the limit. Resubmit your request later.

+ *

The latency configuration for the model.

* @public */ - export interface ThrottlingExceptionMember { - flowOutputEvent?: never; - flowCompletionEvent?: never; - flowTraceEvent?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException: ThrottlingException; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - flowMultiTurnInputRequestEvent?: never; - $unknown?: never; - } + performanceConfig?: PerformanceConfiguration | undefined; +} +/** + * @public + */ +export interface StartFlowExecutionRequest { /** - *

The request is denied because of missing access permissions. Check your permissions and retry your request.

+ *

The unique identifier of the flow to execute.

* @public */ - export interface AccessDeniedExceptionMember { - flowOutputEvent?: never; - flowCompletionEvent?: never; - flowTraceEvent?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException: AccessDeniedException; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - flowMultiTurnInputRequestEvent?: never; - $unknown?: never; - } + flowIdentifier: string | undefined; /** - *

There was a conflict performing an operation. Resolve the conflict and retry your request.

+ *

The unique identifier of the flow alias to use for the async execution.

* @public */ - export interface ConflictExceptionMember { - flowOutputEvent?: never; - flowCompletionEvent?: never; - flowTraceEvent?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException: ConflictException; - dependencyFailedException?: never; - badGatewayException?: never; - flowMultiTurnInputRequestEvent?: never; - $unknown?: never; - } + flowAliasIdentifier: string | undefined; /** - *

There was an issue with a dependency. Check the resource configurations and retry the request.

+ *

The unique name for the async execution. If you don't provide one, a system-generated name is used.

* @public */ - export interface DependencyFailedExceptionMember { - flowOutputEvent?: never; - flowCompletionEvent?: never; - flowTraceEvent?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException: DependencyFailedException; - badGatewayException?: never; - flowMultiTurnInputRequestEvent?: never; - $unknown?: never; - } + flowExecutionName?: string | undefined; /** - *

There was an issue with a dependency due to a server issue. Retry your request.

+ *

The input data required for the async execution. This must match the input schema defined in the flow.

* @public */ - export interface BadGatewayExceptionMember { - flowOutputEvent?: never; - flowCompletionEvent?: never; - flowTraceEvent?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException: BadGatewayException; - flowMultiTurnInputRequestEvent?: never; - $unknown?: never; - } + inputs: FlowInput[] | undefined; /** - *

The event stream containing the multi-turn input request information from the flow.

+ *

The performance settings for the foundation model used in the async execution.

* @public */ - export interface FlowMultiTurnInputRequestEventMember { - flowOutputEvent?: never; - flowCompletionEvent?: never; - flowTraceEvent?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - flowMultiTurnInputRequestEvent: FlowMultiTurnInputRequestEvent; - $unknown?: never; - } + modelPerformanceConfiguration?: ModelPerformanceConfiguration | undefined; +} +/** + * @public + */ +export interface StartFlowExecutionResponse { /** + *

The Amazon Resource Name (ARN) that uniquely identifies the async execution.

* @public */ - export interface $UnknownMember { - flowOutputEvent?: never; - flowCompletionEvent?: never; - flowTraceEvent?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - flowMultiTurnInputRequestEvent?: never; - $unknown: [string, any]; - } - - export interface Visitor { - flowOutputEvent: (value: FlowOutputEvent) => T; - flowCompletionEvent: (value: FlowCompletionEvent) => T; - flowTraceEvent: (value: FlowTraceEvent) => T; - internalServerException: (value: InternalServerException) => T; - validationException: (value: ValidationException) => T; - resourceNotFoundException: (value: ResourceNotFoundException) => T; - serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T; - throttlingException: (value: ThrottlingException) => T; - accessDeniedException: (value: AccessDeniedException) => T; - conflictException: (value: ConflictException) => T; - dependencyFailedException: (value: DependencyFailedException) => T; - badGatewayException: (value: BadGatewayException) => T; - flowMultiTurnInputRequestEvent: (value: FlowMultiTurnInputRequestEvent) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: FlowResponseStream, visitor: Visitor): T => { - if (value.flowOutputEvent !== undefined) return visitor.flowOutputEvent(value.flowOutputEvent); - if (value.flowCompletionEvent !== undefined) return visitor.flowCompletionEvent(value.flowCompletionEvent); - if (value.flowTraceEvent !== undefined) return visitor.flowTraceEvent(value.flowTraceEvent); - if (value.internalServerException !== undefined) - return visitor.internalServerException(value.internalServerException); - if (value.validationException !== undefined) return visitor.validationException(value.validationException); - if (value.resourceNotFoundException !== undefined) - return visitor.resourceNotFoundException(value.resourceNotFoundException); - if (value.serviceQuotaExceededException !== undefined) - return visitor.serviceQuotaExceededException(value.serviceQuotaExceededException); - if (value.throttlingException !== undefined) return visitor.throttlingException(value.throttlingException); - if (value.accessDeniedException !== undefined) return visitor.accessDeniedException(value.accessDeniedException); - if (value.conflictException !== undefined) return visitor.conflictException(value.conflictException); - if (value.dependencyFailedException !== undefined) - return visitor.dependencyFailedException(value.dependencyFailedException); - if (value.badGatewayException !== undefined) return visitor.badGatewayException(value.badGatewayException); - if (value.flowMultiTurnInputRequestEvent !== undefined) - return visitor.flowMultiTurnInputRequestEvent(value.flowMultiTurnInputRequestEvent); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + executionArn?: string | undefined; } /** * @public */ -export interface InvokeFlowResponse { +export interface StopFlowExecutionRequest { /** - *

The output of the flow, returned as a stream. If there's an error, the error is returned.

+ *

The unique identifier of the flow.

* @public */ - responseStream: AsyncIterable | undefined; + flowIdentifier: string | undefined; /** - *

The unique identifier for the current flow execution.

+ *

The unique identifier of the flow alias used for the execution.

* @public */ - executionId?: string | undefined; -} + flowAliasIdentifier: string | undefined; -/** - * @public - * @enum - */ -export const InputQueryType = { - TEXT: "TEXT", -} as const; - -/** - * @public - */ -export type InputQueryType = (typeof InputQueryType)[keyof typeof InputQueryType]; + /** + *

The unique identifier of the async execution to stop.

+ * @public + */ + executionIdentifier: string | undefined; +} /** - *

Contains information about a natural language query to transform into SQL.

* @public */ -export interface QueryGenerationInput { +export interface StopFlowExecutionResponse { /** - *

The type of the query.

+ *

The Amazon Resource Name (ARN) that uniquely identifies the async execution that was stopped.

* @public */ - type: InputQueryType | undefined; + executionArn?: string | undefined; /** - *

The text of the query.

+ *

The updated status of the async execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.

* @public */ - text: string | undefined; + status: FlowExecutionStatus | undefined; } /** * @public - * @enum */ -export const QueryTransformationMode = { - TEXT_TO_SQL: "TEXT_TO_SQL", -} as const; +export interface InvokeFlowRequest { + /** + *

The unique identifier of the flow.

+ * @public + */ + flowIdentifier: string | undefined; -/** - * @public - */ -export type QueryTransformationMode = (typeof QueryTransformationMode)[keyof typeof QueryTransformationMode]; + /** + *

The unique identifier of the flow alias.

+ * @public + */ + flowAliasIdentifier: string | undefined; -/** - *

Contains configurations for a knowledge base to use in transformation.

- * @public - */ -export interface TextToSqlKnowledgeBaseConfiguration { /** - *

The ARN of the knowledge base

+ *

A list of objects, each containing information about an input into the flow.

* @public */ - knowledgeBaseArn: string | undefined; + inputs: FlowInput[] | undefined; + + /** + *

Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

+ * @public + */ + enableTrace?: boolean | undefined; + + /** + *

Model performance settings for the request.

+ * @public + */ + modelPerformanceConfiguration?: ModelPerformanceConfiguration | undefined; + + /** + *

The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.

+ * @public + */ + executionId?: string | undefined; } /** * @public * @enum */ -export const TextToSqlConfigurationType = { - KNOWLEDGE_BASE: "KNOWLEDGE_BASE", +export const FlowCompletionReason = { + INPUT_REQUIRED: "INPUT_REQUIRED", + SUCCESS: "SUCCESS", } as const; /** * @public */ -export type TextToSqlConfigurationType = (typeof TextToSqlConfigurationType)[keyof typeof TextToSqlConfigurationType]; +export type FlowCompletionReason = (typeof FlowCompletionReason)[keyof typeof FlowCompletionReason]; /** - *

Contains configurations for transforming text to SQL.

+ *

Contains information about why a flow completed.

* @public */ -export interface TextToSqlConfiguration { - /** - *

The type of resource to use in transformation.

- * @public - */ - type: TextToSqlConfigurationType | undefined; - +export interface FlowCompletionEvent { /** - *

Specifies configurations for a knowledge base to use in transformation.

+ *

The reason that the flow completed.

* @public */ - knowledgeBaseConfiguration?: TextToSqlKnowledgeBaseConfiguration | undefined; + completionReason: FlowCompletionReason | undefined; } /** - *

Contains configurations for transforming the natural language query into SQL.

+ *

The content structure containing input information for multi-turn flow interactions.

* @public */ -export interface TransformationConfiguration { - /** - *

The mode of the transformation.

- * @public - */ - mode: QueryTransformationMode | undefined; - - /** - *

Specifies configurations for transforming text to SQL.

- * @public - */ - textToSqlConfiguration?: TextToSqlConfiguration | undefined; -} +export type FlowMultiTurnInputContent = + | FlowMultiTurnInputContent.DocumentMember + | FlowMultiTurnInputContent.$UnknownMember; /** * @public */ -export interface GenerateQueryRequest { +export namespace FlowMultiTurnInputContent { /** - *

Specifies information about a natural language query to transform into SQL.

+ *

The requested additional input to send back to the multi-turn flow node.

* @public */ - queryGenerationInput: QueryGenerationInput | undefined; + export interface DocumentMember { + document: __DocumentType; + $unknown?: never; + } /** - *

Specifies configurations for transforming the natural language query into SQL.

* @public */ - transformationConfiguration: TransformationConfiguration | undefined; + export interface $UnknownMember { + document?: never; + $unknown: [string, any]; + } + + export interface Visitor { + document: (value: __DocumentType) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: FlowMultiTurnInputContent, visitor: Visitor): T => { + if (value.document !== undefined) return visitor.document(value.document); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** * @public * @enum */ -export const GeneratedQueryType = { - REDSHIFT_SQL: "REDSHIFT_SQL", +export const NodeType = { + CONDITION_NODE: "ConditionNode", + FLOW_INPUT_NODE: "FlowInputNode", + FLOW_OUTPUT_NODE: "FlowOutputNode", + KNOWLEDGE_BASE_NODE: "KnowledgeBaseNode", + LAMBDA_FUNCTION_NODE: "LambdaFunctionNode", + LEX_NODE: "LexNode", + PROMPT_NODE: "PromptNode", } as const; /** * @public */ -export type GeneratedQueryType = (typeof GeneratedQueryType)[keyof typeof GeneratedQueryType]; +export type NodeType = (typeof NodeType)[keyof typeof NodeType]; /** - *

Contains information about a query generated for a natural language query.

+ *

Response object from the flow multi-turn node requesting additional information.

* @public */ -export interface GeneratedQuery { - /** - *

The type of transformed query.

- * @public - */ - type?: GeneratedQueryType | undefined; - +export interface FlowMultiTurnInputRequestEvent { /** - *

An SQL query that corresponds to the natural language query.

+ *

The name of the node in the flow that is requesting the input.

* @public */ - sql?: string | undefined; -} + nodeName: string | undefined; -/** - * @public - */ -export interface GenerateQueryResponse { /** - *

A list of objects, each of which defines a generated query that can correspond to the natural language queries.

+ *

The type of the node in the flow that is requesting the input.

* @public */ - queries?: GeneratedQuery[] | undefined; -} + nodeType: NodeType | undefined; -/** - *

Settings for a model called with InvokeAgent.

- * @public - */ -export interface BedrockModelConfigurations { /** - *

The performance configuration for the model.

+ *

The content payload containing the input request details for the multi-turn interaction.

* @public */ - performanceConfig?: PerformanceConfiguration | undefined; + content: FlowMultiTurnInputContent | undefined; } /** - *

A content block.

+ *

Contains information about the content in an output from prompt flow invocation.

* @public */ -export type ContentBlock = ContentBlock.TextMember | ContentBlock.$UnknownMember; +export type FlowOutputContent = FlowOutputContent.DocumentMember | FlowOutputContent.$UnknownMember; /** * @public */ -export namespace ContentBlock { +export namespace FlowOutputContent { /** - *

The block's text.

+ *

The content in the output.

* @public */ - export interface TextMember { - text: string; + export interface DocumentMember { + document: __DocumentType; $unknown?: never; } @@ -2620,318 +2639,217 @@ export namespace ContentBlock { * @public */ export interface $UnknownMember { - text?: never; + document?: never; $unknown: [string, any]; } export interface Visitor { - text: (value: string) => T; + document: (value: __DocumentType) => T; _: (name: string, value: any) => T; } - export const visit = (value: ContentBlock, visitor: Visitor): T => { - if (value.text !== undefined) return visitor.text(value.text); + export const visit = (value: FlowOutputContent, visitor: Visitor): T => { + if (value.document !== undefined) return visitor.document(value.document); return visitor._(value.$unknown[0], value.$unknown[1]); }; } /** - * @public - * @enum - */ -export const ConversationRole = { - ASSISTANT: "assistant", - USER: "user", -} as const; - -/** + *

Contains information about an output from prompt flow invoction.

* @public */ -export type ConversationRole = (typeof ConversationRole)[keyof typeof ConversationRole]; +export interface FlowOutputEvent { + /** + *

The name of the flow output node that the output is from.

+ * @public + */ + nodeName: string | undefined; -/** - *

Details about a message.

- * @public - */ -export interface Message { /** - *

The message's role.

+ *

The type of the node that the output is from.

* @public */ - role: ConversationRole | undefined; + nodeType: NodeType | undefined; /** - *

The message's content.

+ *

The content in the output.

* @public */ - content: ContentBlock[] | undefined; + content: FlowOutputContent | undefined; } /** - *

A conversation history.

+ *

Contains information about a condition that was satisfied. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

* @public */ -export interface ConversationHistory { +export interface FlowTraceCondition { /** - *

The conversation's messages.

+ *

The name of the condition.

* @public */ - messages?: Message[] | undefined; + conditionName: string | undefined; } /** - *

The property contains the file to chat with, along with its attributes.

+ *

Contains information about an output from a condition node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

* @public */ -export interface ByteContentFile { +export interface FlowTraceConditionNodeResultEvent { /** - *

The MIME type of data contained in the file used for chat.

+ *

The name of the condition node.

* @public */ - mediaType: string | undefined; + nodeName: string | undefined; /** - *

The raw bytes of the file to attach. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files.

+ *

The date and time that the trace was returned.

* @public */ - data: Uint8Array | undefined; + timestamp: Date | undefined; + + /** + *

An array of objects containing information about the conditions that were satisfied.

+ * @public + */ + satisfiedConditions: FlowTraceCondition[] | undefined; } /** - *

Contains details of the s3 object where the source file is located.

+ *

Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes, agent nodes, and Amazon Web Services Lambda nodes.

* @public */ -export interface S3ObjectFile { +export interface FlowTraceNodeActionEvent { /** - *

The uri of the s3 object.

+ *

The name of the node that called the operation.

* @public */ - uri: string | undefined; -} - -/** - * @public - * @enum - */ -export const FileSourceType = { - BYTE_CONTENT: "BYTE_CONTENT", - S3: "S3", -} as const; + nodeName: string | undefined; -/** - * @public - */ -export type FileSourceType = (typeof FileSourceType)[keyof typeof FileSourceType]; + /** + *

The date and time that the operation was called.

+ * @public + */ + timestamp: Date | undefined; -/** - *

The source file of the content contained in the wrapper object.

- * @public - */ -export interface FileSource { /** - *

The source type of the files to attach.

+ *

The ID of the request that the node made to the operation.

* @public */ - sourceType: FileSourceType | undefined; + requestId: string | undefined; /** - *

The s3 location of the files to attach.

+ *

The name of the service that the node called.

* @public */ - s3Location?: S3ObjectFile | undefined; + serviceName: string | undefined; /** - *

The data and the text of the attached files.

+ *

The name of the operation that the node called.

* @public */ - byteContent?: ByteContentFile | undefined; + operationName: string | undefined; } /** - * @public - * @enum - */ -export const FileUseCase = { - CHAT: "CHAT", - CODE_INTERPRETER: "CODE_INTERPRETER", -} as const; - -/** + *

Contains the content of the node input. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

* @public */ -export type FileUseCase = (typeof FileUseCase)[keyof typeof FileUseCase]; +export type FlowTraceNodeInputContent = + | FlowTraceNodeInputContent.DocumentMember + | FlowTraceNodeInputContent.$UnknownMember; /** - *

Contains details of the source files.

* @public */ -export interface InputFile { - /** - *

The name of the source file.

- * @public - */ - name: string | undefined; - +export namespace FlowTraceNodeInputContent { /** - *

Specifies where the files are located.

+ *

The content of the node input.

* @public */ - source: FileSource | undefined; + export interface DocumentMember { + document: __DocumentType; + $unknown?: never; + } /** - *

Specifies how the source files will be used by the code interpreter.

* @public */ - useCase: FileUseCase | undefined; -} + export interface $UnknownMember { + document?: never; + $unknown: [string, any]; + } -/** - *

Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.

This data type is used in the following API operations:

- * @public - */ -export interface FilterAttribute { - /** - *

The name that the metadata attribute must match.

- * @public - */ - key: string | undefined; + export interface Visitor { + document: (value: __DocumentType) => T; + _: (name: string, value: any) => T; + } - /** - *

The value to whcih to compare the value of the metadata attribute.

- * @public - */ - value: __DocumentType | undefined; + export const visit = (value: FlowTraceNodeInputContent, visitor: Visitor): T => { + if (value.document !== undefined) return visitor.document(value.document); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** - * @public - * @enum - */ -export const AttributeType = { - BOOLEAN: "BOOLEAN", - NUMBER: "NUMBER", - STRING: "STRING", - STRING_LIST: "STRING_LIST", -} as const; - -/** - * @public - */ -export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType]; - -/** - *

Details about a metadata attribute.

+ *

Contains information about a field in the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

* @public */ -export interface MetadataAttributeSchema { - /** - *

The attribute's key.

- * @public - */ - key: string | undefined; - +export interface FlowTraceNodeInputField { /** - *

The attribute's type.

+ *

The name of the node input.

* @public */ - type: AttributeType | undefined; + nodeInputName: string | undefined; /** - *

The attribute's description.

+ *

The content of the node input.

* @public */ - description: string | undefined; + content: FlowTraceNodeInputContent | undefined; } /** - *

Settings for implicit filtering, where a model generates a metadata filter based on the prompt.

+ *

Contains information about the input into a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

* @public */ -export interface ImplicitFilterConfiguration { +export interface FlowTraceNodeInputEvent { /** - *

Metadata that can be used in a filter.

+ *

The name of the node that received the input.

* @public */ - metadataAttributes: MetadataAttributeSchema[] | undefined; + nodeName: string | undefined; /** - *

The model that generates the filter.

+ *

The date and time that the trace was returned.

* @public */ - modelArn: string | undefined; -} - -/** - * @public - * @enum - */ -export const SearchType = { - HYBRID: "HYBRID", - SEMANTIC: "SEMANTIC", -} as const; - -/** - * @public - */ -export type SearchType = (typeof SearchType)[keyof typeof SearchType]; - -/** - * @public - * @enum - */ -export const RerankingMetadataSelectionMode = { - ALL: "ALL", - SELECTIVE: "SELECTIVE", -} as const; - -/** - * @public - */ -export type RerankingMetadataSelectionMode = - (typeof RerankingMetadataSelectionMode)[keyof typeof RerankingMetadataSelectionMode]; + timestamp: Date | undefined; -/** - *

Contains information for a metadata field to include in or exclude from consideration when reranking.

- * @public - */ -export interface FieldForReranking { /** - *

The name of a metadata field to include in or exclude from consideration when reranking.

+ *

An array of objects containing information about each field in the input.

* @public */ - fieldName: string | undefined; + fields: FlowTraceNodeInputField[] | undefined; } /** - *

Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the fieldsToExclude field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.

+ *

Contains the content of the node output. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

* @public */ -export type RerankingMetadataSelectiveModeConfiguration = - | RerankingMetadataSelectiveModeConfiguration.FieldsToExcludeMember - | RerankingMetadataSelectiveModeConfiguration.FieldsToIncludeMember - | RerankingMetadataSelectiveModeConfiguration.$UnknownMember; +export type FlowTraceNodeOutputContent = + | FlowTraceNodeOutputContent.DocumentMember + | FlowTraceNodeOutputContent.$UnknownMember; /** * @public */ -export namespace RerankingMetadataSelectiveModeConfiguration { - /** - *

An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.

- * @public - */ - export interface FieldsToIncludeMember { - fieldsToInclude: FieldForReranking[]; - fieldsToExclude?: never; - $unknown?: never; - } - +export namespace FlowTraceNodeOutputContent { /** - *

An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.

+ *

The content of the node output.

* @public */ - export interface FieldsToExcludeMember { - fieldsToInclude?: never; - fieldsToExclude: FieldForReranking[]; + export interface DocumentMember { + document: __DocumentType; $unknown?: never; } @@ -2939,1392 +2857,1052 @@ export namespace RerankingMetadataSelectiveModeConfiguration { * @public */ export interface $UnknownMember { - fieldsToInclude?: never; - fieldsToExclude?: never; + document?: never; $unknown: [string, any]; } export interface Visitor { - fieldsToInclude: (value: FieldForReranking[]) => T; - fieldsToExclude: (value: FieldForReranking[]) => T; + document: (value: __DocumentType) => T; _: (name: string, value: any) => T; } - export const visit = (value: RerankingMetadataSelectiveModeConfiguration, visitor: Visitor): T => { - if (value.fieldsToInclude !== undefined) return visitor.fieldsToInclude(value.fieldsToInclude); - if (value.fieldsToExclude !== undefined) return visitor.fieldsToExclude(value.fieldsToExclude); + export const visit = (value: FlowTraceNodeOutputContent, visitor: Visitor): T => { + if (value.document !== undefined) return visitor.document(value.document); return visitor._(value.$unknown[0], value.$unknown[1]); }; } /** - *

Contains configurations for the metadata to use in reranking.

+ *

Contains information about a field in the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

* @public */ -export interface MetadataConfigurationForReranking { +export interface FlowTraceNodeOutputField { /** - *

Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify SELECTIVE, include the selectiveModeConfiguration field.

+ *

The name of the node output.

* @public */ - selectionMode: RerankingMetadataSelectionMode | undefined; + nodeOutputName: string | undefined; /** - *

Contains configurations for the metadata fields to include or exclude when considering reranking.

+ *

The content of the node output.

* @public */ - selectiveModeConfiguration?: RerankingMetadataSelectiveModeConfiguration | undefined; + content: FlowTraceNodeOutputContent | undefined; } /** - *

Contains configurations for an Amazon Bedrock reranker model.

+ *

Contains information about the output from a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

* @public */ -export interface VectorSearchBedrockRerankingModelConfiguration { +export interface FlowTraceNodeOutputEvent { /** - *

The ARN of the reranker model to use.

+ *

The name of the node that yielded the output.

* @public */ - modelArn: string | undefined; + nodeName: string | undefined; /** - *

A JSON object whose keys are request fields for the model and whose values are values for those fields.

+ *

The date and time that the trace was returned.

* @public */ - additionalModelRequestFields?: Record | undefined; + timestamp: Date | undefined; + + /** + *

An array of objects containing information about each field in the output.

+ * @public + */ + fields: FlowTraceNodeOutputField[] | undefined; } /** - *

Contains configurations for reranking with an Amazon Bedrock reranker model.

+ *

Contains information about an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

* @public */ -export interface VectorSearchBedrockRerankingConfiguration { +export type FlowTrace = + | FlowTrace.ConditionNodeResultTraceMember + | FlowTrace.NodeActionTraceMember + | FlowTrace.NodeInputTraceMember + | FlowTrace.NodeOutputTraceMember + | FlowTrace.$UnknownMember; + +/** + * @public + */ +export namespace FlowTrace { /** - *

Contains configurations for the reranker model.

+ *

Contains information about the input into a node.

* @public */ - modelConfiguration: VectorSearchBedrockRerankingModelConfiguration | undefined; + export interface NodeInputTraceMember { + nodeInputTrace: FlowTraceNodeInputEvent; + nodeOutputTrace?: never; + conditionNodeResultTrace?: never; + nodeActionTrace?: never; + $unknown?: never; + } /** - *

The number of results to return after reranking.

+ *

Contains information about the output from a node.

* @public */ - numberOfRerankedResults?: number | undefined; + export interface NodeOutputTraceMember { + nodeInputTrace?: never; + nodeOutputTrace: FlowTraceNodeOutputEvent; + conditionNodeResultTrace?: never; + nodeActionTrace?: never; + $unknown?: never; + } /** - *

Contains configurations for the metadata to use in reranking.

+ *

Contains information about an output from a condition node.

* @public */ - metadataConfiguration?: MetadataConfigurationForReranking | undefined; -} - -/** - * @public - * @enum - */ -export const VectorSearchRerankingConfigurationType = { - BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL", -} as const; - -/** - * @public - */ -export type VectorSearchRerankingConfigurationType = - (typeof VectorSearchRerankingConfigurationType)[keyof typeof VectorSearchRerankingConfigurationType]; + export interface ConditionNodeResultTraceMember { + nodeInputTrace?: never; + nodeOutputTrace?: never; + conditionNodeResultTrace: FlowTraceConditionNodeResultEvent; + nodeActionTrace?: never; + $unknown?: never; + } -/** - *

Contains configurations for reranking the retrieved results.

- * @public - */ -export interface VectorSearchRerankingConfiguration { /** - *

The type of reranker model.

+ *

Contains information about an action (operation) called by a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

* @public */ - type: VectorSearchRerankingConfigurationType | undefined; + export interface NodeActionTraceMember { + nodeInputTrace?: never; + nodeOutputTrace?: never; + conditionNodeResultTrace?: never; + nodeActionTrace: FlowTraceNodeActionEvent; + $unknown?: never; + } /** - *

Contains configurations for an Amazon Bedrock reranker model.

* @public */ - bedrockRerankingConfiguration?: VectorSearchBedrockRerankingConfiguration | undefined; + export interface $UnknownMember { + nodeInputTrace?: never; + nodeOutputTrace?: never; + conditionNodeResultTrace?: never; + nodeActionTrace?: never; + $unknown: [string, any]; + } + + export interface Visitor { + nodeInputTrace: (value: FlowTraceNodeInputEvent) => T; + nodeOutputTrace: (value: FlowTraceNodeOutputEvent) => T; + conditionNodeResultTrace: (value: FlowTraceConditionNodeResultEvent) => T; + nodeActionTrace: (value: FlowTraceNodeActionEvent) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: FlowTrace, visitor: Visitor): T => { + if (value.nodeInputTrace !== undefined) return visitor.nodeInputTrace(value.nodeInputTrace); + if (value.nodeOutputTrace !== undefined) return visitor.nodeOutputTrace(value.nodeOutputTrace); + if (value.conditionNodeResultTrace !== undefined) + return visitor.conditionNodeResultTrace(value.conditionNodeResultTrace); + if (value.nodeActionTrace !== undefined) return visitor.nodeActionTrace(value.nodeActionTrace); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** - *

Configurations for streaming.

+ *

Contains information about a trace, which tracks an input or output for a node in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

* @public */ -export interface StreamingConfigurations { - /** - *

Specifies whether to enable streaming for the final response. This is set to false by default.

- * @public - */ - streamFinalResponse?: boolean | undefined; - +export interface FlowTraceEvent { /** - *

The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer ApplyGuardrail calls. The following examples show the response generated for Hello, I am an agent input string.

Example response in chunks: Interval set to 3 characters

'Hel', 'lo, ','I am', ' an', ' Age', 'nt'

Each chunk has at least 3 characters except for the last chunk

Example response in chunks: Interval set to 20 or more characters

Hello, I am an Agent

+ *

The trace object containing information about an input or output for a node in the flow.

* @public */ - applyGuardrailInterval?: number | undefined; + trace: FlowTrace | undefined; } /** - *

Contains information about where the text with a citation begins and ends in the generated output.

This data type is used in the following API operations:

+ *

The output of the flow.

* @public */ -export interface Span { - /** - *

Where the text with a citation starts in the generated output.

- * @public - */ - start?: number | undefined; - - /** - *

Where the text with a citation ends in the generated output.

- * @public - */ - end?: number | undefined; -} +export type FlowResponseStream = + | FlowResponseStream.AccessDeniedExceptionMember + | FlowResponseStream.BadGatewayExceptionMember + | FlowResponseStream.ConflictExceptionMember + | FlowResponseStream.DependencyFailedExceptionMember + | FlowResponseStream.FlowCompletionEventMember + | FlowResponseStream.FlowMultiTurnInputRequestEventMember + | FlowResponseStream.FlowOutputEventMember + | FlowResponseStream.FlowTraceEventMember + | FlowResponseStream.InternalServerExceptionMember + | FlowResponseStream.ResourceNotFoundExceptionMember + | FlowResponseStream.ServiceQuotaExceededExceptionMember + | FlowResponseStream.ThrottlingExceptionMember + | FlowResponseStream.ValidationExceptionMember + | FlowResponseStream.$UnknownMember; /** - *

Contains the part of the generated text that contains a citation, alongside where it begins and ends.

This data type is used in the following API operations:

* @public */ -export interface TextResponsePart { +export namespace FlowResponseStream { /** - *

The part of the generated text that contains a citation.

+ *

Contains information about an output from flow invocation.

* @public */ - text?: string | undefined; + export interface FlowOutputEventMember { + flowOutputEvent: FlowOutputEvent; + flowCompletionEvent?: never; + flowTraceEvent?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + flowMultiTurnInputRequestEvent?: never; + $unknown?: never; + } /** - *

Contains information about where the text with a citation begins and ends in the generated output.

+ *

Contains information about why the flow completed.

* @public */ - span?: Span | undefined; -} + export interface FlowCompletionEventMember { + flowOutputEvent?: never; + flowCompletionEvent: FlowCompletionEvent; + flowTraceEvent?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + flowMultiTurnInputRequestEvent?: never; + $unknown?: never; + } -/** - *

Contains metadata about a part of the generated response that is accompanied by a citation.

This data type is used in the following API operations:

- * @public - */ -export interface GeneratedResponsePart { /** - *

Contains metadata about a textual part of the generated response that is accompanied by a citation.

+ *

Contains information about a trace, which tracks an input or output for a node in the flow.

* @public */ - textResponsePart?: TextResponsePart | undefined; -} - -/** - * @public - * @enum - */ -export const RetrievalResultContentColumnType = { - BLOB: "BLOB", - BOOLEAN: "BOOLEAN", - DOUBLE: "DOUBLE", - LONG: "LONG", - NULL: "NULL", - STRING: "STRING", -} as const; - -/** - * @public - */ -export type RetrievalResultContentColumnType = - (typeof RetrievalResultContentColumnType)[keyof typeof RetrievalResultContentColumnType]; + export interface FlowTraceEventMember { + flowOutputEvent?: never; + flowCompletionEvent?: never; + flowTraceEvent: FlowTraceEvent; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + flowMultiTurnInputRequestEvent?: never; + $unknown?: never; + } -/** - *

Contains information about a column with a cell to return in retrieval.

- * @public - */ -export interface RetrievalResultContentColumn { /** - *

The name of the column.

+ *

An internal server error occurred. Retry your request.

* @public */ - columnName?: string | undefined; + export interface InternalServerExceptionMember { + flowOutputEvent?: never; + flowCompletionEvent?: never; + flowTraceEvent?: never; + internalServerException: InternalServerException; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + flowMultiTurnInputRequestEvent?: never; + $unknown?: never; + } /** - *

The value in the column.

+ *

Input validation failed. Check your request parameters and retry the request.

* @public */ - columnValue?: string | undefined; - - /** - *

The data type of the value.

- * @public - */ - type?: RetrievalResultContentColumnType | undefined; -} - -/** - * @public - * @enum - */ -export const RetrievalResultContentType = { - IMAGE: "IMAGE", - ROW: "ROW", - TEXT: "TEXT", -} as const; - -/** - * @public - */ -export type RetrievalResultContentType = (typeof RetrievalResultContentType)[keyof typeof RetrievalResultContentType]; - -/** - *

Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.

This data type is used in the following API operations:

- * @public - */ -export interface RetrievalResultContent { - /** - *

The type of content in the retrieval result.

- * @public - */ - type?: RetrievalResultContentType | undefined; - - /** - *

The cited text from the data source.

- * @public - */ - text?: string | undefined; - - /** - *

A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,$\{base64-encoded string\}.

- * @public - */ - byteContent?: string | undefined; - - /** - *

Specifies information about the rows with the cells to return in retrieval.

- * @public - */ - row?: RetrievalResultContentColumn[] | undefined; -} - -/** - *

The Confluence data source location.

- * @public - */ -export interface RetrievalResultConfluenceLocation { - /** - *

The Confluence host URL for the data source location.

- * @public - */ - url?: string | undefined; -} - -/** - *

Contains information about the location of a document in a custom data source.

- * @public - */ -export interface RetrievalResultCustomDocumentLocation { - /** - *

The ID of the document.

- * @public - */ - id?: string | undefined; -} - -/** - *

The location of a result in Amazon Kendra.

- * @public - */ -export interface RetrievalResultKendraDocumentLocation { - /** - *

The document's uri.

- * @public - */ - uri?: string | undefined; -} - -/** - *

The S3 data source location.

This data type is used in the following API operations:

- * @public - */ -export interface RetrievalResultS3Location { - /** - *

The S3 URI for the data source location.

- * @public - */ - uri?: string | undefined; -} - -/** - *

The Salesforce data source location.

- * @public - */ -export interface RetrievalResultSalesforceLocation { - /** - *

The Salesforce host URL for the data source location.

- * @public - */ - url?: string | undefined; -} - -/** - *

The SharePoint data source location.

- * @public - */ -export interface RetrievalResultSharePointLocation { - /** - *

The SharePoint site URL for the data source location.

- * @public - */ - url?: string | undefined; -} - -/** - *

Contains information about the SQL query used to retrieve the result.

- * @public - */ -export interface RetrievalResultSqlLocation { - /** - *

The SQL query used to retrieve the result.

- * @public - */ - query?: string | undefined; -} - -/** - * @public - * @enum - */ -export const RetrievalResultLocationType = { - CONFLUENCE: "CONFLUENCE", - CUSTOM: "CUSTOM", - KENDRA: "KENDRA", - S3: "S3", - SALESFORCE: "SALESFORCE", - SHAREPOINT: "SHAREPOINT", - SQL: "SQL", - WEB: "WEB", -} as const; - -/** - * @public - */ -export type RetrievalResultLocationType = - (typeof RetrievalResultLocationType)[keyof typeof RetrievalResultLocationType]; - -/** - *

The web URL/URLs data source location.

- * @public - */ -export interface RetrievalResultWebLocation { - /** - *

The web URL/URLs for the data source location.

- * @public - */ - url?: string | undefined; -} - -/** - *

Contains information about the data source location.

This data type is used in the following API operations:

- * @public - */ -export interface RetrievalResultLocation { - /** - *

The type of data source location.

- * @public - */ - type: RetrievalResultLocationType | undefined; - - /** - *

The S3 data source location.

- * @public - */ - s3Location?: RetrievalResultS3Location | undefined; - - /** - *

The web URL/URLs data source location.

- * @public - */ - webLocation?: RetrievalResultWebLocation | undefined; - - /** - *

The Confluence data source location.

- * @public - */ - confluenceLocation?: RetrievalResultConfluenceLocation | undefined; - - /** - *

The Salesforce data source location.

- * @public - */ - salesforceLocation?: RetrievalResultSalesforceLocation | undefined; - - /** - *

The SharePoint data source location.

- * @public - */ - sharePointLocation?: RetrievalResultSharePointLocation | undefined; - - /** - *

Specifies the location of a document in a custom data source.

- * @public - */ - customDocumentLocation?: RetrievalResultCustomDocumentLocation | undefined; - - /** - *

The location of a document in Amazon Kendra.

- * @public - */ - kendraDocumentLocation?: RetrievalResultKendraDocumentLocation | undefined; - - /** - *

Specifies information about the SQL query used to retrieve the result.

- * @public - */ - sqlLocation?: RetrievalResultSqlLocation | undefined; -} - -/** - *

Contains metadata about a source cited for the generated response.

This data type is used in the following API operations:

- * @public - */ -export interface RetrievedReference { - /** - *

Contains the cited text from the data source.

- * @public - */ - content?: RetrievalResultContent | undefined; - - /** - *

Contains information about the location of the data source.

- * @public - */ - location?: RetrievalResultLocation | undefined; - - /** - *

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

- * @public - */ - metadata?: Record | undefined; -} - -/** - *

An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.

This data type is used in the following API operations:

- * @public - */ -export interface Citation { - /** - *

Contains the generated response and metadata

- * @public - */ - generatedResponsePart?: GeneratedResponsePart | undefined; - - /** - *

Contains metadata about the sources cited for the generated response.

- * @public - */ - retrievedReferences?: RetrievedReference[] | undefined; -} - -/** - *

Contains citations for a part of an agent response.

- * @public - */ -export interface Attribution { - /** - *

A list of citations and related information for a part of an agent response.

- * @public - */ - citations?: Citation[] | undefined; -} - -/** - *

Contains a part of an agent response and citations for it.

- * @public - */ -export interface PayloadPart { - /** - *

A part of the agent response in bytes.

- * @public - */ - bytes?: Uint8Array | undefined; - - /** - *

Contains citations for a part of an agent response.

- * @public - */ - attribution?: Attribution | undefined; -} - -/** - *

Contains details of the response from code interpreter.

- * @public - */ -export interface OutputFile { - /** - *

The name of the file containing response from code interpreter.

- * @public - */ - name?: string | undefined; - - /** - *

The type of file that contains response from the code interpreter.

- * @public - */ - type?: string | undefined; - - /** - *

The byte count of files that contains response from code interpreter.

- * @public - */ - bytes?: Uint8Array | undefined; -} - -/** - *

Contains intermediate response for code interpreter if any files have been generated.

- * @public - */ -export interface FilePart { - /** - *

Files containing intermediate response for the user.

- * @public - */ - files?: OutputFile[] | undefined; -} - -/** - *

The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.

- * @public - */ -export class ModelNotReadyException extends __BaseException { - readonly name: "ModelNotReadyException" = "ModelNotReadyException"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionType) { - super({ - name: "ModelNotReadyException", - $fault: "client", - ...opts, - }); - Object.setPrototypeOf(this, ModelNotReadyException.prototype); - } -} - -/** - *

Details about a caller.

- * @public - */ -export type Caller = Caller.AgentAliasArnMember | Caller.$UnknownMember; - -/** - * @public - */ -export namespace Caller { - /** - *

The caller's agent alias ARN.

- * @public - */ - export interface AgentAliasArnMember { - agentAliasArn: string; - $unknown?: never; - } - - /** - * @public - */ - export interface $UnknownMember { - agentAliasArn?: never; - $unknown: [string, any]; - } - - export interface Visitor { - agentAliasArn: (value: string) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: Caller, visitor: Visitor): T => { - if (value.agentAliasArn !== undefined) return visitor.agentAliasArn(value.agentAliasArn); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} - -/** - *

The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.

- * @public - */ -export interface CustomOrchestrationTraceEvent { - /** - *

The text that prompted the event at this step.

- * @public - */ - text?: string | undefined; -} - -/** - *

The trace behavior for the custom orchestration.

- * @public - */ -export interface CustomOrchestrationTrace { - /** - *

The unique identifier of the trace.

- * @public - */ - traceId?: string | undefined; - - /** - *

The event details used with the custom orchestration.

- * @public - */ - event?: CustomOrchestrationTraceEvent | undefined; -} - -/** - *

Contains information about the failure of the interaction.

- * @public - */ -export interface FailureTrace { - /** - *

The unique identifier of the trace.

- * @public - */ - traceId?: string | undefined; - - /** - *

The reason the interaction failed.

- * @public - */ - failureReason?: string | undefined; - - /** - *

The failure code for the trace.

- * @public - */ - failureCode?: number | undefined; - - /** - *

Information about the failure that occurred.

- * @public - */ - metadata?: Metadata | undefined; -} - -/** - * @public - * @enum - */ -export const GuardrailAction = { - INTERVENED: "INTERVENED", - NONE: "NONE", -} as const; - -/** - * @public - */ -export type GuardrailAction = (typeof GuardrailAction)[keyof typeof GuardrailAction]; - -/** - * @public - * @enum - */ -export const GuardrailContentPolicyAction = { - BLOCKED: "BLOCKED", -} as const; - -/** - * @public - */ -export type GuardrailContentPolicyAction = - (typeof GuardrailContentPolicyAction)[keyof typeof GuardrailContentPolicyAction]; - -/** - * @public - * @enum - */ -export const GuardrailContentFilterConfidence = { - HIGH: "HIGH", - LOW: "LOW", - MEDIUM: "MEDIUM", - NONE: "NONE", -} as const; - -/** - * @public - */ -export type GuardrailContentFilterConfidence = - (typeof GuardrailContentFilterConfidence)[keyof typeof GuardrailContentFilterConfidence]; - -/** - * @public - * @enum - */ -export const GuardrailContentFilterType = { - HATE: "HATE", - INSULTS: "INSULTS", - MISCONDUCT: "MISCONDUCT", - PROMPT_ATTACK: "PROMPT_ATTACK", - SEXUAL: "SEXUAL", - VIOLENCE: "VIOLENCE", -} as const; - -/** - * @public - */ -export type GuardrailContentFilterType = (typeof GuardrailContentFilterType)[keyof typeof GuardrailContentFilterType]; + export interface ValidationExceptionMember { + flowOutputEvent?: never; + flowCompletionEvent?: never; + flowTraceEvent?: never; + internalServerException?: never; + validationException: ValidationException; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + flowMultiTurnInputRequestEvent?: never; + $unknown?: never; + } -/** - *

Details of the content filter used in the Guardrail.

- * @public - */ -export interface GuardrailContentFilter { /** - *

The type of content detected in the filter by the Guardrail.

+ *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

* @public */ - type?: GuardrailContentFilterType | undefined; + export interface ResourceNotFoundExceptionMember { + flowOutputEvent?: never; + flowCompletionEvent?: never; + flowTraceEvent?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException: ResourceNotFoundException; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + flowMultiTurnInputRequestEvent?: never; + $unknown?: never; + } /** - *

The confidence level regarding the content detected in the filter by the Guardrail.

+ *

The number of requests exceeds the service quota. Resubmit your request later.

* @public */ - confidence?: GuardrailContentFilterConfidence | undefined; + export interface ServiceQuotaExceededExceptionMember { + flowOutputEvent?: never; + flowCompletionEvent?: never; + flowTraceEvent?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException: ServiceQuotaExceededException; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + flowMultiTurnInputRequestEvent?: never; + $unknown?: never; + } /** - *

The action placed on the content by the Guardrail filter.

+ *

The number of requests exceeds the limit. Resubmit your request later.

* @public */ - action?: GuardrailContentPolicyAction | undefined; -} + export interface ThrottlingExceptionMember { + flowOutputEvent?: never; + flowCompletionEvent?: never; + flowTraceEvent?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException: ThrottlingException; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + flowMultiTurnInputRequestEvent?: never; + $unknown?: never; + } -/** - *

The details of the policy assessment in the Guardrails filter.

- * @public - */ -export interface GuardrailContentPolicyAssessment { /** - *

The filter details of the policy assessment used in the Guardrails filter.

+ *

The request is denied because of missing access permissions. Check your permissions and retry your request.

* @public */ - filters?: GuardrailContentFilter[] | undefined; -} - -/** - * @public - * @enum - */ -export const GuardrailSensitiveInformationPolicyAction = { - ANONYMIZED: "ANONYMIZED", - BLOCKED: "BLOCKED", -} as const; - -/** - * @public - */ -export type GuardrailSensitiveInformationPolicyAction = - (typeof GuardrailSensitiveInformationPolicyAction)[keyof typeof GuardrailSensitiveInformationPolicyAction]; - -/** - * @public - * @enum - */ -export const GuardrailPiiEntityType = { - ADDRESS: "ADDRESS", - AGE: "AGE", - AWS_ACCESS_KEY: "AWS_ACCESS_KEY", - AWS_SECRET_KEY: "AWS_SECRET_KEY", - CA_HEALTH_NUMBER: "CA_HEALTH_NUMBER", - CA_SOCIAL_INSURANCE_NUMBER: "CA_SOCIAL_INSURANCE_NUMBER", - CREDIT_DEBIT_CARD_CVV: "CREDIT_DEBIT_CARD_CVV", - CREDIT_DEBIT_CARD_EXPIRY: "CREDIT_DEBIT_CARD_EXPIRY", - CREDIT_DEBIT_CARD_NUMBER: "CREDIT_DEBIT_CARD_NUMBER", - DRIVER_ID: "DRIVER_ID", - EMAIL: "EMAIL", - INTERNATIONAL_BANK_ACCOUNT_NUMBER: "INTERNATIONAL_BANK_ACCOUNT_NUMBER", - IP_ADDRESS: "IP_ADDRESS", - LICENSE_PLATE: "LICENSE_PLATE", - MAC_ADDRESS: "MAC_ADDRESS", - NAME: "NAME", - PASSWORD: "PASSWORD", - PHONE: "PHONE", - PIN: "PIN", - SWIFT_CODE: "SWIFT_CODE", - UK_NATIONAL_HEALTH_SERVICE_NUMBER: "UK_NATIONAL_HEALTH_SERVICE_NUMBER", - UK_NATIONAL_INSURANCE_NUMBER: "UK_NATIONAL_INSURANCE_NUMBER", - UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER: "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", - URL: "URL", - USERNAME: "USERNAME", - US_BANK_ACCOUNT_NUMBER: "US_BANK_ACCOUNT_NUMBER", - US_BANK_ROUTING_NUMBER: "US_BANK_ROUTING_NUMBER", - US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER: "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", - US_PASSPORT_NUMBER: "US_PASSPORT_NUMBER", - US_SOCIAL_SECURITY_NUMBER: "US_SOCIAL_SECURITY_NUMBER", - VEHICLE_IDENTIFICATION_NUMBER: "VEHICLE_IDENTIFICATION_NUMBER", -} as const; - -/** - * @public - */ -export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType]; + export interface AccessDeniedExceptionMember { + flowOutputEvent?: never; + flowCompletionEvent?: never; + flowTraceEvent?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException: AccessDeniedException; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + flowMultiTurnInputRequestEvent?: never; + $unknown?: never; + } -/** - *

The Guardrail filter to identify and remove personally identifiable information (PII).

- * @public - */ -export interface GuardrailPiiEntityFilter { /** - *

The type of PII the Guardrail filter has identified and removed.

+ *

There was a conflict performing an operation. Resolve the conflict and retry your request.

* @public */ - type?: GuardrailPiiEntityType | undefined; + export interface ConflictExceptionMember { + flowOutputEvent?: never; + flowCompletionEvent?: never; + flowTraceEvent?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException: ConflictException; + dependencyFailedException?: never; + badGatewayException?: never; + flowMultiTurnInputRequestEvent?: never; + $unknown?: never; + } /** - *

The match to settings in the Guardrail filter to identify and remove PII.

+ *

There was an issue with a dependency. Check the resource configurations and retry the request.

* @public */ - match?: string | undefined; + export interface DependencyFailedExceptionMember { + flowOutputEvent?: never; + flowCompletionEvent?: never; + flowTraceEvent?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException: DependencyFailedException; + badGatewayException?: never; + flowMultiTurnInputRequestEvent?: never; + $unknown?: never; + } /** - *

The action of the Guardrail filter to identify and remove PII.

+ *

There was an issue with a dependency due to a server issue. Retry your request.

* @public */ - action?: GuardrailSensitiveInformationPolicyAction | undefined; -} + export interface BadGatewayExceptionMember { + flowOutputEvent?: never; + flowCompletionEvent?: never; + flowTraceEvent?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException: BadGatewayException; + flowMultiTurnInputRequestEvent?: never; + $unknown?: never; + } -/** - *

The details for the regex filter used in the Guardrail.

- * @public - */ -export interface GuardrailRegexFilter { /** - *

The name details for the regex filter used in the Guardrail.

+ *

The event stream containing the multi-turn input request information from the flow.

* @public */ - name?: string | undefined; + export interface FlowMultiTurnInputRequestEventMember { + flowOutputEvent?: never; + flowCompletionEvent?: never; + flowTraceEvent?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + flowMultiTurnInputRequestEvent: FlowMultiTurnInputRequestEvent; + $unknown?: never; + } /** - *

The regex details for the regex filter used in the Guardrail.

* @public */ - regex?: string | undefined; + export interface $UnknownMember { + flowOutputEvent?: never; + flowCompletionEvent?: never; + flowTraceEvent?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + flowMultiTurnInputRequestEvent?: never; + $unknown: [string, any]; + } - /** - *

The match details for the regex filter used in the Guardrail.

- * @public - */ - match?: string | undefined; + export interface Visitor { + flowOutputEvent: (value: FlowOutputEvent) => T; + flowCompletionEvent: (value: FlowCompletionEvent) => T; + flowTraceEvent: (value: FlowTraceEvent) => T; + internalServerException: (value: InternalServerException) => T; + validationException: (value: ValidationException) => T; + resourceNotFoundException: (value: ResourceNotFoundException) => T; + serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T; + throttlingException: (value: ThrottlingException) => T; + accessDeniedException: (value: AccessDeniedException) => T; + conflictException: (value: ConflictException) => T; + dependencyFailedException: (value: DependencyFailedException) => T; + badGatewayException: (value: BadGatewayException) => T; + flowMultiTurnInputRequestEvent: (value: FlowMultiTurnInputRequestEvent) => T; + _: (name: string, value: any) => T; + } - /** - *

The action details for the regex filter used in the Guardrail.

- * @public - */ - action?: GuardrailSensitiveInformationPolicyAction | undefined; + export const visit = (value: FlowResponseStream, visitor: Visitor): T => { + if (value.flowOutputEvent !== undefined) return visitor.flowOutputEvent(value.flowOutputEvent); + if (value.flowCompletionEvent !== undefined) return visitor.flowCompletionEvent(value.flowCompletionEvent); + if (value.flowTraceEvent !== undefined) return visitor.flowTraceEvent(value.flowTraceEvent); + if (value.internalServerException !== undefined) + return visitor.internalServerException(value.internalServerException); + if (value.validationException !== undefined) return visitor.validationException(value.validationException); + if (value.resourceNotFoundException !== undefined) + return visitor.resourceNotFoundException(value.resourceNotFoundException); + if (value.serviceQuotaExceededException !== undefined) + return visitor.serviceQuotaExceededException(value.serviceQuotaExceededException); + if (value.throttlingException !== undefined) return visitor.throttlingException(value.throttlingException); + if (value.accessDeniedException !== undefined) return visitor.accessDeniedException(value.accessDeniedException); + if (value.conflictException !== undefined) return visitor.conflictException(value.conflictException); + if (value.dependencyFailedException !== undefined) + return visitor.dependencyFailedException(value.dependencyFailedException); + if (value.badGatewayException !== undefined) return visitor.badGatewayException(value.badGatewayException); + if (value.flowMultiTurnInputRequestEvent !== undefined) + return visitor.flowMultiTurnInputRequestEvent(value.flowMultiTurnInputRequestEvent); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** - *

The details of the sensitive policy assessment used in the Guardrail.

* @public */ -export interface GuardrailSensitiveInformationPolicyAssessment { +export interface InvokeFlowResponse { /** - *

The details of the PII entities used in the sensitive policy assessment for the Guardrail.

+ *

The output of the flow, returned as a stream. If there's an error, the error is returned.

* @public */ - piiEntities?: GuardrailPiiEntityFilter[] | undefined; + responseStream: AsyncIterable | undefined; /** - *

The details of the regexes used in the sensitive policy assessment for the Guardrail.

+ *

The unique identifier for the current flow execution.

* @public */ - regexes?: GuardrailRegexFilter[] | undefined; + executionId?: string | undefined; } /** * @public * @enum */ -export const GuardrailTopicPolicyAction = { - BLOCKED: "BLOCKED", -} as const; - -/** - * @public - */ -export type GuardrailTopicPolicyAction = (typeof GuardrailTopicPolicyAction)[keyof typeof GuardrailTopicPolicyAction]; - -/** - * @public - * @enum - */ -export const GuardrailTopicType = { - DENY: "DENY", +export const InputQueryType = { + TEXT: "TEXT", } as const; /** * @public */ -export type GuardrailTopicType = (typeof GuardrailTopicType)[keyof typeof GuardrailTopicType]; +export type InputQueryType = (typeof InputQueryType)[keyof typeof InputQueryType]; /** - *

The details for a specific topic defined in the Guardrail.

+ *

Contains information about a natural language query to transform into SQL.

* @public */ -export interface GuardrailTopic { - /** - *

The name details on a specific topic in the Guardrail.

- * @public - */ - name?: string | undefined; - - /** - *

The type details on a specific topic in the Guardrail.

- * @public - */ - type?: GuardrailTopicType | undefined; - +export interface QueryGenerationInput { /** - *

The action details on a specific topic in the Guardrail.

+ *

The type of the query.

* @public */ - action?: GuardrailTopicPolicyAction | undefined; -} + type: InputQueryType | undefined; -/** - *

The details of the policy assessment used in the Guardrail.

- * @public - */ -export interface GuardrailTopicPolicyAssessment { /** - *

The topic details of the policy assessment used in the Guardrail.

+ *

The text of the query.

* @public */ - topics?: GuardrailTopic[] | undefined; + text: string | undefined; } /** * @public * @enum */ -export const GuardrailWordPolicyAction = { - BLOCKED: "BLOCKED", +export const QueryTransformationMode = { + TEXT_TO_SQL: "TEXT_TO_SQL", } as const; /** * @public */ -export type GuardrailWordPolicyAction = (typeof GuardrailWordPolicyAction)[keyof typeof GuardrailWordPolicyAction]; +export type QueryTransformationMode = (typeof QueryTransformationMode)[keyof typeof QueryTransformationMode]; /** - *

The custom word details for the filter in the Guardrail.

+ *

Contains configurations for a knowledge base to use in transformation.

* @public */ -export interface GuardrailCustomWord { - /** - *

The match details for the custom word filter in the Guardrail.

- * @public - */ - match?: string | undefined; - +export interface TextToSqlKnowledgeBaseConfiguration { /** - *

The action details for the custom word filter in the Guardrail.

+ *

The ARN of the knowledge base

* @public */ - action?: GuardrailWordPolicyAction | undefined; + knowledgeBaseArn: string | undefined; } /** * @public * @enum */ -export const GuardrailManagedWordType = { - PROFANITY: "PROFANITY", +export const TextToSqlConfigurationType = { + KNOWLEDGE_BASE: "KNOWLEDGE_BASE", } as const; /** * @public */ -export type GuardrailManagedWordType = (typeof GuardrailManagedWordType)[keyof typeof GuardrailManagedWordType]; - -/** - *

The managed word details for the filter in the Guardrail.

- * @public - */ -export interface GuardrailManagedWord { - /** - *

The match details for the managed word filter in the Guardrail.

- * @public - */ - match?: string | undefined; - - /** - *

The type details for the managed word filter in the Guardrail.

- * @public - */ - type?: GuardrailManagedWordType | undefined; - - /** - *

The action details for the managed word filter in the Guardrail.

- * @public - */ - action?: GuardrailWordPolicyAction | undefined; -} +export type TextToSqlConfigurationType = (typeof TextToSqlConfigurationType)[keyof typeof TextToSqlConfigurationType]; /** - *

The assessment details for words defined in the Guardrail filter.

+ *

Contains configurations for transforming text to SQL.

* @public */ -export interface GuardrailWordPolicyAssessment { +export interface TextToSqlConfiguration { /** - *

The custom word details for words defined in the Guardrail filter.

+ *

The type of resource to use in transformation.

* @public */ - customWords?: GuardrailCustomWord[] | undefined; + type: TextToSqlConfigurationType | undefined; /** - *

The managed word lists for words defined in the Guardrail filter.

+ *

Specifies configurations for a knowledge base to use in transformation.

* @public */ - managedWordLists?: GuardrailManagedWord[] | undefined; + knowledgeBaseConfiguration?: TextToSqlKnowledgeBaseConfiguration | undefined; } /** - *

Assessment details of the content analyzed by Guardrails.

+ *

Contains configurations for transforming the natural language query into SQL.

* @public */ -export interface GuardrailAssessment { +export interface TransformationConfiguration { /** - *

Topic policy details of the Guardrail.

+ *

The mode of the transformation.

* @public */ - topicPolicy?: GuardrailTopicPolicyAssessment | undefined; + mode: QueryTransformationMode | undefined; /** - *

Content policy details of the Guardrail.

+ *

Specifies configurations for transforming text to SQL.

* @public */ - contentPolicy?: GuardrailContentPolicyAssessment | undefined; + textToSqlConfiguration?: TextToSqlConfiguration | undefined; +} +/** + * @public + */ +export interface GenerateQueryRequest { /** - *

Word policy details of the Guardrail.

+ *

Specifies information about a natural language query to transform into SQL.

* @public */ - wordPolicy?: GuardrailWordPolicyAssessment | undefined; + queryGenerationInput: QueryGenerationInput | undefined; /** - *

Sensitive Information policy details of Guardrail.

+ *

Specifies configurations for transforming the natural language query into SQL.

* @public */ - sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment | undefined; + transformationConfiguration: TransformationConfiguration | undefined; } /** - *

The trace details used in the Guardrail.

* @public + * @enum */ -export interface GuardrailTrace { - /** - *

The trace action details used with the Guardrail.

- * @public - */ - action?: GuardrailAction | undefined; +export const GeneratedQueryType = { + REDSHIFT_SQL: "REDSHIFT_SQL", +} as const; + +/** + * @public + */ +export type GeneratedQueryType = (typeof GeneratedQueryType)[keyof typeof GeneratedQueryType]; +/** + *

Contains information about a query generated for a natural language query.

+ * @public + */ +export interface GeneratedQuery { /** - *

The details of the trace Id used in the Guardrail Trace.

+ *

The type of transformed query.

* @public */ - traceId?: string | undefined; + type?: GeneratedQueryType | undefined; /** - *

The details of the input assessments used in the Guardrail Trace.

+ *

An SQL query that corresponds to the natural language query.

* @public */ - inputAssessments?: GuardrailAssessment[] | undefined; + sql?: string | undefined; +} +/** + * @public + */ +export interface GenerateQueryResponse { /** - *

The details of the output assessments used in the Guardrail Trace.

+ *

A list of objects, each of which defines a generated query that can correspond to the natural language queries.

* @public */ - outputAssessments?: GuardrailAssessment[] | undefined; + queries?: GeneratedQuery[] | undefined; +} +/** + *

Settings for a model called with InvokeAgent.

+ * @public + */ +export interface BedrockModelConfigurations { /** - *

Contains information about the Guardrail output.

+ *

The performance configuration for the model.

* @public */ - metadata?: Metadata | undefined; + performanceConfig?: PerformanceConfiguration | undefined; } /** - *

Contains information about the code interpreter being invoked.

+ *

A content block.

* @public */ -export interface CodeInterpreterInvocationInput { +export type ContentBlock = ContentBlock.TextMember | ContentBlock.$UnknownMember; + +/** + * @public + */ +export namespace ContentBlock { /** - *

The code for the code interpreter to use.

+ *

The block's text.

* @public */ - code?: string | undefined; + export interface TextMember { + text: string; + $unknown?: never; + } /** - *

Files that are uploaded for code interpreter to use.

* @public */ - files?: string[] | undefined; + export interface $UnknownMember { + text?: never; + $unknown: [string, any]; + } + + export interface Visitor { + text: (value: string) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: ContentBlock, visitor: Visitor): T => { + if (value.text !== undefined) return visitor.text(value.text); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** * @public * @enum */ -export const InvocationType = { - ACTION_GROUP: "ACTION_GROUP", - ACTION_GROUP_CODE_INTERPRETER: "ACTION_GROUP_CODE_INTERPRETER", - AGENT_COLLABORATOR: "AGENT_COLLABORATOR", - FINISH: "FINISH", - KNOWLEDGE_BASE: "KNOWLEDGE_BASE", +export const ConversationRole = { + ASSISTANT: "assistant", + USER: "user", } as const; /** * @public */ -export type InvocationType = (typeof InvocationType)[keyof typeof InvocationType]; +export type ConversationRole = (typeof ConversationRole)[keyof typeof ConversationRole]; /** - *

Contains details about the knowledge base to look up and the query to be made.

+ *

Details about a message.

* @public */ -export interface KnowledgeBaseLookupInput { +export interface Message { /** - *

The query made to the knowledge base.

+ *

The message's role.

* @public */ - text?: string | undefined; + role: ConversationRole | undefined; /** - *

The unique identifier of the knowledge base to look up.

+ *

The message's content.

* @public */ - knowledgeBaseId?: string | undefined; + content: ContentBlock[] | undefined; } /** - *

Contains information pertaining to the action group or knowledge base that is being invoked.

+ *

A conversation history.

* @public */ -export interface InvocationInput { +export interface ConversationHistory { /** - *

The unique identifier of the trace.

+ *

The conversation's messages.

* @public */ - traceId?: string | undefined; + messages?: Message[] | undefined; +} +/** + *

The property contains the file to chat with, along with its attributes.

+ * @public + */ +export interface ByteContentFile { /** - *

Specifies whether the agent is invoking an action group or a knowledge base.

+ *

The MIME type of data contained in the file used for chat.

* @public */ - invocationType?: InvocationType | undefined; + mediaType: string | undefined; /** - *

Contains information about the action group to be invoked.

+ *

The raw bytes of the file to attach. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files.

* @public */ - actionGroupInvocationInput?: ActionGroupInvocationInput | undefined; + data: Uint8Array | undefined; +} +/** + *

Contains details of the s3 object where the source file is located.

+ * @public + */ +export interface S3ObjectFile { /** - *

Contains details about the knowledge base to look up and the query to be made.

+ *

The uri of the s3 object.

* @public */ - knowledgeBaseLookupInput?: KnowledgeBaseLookupInput | undefined; + uri: string | undefined; +} + +/** + * @public + * @enum + */ +export const FileSourceType = { + BYTE_CONTENT: "BYTE_CONTENT", + S3: "S3", +} as const; + +/** + * @public + */ +export type FileSourceType = (typeof FileSourceType)[keyof typeof FileSourceType]; +/** + *

The source file of the content contained in the wrapper object.

+ * @public + */ +export interface FileSource { /** - *

Contains information about the code interpreter to be invoked.

+ *

The source type of the files to attach.

* @public */ - codeInterpreterInvocationInput?: CodeInterpreterInvocationInput | undefined; + sourceType: FileSourceType | undefined; /** - *

The collaborator's invocation input.

+ *

The s3 location of the files to attach.

* @public */ - agentCollaboratorInvocationInput?: AgentCollaboratorInvocationInput | undefined; + s3Location?: S3ObjectFile | undefined; + + /** + *

The data and the text of the attached files.

+ * @public + */ + byteContent?: ByteContentFile | undefined; } /** - *

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

* @public + * @enum */ -export interface InferenceConfiguration { +export const FileUseCase = { + CHAT: "CHAT", + CODE_INTERPRETER: "CODE_INTERPRETER", +} as const; + +/** + * @public + */ +export type FileUseCase = (typeof FileUseCase)[keyof typeof FileUseCase]; + +/** + *

Contains details of the source files.

+ * @public + */ +export interface InputFile { /** - *

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

+ *

The name of the source file.

* @public */ - temperature?: number | undefined; + name: string | undefined; /** - *

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.

+ *

Specifies where the files are located.

* @public */ - topP?: number | undefined; + source: FileSource | undefined; /** - *

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

+ *

Specifies how the source files will be used by the code interpreter.

* @public */ - topK?: number | undefined; + useCase: FileUseCase | undefined; +} +/** + *

Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.

This data type is used in the following API operations:

+ * @public + */ +export interface FilterAttribute { /** - *

The maximum number of tokens allowed in the generated response.

+ *

The name that the metadata attribute must match.

* @public */ - maximumLength?: number | undefined; + key: string | undefined; /** - *

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

+ *

The value to whcih to compare the value of the metadata attribute.

* @public */ - stopSequences?: string[] | undefined; + value: __DocumentType | undefined; } /** * @public * @enum */ -export const CreationMode = { - DEFAULT: "DEFAULT", - OVERRIDDEN: "OVERRIDDEN", -} as const; - -/** - * @public - */ -export type CreationMode = (typeof CreationMode)[keyof typeof CreationMode]; - -/** - * @public - * @enum - */ -export const PromptType = { - KNOWLEDGE_BASE_RESPONSE_GENERATION: "KNOWLEDGE_BASE_RESPONSE_GENERATION", - ORCHESTRATION: "ORCHESTRATION", - POST_PROCESSING: "POST_PROCESSING", - PRE_PROCESSING: "PRE_PROCESSING", - ROUTING_CLASSIFIER: "ROUTING_CLASSIFIER", +export const AttributeType = { + BOOLEAN: "BOOLEAN", + NUMBER: "NUMBER", + STRING: "STRING", + STRING_LIST: "STRING_LIST", } as const; /** * @public */ -export type PromptType = (typeof PromptType)[keyof typeof PromptType]; +export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType]; /** - *

The input for the pre-processing step.

  • The type matches the agent step.

  • The text contains the prompt.

  • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

+ *

Details about a metadata attribute.

* @public */ -export interface ModelInvocationInput { - /** - *

The unique identifier of the trace.

- * @public - */ - traceId?: string | undefined; - +export interface MetadataAttributeSchema { /** - *

The text that prompted the agent at this step.

+ *

The attribute's key.

* @public */ - text?: string | undefined; + key: string | undefined; /** - *

The step in the agent sequence.

+ *

The attribute's type.

* @public */ - type?: PromptType | undefined; + type: AttributeType | undefined; /** - *

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.

+ *

The attribute's description.

* @public */ - overrideLambda?: string | undefined; + description: string | undefined; +} +/** + *

Settings for implicit filtering, where a model generates a metadata filter based on the prompt.

+ * @public + */ +export interface ImplicitFilterConfiguration { /** - *

Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.

+ *

Metadata that can be used in a filter.

* @public */ - promptCreationMode?: CreationMode | undefined; + metadataAttributes: MetadataAttributeSchema[] | undefined; /** - *

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

+ *

The model that generates the filter.

* @public */ - inferenceConfiguration?: InferenceConfiguration | undefined; + modelArn: string | undefined; +} - /** - *

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.

- * @public - */ - parserMode?: CreationMode | undefined; +/** + * @public + * @enum + */ +export const SearchType = { + HYBRID: "HYBRID", + SEMANTIC: "SEMANTIC", +} as const; - /** - *

The identifier of a foundation model.

- * @public - */ - foundationModel?: string | undefined; -} +/** + * @public + */ +export type SearchType = (typeof SearchType)[keyof typeof SearchType]; /** - *

Contains the raw output from the foundation model.

* @public + * @enum */ -export interface RawResponse { - /** - *

The foundation model's raw output content.

- * @public - */ - content?: string | undefined; -} +export const RerankingMetadataSelectionMode = { + ALL: "ALL", + SELECTIVE: "SELECTIVE", +} as const; /** - *

Contains information about the reasoning that the model used to return the content in the content block.

* @public */ -export interface ReasoningTextBlock { - /** - *

Text describing the reasoning that the model used to return the content in the content block.

- * @public - */ - text: string | undefined; +export type RerankingMetadataSelectionMode = + (typeof RerankingMetadataSelectionMode)[keyof typeof RerankingMetadataSelectionMode]; +/** + *

Contains information for a metadata field to include in or exclude from consideration when reranking.

+ * @public + */ +export interface FieldForReranking { /** - *

A hash of all the messages in the conversation to ensure that the content in the reasoning text block isn't tampered with. You must submit the signature in subsequent Converse requests, in addition to the previous messages. If the previous messages are tampered with, the response throws an error.

+ *

The name of a metadata field to include in or exclude from consideration when reranking.

* @public */ - signature?: string | undefined; + fieldName: string | undefined; } /** - *

Contains content regarding the reasoning that the foundation model made with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

+ *

Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the fieldsToExclude field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.

* @public */ -export type ReasoningContentBlock = - | ReasoningContentBlock.ReasoningTextMember - | ReasoningContentBlock.RedactedContentMember - | ReasoningContentBlock.$UnknownMember; +export type RerankingMetadataSelectiveModeConfiguration = + | RerankingMetadataSelectiveModeConfiguration.FieldsToExcludeMember + | RerankingMetadataSelectiveModeConfiguration.FieldsToIncludeMember + | RerankingMetadataSelectiveModeConfiguration.$UnknownMember; /** * @public */ -export namespace ReasoningContentBlock { +export namespace RerankingMetadataSelectiveModeConfiguration { /** - *

Contains information about the reasoning that the model used to return the content in the content block.

+ *

An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.

* @public */ - export interface ReasoningTextMember { - reasoningText: ReasoningTextBlock; - redactedContent?: never; + export interface FieldsToIncludeMember { + fieldsToInclude: FieldForReranking[]; + fieldsToExclude?: never; $unknown?: never; } /** - *

The content in the reasoning that was encrypted by the model provider for trust and safety reasons.

+ *

An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.

* @public */ - export interface RedactedContentMember { - reasoningText?: never; - redactedContent: Uint8Array; + export interface FieldsToExcludeMember { + fieldsToInclude?: never; + fieldsToExclude: FieldForReranking[]; $unknown?: never; } @@ -4332,548 +3910,591 @@ export namespace ReasoningContentBlock { * @public */ export interface $UnknownMember { - reasoningText?: never; - redactedContent?: never; + fieldsToInclude?: never; + fieldsToExclude?: never; $unknown: [string, any]; } export interface Visitor { - reasoningText: (value: ReasoningTextBlock) => T; - redactedContent: (value: Uint8Array) => T; + fieldsToInclude: (value: FieldForReranking[]) => T; + fieldsToExclude: (value: FieldForReranking[]) => T; _: (name: string, value: any) => T; } - export const visit = (value: ReasoningContentBlock, visitor: Visitor): T => { - if (value.reasoningText !== undefined) return visitor.reasoningText(value.reasoningText); - if (value.redactedContent !== undefined) return visitor.redactedContent(value.redactedContent); + export const visit = (value: RerankingMetadataSelectiveModeConfiguration, visitor: Visitor): T => { + if (value.fieldsToInclude !== undefined) return visitor.fieldsToInclude(value.fieldsToInclude); + if (value.fieldsToExclude !== undefined) return visitor.fieldsToExclude(value.fieldsToExclude); return visitor._(value.$unknown[0], value.$unknown[1]); }; } /** - *

The foundation model output from the orchestration step.

+ *

Contains configurations for the metadata to use in reranking.

* @public */ -export interface OrchestrationModelInvocationOutput { +export interface MetadataConfigurationForReranking { /** - *

The unique identifier of the trace.

+ *

Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify SELECTIVE, include the selectiveModeConfiguration field.

* @public */ - traceId?: string | undefined; + selectionMode: RerankingMetadataSelectionMode | undefined; /** - *

Contains details of the raw response from the foundation model output.

+ *

Contains configurations for the metadata fields to include or exclude when considering reranking.

* @public */ - rawResponse?: RawResponse | undefined; + selectiveModeConfiguration?: RerankingMetadataSelectiveModeConfiguration | undefined; +} +/** + *

Contains configurations for an Amazon Bedrock reranker model.

+ * @public + */ +export interface VectorSearchBedrockRerankingModelConfiguration { /** - *

Contains information about the foundation model output from the orchestration step.

+ *

The ARN of the reranker model to use.

* @public */ - metadata?: Metadata | undefined; + modelArn: string | undefined; /** - *

Contains content about the reasoning that the model made during the orchestration step.

+ *

A JSON object whose keys are request fields for the model and whose values are values for those fields.

* @public */ - reasoningContent?: ReasoningContentBlock | undefined; + additionalModelRequestFields?: Record | undefined; } /** - *

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

+ *

Contains configurations for reranking with an Amazon Bedrock reranker model.

* @public */ -export interface CodeInterpreterInvocationOutput { +export interface VectorSearchBedrockRerankingConfiguration { /** - *

Contains the successful output returned from code execution

+ *

Contains configurations for the reranker model.

* @public */ - executionOutput?: string | undefined; + modelConfiguration: VectorSearchBedrockRerankingModelConfiguration | undefined; /** - *

Contains the error returned from code execution.

+ *

The number of results to return after reranking.

* @public */ - executionError?: string | undefined; + numberOfRerankedResults?: number | undefined; /** - *

Contains output files, if generated by code execution.

+ *

Contains configurations for the metadata to use in reranking.

* @public */ - files?: string[] | undefined; + metadataConfiguration?: MetadataConfigurationForReranking | undefined; +} + +/** + * @public + * @enum + */ +export const VectorSearchRerankingConfigurationType = { + BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL", +} as const; + +/** + * @public + */ +export type VectorSearchRerankingConfigurationType = + (typeof VectorSearchRerankingConfigurationType)[keyof typeof VectorSearchRerankingConfigurationType]; +/** + *

Contains configurations for reranking the retrieved results.

+ * @public + */ +export interface VectorSearchRerankingConfiguration { /** - *

Indicates if the execution of the code timed out.

+ *

The type of reranker model.

* @public */ - executionTimeout?: boolean | undefined; + type: VectorSearchRerankingConfigurationType | undefined; /** - *

Contains information about the output from the code interpreter.

+ *

Contains configurations for an Amazon Bedrock reranker model.

* @public */ - metadata?: Metadata | undefined; + bedrockRerankingConfiguration?: VectorSearchBedrockRerankingConfiguration | undefined; } /** - *

Contains details about the response to the user.

+ *

Configurations for streaming.

* @public */ -export interface FinalResponse { +export interface StreamingConfigurations { /** - *

The text in the response to the user.

+ *

Specifies whether to enable streaming for the final response. This is set to false by default.

* @public */ - text?: string | undefined; + streamFinalResponse?: boolean | undefined; /** - *

Contains information about the invoke agent operation.

+ *

The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer ApplyGuardrail calls. The following examples show the response generated for Hello, I am an agent input string.

Example response in chunks: Interval set to 3 characters

'Hel', 'lo, ','I am', ' an', ' Age', 'nt'

Each chunk has at least 3 characters except for the last chunk

Example response in chunks: Interval set to 20 or more characters

Hello, I am an Agent

* @public */ - metadata?: Metadata | undefined; + applyGuardrailInterval?: number | undefined; } /** - *

Contains details about the results from looking up the knowledge base.

+ *

Contains information about where the text with a citation begins and ends in the generated output.

This data type is used in the following API operations:

* @public */ -export interface KnowledgeBaseLookupOutput { +export interface Span { /** - *

Contains metadata about the sources cited for the generated response.

+ *

Where the text with a citation starts in the generated output.

* @public */ - retrievedReferences?: RetrievedReference[] | undefined; + start?: number | undefined; + + /** + *

Where the text with a citation ends in the generated output.

+ * @public + */ + end?: number | undefined; +} + +/** + *

Contains the part of the generated text that contains a citation, alongside where it begins and ends.

This data type is used in the following API operations:

+ * @public + */ +export interface TextResponsePart { + /** + *

The part of the generated text that contains a citation.

+ * @public + */ + text?: string | undefined; + + /** + *

Contains information about where the text with a citation begins and ends in the generated output.

+ * @public + */ + span?: Span | undefined; +} +/** + *

Contains metadata about a part of the generated response that is accompanied by a citation.

This data type is used in the following API operations:

+ * @public + */ +export interface GeneratedResponsePart { /** - *

Contains information about the knowledge base output.

+ *

Contains metadata about a textual part of the generated response that is accompanied by a citation.

* @public */ - metadata?: Metadata | undefined; + textResponsePart?: TextResponsePart | undefined; } /** * @public * @enum */ -export const Source = { - ACTION_GROUP: "ACTION_GROUP", - KNOWLEDGE_BASE: "KNOWLEDGE_BASE", - PARSER: "PARSER", +export const RetrievalResultContentColumnType = { + BLOB: "BLOB", + BOOLEAN: "BOOLEAN", + DOUBLE: "DOUBLE", + LONG: "LONG", + NULL: "NULL", + STRING: "STRING", } as const; /** * @public */ -export type Source = (typeof Source)[keyof typeof Source]; +export type RetrievalResultContentColumnType = + (typeof RetrievalResultContentColumnType)[keyof typeof RetrievalResultContentColumnType]; /** - *

Contains details about the agent's response to reprompt the input.

+ *

Contains information about a column with a cell to return in retrieval.

* @public */ -export interface RepromptResponse { +export interface RetrievalResultContentColumn { /** - *

The text reprompting the input.

+ *

The name of the column.

* @public */ - text?: string | undefined; + columnName?: string | undefined; /** - *

Specifies what output is prompting the agent to reprompt the input.

+ *

The value in the column.

* @public */ - source?: Source | undefined; + columnValue?: string | undefined; + + /** + *

The data type of the value.

+ * @public + */ + type?: RetrievalResultContentColumnType | undefined; } /** * @public * @enum */ -export const Type = { - ACTION_GROUP: "ACTION_GROUP", - AGENT_COLLABORATOR: "AGENT_COLLABORATOR", - ASK_USER: "ASK_USER", - FINISH: "FINISH", - KNOWLEDGE_BASE: "KNOWLEDGE_BASE", - REPROMPT: "REPROMPT", +export const RetrievalResultContentType = { + IMAGE: "IMAGE", + ROW: "ROW", + TEXT: "TEXT", } as const; /** * @public */ -export type Type = (typeof Type)[keyof typeof Type]; +export type RetrievalResultContentType = (typeof RetrievalResultContentType)[keyof typeof RetrievalResultContentType]; /** - *

Contains the result or output of an action group or knowledge base, or the response to the user.

+ *

Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.

This data type is used in the following API operations:

* @public */ -export interface Observation { - /** - *

The unique identifier of the trace.

- * @public - */ - traceId?: string | undefined; - - /** - *

Specifies what kind of information the agent returns in the observation. The following values are possible.

  • ACTION_GROUP – The agent returns the result of an action group.

  • KNOWLEDGE_BASE – The agent returns information from a knowledge base.

  • FINISH – The agent returns a final response to the user with no follow-up.

  • ASK_USER – The agent asks the user a question.

  • REPROMPT – The agent prompts the user again for the same information.

- * @public - */ - type?: Type | undefined; - - /** - *

Contains the JSON-formatted string returned by the API invoked by the action group.

- * @public - */ - actionGroupInvocationOutput?: ActionGroupInvocationOutput | undefined; - - /** - *

A collaborator's invocation output.

- * @public - */ - agentCollaboratorInvocationOutput?: AgentCollaboratorInvocationOutput | undefined; - +export interface RetrievalResultContent { /** - *

Contains details about the results from looking up the knowledge base.

+ *

The type of content in the retrieval result.

* @public */ - knowledgeBaseLookupOutput?: KnowledgeBaseLookupOutput | undefined; + type?: RetrievalResultContentType | undefined; /** - *

Contains details about the response to the user.

+ *

The cited text from the data source.

* @public */ - finalResponse?: FinalResponse | undefined; + text?: string | undefined; /** - *

Contains details about the response to reprompt the input.

+ *

A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,$\{base64-encoded string\}.

* @public */ - repromptResponse?: RepromptResponse | undefined; + byteContent?: string | undefined; /** - *

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

+ *

Specifies information about the rows with the cells to return in retrieval.

* @public */ - codeInterpreterInvocationOutput?: CodeInterpreterInvocationOutput | undefined; + row?: RetrievalResultContentColumn[] | undefined; } /** - *

Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

+ *

The Confluence data source location.

* @public */ -export interface Rationale { - /** - *

The unique identifier of the trace step.

- * @public - */ - traceId?: string | undefined; - +export interface RetrievalResultConfluenceLocation { /** - *

The reasoning or thought process of the agent, based on the input.

+ *

The Confluence host URL for the data source location.

* @public */ - text?: string | undefined; + url?: string | undefined; } /** - *

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

- * @public - */ -export type OrchestrationTrace = - | OrchestrationTrace.InvocationInputMember - | OrchestrationTrace.ModelInvocationInputMember - | OrchestrationTrace.ModelInvocationOutputMember - | OrchestrationTrace.ObservationMember - | OrchestrationTrace.RationaleMember - | OrchestrationTrace.$UnknownMember; - -/** + *

Contains information about the location of a document in a custom data source.

* @public */ -export namespace OrchestrationTrace { +export interface RetrievalResultCustomDocumentLocation { /** - *

Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

+ *

The ID of the document.

* @public */ - export interface RationaleMember { - rationale: Rationale; - invocationInput?: never; - observation?: never; - modelInvocationInput?: never; - modelInvocationOutput?: never; - $unknown?: never; - } + id?: string | undefined; +} +/** + *

The location of a result in Amazon Kendra.

+ * @public + */ +export interface RetrievalResultKendraDocumentLocation { /** - *

Contains information pertaining to the action group or knowledge base that is being invoked.

+ *

The document's uri.

* @public */ - export interface InvocationInputMember { - rationale?: never; - invocationInput: InvocationInput; - observation?: never; - modelInvocationInput?: never; - modelInvocationOutput?: never; - $unknown?: never; - } + uri?: string | undefined; +} +/** + *

The S3 data source location.

This data type is used in the following API operations:

+ * @public + */ +export interface RetrievalResultS3Location { /** - *

Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

+ *

The S3 URI for the data source location.

* @public */ - export interface ObservationMember { - rationale?: never; - invocationInput?: never; - observation: Observation; - modelInvocationInput?: never; - modelInvocationOutput?: never; - $unknown?: never; - } + uri?: string | undefined; +} +/** + *

The Salesforce data source location.

+ * @public + */ +export interface RetrievalResultSalesforceLocation { /** - *

The input for the orchestration step.

  • The type is ORCHESTRATION.

  • The text contains the prompt.

  • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

+ *

The Salesforce host URL for the data source location.

* @public */ - export interface ModelInvocationInputMember { - rationale?: never; - invocationInput?: never; - observation?: never; - modelInvocationInput: ModelInvocationInput; - modelInvocationOutput?: never; - $unknown?: never; - } + url?: string | undefined; +} +/** + *

The SharePoint data source location.

+ * @public + */ +export interface RetrievalResultSharePointLocation { /** - *

Contains information pertaining to the output from the foundation model that is being invoked.

+ *

The SharePoint site URL for the data source location.

* @public */ - export interface ModelInvocationOutputMember { - rationale?: never; - invocationInput?: never; - observation?: never; - modelInvocationInput?: never; - modelInvocationOutput: OrchestrationModelInvocationOutput; - $unknown?: never; - } + url?: string | undefined; +} +/** + *

Contains information about the SQL query used to retrieve the result.

+ * @public + */ +export interface RetrievalResultSqlLocation { /** + *

The SQL query used to retrieve the result.

* @public */ - export interface $UnknownMember { - rationale?: never; - invocationInput?: never; - observation?: never; - modelInvocationInput?: never; - modelInvocationOutput?: never; - $unknown: [string, any]; - } + query?: string | undefined; +} - export interface Visitor { - rationale: (value: Rationale) => T; - invocationInput: (value: InvocationInput) => T; - observation: (value: Observation) => T; - modelInvocationInput: (value: ModelInvocationInput) => T; - modelInvocationOutput: (value: OrchestrationModelInvocationOutput) => T; - _: (name: string, value: any) => T; - } +/** + * @public + * @enum + */ +export const RetrievalResultLocationType = { + CONFLUENCE: "CONFLUENCE", + CUSTOM: "CUSTOM", + KENDRA: "KENDRA", + S3: "S3", + SALESFORCE: "SALESFORCE", + SHAREPOINT: "SHAREPOINT", + SQL: "SQL", + WEB: "WEB", +} as const; - export const visit = (value: OrchestrationTrace, visitor: Visitor): T => { - if (value.rationale !== undefined) return visitor.rationale(value.rationale); - if (value.invocationInput !== undefined) return visitor.invocationInput(value.invocationInput); - if (value.observation !== undefined) return visitor.observation(value.observation); - if (value.modelInvocationInput !== undefined) return visitor.modelInvocationInput(value.modelInvocationInput); - if (value.modelInvocationOutput !== undefined) return visitor.modelInvocationOutput(value.modelInvocationOutput); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} +/** + * @public + */ +export type RetrievalResultLocationType = + (typeof RetrievalResultLocationType)[keyof typeof RetrievalResultLocationType]; /** - *

Details about the response from the Lambda parsing of the output from the post-processing step.

+ *

The web URL/URLs data source location.

* @public */ -export interface PostProcessingParsedResponse { +export interface RetrievalResultWebLocation { /** - *

The text returned by the parser.

+ *

The web URL/URLs for the data source location.

* @public */ - text?: string | undefined; + url?: string | undefined; } /** - *

The foundation model output from the post-processing step.

+ *

Contains information about the data source location.

This data type is used in the following API operations:

* @public */ -export interface PostProcessingModelInvocationOutput { +export interface RetrievalResultLocation { /** - *

The unique identifier of the trace.

+ *

The type of data source location.

* @public */ - traceId?: string | undefined; + type: RetrievalResultLocationType | undefined; /** - *

Details about the response from the Lambda parsing of the output of the post-processing step.

+ *

The S3 data source location.

* @public */ - parsedResponse?: PostProcessingParsedResponse | undefined; + s3Location?: RetrievalResultS3Location | undefined; /** - *

Details of the raw response from the foundation model output.

+ *

The web URL/URLs data source location.

* @public */ - rawResponse?: RawResponse | undefined; + webLocation?: RetrievalResultWebLocation | undefined; /** - *

Contains information about the foundation model output from the post-processing step.

+ *

The Confluence data source location.

* @public */ - metadata?: Metadata | undefined; + confluenceLocation?: RetrievalResultConfluenceLocation | undefined; /** - *

Contains content about the reasoning that the model made during the post-processing step.

+ *

The Salesforce data source location.

* @public */ - reasoningContent?: ReasoningContentBlock | undefined; -} + salesforceLocation?: RetrievalResultSalesforceLocation | undefined; -/** - *

Details about the post-processing step, in which the agent shapes the response.

- * @public - */ -export type PostProcessingTrace = - | PostProcessingTrace.ModelInvocationInputMember - | PostProcessingTrace.ModelInvocationOutputMember - | PostProcessingTrace.$UnknownMember; + /** + *

The SharePoint data source location.

+ * @public + */ + sharePointLocation?: RetrievalResultSharePointLocation | undefined; + + /** + *

Specifies the location of a document in a custom data source.

+ * @public + */ + customDocumentLocation?: RetrievalResultCustomDocumentLocation | undefined; + + /** + *

The location of a document in Amazon Kendra.

+ * @public + */ + kendraDocumentLocation?: RetrievalResultKendraDocumentLocation | undefined; + + /** + *

Specifies information about the SQL query used to retrieve the result.

+ * @public + */ + sqlLocation?: RetrievalResultSqlLocation | undefined; +} /** + *

Contains metadata about a source cited for the generated response.

This data type is used in the following API operations:

* @public */ -export namespace PostProcessingTrace { +export interface RetrievedReference { /** - *

The input for the post-processing step.

  • The type is POST_PROCESSING.

  • The text contains the prompt.

  • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

+ *

Contains the cited text from the data source.

* @public */ - export interface ModelInvocationInputMember { - modelInvocationInput: ModelInvocationInput; - modelInvocationOutput?: never; - $unknown?: never; - } + content?: RetrievalResultContent | undefined; /** - *

The foundation model output from the post-processing step.

+ *

Contains information about the location of the data source.

* @public */ - export interface ModelInvocationOutputMember { - modelInvocationInput?: never; - modelInvocationOutput: PostProcessingModelInvocationOutput; - $unknown?: never; - } + location?: RetrievalResultLocation | undefined; /** + *

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

* @public */ - export interface $UnknownMember { - modelInvocationInput?: never; - modelInvocationOutput?: never; - $unknown: [string, any]; - } - - export interface Visitor { - modelInvocationInput: (value: ModelInvocationInput) => T; - modelInvocationOutput: (value: PostProcessingModelInvocationOutput) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: PostProcessingTrace, visitor: Visitor): T => { - if (value.modelInvocationInput !== undefined) return visitor.modelInvocationInput(value.modelInvocationInput); - if (value.modelInvocationOutput !== undefined) return visitor.modelInvocationOutput(value.modelInvocationOutput); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + metadata?: Record | undefined; } /** - *

Details about the response from the Lambda parsing of the output from the pre-processing step.

+ *

An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.

This data type is used in the following API operations:

* @public */ -export interface PreProcessingParsedResponse { +export interface Citation { /** - *

The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.

+ *

Contains the generated response and metadata

* @public */ - rationale?: string | undefined; + generatedResponsePart?: GeneratedResponsePart | undefined; /** - *

Whether the user input is valid or not. If false, the agent doesn't proceed to orchestration.

+ *

Contains metadata about the sources cited for the generated response.

* @public */ - isValid?: boolean | undefined; + retrievedReferences?: RetrievedReference[] | undefined; } /** - *

The foundation model output from the pre-processing step.

+ *

Contains citations for a part of an agent response.

* @public */ -export interface PreProcessingModelInvocationOutput { +export interface Attribution { /** - *

The unique identifier of the trace.

+ *

A list of citations and related information for a part of an agent response.

* @public */ - traceId?: string | undefined; + citations?: Citation[] | undefined; +} + +/** + *

Contains a part of an agent response and citations for it.

+ * @public + */ +export interface PayloadPart { + /** + *

A part of the agent response in bytes.

+ * @public + */ + bytes?: Uint8Array | undefined; /** - *

Details about the response from the Lambda parsing of the output of the pre-processing step.

+ *

Contains citations for a part of an agent response.

* @public */ - parsedResponse?: PreProcessingParsedResponse | undefined; + attribution?: Attribution | undefined; +} +/** + *

Contains details of the response from code interpreter.

+ * @public + */ +export interface OutputFile { /** - *

Details of the raw response from the foundation model output.

+ *

The name of the file containing response from code interpreter.

* @public */ - rawResponse?: RawResponse | undefined; + name?: string | undefined; /** - *

Contains information about the foundation model output from the pre-processing step.

+ *

The type of file that contains response from the code interpreter.

* @public */ - metadata?: Metadata | undefined; + type?: string | undefined; /** - *

Contains content about the reasoning that the model made during the pre-processing step.

+ *

The byte count of files that contains response from code interpreter.

* @public */ - reasoningContent?: ReasoningContentBlock | undefined; + bytes?: Uint8Array | undefined; } /** - *

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

+ *

Contains intermediate response for code interpreter if any files have been generated.

* @public */ -export type PreProcessingTrace = - | PreProcessingTrace.ModelInvocationInputMember - | PreProcessingTrace.ModelInvocationOutputMember - | PreProcessingTrace.$UnknownMember; +export interface FilePart { + /** + *

Files containing intermediate response for the user.

+ * @public + */ + files?: OutputFile[] | undefined; +} /** + *

The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.

* @public */ -export namespace PreProcessingTrace { +export class ModelNotReadyException extends __BaseException { + readonly name: "ModelNotReadyException" = "ModelNotReadyException"; + readonly $fault: "client" = "client"; /** - *

The input for the pre-processing step.

  • The type is PRE_PROCESSING.

  • The text contains the prompt.

  • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

- * @public + * @internal */ - export interface ModelInvocationInputMember { - modelInvocationInput: ModelInvocationInput; - modelInvocationOutput?: never; - $unknown?: never; + constructor(opts: __ExceptionOptionType) { + super({ + name: "ModelNotReadyException", + $fault: "client", + ...opts, + }); + Object.setPrototypeOf(this, ModelNotReadyException.prototype); } +} + +/** + *

Details about a caller.

+ * @public + */ +export type Caller = Caller.AgentAliasArnMember | Caller.$UnknownMember; +/** + * @public + */ +export namespace Caller { /** - *

The foundation model output from the pre-processing step.

+ *

The caller's agent alias ARN.

* @public */ - export interface ModelInvocationOutputMember { - modelInvocationInput?: never; - modelInvocationOutput: PreProcessingModelInvocationOutput; + export interface AgentAliasArnMember { + agentAliasArn: string; $unknown?: never; } @@ -4881,954 +4502,800 @@ export namespace PreProcessingTrace { * @public */ export interface $UnknownMember { - modelInvocationInput?: never; - modelInvocationOutput?: never; + agentAliasArn?: never; $unknown: [string, any]; } export interface Visitor { - modelInvocationInput: (value: ModelInvocationInput) => T; - modelInvocationOutput: (value: PreProcessingModelInvocationOutput) => T; + agentAliasArn: (value: string) => T; _: (name: string, value: any) => T; } - export const visit = (value: PreProcessingTrace, visitor: Visitor): T => { - if (value.modelInvocationInput !== undefined) return visitor.modelInvocationInput(value.modelInvocationInput); - if (value.modelInvocationOutput !== undefined) return visitor.modelInvocationOutput(value.modelInvocationOutput); + export const visit = (value: Caller, visitor: Visitor): T => { + if (value.agentAliasArn !== undefined) return visitor.agentAliasArn(value.agentAliasArn); return visitor._(value.$unknown[0], value.$unknown[1]); }; } /** - *

Invocation output from a routing classifier model.

+ *

The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.

* @public */ -export interface RoutingClassifierModelInvocationOutput { +export interface CustomOrchestrationTraceEvent { + /** + *

The text that prompted the event at this step.

+ * @public + */ + text?: string | undefined; +} + +/** + *

The trace behavior for the custom orchestration.

+ * @public + */ +export interface CustomOrchestrationTrace { + /** + *

The unique identifier of the trace.

+ * @public + */ + traceId?: string | undefined; + + /** + *

The event details used with the custom orchestration.

+ * @public + */ + event?: CustomOrchestrationTraceEvent | undefined; +} + +/** + *

Contains information about the failure of the interaction.

+ * @public + */ +export interface FailureTrace { + /** + *

The unique identifier of the trace.

+ * @public + */ + traceId?: string | undefined; + /** - *

The invocation's trace ID.

+ *

The reason the interaction failed.

* @public */ - traceId?: string | undefined; + failureReason?: string | undefined; /** - *

The invocation's raw response.

+ *

The failure code for the trace.

* @public */ - rawResponse?: RawResponse | undefined; + failureCode?: number | undefined; /** - *

The invocation's metadata.

+ *

Information about the failure that occurred.

* @public */ metadata?: Metadata | undefined; } /** - *

A trace for a routing classifier.

* @public + * @enum */ -export type RoutingClassifierTrace = - | RoutingClassifierTrace.InvocationInputMember - | RoutingClassifierTrace.ModelInvocationInputMember - | RoutingClassifierTrace.ModelInvocationOutputMember - | RoutingClassifierTrace.ObservationMember - | RoutingClassifierTrace.$UnknownMember; +export const GuardrailAction = { + INTERVENED: "INTERVENED", + NONE: "NONE", +} as const; /** * @public */ -export namespace RoutingClassifierTrace { - /** - *

The classifier's invocation input.

- * @public - */ - export interface InvocationInputMember { - invocationInput: InvocationInput; - observation?: never; - modelInvocationInput?: never; - modelInvocationOutput?: never; - $unknown?: never; - } - - /** - *

The classifier's observation.

- * @public - */ - export interface ObservationMember { - invocationInput?: never; - observation: Observation; - modelInvocationInput?: never; - modelInvocationOutput?: never; - $unknown?: never; - } +export type GuardrailAction = (typeof GuardrailAction)[keyof typeof GuardrailAction]; - /** - *

The classifier's model invocation input.

- * @public - */ - export interface ModelInvocationInputMember { - invocationInput?: never; - observation?: never; - modelInvocationInput: ModelInvocationInput; - modelInvocationOutput?: never; - $unknown?: never; - } +/** + * @public + * @enum + */ +export const GuardrailContentPolicyAction = { + BLOCKED: "BLOCKED", +} as const; - /** - *

The classifier's model invocation output.

- * @public - */ - export interface ModelInvocationOutputMember { - invocationInput?: never; - observation?: never; - modelInvocationInput?: never; - modelInvocationOutput: RoutingClassifierModelInvocationOutput; - $unknown?: never; - } +/** + * @public + */ +export type GuardrailContentPolicyAction = + (typeof GuardrailContentPolicyAction)[keyof typeof GuardrailContentPolicyAction]; - /** - * @public - */ - export interface $UnknownMember { - invocationInput?: never; - observation?: never; - modelInvocationInput?: never; - modelInvocationOutput?: never; - $unknown: [string, any]; - } +/** + * @public + * @enum + */ +export const GuardrailContentFilterConfidence = { + HIGH: "HIGH", + LOW: "LOW", + MEDIUM: "MEDIUM", + NONE: "NONE", +} as const; - export interface Visitor { - invocationInput: (value: InvocationInput) => T; - observation: (value: Observation) => T; - modelInvocationInput: (value: ModelInvocationInput) => T; - modelInvocationOutput: (value: RoutingClassifierModelInvocationOutput) => T; - _: (name: string, value: any) => T; - } +/** + * @public + */ +export type GuardrailContentFilterConfidence = + (typeof GuardrailContentFilterConfidence)[keyof typeof GuardrailContentFilterConfidence]; - export const visit = (value: RoutingClassifierTrace, visitor: Visitor): T => { - if (value.invocationInput !== undefined) return visitor.invocationInput(value.invocationInput); - if (value.observation !== undefined) return visitor.observation(value.observation); - if (value.modelInvocationInput !== undefined) return visitor.modelInvocationInput(value.modelInvocationInput); - if (value.modelInvocationOutput !== undefined) return visitor.modelInvocationOutput(value.modelInvocationOutput); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} +/** + * @public + * @enum + */ +export const GuardrailContentFilterType = { + HATE: "HATE", + INSULTS: "INSULTS", + MISCONDUCT: "MISCONDUCT", + PROMPT_ATTACK: "PROMPT_ATTACK", + SEXUAL: "SEXUAL", + VIOLENCE: "VIOLENCE", +} as const; /** - *

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

* @public */ -export type Trace = - | Trace.CustomOrchestrationTraceMember - | Trace.FailureTraceMember - | Trace.GuardrailTraceMember - | Trace.OrchestrationTraceMember - | Trace.PostProcessingTraceMember - | Trace.PreProcessingTraceMember - | Trace.RoutingClassifierTraceMember - | Trace.$UnknownMember; +export type GuardrailContentFilterType = (typeof GuardrailContentFilterType)[keyof typeof GuardrailContentFilterType]; /** + *

Details of the content filter used in the Guardrail.

* @public */ -export namespace Trace { +export interface GuardrailContentFilter { /** - *

The trace details for a trace defined in the Guardrail filter.

+ *

The type of content detected in the filter by the Guardrail.

* @public */ - export interface GuardrailTraceMember { - guardrailTrace: GuardrailTrace; - preProcessingTrace?: never; - orchestrationTrace?: never; - postProcessingTrace?: never; - routingClassifierTrace?: never; - failureTrace?: never; - customOrchestrationTrace?: never; - $unknown?: never; - } + type?: GuardrailContentFilterType | undefined; /** - *

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

+ *

The confidence level regarding the content detected in the filter by the Guardrail.

* @public */ - export interface PreProcessingTraceMember { - guardrailTrace?: never; - preProcessingTrace: PreProcessingTrace; - orchestrationTrace?: never; - postProcessingTrace?: never; - routingClassifierTrace?: never; - failureTrace?: never; - customOrchestrationTrace?: never; - $unknown?: never; - } + confidence?: GuardrailContentFilterConfidence | undefined; /** - *

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

+ *

The action placed on the content by the Guardrail filter.

* @public */ - export interface OrchestrationTraceMember { - guardrailTrace?: never; - preProcessingTrace?: never; - orchestrationTrace: OrchestrationTrace; - postProcessingTrace?: never; - routingClassifierTrace?: never; - failureTrace?: never; - customOrchestrationTrace?: never; - $unknown?: never; - } + action?: GuardrailContentPolicyAction | undefined; +} +/** + *

The details of the policy assessment in the Guardrails filter.

+ * @public + */ +export interface GuardrailContentPolicyAssessment { /** - *

Details about the post-processing step, in which the agent shapes the response..

+ *

The filter details of the policy assessment used in the Guardrails filter.

* @public */ - export interface PostProcessingTraceMember { - guardrailTrace?: never; - preProcessingTrace?: never; - orchestrationTrace?: never; - postProcessingTrace: PostProcessingTrace; - routingClassifierTrace?: never; - failureTrace?: never; - customOrchestrationTrace?: never; - $unknown?: never; - } + filters?: GuardrailContentFilter[] | undefined; +} + +/** + * @public + * @enum + */ +export const GuardrailSensitiveInformationPolicyAction = { + ANONYMIZED: "ANONYMIZED", + BLOCKED: "BLOCKED", +} as const; + +/** + * @public + */ +export type GuardrailSensitiveInformationPolicyAction = + (typeof GuardrailSensitiveInformationPolicyAction)[keyof typeof GuardrailSensitiveInformationPolicyAction]; + +/** + * @public + * @enum + */ +export const GuardrailPiiEntityType = { + ADDRESS: "ADDRESS", + AGE: "AGE", + AWS_ACCESS_KEY: "AWS_ACCESS_KEY", + AWS_SECRET_KEY: "AWS_SECRET_KEY", + CA_HEALTH_NUMBER: "CA_HEALTH_NUMBER", + CA_SOCIAL_INSURANCE_NUMBER: "CA_SOCIAL_INSURANCE_NUMBER", + CREDIT_DEBIT_CARD_CVV: "CREDIT_DEBIT_CARD_CVV", + CREDIT_DEBIT_CARD_EXPIRY: "CREDIT_DEBIT_CARD_EXPIRY", + CREDIT_DEBIT_CARD_NUMBER: "CREDIT_DEBIT_CARD_NUMBER", + DRIVER_ID: "DRIVER_ID", + EMAIL: "EMAIL", + INTERNATIONAL_BANK_ACCOUNT_NUMBER: "INTERNATIONAL_BANK_ACCOUNT_NUMBER", + IP_ADDRESS: "IP_ADDRESS", + LICENSE_PLATE: "LICENSE_PLATE", + MAC_ADDRESS: "MAC_ADDRESS", + NAME: "NAME", + PASSWORD: "PASSWORD", + PHONE: "PHONE", + PIN: "PIN", + SWIFT_CODE: "SWIFT_CODE", + UK_NATIONAL_HEALTH_SERVICE_NUMBER: "UK_NATIONAL_HEALTH_SERVICE_NUMBER", + UK_NATIONAL_INSURANCE_NUMBER: "UK_NATIONAL_INSURANCE_NUMBER", + UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER: "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", + URL: "URL", + USERNAME: "USERNAME", + US_BANK_ACCOUNT_NUMBER: "US_BANK_ACCOUNT_NUMBER", + US_BANK_ROUTING_NUMBER: "US_BANK_ROUTING_NUMBER", + US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER: "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", + US_PASSPORT_NUMBER: "US_PASSPORT_NUMBER", + US_SOCIAL_SECURITY_NUMBER: "US_SOCIAL_SECURITY_NUMBER", + VEHICLE_IDENTIFICATION_NUMBER: "VEHICLE_IDENTIFICATION_NUMBER", +} as const; - /** - *

A routing classifier's trace.

- * @public - */ - export interface RoutingClassifierTraceMember { - guardrailTrace?: never; - preProcessingTrace?: never; - orchestrationTrace?: never; - postProcessingTrace?: never; - routingClassifierTrace: RoutingClassifierTrace; - failureTrace?: never; - customOrchestrationTrace?: never; - $unknown?: never; - } +/** + * @public + */ +export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType]; +/** + *

The Guardrail filter to identify and remove personally identifiable information (PII).

+ * @public + */ +export interface GuardrailPiiEntityFilter { /** - *

Contains information about the failure of the interaction.

+ *

The type of PII the Guardrail filter has identified and removed.

* @public */ - export interface FailureTraceMember { - guardrailTrace?: never; - preProcessingTrace?: never; - orchestrationTrace?: never; - postProcessingTrace?: never; - routingClassifierTrace?: never; - failureTrace: FailureTrace; - customOrchestrationTrace?: never; - $unknown?: never; - } + type?: GuardrailPiiEntityType | undefined; /** - *

Details about the custom orchestration step in which the agent determines the order in which actions are executed.

+ *

The match to settings in the Guardrail filter to identify and remove PII.

* @public */ - export interface CustomOrchestrationTraceMember { - guardrailTrace?: never; - preProcessingTrace?: never; - orchestrationTrace?: never; - postProcessingTrace?: never; - routingClassifierTrace?: never; - failureTrace?: never; - customOrchestrationTrace: CustomOrchestrationTrace; - $unknown?: never; - } + match?: string | undefined; /** + *

The action of the Guardrail filter to identify and remove PII.

* @public */ - export interface $UnknownMember { - guardrailTrace?: never; - preProcessingTrace?: never; - orchestrationTrace?: never; - postProcessingTrace?: never; - routingClassifierTrace?: never; - failureTrace?: never; - customOrchestrationTrace?: never; - $unknown: [string, any]; - } - - export interface Visitor { - guardrailTrace: (value: GuardrailTrace) => T; - preProcessingTrace: (value: PreProcessingTrace) => T; - orchestrationTrace: (value: OrchestrationTrace) => T; - postProcessingTrace: (value: PostProcessingTrace) => T; - routingClassifierTrace: (value: RoutingClassifierTrace) => T; - failureTrace: (value: FailureTrace) => T; - customOrchestrationTrace: (value: CustomOrchestrationTrace) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: Trace, visitor: Visitor): T => { - if (value.guardrailTrace !== undefined) return visitor.guardrailTrace(value.guardrailTrace); - if (value.preProcessingTrace !== undefined) return visitor.preProcessingTrace(value.preProcessingTrace); - if (value.orchestrationTrace !== undefined) return visitor.orchestrationTrace(value.orchestrationTrace); - if (value.postProcessingTrace !== undefined) return visitor.postProcessingTrace(value.postProcessingTrace); - if (value.routingClassifierTrace !== undefined) return visitor.routingClassifierTrace(value.routingClassifierTrace); - if (value.failureTrace !== undefined) return visitor.failureTrace(value.failureTrace); - if (value.customOrchestrationTrace !== undefined) - return visitor.customOrchestrationTrace(value.customOrchestrationTrace); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + action?: GuardrailSensitiveInformationPolicyAction | undefined; } /** - *

Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

+ *

The details for the regex filter used in the Guardrail.

* @public */ -export interface TracePart { - /** - *

The unique identifier of the session with the agent.

- * @public - */ - sessionId?: string | undefined; - - /** - *

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

- * @public - */ - trace?: Trace | undefined; - +export interface GuardrailRegexFilter { /** - *

The part's caller chain.

+ *

The name details for the regex filter used in the Guardrail.

* @public */ - callerChain?: Caller[] | undefined; + name?: string | undefined; /** - *

The time of the trace.

+ *

The regex details for the regex filter used in the Guardrail.

* @public */ - eventTime?: Date | undefined; + regex?: string | undefined; /** - *

The part's collaborator name.

+ *

The match details for the regex filter used in the Guardrail.

* @public */ - collaboratorName?: string | undefined; + match?: string | undefined; /** - *

The unique identifier of the agent.

+ *

The action details for the regex filter used in the Guardrail.

* @public */ - agentId?: string | undefined; + action?: GuardrailSensitiveInformationPolicyAction | undefined; +} +/** + *

The details of the sensitive policy assessment used in the Guardrail.

+ * @public + */ +export interface GuardrailSensitiveInformationPolicyAssessment { /** - *

The unique identifier of the alias of the agent.

+ *

The details of the PII entities used in the sensitive policy assessment for the Guardrail.

* @public */ - agentAliasId?: string | undefined; + piiEntities?: GuardrailPiiEntityFilter[] | undefined; /** - *

The version of the agent.

+ *

The details of the regexes used in the sensitive policy assessment for the Guardrail.

* @public */ - agentVersion?: string | undefined; + regexes?: GuardrailRegexFilter[] | undefined; } /** - *

The response from invoking the agent and associated citations and trace information.

* @public + * @enum */ -export type ResponseStream = - | ResponseStream.AccessDeniedExceptionMember - | ResponseStream.BadGatewayExceptionMember - | ResponseStream.ChunkMember - | ResponseStream.ConflictExceptionMember - | ResponseStream.DependencyFailedExceptionMember - | ResponseStream.FilesMember - | ResponseStream.InternalServerExceptionMember - | ResponseStream.ModelNotReadyExceptionMember - | ResponseStream.ResourceNotFoundExceptionMember - | ResponseStream.ReturnControlMember - | ResponseStream.ServiceQuotaExceededExceptionMember - | ResponseStream.ThrottlingExceptionMember - | ResponseStream.TraceMember - | ResponseStream.ValidationExceptionMember - | ResponseStream.$UnknownMember; +export const GuardrailTopicPolicyAction = { + BLOCKED: "BLOCKED", +} as const; /** * @public */ -export namespace ResponseStream { - /** - *

Contains a part of an agent response and citations for it.

- * @public - */ - export interface ChunkMember { - chunk: PayloadPart; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException?: never; - files?: never; - $unknown?: never; - } +export type GuardrailTopicPolicyAction = (typeof GuardrailTopicPolicyAction)[keyof typeof GuardrailTopicPolicyAction]; - /** - *

Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.

- * @public - */ - export interface TraceMember { - chunk?: never; - trace: TracePart; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException?: never; - files?: never; - $unknown?: never; - } +/** + * @public + * @enum + */ +export const GuardrailTopicType = { + DENY: "DENY", +} as const; + +/** + * @public + */ +export type GuardrailTopicType = (typeof GuardrailTopicType)[keyof typeof GuardrailTopicType]; +/** + *

The details for a specific topic defined in the Guardrail.

+ * @public + */ +export interface GuardrailTopic { /** - *

Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.

+ *

The name details on a specific topic in the Guardrail.

* @public */ - export interface ReturnControlMember { - chunk?: never; - trace?: never; - returnControl: ReturnControlPayload; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException?: never; - files?: never; - $unknown?: never; - } + name?: string | undefined; /** - *

An internal server error occurred. Retry your request.

+ *

The type details on a specific topic in the Guardrail.

* @public */ - export interface InternalServerExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException: InternalServerException; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException?: never; - files?: never; - $unknown?: never; - } + type?: GuardrailTopicType | undefined; /** - *

Input validation failed. Check your request parameters and retry the request.

+ *

The action details on a specific topic in the Guardrail.

* @public */ - export interface ValidationExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException: ValidationException; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException?: never; - files?: never; - $unknown?: never; - } + action?: GuardrailTopicPolicyAction | undefined; +} +/** + *

The details of the policy assessment used in the Guardrail.

+ * @public + */ +export interface GuardrailTopicPolicyAssessment { /** - *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

+ *

The topic details of the policy assessment used in the Guardrail.

* @public */ - export interface ResourceNotFoundExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException: ResourceNotFoundException; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException?: never; - files?: never; - $unknown?: never; - } + topics?: GuardrailTopic[] | undefined; +} + +/** + * @public + * @enum + */ +export const GuardrailWordPolicyAction = { + BLOCKED: "BLOCKED", +} as const; + +/** + * @public + */ +export type GuardrailWordPolicyAction = (typeof GuardrailWordPolicyAction)[keyof typeof GuardrailWordPolicyAction]; +/** + *

The custom word details for the filter in the Guardrail.

+ * @public + */ +export interface GuardrailCustomWord { /** - *

The number of requests exceeds the service quota. Resubmit your request later.

+ *

The match details for the custom word filter in the Guardrail.

* @public */ - export interface ServiceQuotaExceededExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException: ServiceQuotaExceededException; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException?: never; - files?: never; - $unknown?: never; - } + match?: string | undefined; /** - *

The number of requests exceeds the limit. Resubmit your request later.

+ *

The action details for the custom word filter in the Guardrail.

* @public */ - export interface ThrottlingExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException: ThrottlingException; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException?: never; - files?: never; - $unknown?: never; - } + action?: GuardrailWordPolicyAction | undefined; +} + +/** + * @public + * @enum + */ +export const GuardrailManagedWordType = { + PROFANITY: "PROFANITY", +} as const; + +/** + * @public + */ +export type GuardrailManagedWordType = (typeof GuardrailManagedWordType)[keyof typeof GuardrailManagedWordType]; +/** + *

The managed word details for the filter in the Guardrail.

+ * @public + */ +export interface GuardrailManagedWord { /** - *

The request is denied because of missing access permissions. Check your permissions and retry your request.

+ *

The match details for the managed word filter in the Guardrail.

* @public */ - export interface AccessDeniedExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException: AccessDeniedException; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException?: never; - files?: never; - $unknown?: never; - } + match?: string | undefined; /** - *

There was a conflict performing an operation. Resolve the conflict and retry your request.

+ *

The type details for the managed word filter in the Guardrail.

* @public */ - export interface ConflictExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException: ConflictException; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException?: never; - files?: never; - $unknown?: never; - } + type?: GuardrailManagedWordType | undefined; /** - *

There was an issue with a dependency. Check the resource configurations and retry the request.

+ *

The action details for the managed word filter in the Guardrail.

* @public */ - export interface DependencyFailedExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException: DependencyFailedException; - badGatewayException?: never; - modelNotReadyException?: never; - files?: never; - $unknown?: never; - } + action?: GuardrailWordPolicyAction | undefined; +} +/** + *

The assessment details for words defined in the Guardrail filter.

+ * @public + */ +export interface GuardrailWordPolicyAssessment { /** - *

There was an issue with a dependency due to a server issue. Retry your request.

+ *

The custom word details for words defined in the Guardrail filter.

* @public */ - export interface BadGatewayExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException: BadGatewayException; - modelNotReadyException?: never; - files?: never; - $unknown?: never; - } + customWords?: GuardrailCustomWord[] | undefined; /** - *

The model specified in the request is not ready to serve Inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.

+ *

The managed word lists for words defined in the Guardrail filter.

* @public */ - export interface ModelNotReadyExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException: ModelNotReadyException; - files?: never; - $unknown?: never; - } + managedWordLists?: GuardrailManagedWord[] | undefined; +} +/** + *

Assessment details of the content analyzed by Guardrails.

+ * @public + */ +export interface GuardrailAssessment { /** - *

Contains intermediate response for code interpreter if any files have been generated.

+ *

Topic policy details of the Guardrail.

* @public - */ - export interface FilesMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException?: never; - files: FilePart; - $unknown?: never; - } + */ + topicPolicy?: GuardrailTopicPolicyAssessment | undefined; /** + *

Content policy details of the Guardrail.

* @public */ - export interface $UnknownMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - modelNotReadyException?: never; - files?: never; - $unknown: [string, any]; - } + contentPolicy?: GuardrailContentPolicyAssessment | undefined; - export interface Visitor { - chunk: (value: PayloadPart) => T; - trace: (value: TracePart) => T; - returnControl: (value: ReturnControlPayload) => T; - internalServerException: (value: InternalServerException) => T; - validationException: (value: ValidationException) => T; - resourceNotFoundException: (value: ResourceNotFoundException) => T; - serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T; - throttlingException: (value: ThrottlingException) => T; - accessDeniedException: (value: AccessDeniedException) => T; - conflictException: (value: ConflictException) => T; - dependencyFailedException: (value: DependencyFailedException) => T; - badGatewayException: (value: BadGatewayException) => T; - modelNotReadyException: (value: ModelNotReadyException) => T; - files: (value: FilePart) => T; - _: (name: string, value: any) => T; - } + /** + *

Word policy details of the Guardrail.

+ * @public + */ + wordPolicy?: GuardrailWordPolicyAssessment | undefined; - export const visit = (value: ResponseStream, visitor: Visitor): T => { - if (value.chunk !== undefined) return visitor.chunk(value.chunk); - if (value.trace !== undefined) return visitor.trace(value.trace); - if (value.returnControl !== undefined) return visitor.returnControl(value.returnControl); - if (value.internalServerException !== undefined) - return visitor.internalServerException(value.internalServerException); - if (value.validationException !== undefined) return visitor.validationException(value.validationException); - if (value.resourceNotFoundException !== undefined) - return visitor.resourceNotFoundException(value.resourceNotFoundException); - if (value.serviceQuotaExceededException !== undefined) - return visitor.serviceQuotaExceededException(value.serviceQuotaExceededException); - if (value.throttlingException !== undefined) return visitor.throttlingException(value.throttlingException); - if (value.accessDeniedException !== undefined) return visitor.accessDeniedException(value.accessDeniedException); - if (value.conflictException !== undefined) return visitor.conflictException(value.conflictException); - if (value.dependencyFailedException !== undefined) - return visitor.dependencyFailedException(value.dependencyFailedException); - if (value.badGatewayException !== undefined) return visitor.badGatewayException(value.badGatewayException); - if (value.modelNotReadyException !== undefined) return visitor.modelNotReadyException(value.modelNotReadyException); - if (value.files !== undefined) return visitor.files(value.files); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + /** + *

Sensitive Information policy details of Guardrail.

+ * @public + */ + sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment | undefined; } /** + *

The trace details used in the Guardrail.

* @public */ -export interface InvokeAgentResponse { +export interface GuardrailTrace { /** - *

The agent's response to the user prompt.

+ *

The trace action details used with the Guardrail.

* @public */ - completion: AsyncIterable | undefined; + action?: GuardrailAction | undefined; /** - *

The MIME type of the input data in the request. The default value is application/json.

+ *

The details of the trace Id used in the Guardrail Trace.

* @public */ - contentType: string | undefined; + traceId?: string | undefined; /** - *

The unique identifier of the session with the agent.

+ *

The details of the input assessments used in the Guardrail Trace.

* @public */ - sessionId: string | undefined; + inputAssessments?: GuardrailAssessment[] | undefined; /** - *

The unique identifier of the agent memory.

+ *

The details of the output assessments used in the Guardrail Trace.

* @public */ - memoryId?: string | undefined; + outputAssessments?: GuardrailAssessment[] | undefined; + + /** + *

Contains information about the Guardrail output.

+ * @public + */ + metadata?: Metadata | undefined; } /** - *

Settings for a model called with InvokeInlineAgent.

+ *

Contains information about the code interpreter being invoked.

* @public */ -export interface InlineBedrockModelConfigurations { +export interface CodeInterpreterInvocationInput { /** - *

The latency configuration for the model.

+ *

The code for the code interpreter to use.

* @public */ - performanceConfig?: PerformanceConfiguration | undefined; + code?: string | undefined; + + /** + *

Files that are uploaded for code interpreter to use.

+ * @public + */ + files?: string[] | undefined; } /** * @public * @enum */ -export const RelayConversationHistory = { - DISABLED: "DISABLED", - TO_COLLABORATOR: "TO_COLLABORATOR", +export const InvocationType = { + ACTION_GROUP: "ACTION_GROUP", + ACTION_GROUP_CODE_INTERPRETER: "ACTION_GROUP_CODE_INTERPRETER", + AGENT_COLLABORATOR: "AGENT_COLLABORATOR", + FINISH: "FINISH", + KNOWLEDGE_BASE: "KNOWLEDGE_BASE", } as const; /** * @public */ -export type RelayConversationHistory = (typeof RelayConversationHistory)[keyof typeof RelayConversationHistory]; +export type InvocationType = (typeof InvocationType)[keyof typeof InvocationType]; /** - *

Settings of an inline collaborator agent.

+ *

Contains details about the knowledge base to look up and the query to be made.

* @public */ -export interface CollaboratorConfiguration { +export interface KnowledgeBaseLookupInput { /** - *

Name of the inline collaborator agent which must be the same name as specified for agentName.

+ *

The query made to the knowledge base.

* @public */ - collaboratorName: string | undefined; + text?: string | undefined; /** - *

Instructions that tell the inline collaborator agent what it should do and how it should interact with users.

+ *

The unique identifier of the knowledge base to look up.

* @public */ - collaboratorInstruction: string | undefined; + knowledgeBaseId?: string | undefined; +} +/** + *

Contains information pertaining to the action group or knowledge base that is being invoked.

+ * @public + */ +export interface InvocationInput { /** - *

The Amazon Resource Name (ARN) of the inline collaborator agent.

+ *

The unique identifier of the trace.

* @public */ - agentAliasArn?: string | undefined; + traceId?: string | undefined; /** - *

A relay conversation history for the inline collaborator agent.

+ *

Specifies whether the agent is invoking an action group or a knowledge base.

* @public */ - relayConversationHistory?: RelayConversationHistory | undefined; + invocationType?: InvocationType | undefined; + + /** + *

Contains information about the action group to be invoked.

+ * @public + */ + actionGroupInvocationInput?: ActionGroupInvocationInput | undefined; + + /** + *

Contains details about the knowledge base to look up and the query to be made.

+ * @public + */ + knowledgeBaseLookupInput?: KnowledgeBaseLookupInput | undefined; + + /** + *

Contains information about the code interpreter to be invoked.

+ * @public + */ + codeInterpreterInvocationInput?: CodeInterpreterInvocationInput | undefined; + + /** + *

The collaborator's invocation input.

+ * @public + */ + agentCollaboratorInvocationInput?: AgentCollaboratorInvocationInput | undefined; } /** - *

The configuration details for the guardrail.

+ *

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

* @public */ -export interface GuardrailConfigurationWithArn { +export interface InferenceConfiguration { /** - *

The unique identifier for the guardrail.

+ *

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

* @public */ - guardrailIdentifier: string | undefined; + temperature?: number | undefined; /** - *

The version of the guardrail.

+ *

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.

* @public */ - guardrailVersion: string | undefined; + topP?: number | undefined; + + /** + *

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

+ * @public + */ + topK?: number | undefined; + + /** + *

The maximum number of tokens allowed in the generated response.

+ * @public + */ + maximumLength?: number | undefined; + + /** + *

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

+ * @public + */ + stopSequences?: string[] | undefined; } /** * @public * @enum */ -export const PromptState = { - DISABLED: "DISABLED", - ENABLED: "ENABLED", +export const CreationMode = { + DEFAULT: "DEFAULT", + OVERRIDDEN: "OVERRIDDEN", } as const; /** * @public */ -export type PromptState = (typeof PromptState)[keyof typeof PromptState]; +export type CreationMode = (typeof CreationMode)[keyof typeof CreationMode]; /** - *

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

* @public + * @enum */ -export interface PromptConfiguration { +export const PromptType = { + KNOWLEDGE_BASE_RESPONSE_GENERATION: "KNOWLEDGE_BASE_RESPONSE_GENERATION", + ORCHESTRATION: "ORCHESTRATION", + POST_PROCESSING: "POST_PROCESSING", + PRE_PROCESSING: "PRE_PROCESSING", + ROUTING_CLASSIFIER: "ROUTING_CLASSIFIER", +} as const; + +/** + * @public + */ +export type PromptType = (typeof PromptType)[keyof typeof PromptType]; + +/** + *

The input for the pre-processing step.

  • The type matches the agent step.

  • The text contains the prompt.

  • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

+ * @public + */ +export interface ModelInvocationInput { /** - *

The step in the agent sequence that this prompt configuration applies to.

+ *

The unique identifier of the trace.

* @public */ - promptType?: PromptType | undefined; + traceId?: string | undefined; /** - *

Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

+ *

The text that prompted the agent at this step.

* @public */ - promptCreationMode?: CreationMode | undefined; + text?: string | undefined; /** - *

Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

  • PRE_PROCESSING – ENABLED

  • ORCHESTRATION – ENABLED

  • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED

  • POST_PROCESSING – DISABLED

+ *

The step in the agent sequence.

* @public */ - promptState?: PromptState | undefined; + type?: PromptType | undefined; /** - *

Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.

+ *

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.

* @public */ - basePromptTemplate?: string | undefined; + overrideLambda?: string | undefined; /** - *

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

+ *

Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.

+ * @public + */ + promptCreationMode?: CreationMode | undefined; + + /** + *

Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.

* @public */ inferenceConfiguration?: InferenceConfiguration | undefined; /** - *

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

+ *

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.

* @public */ parserMode?: CreationMode | undefined; /** - *

The foundation model to use.

+ *

The identifier of a foundation model.

* @public */ foundationModel?: string | undefined; +} +/** + *

Contains the raw output from the foundation model.

+ * @public + */ +export interface RawResponse { /** - *

If the Converse or ConverseStream operations support the model, additionalModelRequestFields contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration field.

For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.

+ *

The foundation model's raw output content.

* @public */ - additionalModelRequestFields?: __DocumentType | undefined; + content?: string | undefined; } /** - *

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

+ *

Contains information about the reasoning that the model used to return the content in the content block.

* @public */ -export interface PromptOverrideConfiguration { +export interface ReasoningTextBlock { /** - *

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

+ *

Text describing the reasoning that the model used to return the content in the content block.

* @public */ - promptConfigurations: PromptConfiguration[] | undefined; + text: string | undefined; /** - *

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.

+ *

A hash of all the messages in the conversation to ensure that the content in the reasoning text block isn't tampered with. You must submit the signature in subsequent Converse requests, in addition to the previous messages. If the previous messages are tampered with, the response throws an error.

* @public */ - overrideLambda?: string | undefined; + signature?: string | undefined; } /** - *

The structure of the executor invoking the actions in custom orchestration.

+ *

Contains content regarding the reasoning that the foundation model made with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

* @public */ -export type OrchestrationExecutor = OrchestrationExecutor.LambdaMember | OrchestrationExecutor.$UnknownMember; +export type ReasoningContentBlock = + | ReasoningContentBlock.ReasoningTextMember + | ReasoningContentBlock.RedactedContentMember + | ReasoningContentBlock.$UnknownMember; /** * @public */ -export namespace OrchestrationExecutor { +export namespace ReasoningContentBlock { /** - *

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

+ *

Contains information about the reasoning that the model used to return the content in the content block.

* @public */ - export interface LambdaMember { - lambda: string; + export interface ReasoningTextMember { + reasoningText: ReasoningTextBlock; + redactedContent?: never; + $unknown?: never; + } + + /** + *

The content in the reasoning that was encrypted by the model provider for trust and safety reasons.

+ * @public + */ + export interface RedactedContentMember { + reasoningText?: never; + redactedContent: Uint8Array; $unknown?: never; } @@ -5836,467 +5303,439 @@ export namespace OrchestrationExecutor { * @public */ export interface $UnknownMember { - lambda?: never; + reasoningText?: never; + redactedContent?: never; $unknown: [string, any]; } export interface Visitor { - lambda: (value: string) => T; + reasoningText: (value: ReasoningTextBlock) => T; + redactedContent: (value: Uint8Array) => T; _: (name: string, value: any) => T; } - export const visit = (value: OrchestrationExecutor, visitor: Visitor): T => { - if (value.lambda !== undefined) return visitor.lambda(value.lambda); + export const visit = (value: ReasoningContentBlock, visitor: Visitor): T => { + if (value.reasoningText !== undefined) return visitor.reasoningText(value.reasoningText); + if (value.redactedContent !== undefined) return visitor.redactedContent(value.redactedContent); return visitor._(value.$unknown[0], value.$unknown[1]); }; } /** - *

Contains details of the custom orchestration configured for the agent.

+ *

The foundation model output from the orchestration step.

* @public */ -export interface CustomOrchestration { +export interface OrchestrationModelInvocationOutput { /** - *

The structure of the executor invoking the actions in custom orchestration.

+ *

The unique identifier of the trace.

* @public */ - executor?: OrchestrationExecutor | undefined; + traceId?: string | undefined; + + /** + *

Contains details of the raw response from the foundation model output.

+ * @public + */ + rawResponse?: RawResponse | undefined; + + /** + *

Contains information about the foundation model output from the orchestration step.

+ * @public + */ + metadata?: Metadata | undefined; + + /** + *

Contains content about the reasoning that the model made during the orchestration step.

+ * @public + */ + reasoningContent?: ReasoningContentBlock | undefined; } /** - *

Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeInlineAgent request. Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. For more information, see Control session context

+ *

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

* @public */ -export interface InlineSessionState { +export interface CodeInterpreterInvocationOutput { /** - *

Contains attributes that persist across a session and the values of those attributes.

+ *

Contains the successful output returned from code execution

* @public */ - sessionAttributes?: Record | undefined; + executionOutput?: string | undefined; /** - *

Contains attributes that persist across a session and the values of those attributes.

+ *

Contains the error returned from code execution.

* @public */ - promptSessionAttributes?: Record | undefined; + executionError?: string | undefined; /** - *

Contains information about the results from the action group invocation. For more information, see Return control to the agent developer.

If you include this field in the sessionState field, the inputText field will be ignored.

 + *

Contains output files, if generated by code execution.

* @public */ - returnControlInvocationResults?: InvocationResultMember[] | undefined; + files?: string[] | undefined; /** - *

The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeInlineAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer.

+ *

Indicates if the execution of the code timed out.

* @public */ - invocationId?: string | undefined; + executionTimeout?: boolean | undefined; /** - *

Contains information about the files used by code interpreter.

+ *

Contains information about the output from the code interpreter.

* @public */ - files?: InputFile[] | undefined; + metadata?: Metadata | undefined; +} + +/** + *

Contains details about the response to the user.

+ * @public + */ +export interface FinalResponse { + /** + *

The text in the response to the user.

+ * @public + */ + text?: string | undefined; /** - *

Contains the conversation history that persist across sessions.

+ *

Contains information about the invoke agent operation.

* @public */ - conversationHistory?: ConversationHistory | undefined; + metadata?: Metadata | undefined; +} + +/** + *

Contains details about the results from looking up the knowledge base.

+ * @public + */ +export interface KnowledgeBaseLookupOutput { + /** + *

Contains metadata about the sources cited for the generated response.

+ * @public + */ + retrievedReferences?: RetrievedReference[] | undefined; + + /** + *

Contains information about the knowledge base output.

+ * @public + */ + metadata?: Metadata | undefined; } /** * @public * @enum */ -export const OrchestrationType = { - CUSTOM_ORCHESTRATION: "CUSTOM_ORCHESTRATION", - DEFAULT: "DEFAULT", +export const Source = { + ACTION_GROUP: "ACTION_GROUP", + KNOWLEDGE_BASE: "KNOWLEDGE_BASE", + PARSER: "PARSER", } as const; /** * @public */ -export type OrchestrationType = (typeof OrchestrationType)[keyof typeof OrchestrationType]; +export type Source = (typeof Source)[keyof typeof Source]; /** - *

Contains a part of an agent response and citations for it.

+ *

Contains details about the agent's response to reprompt the input.

* @public */ -export interface InlineAgentPayloadPart { +export interface RepromptResponse { /** - *

A part of the agent response in bytes.

+ *

The text reprompting the input.

* @public */ - bytes?: Uint8Array | undefined; + text?: string | undefined; /** - *

Contains citations for a part of an agent response.

+ *

Specifies what output is prompting the agent to reprompt the input.

* @public */ - attribution?: Attribution | undefined; + source?: Source | undefined; } /** - *

Contains intermediate response for code interpreter if any files have been generated.

* @public + * @enum */ -export interface InlineAgentFilePart { - /** - *

Files containing intermediate response for the user.

- * @public - */ - files?: OutputFile[] | undefined; -} +export const Type = { + ACTION_GROUP: "ACTION_GROUP", + AGENT_COLLABORATOR: "AGENT_COLLABORATOR", + ASK_USER: "ASK_USER", + FINISH: "FINISH", + KNOWLEDGE_BASE: "KNOWLEDGE_BASE", + REPROMPT: "REPROMPT", +} as const; /** - *

Contains information to return from the action group that the agent has predicted to invoke.

This data type is used in the InvokeAgent response API operation.

* @public */ -export interface InlineAgentReturnControlPayload { +export type Type = (typeof Type)[keyof typeof Type]; + +/** + *

Contains the result or output of an action group or knowledge base, or the response to the user.

+ * @public + */ +export interface Observation { /** - *

A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.

+ *

The unique identifier of the trace.

* @public */ - invocationInputs?: InvocationInputMember[] | undefined; + traceId?: string | undefined; /** - *

The identifier of the action group invocation.

+ *

Specifies what kind of information the agent returns in the observation. The following values are possible.

  • ACTION_GROUP – The agent returns the result of an action group.

  • KNOWLEDGE_BASE – The agent returns information from a knowledge base.

  • FINISH – The agent returns a final response to the user with no follow-up.

  • ASK_USER – The agent asks the user a question.

  • REPROMPT – The agent prompts the user again for the same information.

* @public */ - invocationId?: string | undefined; -} + type?: Type | undefined; -/** - *

Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

- * @public - */ -export interface InlineAgentTracePart { /** - *

The unique identifier of the session with the agent.

+ *

Contains the JSON-formatted string returned by the API invoked by the action group.

* @public */ - sessionId?: string | undefined; + actionGroupInvocationOutput?: ActionGroupInvocationOutput | undefined; /** - *

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

+ *

A collaborator's invocation output.

* @public */ - trace?: Trace | undefined; + agentCollaboratorInvocationOutput?: AgentCollaboratorInvocationOutput | undefined; /** - *

The caller chain for the trace part.

+ *

Contains details about the results from looking up the knowledge base.

* @public */ - callerChain?: Caller[] | undefined; + knowledgeBaseLookupOutput?: KnowledgeBaseLookupOutput | undefined; /** - *

The time that trace occurred.

+ *

Contains details about the response to the user.

* @public */ - eventTime?: Date | undefined; + finalResponse?: FinalResponse | undefined; /** - *

The collaborator name for the trace part.

+ *

Contains details about the response to reprompt the input.

* @public */ - collaboratorName?: string | undefined; + repromptResponse?: RepromptResponse | undefined; + + /** + *

Contains the JSON-formatted string returned by the API invoked by the code interpreter.

+ * @public + */ + codeInterpreterInvocationOutput?: CodeInterpreterInvocationOutput | undefined; } /** - *

The response from invoking the agent and associated citations and trace information.

+ *

Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

* @public */ -export type InlineAgentResponseStream = - | InlineAgentResponseStream.AccessDeniedExceptionMember - | InlineAgentResponseStream.BadGatewayExceptionMember - | InlineAgentResponseStream.ChunkMember - | InlineAgentResponseStream.ConflictExceptionMember - | InlineAgentResponseStream.DependencyFailedExceptionMember - | InlineAgentResponseStream.FilesMember - | InlineAgentResponseStream.InternalServerExceptionMember - | InlineAgentResponseStream.ResourceNotFoundExceptionMember - | InlineAgentResponseStream.ReturnControlMember - | InlineAgentResponseStream.ServiceQuotaExceededExceptionMember - | InlineAgentResponseStream.ThrottlingExceptionMember - | InlineAgentResponseStream.TraceMember - | InlineAgentResponseStream.ValidationExceptionMember - | InlineAgentResponseStream.$UnknownMember; +export interface Rationale { + /** + *

The unique identifier of the trace step.

+ * @public + */ + traceId?: string | undefined; + + /** + *

The reasoning or thought process of the agent, based on the input.

+ * @public + */ + text?: string | undefined; +} /** + *

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

* @public */ -export namespace InlineAgentResponseStream { +export type OrchestrationTrace = + | OrchestrationTrace.InvocationInputMember + | OrchestrationTrace.ModelInvocationInputMember + | OrchestrationTrace.ModelInvocationOutputMember + | OrchestrationTrace.ObservationMember + | OrchestrationTrace.RationaleMember + | OrchestrationTrace.$UnknownMember; + +/** + * @public + */ +export namespace OrchestrationTrace { /** - *

Contains a part of an agent response and citations for it.

+ *

Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.

* @public */ - export interface ChunkMember { - chunk: InlineAgentPayloadPart; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - files?: never; + export interface RationaleMember { + rationale: Rationale; + invocationInput?: never; + observation?: never; + modelInvocationInput?: never; + modelInvocationOutput?: never; $unknown?: never; } /** - *

Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.

+ *

Contains information pertaining to the action group or knowledge base that is being invoked.

* @public */ - export interface TraceMember { - chunk?: never; - trace: InlineAgentTracePart; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - files?: never; + export interface InvocationInputMember { + rationale?: never; + invocationInput: InvocationInput; + observation?: never; + modelInvocationInput?: never; + modelInvocationOutput?: never; $unknown?: never; } /** - *

Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.

+ *

Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.

* @public */ - export interface ReturnControlMember { - chunk?: never; - trace?: never; - returnControl: InlineAgentReturnControlPayload; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - files?: never; + export interface ObservationMember { + rationale?: never; + invocationInput?: never; + observation: Observation; + modelInvocationInput?: never; + modelInvocationOutput?: never; $unknown?: never; } /** - *

An internal server error occurred. Retry your request.

+ *

The input for the orchestration step.

  • The type is ORCHESTRATION.

  • The text contains the prompt.

  • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

* @public */ - export interface InternalServerExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException: InternalServerException; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - files?: never; + export interface ModelInvocationInputMember { + rationale?: never; + invocationInput?: never; + observation?: never; + modelInvocationInput: ModelInvocationInput; + modelInvocationOutput?: never; $unknown?: never; } /** - *

Input validation failed. Check your request parameters and retry the request.

+ *

Contains information pertaining to the output from the foundation model that is being invoked.

* @public */ - export interface ValidationExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException: ValidationException; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - files?: never; + export interface ModelInvocationOutputMember { + rationale?: never; + invocationInput?: never; + observation?: never; + modelInvocationInput?: never; + modelInvocationOutput: OrchestrationModelInvocationOutput; $unknown?: never; } /** - *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

* @public */ - export interface ResourceNotFoundExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException: ResourceNotFoundException; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - files?: never; - $unknown?: never; + export interface $UnknownMember { + rationale?: never; + invocationInput?: never; + observation?: never; + modelInvocationInput?: never; + modelInvocationOutput?: never; + $unknown: [string, any]; } - /** - *

The number of requests exceeds the service quota. Resubmit your request later.

- * @public - */ - export interface ServiceQuotaExceededExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException: ServiceQuotaExceededException; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - files?: never; - $unknown?: never; + export interface Visitor { + rationale: (value: Rationale) => T; + invocationInput: (value: InvocationInput) => T; + observation: (value: Observation) => T; + modelInvocationInput: (value: ModelInvocationInput) => T; + modelInvocationOutput: (value: OrchestrationModelInvocationOutput) => T; + _: (name: string, value: any) => T; } + export const visit = (value: OrchestrationTrace, visitor: Visitor): T => { + if (value.rationale !== undefined) return visitor.rationale(value.rationale); + if (value.invocationInput !== undefined) return visitor.invocationInput(value.invocationInput); + if (value.observation !== undefined) return visitor.observation(value.observation); + if (value.modelInvocationInput !== undefined) return visitor.modelInvocationInput(value.modelInvocationInput); + if (value.modelInvocationOutput !== undefined) return visitor.modelInvocationOutput(value.modelInvocationOutput); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + *

Details about the response from the Lambda parsing of the output from the post-processing step.

+ * @public + */ +export interface PostProcessingParsedResponse { /** - *

The number of requests exceeds the limit. Resubmit your request later.

+ *

The text returned by the parser.

* @public */ - export interface ThrottlingExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException: ThrottlingException; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - files?: never; - $unknown?: never; - } + text?: string | undefined; +} +/** + *

The foundation model output from the post-processing step.

+ * @public + */ +export interface PostProcessingModelInvocationOutput { /** - *

The request is denied because of missing access permissions. Check your permissions and retry your request.

+ *

The unique identifier of the trace.

* @public */ - export interface AccessDeniedExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException: AccessDeniedException; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - files?: never; - $unknown?: never; - } + traceId?: string | undefined; /** - *

There was a conflict performing an operation. Resolve the conflict and retry your request.

- * @public - */ - export interface ConflictExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException: ConflictException; - dependencyFailedException?: never; - badGatewayException?: never; - files?: never; - $unknown?: never; - } + *

Details about the response from the Lambda parsing of the output of the post-processing step.

+ * @public + */ + parsedResponse?: PostProcessingParsedResponse | undefined; /** - *

There was an issue with a dependency. Check the resource configurations and retry the request.

+ *

Details of the raw response from the foundation model output.

* @public */ - export interface DependencyFailedExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException: DependencyFailedException; - badGatewayException?: never; - files?: never; - $unknown?: never; - } + rawResponse?: RawResponse | undefined; /** - *

There was an issue with a dependency due to a server issue. Retry your request.

+ *

Contains information about the foundation model output from the post-processing step.

* @public */ - export interface BadGatewayExceptionMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException: BadGatewayException; - files?: never; + metadata?: Metadata | undefined; + + /** + *

Contains content about the reasoning that the model made during the post-processing step.

+ * @public + */ + reasoningContent?: ReasoningContentBlock | undefined; +} + +/** + *

Details about the post-processing step, in which the agent shapes the response.

+ * @public + */ +export type PostProcessingTrace = + | PostProcessingTrace.ModelInvocationInputMember + | PostProcessingTrace.ModelInvocationOutputMember + | PostProcessingTrace.$UnknownMember; + +/** + * @public + */ +export namespace PostProcessingTrace { + /** + *

The input for the post-processing step.

  • The type is POST_PROCESSING.

  • The text contains the prompt.

  • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

+ * @public + */ + export interface ModelInvocationInputMember { + modelInvocationInput: ModelInvocationInput; + modelInvocationOutput?: never; $unknown?: never; } /** - *

Contains intermediate response for code interpreter if any files have been generated.

+ *

The foundation model output from the post-processing step.

* @public */ - export interface FilesMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - files: InlineAgentFilePart; + export interface ModelInvocationOutputMember { + modelInvocationInput?: never; + modelInvocationOutput: PostProcessingModelInvocationOutput; $unknown?: never; } @@ -6304,224 +5743,368 @@ export namespace InlineAgentResponseStream { * @public */ export interface $UnknownMember { - chunk?: never; - trace?: never; - returnControl?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - files?: never; + modelInvocationInput?: never; + modelInvocationOutput?: never; $unknown: [string, any]; } export interface Visitor { - chunk: (value: InlineAgentPayloadPart) => T; - trace: (value: InlineAgentTracePart) => T; - returnControl: (value: InlineAgentReturnControlPayload) => T; - internalServerException: (value: InternalServerException) => T; - validationException: (value: ValidationException) => T; - resourceNotFoundException: (value: ResourceNotFoundException) => T; - serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T; - throttlingException: (value: ThrottlingException) => T; - accessDeniedException: (value: AccessDeniedException) => T; - conflictException: (value: ConflictException) => T; - dependencyFailedException: (value: DependencyFailedException) => T; - badGatewayException: (value: BadGatewayException) => T; - files: (value: InlineAgentFilePart) => T; + modelInvocationInput: (value: ModelInvocationInput) => T; + modelInvocationOutput: (value: PostProcessingModelInvocationOutput) => T; _: (name: string, value: any) => T; } - export const visit = (value: InlineAgentResponseStream, visitor: Visitor): T => { - if (value.chunk !== undefined) return visitor.chunk(value.chunk); - if (value.trace !== undefined) return visitor.trace(value.trace); - if (value.returnControl !== undefined) return visitor.returnControl(value.returnControl); - if (value.internalServerException !== undefined) - return visitor.internalServerException(value.internalServerException); - if (value.validationException !== undefined) return visitor.validationException(value.validationException); - if (value.resourceNotFoundException !== undefined) - return visitor.resourceNotFoundException(value.resourceNotFoundException); - if (value.serviceQuotaExceededException !== undefined) - return visitor.serviceQuotaExceededException(value.serviceQuotaExceededException); - if (value.throttlingException !== undefined) return visitor.throttlingException(value.throttlingException); - if (value.accessDeniedException !== undefined) return visitor.accessDeniedException(value.accessDeniedException); - if (value.conflictException !== undefined) return visitor.conflictException(value.conflictException); - if (value.dependencyFailedException !== undefined) - return visitor.dependencyFailedException(value.dependencyFailedException); - if (value.badGatewayException !== undefined) return visitor.badGatewayException(value.badGatewayException); - if (value.files !== undefined) return visitor.files(value.files); + export const visit = (value: PostProcessingTrace, visitor: Visitor): T => { + if (value.modelInvocationInput !== undefined) return visitor.modelInvocationInput(value.modelInvocationInput); + if (value.modelInvocationOutput !== undefined) return visitor.modelInvocationOutput(value.modelInvocationOutput); return visitor._(value.$unknown[0], value.$unknown[1]); }; } /** + *

Details about the response from the Lambda parsing of the output from the pre-processing step.

* @public */ -export interface InvokeInlineAgentResponse { - /** - *

The inline agent's response to the user prompt.

- * @public - */ - completion: AsyncIterable | undefined; - +export interface PreProcessingParsedResponse { /** - *

The MIME type of the input data in the request. The default value is application/json.

+ *

The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.

* @public */ - contentType: string | undefined; + rationale?: string | undefined; /** - *

The unique identifier of the session with the agent.

+ *

Whether the user input is valid or not. If false, the agent doesn't proceed to orchestration.

* @public */ - sessionId: string | undefined; + isValid?: boolean | undefined; } /** + *

The foundation model output from the pre-processing step.

* @public */ -export interface DeleteAgentMemoryRequest { +export interface PreProcessingModelInvocationOutput { /** - *

The unique identifier of the agent to which the alias belongs.

+ *

The unique identifier of the trace.

* @public */ - agentId: string | undefined; + traceId?: string | undefined; /** - *

The unique identifier of an alias of an agent.

+ *

Details about the response from the Lambda parsing of the output of the pre-processing step.

* @public */ - agentAliasId: string | undefined; + parsedResponse?: PreProcessingParsedResponse | undefined; /** - *

The unique identifier of the memory.

+ *

Details of the raw response from the foundation model output.

* @public */ - memoryId?: string | undefined; + rawResponse?: RawResponse | undefined; /** - *

The unique session identifier of the memory.

+ *

Contains information about the foundation model output from the pre-processing step.

* @public */ - sessionId?: string | undefined; + metadata?: Metadata | undefined; + + /** + *

Contains content about the reasoning that the model made during the pre-processing step.

+ * @public + */ + reasoningContent?: ReasoningContentBlock | undefined; } /** + *

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

* @public */ -export interface DeleteAgentMemoryResponse {} +export type PreProcessingTrace = + | PreProcessingTrace.ModelInvocationInputMember + | PreProcessingTrace.ModelInvocationOutputMember + | PreProcessingTrace.$UnknownMember; /** * @public - * @enum */ -export const MemoryType = { - SESSION_SUMMARY: "SESSION_SUMMARY", -} as const; +export namespace PreProcessingTrace { + /** + *

The input for the pre-processing step.

  • The type is PRE_PROCESSING.

  • The text contains the prompt.

  • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

+ * @public + */ + export interface ModelInvocationInputMember { + modelInvocationInput: ModelInvocationInput; + modelInvocationOutput?: never; + $unknown?: never; + } + + /** + *

The foundation model output from the pre-processing step.

+ * @public + */ + export interface ModelInvocationOutputMember { + modelInvocationInput?: never; + modelInvocationOutput: PreProcessingModelInvocationOutput; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + modelInvocationInput?: never; + modelInvocationOutput?: never; + $unknown: [string, any]; + } + + export interface Visitor { + modelInvocationInput: (value: ModelInvocationInput) => T; + modelInvocationOutput: (value: PreProcessingModelInvocationOutput) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: PreProcessingTrace, visitor: Visitor): T => { + if (value.modelInvocationInput !== undefined) return visitor.modelInvocationInput(value.modelInvocationInput); + if (value.modelInvocationOutput !== undefined) return visitor.modelInvocationOutput(value.modelInvocationOutput); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + *

Invocation output from a routing classifier model.

+ * @public + */ +export interface RoutingClassifierModelInvocationOutput { + /** + *

The invocation's trace ID.

+ * @public + */ + traceId?: string | undefined; + + /** + *

The invocation's raw response.

+ * @public + */ + rawResponse?: RawResponse | undefined; + + /** + *

The invocation's metadata.

+ * @public + */ + metadata?: Metadata | undefined; +} /** + *

A trace for a routing classifier.

* @public */ -export type MemoryType = (typeof MemoryType)[keyof typeof MemoryType]; +export type RoutingClassifierTrace = + | RoutingClassifierTrace.InvocationInputMember + | RoutingClassifierTrace.ModelInvocationInputMember + | RoutingClassifierTrace.ModelInvocationOutputMember + | RoutingClassifierTrace.ObservationMember + | RoutingClassifierTrace.$UnknownMember; /** * @public */ -export interface GetAgentMemoryRequest { +export namespace RoutingClassifierTrace { /** - *

If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

+ *

The classifier's invocation input.

* @public */ - nextToken?: string | undefined; + export interface InvocationInputMember { + invocationInput: InvocationInput; + observation?: never; + modelInvocationInput?: never; + modelInvocationOutput?: never; + $unknown?: never; + } /** - *

The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

+ *

The classifier's observation.

* @public */ - maxItems?: number | undefined; + export interface ObservationMember { + invocationInput?: never; + observation: Observation; + modelInvocationInput?: never; + modelInvocationOutput?: never; + $unknown?: never; + } /** - *

The unique identifier of the agent to which the alias belongs.

+ *

The classifier's model invocation input.

* @public */ - agentId: string | undefined; + export interface ModelInvocationInputMember { + invocationInput?: never; + observation?: never; + modelInvocationInput: ModelInvocationInput; + modelInvocationOutput?: never; + $unknown?: never; + } /** - *

The unique identifier of an alias of an agent.

+ *

The classifier's model invocation output.

* @public */ - agentAliasId: string | undefined; + export interface ModelInvocationOutputMember { + invocationInput?: never; + observation?: never; + modelInvocationInput?: never; + modelInvocationOutput: RoutingClassifierModelInvocationOutput; + $unknown?: never; + } /** - *

The type of memory.

* @public */ - memoryType: MemoryType | undefined; + export interface $UnknownMember { + invocationInput?: never; + observation?: never; + modelInvocationInput?: never; + modelInvocationOutput?: never; + $unknown: [string, any]; + } - /** - *

The unique identifier of the memory.

- * @public - */ - memoryId: string | undefined; + export interface Visitor { + invocationInput: (value: InvocationInput) => T; + observation: (value: Observation) => T; + modelInvocationInput: (value: ModelInvocationInput) => T; + modelInvocationOutput: (value: RoutingClassifierModelInvocationOutput) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: RoutingClassifierTrace, visitor: Visitor): T => { + if (value.invocationInput !== undefined) return visitor.invocationInput(value.invocationInput); + if (value.observation !== undefined) return visitor.observation(value.observation); + if (value.modelInvocationInput !== undefined) return visitor.modelInvocationInput(value.modelInvocationInput); + if (value.modelInvocationOutput !== undefined) return visitor.modelInvocationOutput(value.modelInvocationOutput); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** - *

Contains details of a session summary.

+ *

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

* @public */ -export interface MemorySessionSummary { +export type Trace = + | Trace.CustomOrchestrationTraceMember + | Trace.FailureTraceMember + | Trace.GuardrailTraceMember + | Trace.OrchestrationTraceMember + | Trace.PostProcessingTraceMember + | Trace.PreProcessingTraceMember + | Trace.RoutingClassifierTraceMember + | Trace.$UnknownMember; + +/** + * @public + */ +export namespace Trace { /** - *

The unique identifier of the memory where the session summary is stored.

+ *

The trace details for a trace defined in the Guardrail filter.

* @public */ - memoryId?: string | undefined; + export interface GuardrailTraceMember { + guardrailTrace: GuardrailTrace; + preProcessingTrace?: never; + orchestrationTrace?: never; + postProcessingTrace?: never; + routingClassifierTrace?: never; + failureTrace?: never; + customOrchestrationTrace?: never; + $unknown?: never; + } /** - *

The identifier for this session.

+ *

Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.

* @public */ - sessionId?: string | undefined; + export interface PreProcessingTraceMember { + guardrailTrace?: never; + preProcessingTrace: PreProcessingTrace; + orchestrationTrace?: never; + postProcessingTrace?: never; + routingClassifierTrace?: never; + failureTrace?: never; + customOrchestrationTrace?: never; + $unknown?: never; + } /** - *

The start time for this session.

+ *

Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.

* @public */ - sessionStartTime?: Date | undefined; + export interface OrchestrationTraceMember { + guardrailTrace?: never; + preProcessingTrace?: never; + orchestrationTrace: OrchestrationTrace; + postProcessingTrace?: never; + routingClassifierTrace?: never; + failureTrace?: never; + customOrchestrationTrace?: never; + $unknown?: never; + } /** - *

The time when the memory duration for the session is set to end.

+ *

Details about the post-processing step, in which the agent shapes the response..

* @public */ - sessionExpiryTime?: Date | undefined; + export interface PostProcessingTraceMember { + guardrailTrace?: never; + preProcessingTrace?: never; + orchestrationTrace?: never; + postProcessingTrace: PostProcessingTrace; + routingClassifierTrace?: never; + failureTrace?: never; + customOrchestrationTrace?: never; + $unknown?: never; + } /** - *

The summarized text for this session.

+ *

A routing classifier's trace.

* @public */ - summaryText?: string | undefined; -} + export interface RoutingClassifierTraceMember { + guardrailTrace?: never; + preProcessingTrace?: never; + orchestrationTrace?: never; + postProcessingTrace?: never; + routingClassifierTrace: RoutingClassifierTrace; + failureTrace?: never; + customOrchestrationTrace?: never; + $unknown?: never; + } -/** - *

Contains sessions summaries.

- * @public - */ -export type Memory = Memory.SessionSummaryMember | Memory.$UnknownMember; + /** + *

Contains information about the failure of the interaction.

+ * @public + */ + export interface FailureTraceMember { + guardrailTrace?: never; + preProcessingTrace?: never; + orchestrationTrace?: never; + postProcessingTrace?: never; + routingClassifierTrace?: never; + failureTrace: FailureTrace; + customOrchestrationTrace?: never; + $unknown?: never; + } -/** - * @public - */ -export namespace Memory { /** - *

Contains summary of a session.

+ *

Details about the custom orchestration step in which the agent determines the order in which actions are executed.

* @public */ - export interface SessionSummaryMember { - sessionSummary: MemorySessionSummary; + export interface CustomOrchestrationTraceMember { + guardrailTrace?: never; + preProcessingTrace?: never; + orchestrationTrace?: never; + postProcessingTrace?: never; + routingClassifierTrace?: never; + failureTrace?: never; + customOrchestrationTrace: CustomOrchestrationTrace; $unknown?: never; } @@ -6529,311 +6112,424 @@ export namespace Memory { * @public */ export interface $UnknownMember { - sessionSummary?: never; + guardrailTrace?: never; + preProcessingTrace?: never; + orchestrationTrace?: never; + postProcessingTrace?: never; + routingClassifierTrace?: never; + failureTrace?: never; + customOrchestrationTrace?: never; $unknown: [string, any]; } export interface Visitor { - sessionSummary: (value: MemorySessionSummary) => T; + guardrailTrace: (value: GuardrailTrace) => T; + preProcessingTrace: (value: PreProcessingTrace) => T; + orchestrationTrace: (value: OrchestrationTrace) => T; + postProcessingTrace: (value: PostProcessingTrace) => T; + routingClassifierTrace: (value: RoutingClassifierTrace) => T; + failureTrace: (value: FailureTrace) => T; + customOrchestrationTrace: (value: CustomOrchestrationTrace) => T; _: (name: string, value: any) => T; } - export const visit = (value: Memory, visitor: Visitor): T => { - if (value.sessionSummary !== undefined) return visitor.sessionSummary(value.sessionSummary); + export const visit = (value: Trace, visitor: Visitor): T => { + if (value.guardrailTrace !== undefined) return visitor.guardrailTrace(value.guardrailTrace); + if (value.preProcessingTrace !== undefined) return visitor.preProcessingTrace(value.preProcessingTrace); + if (value.orchestrationTrace !== undefined) return visitor.orchestrationTrace(value.orchestrationTrace); + if (value.postProcessingTrace !== undefined) return visitor.postProcessingTrace(value.postProcessingTrace); + if (value.routingClassifierTrace !== undefined) return visitor.routingClassifierTrace(value.routingClassifierTrace); + if (value.failureTrace !== undefined) return visitor.failureTrace(value.failureTrace); + if (value.customOrchestrationTrace !== undefined) + return visitor.customOrchestrationTrace(value.customOrchestrationTrace); return visitor._(value.$unknown[0], value.$unknown[1]); }; } /** + *

Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

* @public */ -export interface GetAgentMemoryResponse { +export interface TracePart { /** - *

If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

+ *

The unique identifier of the session with the agent.

* @public */ - nextToken?: string | undefined; + sessionId?: string | undefined; /** - *

Contains details of the sessions stored in the memory

+ *

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

* @public */ - memoryContents?: Memory[] | undefined; -} + trace?: Trace | undefined; -/** - *

Contains information about the text prompt to optimize.

- * @public - */ -export interface TextPrompt { /** - *

The text in the text prompt to optimize.

+ *

The part's caller chain.

* @public */ - text: string | undefined; -} - -/** - *

Contains information about the prompt to optimize.

- * @public - */ -export type InputPrompt = InputPrompt.TextPromptMember | InputPrompt.$UnknownMember; - -/** - * @public - */ -export namespace InputPrompt { + callerChain?: Caller[] | undefined; + /** - *

Contains information about the text prompt to optimize.

+ *

The time of the trace.

* @public */ - export interface TextPromptMember { - textPrompt: TextPrompt; - $unknown?: never; - } + eventTime?: Date | undefined; /** + *

The part's collaborator name.

* @public */ - export interface $UnknownMember { - textPrompt?: never; - $unknown: [string, any]; - } - - export interface Visitor { - textPrompt: (value: TextPrompt) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: InputPrompt, visitor: Visitor): T => { - if (value.textPrompt !== undefined) return visitor.textPrompt(value.textPrompt); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} + collaboratorName?: string | undefined; -/** - * @public - */ -export interface OptimizePromptRequest { /** - *

Contains the prompt to optimize.

+ *

The unique identifier of the agent.

* @public */ - input: InputPrompt | undefined; + agentId?: string | undefined; /** - *

The unique identifier of the model that you want to optimize the prompt for.

+ *

The unique identifier of the alias of the agent.

* @public */ - targetModelId: string | undefined; -} + agentAliasId?: string | undefined; -/** - *

An event in which the prompt was analyzed in preparation for optimization.

- * @public - */ -export interface AnalyzePromptEvent { /** - *

A message describing the analysis of the prompt.

+ *

The version of the agent.

* @public */ - message?: string | undefined; + agentVersion?: string | undefined; } /** - *

Contains information about the optimized prompt.

+ *

The response from invoking the agent and associated citations and trace information.

* @public */ -export type OptimizedPrompt = OptimizedPrompt.TextPromptMember | OptimizedPrompt.$UnknownMember; +export type ResponseStream = + | ResponseStream.AccessDeniedExceptionMember + | ResponseStream.BadGatewayExceptionMember + | ResponseStream.ChunkMember + | ResponseStream.ConflictExceptionMember + | ResponseStream.DependencyFailedExceptionMember + | ResponseStream.FilesMember + | ResponseStream.InternalServerExceptionMember + | ResponseStream.ModelNotReadyExceptionMember + | ResponseStream.ResourceNotFoundExceptionMember + | ResponseStream.ReturnControlMember + | ResponseStream.ServiceQuotaExceededExceptionMember + | ResponseStream.ThrottlingExceptionMember + | ResponseStream.TraceMember + | ResponseStream.ValidationExceptionMember + | ResponseStream.$UnknownMember; /** * @public */ -export namespace OptimizedPrompt { +export namespace ResponseStream { /** - *

Contains information about the text in the prompt that was optimized.

+ *

Contains a part of an agent response and citations for it.

* @public */ - export interface TextPromptMember { - textPrompt: TextPrompt; + export interface ChunkMember { + chunk: PayloadPart; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + modelNotReadyException?: never; + files?: never; $unknown?: never; } /** + *

Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.

* @public */ - export interface $UnknownMember { - textPrompt?: never; - $unknown: [string, any]; + export interface TraceMember { + chunk?: never; + trace: TracePart; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + modelNotReadyException?: never; + files?: never; + $unknown?: never; } - export interface Visitor { - textPrompt: (value: TextPrompt) => T; - _: (name: string, value: any) => T; + /** + *

Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.

+ * @public + */ + export interface ReturnControlMember { + chunk?: never; + trace?: never; + returnControl: ReturnControlPayload; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + modelNotReadyException?: never; + files?: never; + $unknown?: never; } - export const visit = (value: OptimizedPrompt, visitor: Visitor): T => { - if (value.textPrompt !== undefined) return visitor.textPrompt(value.textPrompt); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} - -/** - *

An event in which the prompt was optimized.

- * @public - */ -export interface OptimizedPromptEvent { /** - *

Contains information about the optimized prompt.

+ *

An internal server error occurred. Retry your request.

* @public */ - optimizedPrompt?: OptimizedPrompt | undefined; -} - -/** - *

The stream containing events in the prompt optimization process.

- * @public - */ -export type OptimizedPromptStream = - | OptimizedPromptStream.AccessDeniedExceptionMember - | OptimizedPromptStream.AnalyzePromptEventMember - | OptimizedPromptStream.BadGatewayExceptionMember - | OptimizedPromptStream.DependencyFailedExceptionMember - | OptimizedPromptStream.InternalServerExceptionMember - | OptimizedPromptStream.OptimizedPromptEventMember - | OptimizedPromptStream.ThrottlingExceptionMember - | OptimizedPromptStream.ValidationExceptionMember - | OptimizedPromptStream.$UnknownMember; + export interface InternalServerExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException: InternalServerException; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + modelNotReadyException?: never; + files?: never; + $unknown?: never; + } -/** - * @public - */ -export namespace OptimizedPromptStream { /** - *

An event in which the prompt was optimized.

+ *

Input validation failed. Check your request parameters and retry the request.

* @public */ - export interface OptimizedPromptEventMember { - optimizedPromptEvent: OptimizedPromptEvent; - analyzePromptEvent?: never; + export interface ValidationExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; internalServerException?: never; + validationException: ValidationException; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; throttlingException?: never; - validationException?: never; - dependencyFailedException?: never; accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; badGatewayException?: never; + modelNotReadyException?: never; + files?: never; $unknown?: never; } /** - *

An event in which the prompt was analyzed in preparation for optimization.

+ *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

* @public */ - export interface AnalyzePromptEventMember { - optimizedPromptEvent?: never; - analyzePromptEvent: AnalyzePromptEvent; + export interface ResourceNotFoundExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; internalServerException?: never; + validationException?: never; + resourceNotFoundException: ResourceNotFoundException; + serviceQuotaExceededException?: never; throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + modelNotReadyException?: never; + files?: never; + $unknown?: never; + } + + /** + *

The number of requests exceeds the service quota. Resubmit your request later.

+ * @public + */ + export interface ServiceQuotaExceededExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException: ServiceQuotaExceededException; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; dependencyFailedException?: never; + badGatewayException?: never; + modelNotReadyException?: never; + files?: never; + $unknown?: never; + } + + /** + *

The number of requests exceeds the limit. Resubmit your request later.

+ * @public + */ + export interface ThrottlingExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException: ThrottlingException; accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; badGatewayException?: never; + modelNotReadyException?: never; + files?: never; $unknown?: never; } /** - *

An internal server error occurred. Retry your request.

+ *

The request is denied because of missing access permissions. Check your permissions and retry your request.

* @public */ - export interface InternalServerExceptionMember { - optimizedPromptEvent?: never; - analyzePromptEvent?: never; - internalServerException: InternalServerException; - throttlingException?: never; + export interface AccessDeniedExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException: AccessDeniedException; + conflictException?: never; dependencyFailedException?: never; - accessDeniedException?: never; badGatewayException?: never; + modelNotReadyException?: never; + files?: never; $unknown?: never; } /** - *

Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase Provisioned Throughput to increase the rate or number of tokens you can process.

+ *

There was a conflict performing an operation. Resolve the conflict and retry your request.

* @public */ - export interface ThrottlingExceptionMember { - optimizedPromptEvent?: never; - analyzePromptEvent?: never; + export interface ConflictExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; internalServerException?: never; - throttlingException: ThrottlingException; validationException?: never; - dependencyFailedException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; accessDeniedException?: never; + conflictException: ConflictException; + dependencyFailedException?: never; badGatewayException?: never; + modelNotReadyException?: never; + files?: never; $unknown?: never; } /** - *

Input validation failed. Check your request parameters and retry the request.

+ *

There was an issue with a dependency. Check the resource configurations and retry the request.

* @public */ - export interface ValidationExceptionMember { - optimizedPromptEvent?: never; - analyzePromptEvent?: never; + export interface DependencyFailedExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; throttlingException?: never; - validationException: ValidationException; - dependencyFailedException?: never; accessDeniedException?: never; + conflictException?: never; + dependencyFailedException: DependencyFailedException; badGatewayException?: never; + modelNotReadyException?: never; + files?: never; $unknown?: never; } /** - *

There was an issue with a dependency. Check the resource configurations and retry the request.

+ *

There was an issue with a dependency due to a server issue. Retry your request.

* @public */ - export interface DependencyFailedExceptionMember { - optimizedPromptEvent?: never; - analyzePromptEvent?: never; + export interface BadGatewayExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; internalServerException?: never; - throttlingException?: never; validationException?: never; - dependencyFailedException: DependencyFailedException; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; accessDeniedException?: never; - badGatewayException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException: BadGatewayException; + modelNotReadyException?: never; + files?: never; $unknown?: never; } /** - *

The request is denied because of missing access permissions. Check your permissions and retry your request.

+ *

The model specified in the request is not ready to serve Inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.

* @public */ - export interface AccessDeniedExceptionMember { - optimizedPromptEvent?: never; - analyzePromptEvent?: never; + export interface ModelNotReadyExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; internalServerException?: never; - throttlingException?: never; validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; dependencyFailedException?: never; - accessDeniedException: AccessDeniedException; badGatewayException?: never; + modelNotReadyException: ModelNotReadyException; + files?: never; $unknown?: never; } /** - *

There was an issue with a dependency due to a server issue. Retry your request.

+ *

Contains intermediate response for code interpreter if any files have been generated.

* @public */ - export interface BadGatewayExceptionMember { - optimizedPromptEvent?: never; - analyzePromptEvent?: never; + export interface FilesMember { + chunk?: never; + trace?: never; + returnControl?: never; internalServerException?: never; - throttlingException?: never; validationException?: never; - dependencyFailedException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; accessDeniedException?: never; - badGatewayException: BadGatewayException; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + modelNotReadyException?: never; + files: FilePart; $unknown?: never; } @@ -6841,40 +6537,60 @@ export namespace OptimizedPromptStream { * @public */ export interface $UnknownMember { - optimizedPromptEvent?: never; - analyzePromptEvent?: never; + chunk?: never; + trace?: never; + returnControl?: never; internalServerException?: never; - throttlingException?: never; validationException?: never; - dependencyFailedException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; badGatewayException?: never; + modelNotReadyException?: never; + files?: never; $unknown: [string, any]; } export interface Visitor { - optimizedPromptEvent: (value: OptimizedPromptEvent) => T; - analyzePromptEvent: (value: AnalyzePromptEvent) => T; + chunk: (value: PayloadPart) => T; + trace: (value: TracePart) => T; + returnControl: (value: ReturnControlPayload) => T; internalServerException: (value: InternalServerException) => T; - throttlingException: (value: ThrottlingException) => T; validationException: (value: ValidationException) => T; - dependencyFailedException: (value: DependencyFailedException) => T; + resourceNotFoundException: (value: ResourceNotFoundException) => T; + serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T; + throttlingException: (value: ThrottlingException) => T; accessDeniedException: (value: AccessDeniedException) => T; + conflictException: (value: ConflictException) => T; + dependencyFailedException: (value: DependencyFailedException) => T; badGatewayException: (value: BadGatewayException) => T; + modelNotReadyException: (value: ModelNotReadyException) => T; + files: (value: FilePart) => T; _: (name: string, value: any) => T; } - export const visit = (value: OptimizedPromptStream, visitor: Visitor): T => { - if (value.optimizedPromptEvent !== undefined) return visitor.optimizedPromptEvent(value.optimizedPromptEvent); - if (value.analyzePromptEvent !== undefined) return visitor.analyzePromptEvent(value.analyzePromptEvent); + export const visit = (value: ResponseStream, visitor: Visitor): T => { + if (value.chunk !== undefined) return visitor.chunk(value.chunk); + if (value.trace !== undefined) return visitor.trace(value.trace); + if (value.returnControl !== undefined) return visitor.returnControl(value.returnControl); if (value.internalServerException !== undefined) return visitor.internalServerException(value.internalServerException); - if (value.throttlingException !== undefined) return visitor.throttlingException(value.throttlingException); if (value.validationException !== undefined) return visitor.validationException(value.validationException); + if (value.resourceNotFoundException !== undefined) + return visitor.resourceNotFoundException(value.resourceNotFoundException); + if (value.serviceQuotaExceededException !== undefined) + return visitor.serviceQuotaExceededException(value.serviceQuotaExceededException); + if (value.throttlingException !== undefined) return visitor.throttlingException(value.throttlingException); + if (value.accessDeniedException !== undefined) return visitor.accessDeniedException(value.accessDeniedException); + if (value.conflictException !== undefined) return visitor.conflictException(value.conflictException); if (value.dependencyFailedException !== undefined) return visitor.dependencyFailedException(value.dependencyFailedException); - if (value.accessDeniedException !== undefined) return visitor.accessDeniedException(value.accessDeniedException); if (value.badGatewayException !== undefined) return visitor.badGatewayException(value.badGatewayException); + if (value.modelNotReadyException !== undefined) return visitor.modelNotReadyException(value.modelNotReadyException); + if (value.files !== undefined) return visitor.files(value.files); return visitor._(value.$unknown[0], value.$unknown[1]); }; } @@ -6882,968 +6598,1212 @@ export namespace OptimizedPromptStream { /** * @public */ -export interface OptimizePromptResponse { +export interface InvokeAgentResponse { /** - *

The prompt after being optimized for the task.

+ *

The agent's response to the user prompt.

* @public */ - optimizedPrompt: AsyncIterable | undefined; + completion: AsyncIterable | undefined; + + /** + *

The MIME type of the input data in the request. The default value is application/json.

+ * @public + */ + contentType: string | undefined; + + /** + *

The unique identifier of the session with the agent.

+ * @public + */ + sessionId: string | undefined; + + /** + *

The unique identifier of the agent memory.

+ * @public + */ + memoryId?: string | undefined; } /** - *

Contains information about a text document to rerank.

+ *

Settings for a model called with InvokeInlineAgent.

* @public */ -export interface RerankTextDocument { +export interface InlineBedrockModelConfigurations { /** - *

The text of the document.

+ *

The latency configuration for the model.

* @public */ - text?: string | undefined; + performanceConfig?: PerformanceConfiguration | undefined; } /** * @public * @enum */ -export const RerankQueryContentType = { - TEXT: "TEXT", +export const RelayConversationHistory = { + DISABLED: "DISABLED", + TO_COLLABORATOR: "TO_COLLABORATOR", +} as const; + +/** + * @public + */ +export type RelayConversationHistory = (typeof RelayConversationHistory)[keyof typeof RelayConversationHistory]; + +/** + *

Settings of an inline collaborator agent.

+ * @public + */ +export interface CollaboratorConfiguration { + /** + *

Name of the inline collaborator agent which must be the same name as specified for agentName.

+ * @public + */ + collaboratorName: string | undefined; + + /** + *

Instructions that tell the inline collaborator agent what it should do and how it should interact with users.

+ * @public + */ + collaboratorInstruction: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the inline collaborator agent.

+ * @public + */ + agentAliasArn?: string | undefined; + + /** + *

A relay conversation history for the inline collaborator agent.

+ * @public + */ + relayConversationHistory?: RelayConversationHistory | undefined; +} + +/** + *

The configuration details for the guardrail.

+ * @public + */ +export interface GuardrailConfigurationWithArn { + /** + *

The unique identifier for the guardrail.

+ * @public + */ + guardrailIdentifier: string | undefined; + + /** + *

The version of the guardrail.

+ * @public + */ + guardrailVersion: string | undefined; +} + +/** + * @public + * @enum + */ +export const PromptState = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", } as const; /** * @public */ -export type RerankQueryContentType = (typeof RerankQueryContentType)[keyof typeof RerankQueryContentType]; +export type PromptState = (typeof PromptState)[keyof typeof PromptState]; /** - *

Contains information about a query to submit to the reranker model.

+ *

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

* @public */ -export interface RerankQuery { +export interface PromptConfiguration { /** - *

The type of the query.

+ *

The step in the agent sequence that this prompt configuration applies to.

* @public */ - type: RerankQueryContentType | undefined; + promptType?: PromptType | undefined; /** - *

Contains information about a text query.

+ *

Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

* @public */ - textQuery: RerankTextDocument | undefined; -} + promptCreationMode?: CreationMode | undefined; -/** - *

Contains configurations for a reranker model.

- * @public - */ -export interface BedrockRerankingModelConfiguration { /** - *

The ARN of the reranker model.

+ *

Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

  • PRE_PROCESSING – ENABLED

  • ORCHESTRATION – ENABLED

  • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED

  • POST_PROCESSING – DISABLED

* @public */ - modelArn: string | undefined; + promptState?: PromptState | undefined; /** - *

A JSON object whose keys are request fields for the model and whose values are values for those fields.

+ *

Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.

* @public */ - additionalModelRequestFields?: Record | undefined; -} + basePromptTemplate?: string | undefined; -/** - *

Contains configurations for an Amazon Bedrock reranker model.

- * @public - */ -export interface BedrockRerankingConfiguration { /** - *

The number of results to return after reranking.

+ *

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

* @public */ - numberOfResults?: number | undefined; + inferenceConfiguration?: InferenceConfiguration | undefined; /** - *

Contains configurations for a reranker model.

+ *

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

* @public */ - modelConfiguration: BedrockRerankingModelConfiguration | undefined; + parserMode?: CreationMode | undefined; + + /** + *

The foundation model to use.

+ * @public + */ + foundationModel?: string | undefined; + + /** + *

If the Converse or ConverseStream operations support the model, additionalModelRequestFields contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration field.

For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.

+ * @public + */ + additionalModelRequestFields?: __DocumentType | undefined; } /** + *

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

* @public - * @enum */ -export const RerankingConfigurationType = { - BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL", -} as const; +export interface PromptOverrideConfiguration { + /** + *

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

+ * @public + */ + promptConfigurations: PromptConfiguration[] | undefined; + + /** + *

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.

+ * @public + */ + overrideLambda?: string | undefined; +} /** + *

The structure of the executor invoking the actions in custom orchestration.

* @public */ -export type RerankingConfigurationType = (typeof RerankingConfigurationType)[keyof typeof RerankingConfigurationType]; +export type OrchestrationExecutor = OrchestrationExecutor.LambdaMember | OrchestrationExecutor.$UnknownMember; /** - *

Contains configurations for reranking.

* @public */ -export interface RerankingConfiguration { +export namespace OrchestrationExecutor { /** - *

The type of reranker that the configurations apply to.

+ *

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

* @public */ - type: RerankingConfigurationType | undefined; + export interface LambdaMember { + lambda: string; + $unknown?: never; + } /** - *

Contains configurations for an Amazon Bedrock reranker.

* @public */ - bedrockRerankingConfiguration: BedrockRerankingConfiguration | undefined; + export interface $UnknownMember { + lambda?: never; + $unknown: [string, any]; + } + + export interface Visitor { + lambda: (value: string) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: OrchestrationExecutor, visitor: Visitor): T => { + if (value.lambda !== undefined) return visitor.lambda(value.lambda); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** + *

Contains details of the custom orchestration configured for the agent.

* @public - * @enum */ -export const RerankDocumentType = { - JSON: "JSON", - TEXT: "TEXT", -} as const; +export interface CustomOrchestration { + /** + *

The structure of the executor invoking the actions in custom orchestration.

+ * @public + */ + executor?: OrchestrationExecutor | undefined; +} /** + *

Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeInlineAgent request. Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. For more information, see Control session context

* @public */ -export type RerankDocumentType = (typeof RerankDocumentType)[keyof typeof RerankDocumentType]; +export interface InlineSessionState { + /** + *

Contains attributes that persist across a session and the values of those attributes.

+ * @public + */ + sessionAttributes?: Record | undefined; -/** - *

Contains information about a document to rerank. Choose the type to define and include the field that corresponds to the type.

- * @public - */ -export interface RerankDocument { /** - *

The type of document to rerank.

+ *

Contains attributes that persist across a session and the values of those attributes.

* @public */ - type: RerankDocumentType | undefined; + promptSessionAttributes?: Record | undefined; /** - *

Contains information about a text document to rerank.

+ *

Contains information about the results from the action group invocation. For more information, see Return control to the agent developer.

If you include this field in the sessionState field, the inputText field will be ignored.

 * @public */ - textDocument?: RerankTextDocument | undefined; + returnControlInvocationResults?: InvocationResultMember[] | undefined; /** - *

Contains a JSON document to rerank.

+ *

The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeInlineAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer.

* @public */ - jsonDocument?: __DocumentType | undefined; + invocationId?: string | undefined; + + /** + *

Contains information about the files used by code interpreter.

+ * @public + */ + files?: InputFile[] | undefined; + + /** + *

Contains the conversation history that persist across sessions.

+ * @public + */ + conversationHistory?: ConversationHistory | undefined; } /** * @public * @enum */ -export const RerankSourceType = { - INLINE: "INLINE", +export const OrchestrationType = { + CUSTOM_ORCHESTRATION: "CUSTOM_ORCHESTRATION", + DEFAULT: "DEFAULT", } as const; /** * @public */ -export type RerankSourceType = (typeof RerankSourceType)[keyof typeof RerankSourceType]; +export type OrchestrationType = (typeof OrchestrationType)[keyof typeof OrchestrationType]; /** - *

Contains information about a source for reranking.

+ *

Contains a part of an agent response and citations for it.

* @public */ -export interface RerankSource { +export interface InlineAgentPayloadPart { /** - *

The type of the source.

+ *

A part of the agent response in bytes.

* @public */ - type: RerankSourceType | undefined; + bytes?: Uint8Array | undefined; /** - *

Contains an inline definition of a source for reranking.

+ *

Contains citations for a part of an agent response.

* @public */ - inlineDocumentSource: RerankDocument | undefined; + attribution?: Attribution | undefined; } /** + *

Contains intermediate response for code interpreter if any files have been generated.

* @public */ -export interface RerankRequest { - /** - *

An array of objects, each of which contains information about a query to submit to the reranker model.

- * @public - */ - queries: RerankQuery[] | undefined; - +export interface InlineAgentFilePart { /** - *

An array of objects, each of which contains information about the sources to rerank.

+ *

Files containing intermediate response for the user.

* @public */ - sources: RerankSource[] | undefined; + files?: OutputFile[] | undefined; +} +/** + *

Contains information to return from the action group that the agent has predicted to invoke.

This data type is used in the InvokeAgent response API operation.

+ * @public + */ +export interface InlineAgentReturnControlPayload { /** - *

Contains configurations for reranking.

+ *

A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.

* @public */ - rerankingConfiguration: RerankingConfiguration | undefined; + invocationInputs?: InvocationInputMember[] | undefined; /** - *

If the total number of results was greater than could fit in a response, a token is returned in the nextToken field. You can enter that token in this field to return the next batch of results.

+ *

The identifier of the action group invocation.

* @public */ - nextToken?: string | undefined; + invocationId?: string | undefined; } /** - *

Contains information about a document that was reranked.

+ *

Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

* @public */ -export interface RerankResult { +export interface InlineAgentTracePart { /** - *

The ranking of the document. The lower a number, the higher the document is ranked.

+ *

The unique identifier of the session with the agent.

* @public */ - index: number | undefined; + sessionId?: string | undefined; /** - *

The relevance score of the document.

+ *

Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.

* @public */ - relevanceScore: number | undefined; + trace?: Trace | undefined; /** - *

Contains information about the document.

+ *

The caller chain for the trace part.

* @public */ - document?: RerankDocument | undefined; + callerChain?: Caller[] | undefined; + + /** + *

The time that trace occurred.

+ * @public + */ + eventTime?: Date | undefined; + + /** + *

The collaborator name for the trace part.

+ * @public + */ + collaboratorName?: string | undefined; } /** + *

The response from invoking the agent and associated citations and trace information.

* @public */ -export interface RerankResponse { +export type InlineAgentResponseStream = + | InlineAgentResponseStream.AccessDeniedExceptionMember + | InlineAgentResponseStream.BadGatewayExceptionMember + | InlineAgentResponseStream.ChunkMember + | InlineAgentResponseStream.ConflictExceptionMember + | InlineAgentResponseStream.DependencyFailedExceptionMember + | InlineAgentResponseStream.FilesMember + | InlineAgentResponseStream.InternalServerExceptionMember + | InlineAgentResponseStream.ResourceNotFoundExceptionMember + | InlineAgentResponseStream.ReturnControlMember + | InlineAgentResponseStream.ServiceQuotaExceededExceptionMember + | InlineAgentResponseStream.ThrottlingExceptionMember + | InlineAgentResponseStream.TraceMember + | InlineAgentResponseStream.ValidationExceptionMember + | InlineAgentResponseStream.$UnknownMember; + +/** + * @public + */ +export namespace InlineAgentResponseStream { /** - *

An array of objects, each of which contains information about the results of reranking.

+ *

Contains a part of an agent response and citations for it.

* @public */ - results: RerankResult[] | undefined; + export interface ChunkMember { + chunk: InlineAgentPayloadPart; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + files?: never; + $unknown?: never; + } /** - *

If the total number of results is greater than can fit in the response, use this token in the nextToken field when making another request to return the next batch of results.

+ *

Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.

* @public */ - nextToken?: string | undefined; -} + export interface TraceMember { + chunk?: never; + trace: InlineAgentTracePart; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + files?: never; + $unknown?: never; + } -/** - *

Contains the query made to the knowledge base.

This data type is used in the following API operations:

- * @public - */ -export interface RetrieveAndGenerateInput { /** - *

The query made to the knowledge base.

+ *

Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.

* @public */ - text: string | undefined; -} + export interface ReturnControlMember { + chunk?: never; + trace?: never; + returnControl: InlineAgentReturnControlPayload; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + files?: never; + $unknown?: never; + } -/** - *

The configuration details for the guardrail.

- * @public - */ -export interface GuardrailConfiguration { /** - *

The unique identifier for the guardrail.

+ *

An internal server error occurred. Retry your request.

* @public */ - guardrailId: string | undefined; + export interface InternalServerExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException: InternalServerException; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + files?: never; + $unknown?: never; + } /** - *

The version of the guardrail.

+ *

Input validation failed. Check your request parameters and retry the request.

* @public */ - guardrailVersion: string | undefined; -} + export interface ValidationExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException: ValidationException; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + files?: never; + $unknown?: never; + } -/** - *

Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.

The valid range of maxTokens depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.

- * @public - */ -export interface TextInferenceConfig { /** - *

Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.

+ *

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

* @public */ - temperature?: number | undefined; + export interface ResourceNotFoundExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException: ResourceNotFoundException; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + files?: never; + $unknown?: never; + } /** - *

A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.

+ *

The number of requests exceeds the service quota. Resubmit your request later.

* @public */ - topP?: number | undefined; + export interface ServiceQuotaExceededExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException: ServiceQuotaExceededException; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + files?: never; + $unknown?: never; + } /** - *

The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.

+ *

The number of requests exceeds the limit. Resubmit your request later.

* @public */ - maxTokens?: number | undefined; + export interface ThrottlingExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException: ThrottlingException; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + files?: never; + $unknown?: never; + } /** - *

A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.

+ *

The request is denied because of missing access permissions. Check your permissions and retry your request.

* @public */ - stopSequences?: string[] | undefined; -} + export interface AccessDeniedExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException: AccessDeniedException; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + files?: never; + $unknown?: never; + } -/** - *

The configuration for inference settings when generating responses using RetrieveAndGenerate.

- * @public - */ -export interface InferenceConfig { /** - *

Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.

+ *

There was a conflict performing an operation. Resolve the conflict and retry your request.

* @public */ - textInferenceConfig?: TextInferenceConfig | undefined; -} + export interface ConflictExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException: ConflictException; + dependencyFailedException?: never; + badGatewayException?: never; + files?: never; + $unknown?: never; + } -/** - *

Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.

This data type is used in the following API operations:

- * @public - */ -export interface PromptTemplate { /** - *

The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.

For more information, see the following resources:

+ *

There was an issue with a dependency. Check the resource configurations and retry the request.

* @public */ - textPromptTemplate?: string | undefined; -} + export interface DependencyFailedExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException: DependencyFailedException; + badGatewayException?: never; + files?: never; + $unknown?: never; + } -/** - *

Contains the generation configuration of the external source wrapper object.

- * @public - */ -export interface ExternalSourcesGenerationConfiguration { /** - *

Contain the textPromptTemplate string for the external source wrapper object.

+ *

There was an issue with a dependency due to a server issue. Retry your request.

* @public */ - promptTemplate?: PromptTemplate | undefined; + export interface BadGatewayExceptionMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException: BadGatewayException; + files?: never; + $unknown?: never; + } /** - *

The configuration details for the guardrail.

+ *

Contains intermediate response for code interpreter if any files have been generated.

* @public */ - guardrailConfiguration?: GuardrailConfiguration | undefined; + export interface FilesMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + files: InlineAgentFilePart; + $unknown?: never; + } /** - *

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.

* @public */ - inferenceConfig?: InferenceConfig | undefined; + export interface $UnknownMember { + chunk?: never; + trace?: never; + returnControl?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + files?: never; + $unknown: [string, any]; + } - /** - *

Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.

- * @public - */ - additionalModelRequestFields?: Record | undefined; + export interface Visitor { + chunk: (value: InlineAgentPayloadPart) => T; + trace: (value: InlineAgentTracePart) => T; + returnControl: (value: InlineAgentReturnControlPayload) => T; + internalServerException: (value: InternalServerException) => T; + validationException: (value: ValidationException) => T; + resourceNotFoundException: (value: ResourceNotFoundException) => T; + serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T; + throttlingException: (value: ThrottlingException) => T; + accessDeniedException: (value: AccessDeniedException) => T; + conflictException: (value: ConflictException) => T; + dependencyFailedException: (value: DependencyFailedException) => T; + badGatewayException: (value: BadGatewayException) => T; + files: (value: InlineAgentFilePart) => T; + _: (name: string, value: any) => T; + } - /** - *

The latency configuration for the model.

- * @public - */ - performanceConfig?: PerformanceConfiguration | undefined; + export const visit = (value: InlineAgentResponseStream, visitor: Visitor): T => { + if (value.chunk !== undefined) return visitor.chunk(value.chunk); + if (value.trace !== undefined) return visitor.trace(value.trace); + if (value.returnControl !== undefined) return visitor.returnControl(value.returnControl); + if (value.internalServerException !== undefined) + return visitor.internalServerException(value.internalServerException); + if (value.validationException !== undefined) return visitor.validationException(value.validationException); + if (value.resourceNotFoundException !== undefined) + return visitor.resourceNotFoundException(value.resourceNotFoundException); + if (value.serviceQuotaExceededException !== undefined) + return visitor.serviceQuotaExceededException(value.serviceQuotaExceededException); + if (value.throttlingException !== undefined) return visitor.throttlingException(value.throttlingException); + if (value.accessDeniedException !== undefined) return visitor.accessDeniedException(value.accessDeniedException); + if (value.conflictException !== undefined) return visitor.conflictException(value.conflictException); + if (value.dependencyFailedException !== undefined) + return visitor.dependencyFailedException(value.dependencyFailedException); + if (value.badGatewayException !== undefined) return visitor.badGatewayException(value.badGatewayException); + if (value.files !== undefined) return visitor.files(value.files); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** - *

This property contains the document to chat with, along with its attributes.

* @public */ -export interface ByteContentDoc { +export interface InvokeInlineAgentResponse { /** - *

The file name of the document contained in the wrapper object.

+ *

The inline agent's response to the user prompt.

* @public */ - identifier: string | undefined; + completion: AsyncIterable | undefined; /** - *

The MIME type of the document contained in the wrapper object.

+ *

The MIME type of the input data in the request. The default value is application/json.

* @public */ contentType: string | undefined; /** - *

The byte value of the file to upload, encoded as a Base-64 string.

+ *

The unique identifier of the session with the agent.

* @public */ - data: Uint8Array | undefined; + sessionId: string | undefined; } /** - *

The unique wrapper object of the document from the S3 location.

* @public */ -export interface S3ObjectDoc { +export interface DeleteAgentMemoryRequest { /** - *

The file location of the S3 wrapper object.

+ *

The unique identifier of the agent to which the alias belongs.

* @public */ - uri: string | undefined; -} - -/** - * @public - * @enum - */ -export const ExternalSourceType = { - BYTE_CONTENT: "BYTE_CONTENT", - S3: "S3", -} as const; - -/** - * @public - */ -export type ExternalSourceType = (typeof ExternalSourceType)[keyof typeof ExternalSourceType]; + agentId: string | undefined; -/** - *

The unique external source of the content contained in the wrapper object.

- * @public - */ -export interface ExternalSource { /** - *

The source type of the external source wrapper object.

+ *

The unique identifier of an alias of an agent.

* @public */ - sourceType: ExternalSourceType | undefined; + agentAliasId: string | undefined; /** - *

The S3 location of the external source wrapper object.

+ *

The unique identifier of the memory.

* @public */ - s3Location?: S3ObjectDoc | undefined; + memoryId?: string | undefined; /** - *

The identifier, contentType, and data of the external source wrapper object.

+ *

The unique session identifier of the memory.

* @public */ - byteContent?: ByteContentDoc | undefined; + sessionId?: string | undefined; } /** - *

The configurations of the external source wrapper object in the retrieveAndGenerate function.

* @public */ -export interface ExternalSourcesRetrieveAndGenerateConfiguration { - /** - *

The model Amazon Resource Name (ARN) for the external source wrapper object in the retrieveAndGenerate function.

- * @public - */ - modelArn: string | undefined; +export interface DeleteAgentMemoryResponse {} - /** - *

The document for the external source wrapper object in the retrieveAndGenerate function.

- * @public - */ - sources: ExternalSource[] | undefined; +/** + * @public + * @enum + */ +export const MemoryType = { + SESSION_SUMMARY: "SESSION_SUMMARY", +} as const; - /** - *

The prompt used with the external source wrapper object with the retrieveAndGenerate function.

- * @public - */ - generationConfiguration?: ExternalSourcesGenerationConfiguration | undefined; -} +/** + * @public + */ +export type MemoryType = (typeof MemoryType)[keyof typeof MemoryType]; /** - *

Contains configurations for response generation based on the knowledge base query results.

This data type is used in the following API operations:

* @public */ -export interface GenerationConfiguration { +export interface GetAgentMemoryRequest { /** - *

Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$ variable. For more information, see Use placeholder variables in the user guide.

+ *

If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

* @public */ - promptTemplate?: PromptTemplate | undefined; + nextToken?: string | undefined; /** - *

The configuration details for the guardrail.

+ *

The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

* @public */ - guardrailConfiguration?: GuardrailConfiguration | undefined; + maxItems?: number | undefined; /** - *

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

+ *

The unique identifier of the agent to which the alias belongs.

* @public */ - inferenceConfig?: InferenceConfig | undefined; + agentId: string | undefined; /** - *

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

+ *

The unique identifier of an alias of an agent.

* @public */ - additionalModelRequestFields?: Record | undefined; + agentAliasId: string | undefined; /** - *

The latency configuration for the model.

+ *

The type of memory.

* @public */ - performanceConfig?: PerformanceConfiguration | undefined; -} - -/** - * @public - * @enum - */ -export const QueryTransformationType = { - QUERY_DECOMPOSITION: "QUERY_DECOMPOSITION", -} as const; - -/** - * @public - */ -export type QueryTransformationType = (typeof QueryTransformationType)[keyof typeof QueryTransformationType]; + memoryType: MemoryType | undefined; -/** - *

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

- * @public - */ -export interface QueryTransformationConfiguration { /** - *

The type of transformation to apply to the prompt.

+ *

The unique identifier of the memory.

* @public */ - type: QueryTransformationType | undefined; + memoryId: string | undefined; } /** - *

Settings for how the model processes the prompt prior to retrieval and generation.

+ *

Contains details of a session summary.

* @public */ -export interface OrchestrationConfiguration { - /** - *

Contains the template for the prompt that's sent to the model. Orchestration prompts must include the $conversation_history$ and $output_format_instructions$ variables. For more information, see Use placeholder variables in the user guide.

- * @public - */ - promptTemplate?: PromptTemplate | undefined; - +export interface MemorySessionSummary { /** - *

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

+ *

The unique identifier of the memory where the session summary is stored.

* @public */ - inferenceConfig?: InferenceConfig | undefined; + memoryId?: string | undefined; /** - *

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

+ *

The identifier for this session.

* @public */ - additionalModelRequestFields?: Record | undefined; + sessionId?: string | undefined; /** - *

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

+ *

The start time for this session.

* @public */ - queryTransformationConfiguration?: QueryTransformationConfiguration | undefined; + sessionStartTime?: Date | undefined; /** - *

The latency configuration for the model.

- * @public - */ - performanceConfig?: PerformanceConfiguration | undefined; -} - -/** - * @public - * @enum - */ -export const RetrieveAndGenerateType = { - EXTERNAL_SOURCES: "EXTERNAL_SOURCES", - KNOWLEDGE_BASE: "KNOWLEDGE_BASE", -} as const; - -/** - * @public - */ -export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType]; + *

The time when the memory duration for the session is set to end.

+ * @public + */ + sessionExpiryTime?: Date | undefined; -/** - *

Contains configuration about the session with the knowledge base.

This data type is used in the following API operations:

- * @public - */ -export interface RetrieveAndGenerateSessionConfiguration { /** - *

The ARN of the KMS key encrypting the session.

+ *

The summarized text for this session.

* @public */ - kmsKeyArn: string | undefined; + summaryText?: string | undefined; } /** + *

Contains sessions summaries.

* @public - * @enum */ -export const GuadrailAction = { - INTERVENED: "INTERVENED", - NONE: "NONE", -} as const; +export type Memory = Memory.SessionSummaryMember | Memory.$UnknownMember; /** * @public */ -export type GuadrailAction = (typeof GuadrailAction)[keyof typeof GuadrailAction]; +export namespace Memory { + /** + *

Contains summary of a session.

+ * @public + */ + export interface SessionSummaryMember { + sessionSummary: MemorySessionSummary; + $unknown?: never; + } -/** - *

Contains the response generated from querying the knowledge base.

This data type is used in the following API operations:

- * @public - */ -export interface RetrieveAndGenerateOutput { /** - *

The response generated from querying the knowledge base.

* @public */ - text: string | undefined; + export interface $UnknownMember { + sessionSummary?: never; + $unknown: [string, any]; + } + + export interface Visitor { + sessionSummary: (value: MemorySessionSummary) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: Memory, visitor: Visitor): T => { + if (value.sessionSummary !== undefined) return visitor.sessionSummary(value.sessionSummary); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** * @public */ -export interface RetrieveAndGenerateResponse { - /** - *

The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

- * @public - */ - sessionId: string | undefined; - +export interface GetAgentMemoryResponse { /** - *

Contains the response generated from querying the knowledge base.

+ *

If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

* @public */ - output: RetrieveAndGenerateOutput | undefined; + nextToken?: string | undefined; /** - *

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

+ *

Contains details of the sessions stored in the memory

* @public */ - citations?: Citation[] | undefined; + memoryContents?: Memory[] | undefined; +} +/** + *

Contains information about the text prompt to optimize.

+ * @public + */ +export interface TextPrompt { /** - *

Specifies if there is a guardrail intervention in the response.

+ *

The text in the text prompt to optimize.

* @public */ - guardrailAction?: GuadrailAction | undefined; + text: string | undefined; } /** - *

A citation event.

+ *

Contains information about the prompt to optimize.

* @public */ -export interface CitationEvent { - /** - *

The citation.

- * - * @deprecated - * @public - */ - citation?: Citation | undefined; +export type InputPrompt = InputPrompt.TextPromptMember | InputPrompt.$UnknownMember; +/** + * @public + */ +export namespace InputPrompt { /** - *

The generated response to the citation event.

+ *

Contains information about the text prompt to optimize.

* @public */ - generatedResponsePart?: GeneratedResponsePart | undefined; + export interface TextPromptMember { + textPrompt: TextPrompt; + $unknown?: never; + } /** - *

The retrieved references of the citation event.

* @public */ - retrievedReferences?: RetrievedReference[] | undefined; + export interface $UnknownMember { + textPrompt?: never; + $unknown: [string, any]; + } + + export interface Visitor { + textPrompt: (value: TextPrompt) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: InputPrompt, visitor: Visitor): T => { + if (value.textPrompt !== undefined) return visitor.textPrompt(value.textPrompt); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** - *

A guardrail event.

* @public */ -export interface GuardrailEvent { +export interface OptimizePromptRequest { /** - *

The guardrail action.

+ *

Contains the prompt to optimize.

* @public */ - action?: GuadrailAction | undefined; + input: InputPrompt | undefined; + + /** + *

The unique identifier of the model that you want to optimize the prompt for.

+ * @public + */ + targetModelId: string | undefined; } /** - *

A retrieve and generate output event.

+ *

An event in which the prompt was analyzed in preparation for optimization.

* @public */ -export interface RetrieveAndGenerateOutputEvent { +export interface AnalyzePromptEvent { /** - *

A text response.

+ *

A message describing the analysis of the prompt.

* @public */ - text: string | undefined; + message?: string | undefined; } /** - *

A retrieve and generate stream response output.

+ *

Contains information about the optimized prompt.

* @public */ -export type RetrieveAndGenerateStreamResponseOutput = - | RetrieveAndGenerateStreamResponseOutput.AccessDeniedExceptionMember - | RetrieveAndGenerateStreamResponseOutput.BadGatewayExceptionMember - | RetrieveAndGenerateStreamResponseOutput.CitationMember - | RetrieveAndGenerateStreamResponseOutput.ConflictExceptionMember - | RetrieveAndGenerateStreamResponseOutput.DependencyFailedExceptionMember - | RetrieveAndGenerateStreamResponseOutput.GuardrailMember - | RetrieveAndGenerateStreamResponseOutput.InternalServerExceptionMember - | RetrieveAndGenerateStreamResponseOutput.OutputMember - | RetrieveAndGenerateStreamResponseOutput.ResourceNotFoundExceptionMember - | RetrieveAndGenerateStreamResponseOutput.ServiceQuotaExceededExceptionMember - | RetrieveAndGenerateStreamResponseOutput.ThrottlingExceptionMember - | RetrieveAndGenerateStreamResponseOutput.ValidationExceptionMember - | RetrieveAndGenerateStreamResponseOutput.$UnknownMember; +export type OptimizedPrompt = OptimizedPrompt.TextPromptMember | OptimizedPrompt.$UnknownMember; /** * @public */ -export namespace RetrieveAndGenerateStreamResponseOutput { +export namespace OptimizedPrompt { /** - *

An output event.

+ *

Contains information about the text in the prompt that was optimized.

* @public */ - export interface OutputMember { - output: RetrieveAndGenerateOutputEvent; - citation?: never; - guardrail?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; + export interface TextPromptMember { + textPrompt: TextPrompt; $unknown?: never; } /** - *

A citation event.

* @public */ - export interface CitationMember { - output?: never; - citation: CitationEvent; - guardrail?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - $unknown?: never; + export interface $UnknownMember { + textPrompt?: never; + $unknown: [string, any]; } - /** - *

A guardrail event.

- * @public - */ - export interface GuardrailMember { - output?: never; - citation?: never; - guardrail: GuardrailEvent; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - $unknown?: never; + export interface Visitor { + textPrompt: (value: TextPrompt) => T; + _: (name: string, value: any) => T; } + export const visit = (value: OptimizedPrompt, visitor: Visitor): T => { + if (value.textPrompt !== undefined) return visitor.textPrompt(value.textPrompt); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + *

An event in which the prompt was optimized.

+ * @public + */ +export interface OptimizedPromptEvent { /** - *

An internal server error occurred. Retry your request.

+ *

Contains information about the optimized prompt.

* @public */ - export interface InternalServerExceptionMember { - output?: never; - citation?: never; - guardrail?: never; - internalServerException: InternalServerException; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; - throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException?: never; - badGatewayException?: never; - $unknown?: never; - } + optimizedPrompt?: OptimizedPrompt | undefined; +} + +/** + *

The stream containing events in the prompt optimization process.

+ * @public + */ +export type OptimizedPromptStream = + | OptimizedPromptStream.AccessDeniedExceptionMember + | OptimizedPromptStream.AnalyzePromptEventMember + | OptimizedPromptStream.BadGatewayExceptionMember + | OptimizedPromptStream.DependencyFailedExceptionMember + | OptimizedPromptStream.InternalServerExceptionMember + | OptimizedPromptStream.OptimizedPromptEventMember + | OptimizedPromptStream.ThrottlingExceptionMember + | OptimizedPromptStream.ValidationExceptionMember + | OptimizedPromptStream.$UnknownMember; +/** + * @public + */ +export namespace OptimizedPromptStream { /** - *

The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide.

+ *

An event in which the prompt was optimized.

* @public */ - export interface ValidationExceptionMember { - output?: never; - citation?: never; - guardrail?: never; + export interface OptimizedPromptEventMember { + optimizedPromptEvent: OptimizedPromptEvent; + analyzePromptEvent?: never; internalServerException?: never; - validationException: ValidationException; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; + validationException?: never; dependencyFailedException?: never; + accessDeniedException?: never; badGatewayException?: never; $unknown?: never; } /** - *

The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide.

+ *

An event in which the prompt was analyzed in preparation for optimization.

* @public */ - export interface ResourceNotFoundExceptionMember { - output?: never; - citation?: never; - guardrail?: never; + export interface AnalyzePromptEventMember { + optimizedPromptEvent?: never; + analyzePromptEvent: AnalyzePromptEvent; internalServerException?: never; - validationException?: never; - resourceNotFoundException: ResourceNotFoundException; - serviceQuotaExceededException?: never; throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; + validationException?: never; dependencyFailedException?: never; + accessDeniedException?: never; badGatewayException?: never; $unknown?: never; } /** - *

Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.

+ *

An internal server error occurred. Retry your request.

* @public */ - export interface ServiceQuotaExceededExceptionMember { - output?: never; - citation?: never; - guardrail?: never; - internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException: ServiceQuotaExceededException; + export interface InternalServerExceptionMember { + optimizedPromptEvent?: never; + analyzePromptEvent?: never; + internalServerException: InternalServerException; throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; + validationException?: never; dependencyFailedException?: never; + accessDeniedException?: never; badGatewayException?: never; $unknown?: never; } /** - *

Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide.

+ *

Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase Provisioned Throughput to increase the rate or number of tokens you can process.

* @public */ export interface ThrottlingExceptionMember { - output?: never; - citation?: never; - guardrail?: never; + optimizedPromptEvent?: never; + analyzePromptEvent?: never; internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; throttlingException: ThrottlingException; - accessDeniedException?: never; - conflictException?: never; + validationException?: never; dependencyFailedException?: never; + accessDeniedException?: never; badGatewayException?: never; $unknown?: never; } /** - *

The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide.

+ *

Input validation failed. Check your request parameters and retry the request.

* @public */ - export interface AccessDeniedExceptionMember { - output?: never; - citation?: never; - guardrail?: never; + export interface ValidationExceptionMember { + optimizedPromptEvent?: never; + analyzePromptEvent?: never; internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; throttlingException?: never; - accessDeniedException: AccessDeniedException; - conflictException?: never; + validationException: ValidationException; dependencyFailedException?: never; + accessDeniedException?: never; badGatewayException?: never; $unknown?: never; } /** - *

Error occurred because of a conflict while performing an operation.

+ *

There was an issue with a dependency. Check the resource configurations and retry the request.

* @public */ - export interface ConflictExceptionMember { - output?: never; - citation?: never; - guardrail?: never; + export interface DependencyFailedExceptionMember { + optimizedPromptEvent?: never; + analyzePromptEvent?: never; internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; throttlingException?: never; + validationException?: never; + dependencyFailedException: DependencyFailedException; accessDeniedException?: never; - conflictException: ConflictException; - dependencyFailedException?: never; badGatewayException?: never; $unknown?: never; } /** - *

The request failed due to a dependency error.

+ *

The request is denied because of missing access permissions. Check your permissions and retry your request.

* @public */ - export interface DependencyFailedExceptionMember { - output?: never; - citation?: never; - guardrail?: never; + export interface AccessDeniedExceptionMember { + optimizedPromptEvent?: never; + analyzePromptEvent?: never; internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; - dependencyFailedException: DependencyFailedException; + validationException?: never; + dependencyFailedException?: never; + accessDeniedException: AccessDeniedException; badGatewayException?: never; $unknown?: never; } /** - *

The request failed due to a bad gateway error.

+ *

There was an issue with a dependency due to a server issue. Retry your request.

* @public */ export interface BadGatewayExceptionMember { - output?: never; - citation?: never; - guardrail?: never; + optimizedPromptEvent?: never; + analyzePromptEvent?: never; internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; + validationException?: never; dependencyFailedException?: never; + accessDeniedException?: never; badGatewayException: BadGatewayException; $unknown?: never; } @@ -7852,53 +7812,39 @@ export namespace RetrieveAndGenerateStreamResponseOutput { * @public */ export interface $UnknownMember { - output?: never; - citation?: never; - guardrail?: never; + optimizedPromptEvent?: never; + analyzePromptEvent?: never; internalServerException?: never; - validationException?: never; - resourceNotFoundException?: never; - serviceQuotaExceededException?: never; throttlingException?: never; - accessDeniedException?: never; - conflictException?: never; + validationException?: never; dependencyFailedException?: never; + accessDeniedException?: never; badGatewayException?: never; $unknown: [string, any]; } export interface Visitor { - output: (value: RetrieveAndGenerateOutputEvent) => T; - citation: (value: CitationEvent) => T; - guardrail: (value: GuardrailEvent) => T; + optimizedPromptEvent: (value: OptimizedPromptEvent) => T; + analyzePromptEvent: (value: AnalyzePromptEvent) => T; internalServerException: (value: InternalServerException) => T; - validationException: (value: ValidationException) => T; - resourceNotFoundException: (value: ResourceNotFoundException) => T; - serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T; throttlingException: (value: ThrottlingException) => T; - accessDeniedException: (value: AccessDeniedException) => T; - conflictException: (value: ConflictException) => T; + validationException: (value: ValidationException) => T; dependencyFailedException: (value: DependencyFailedException) => T; + accessDeniedException: (value: AccessDeniedException) => T; badGatewayException: (value: BadGatewayException) => T; _: (name: string, value: any) => T; } - export const visit = (value: RetrieveAndGenerateStreamResponseOutput, visitor: Visitor): T => { - if (value.output !== undefined) return visitor.output(value.output); - if (value.citation !== undefined) return visitor.citation(value.citation); - if (value.guardrail !== undefined) return visitor.guardrail(value.guardrail); + export const visit = (value: OptimizedPromptStream, visitor: Visitor): T => { + if (value.optimizedPromptEvent !== undefined) return visitor.optimizedPromptEvent(value.optimizedPromptEvent); + if (value.analyzePromptEvent !== undefined) return visitor.analyzePromptEvent(value.analyzePromptEvent); if (value.internalServerException !== undefined) return visitor.internalServerException(value.internalServerException); - if (value.validationException !== undefined) return visitor.validationException(value.validationException); - if (value.resourceNotFoundException !== undefined) - return visitor.resourceNotFoundException(value.resourceNotFoundException); - if (value.serviceQuotaExceededException !== undefined) - return visitor.serviceQuotaExceededException(value.serviceQuotaExceededException); if (value.throttlingException !== undefined) return visitor.throttlingException(value.throttlingException); - if (value.accessDeniedException !== undefined) return visitor.accessDeniedException(value.accessDeniedException); - if (value.conflictException !== undefined) return visitor.conflictException(value.conflictException); + if (value.validationException !== undefined) return visitor.validationException(value.validationException); if (value.dependencyFailedException !== undefined) return visitor.dependencyFailedException(value.dependencyFailedException); + if (value.accessDeniedException !== undefined) return visitor.accessDeniedException(value.accessDeniedException); if (value.badGatewayException !== undefined) return visitor.badGatewayException(value.badGatewayException); return visitor._(value.$unknown[0], value.$unknown[1]); }; @@ -7907,768 +7853,707 @@ export namespace RetrieveAndGenerateStreamResponseOutput { /** * @public */ -export interface RetrieveAndGenerateStreamResponse { - /** - *

A stream of events from the model.

- * @public - */ - stream: AsyncIterable | undefined; - +export interface OptimizePromptResponse { /** - *

The session ID.

+ *

The prompt after being optimized for the task.

* @public */ - sessionId: string | undefined; + optimizedPrompt: AsyncIterable | undefined; } /** - *

Contains the query made to the knowledge base.

This data type is used in the following API operations:

+ *

Contains information about a text document to rerank.

* @public */ -export interface KnowledgeBaseQuery { +export interface RerankTextDocument { /** - *

The text of the query made to the knowledge base.

+ *

The text of the document.

* @public */ - text: string | undefined; + text?: string | undefined; } /** - *

Details about a result from querying the knowledge base.

This data type is used in the following API operations:

+ * @public + * @enum + */ +export const RerankQueryContentType = { + TEXT: "TEXT", +} as const; + +/** + * @public + */ +export type RerankQueryContentType = (typeof RerankQueryContentType)[keyof typeof RerankQueryContentType]; + +/** + *

Contains information about a query to submit to the reranker model.

* @public */ -export interface KnowledgeBaseRetrievalResult { +export interface RerankQuery { /** - *

Contains information about the content of the chunk.

+ *

The type of the query.

* @public */ - content: RetrievalResultContent | undefined; + type: RerankQueryContentType | undefined; /** - *

Contains information about the location of the data source.

+ *

Contains information about a text query.

* @public */ - location?: RetrievalResultLocation | undefined; + textQuery: RerankTextDocument | undefined; +} +/** + *

Contains configurations for a reranker model.

+ * @public + */ +export interface BedrockRerankingModelConfiguration { /** - *

The level of relevance of the result to the query.

+ *

The ARN of the reranker model.

* @public */ - score?: number | undefined; + modelArn: string | undefined; /** - *

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

+ *

A JSON object whose keys are request fields for the model and whose values are values for those fields.

* @public */ - metadata?: Record | undefined; + additionalModelRequestFields?: Record | undefined; } /** + *

Contains configurations for an Amazon Bedrock reranker model.

* @public */ -export interface RetrieveResponse { - /** - *

A list of results from querying the knowledge base.

- * @public - */ - retrievalResults: KnowledgeBaseRetrievalResult[] | undefined; - +export interface BedrockRerankingConfiguration { /** - *

Specifies if there is a guardrail intervention in the response.

+ *

The number of results to return after reranking.

* @public */ - guardrailAction?: GuadrailAction | undefined; + numberOfResults?: number | undefined; /** - *

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

+ *

Contains configurations for a reranker model.

* @public */ - nextToken?: string | undefined; + modelConfiguration: BedrockRerankingModelConfiguration | undefined; } /** * @public + * @enum */ -export interface CreateSessionRequest { - /** - *

A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.

- * @public - */ - sessionMetadata?: Record | undefined; +export const RerankingConfigurationType = { + BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL", +} as const; + +/** + * @public + */ +export type RerankingConfigurationType = (typeof RerankingConfigurationType)[keyof typeof RerankingConfigurationType]; +/** + *

Contains configurations for reranking.

+ * @public + */ +export interface RerankingConfiguration { /** - *

The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see Amazon Bedrock session encryption.

+ *

The type of reranker that the configurations apply to.

* @public */ - encryptionKeyArn?: string | undefined; + type: RerankingConfigurationType | undefined; /** - *

Specify the key-value pairs for the tags that you want to attach to the session.

+ *

Contains configurations for an Amazon Bedrock reranker.

* @public */ - tags?: Record | undefined; + bedrockRerankingConfiguration: BedrockRerankingConfiguration | undefined; } /** * @public * @enum */ -export const SessionStatus = { - ACTIVE: "ACTIVE", - ENDED: "ENDED", - EXPIRED: "EXPIRED", +export const RerankDocumentType = { + JSON: "JSON", + TEXT: "TEXT", } as const; /** * @public */ -export type SessionStatus = (typeof SessionStatus)[keyof typeof SessionStatus]; +export type RerankDocumentType = (typeof RerankDocumentType)[keyof typeof RerankDocumentType]; /** + *

Contains information about a document to rerank. Choose the type to define and include the field that corresponds to the type.

* @public */ -export interface CreateSessionResponse { - /** - *

The unique identifier for the session.

- * @public - */ - sessionId: string | undefined; - +export interface RerankDocument { /** - *

The Amazon Resource Name (ARN) of the created session.

+ *

The type of document to rerank.

* @public */ - sessionArn: string | undefined; + type: RerankDocumentType | undefined; /** - *

The current status of the session.

+ *

Contains information about a text document to rerank.

* @public */ - sessionStatus: SessionStatus | undefined; + textDocument?: RerankTextDocument | undefined; /** - *

The timestamp for when the session was created.

+ *

Contains a JSON document to rerank.

* @public */ - createdAt: Date | undefined; + jsonDocument?: __DocumentType | undefined; } /** * @public + * @enum */ -export interface DeleteSessionRequest { - /** - *

The unique identifier for the session to be deleted. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

- * @public - */ - sessionIdentifier: string | undefined; -} +export const RerankSourceType = { + INLINE: "INLINE", +} as const; /** * @public */ -export interface DeleteSessionResponse {} +export type RerankSourceType = (typeof RerankSourceType)[keyof typeof RerankSourceType]; /** + *

Contains information about a source for reranking.

* @public */ -export interface EndSessionRequest { +export interface RerankSource { + /** + *

The type of the source.

+ * @public + */ + type: RerankSourceType | undefined; + /** - *

The unique identifier for the session to end. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ *

Contains an inline definition of a source for reranking.

* @public */ - sessionIdentifier: string | undefined; + inlineDocumentSource: RerankDocument | undefined; } /** * @public */ -export interface EndSessionResponse { +export interface RerankRequest { /** - *

The unique identifier of the session you ended.

+ *

An array of objects, each of which contains information about a query to submit to the reranker model.

* @public */ - sessionId: string | undefined; + queries: RerankQuery[] | undefined; /** - *

The Amazon Resource Name (ARN) of the session you ended.

+ *

An array of objects, each of which contains information about the sources to rerank.

* @public */ - sessionArn: string | undefined; + sources: RerankSource[] | undefined; /** - *

The current status of the session you ended.

+ *

Contains configurations for reranking.

* @public */ - sessionStatus: SessionStatus | undefined; -} + rerankingConfiguration: RerankingConfiguration | undefined; -/** - * @public - */ -export interface GetSessionRequest { /** - *

A unique identifier for the session to retrieve. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ *

If the total number of results was greater than could fit in a response, a token is returned in the nextToken field. You can enter that token in this field to return the next batch of results.

* @public */ - sessionIdentifier: string | undefined; + nextToken?: string | undefined; } /** + *

Contains information about a document that was reranked.

* @public */ -export interface GetSessionResponse { - /** - *

The unique identifier for the session in UUID format.

- * @public - */ - sessionId: string | undefined; - +export interface RerankResult { /** - *

The Amazon Resource Name (ARN) of the session.

+ *

The ranking of the document. The lower a number, the higher the document is ranked.

* @public */ - sessionArn: string | undefined; + index: number | undefined; /** - *

The current status of the session.

+ *

The relevance score of the document.

* @public */ - sessionStatus: SessionStatus | undefined; + relevanceScore: number | undefined; /** - *

The timestamp for when the session was created.

+ *

Contains information about the document.

* @public */ - createdAt: Date | undefined; + document?: RerankDocument | undefined; +} +/** + * @public + */ +export interface RerankResponse { /** - *

The timestamp for when the session was last modified.

+ *

An array of objects, each of which contains information about the results of reranking.

* @public */ - lastUpdatedAt: Date | undefined; + results: RerankResult[] | undefined; /** - *

A map of key-value pairs containing attributes persisted across the session.

+ *

If the total number of results is greater than can fit in the response, use this token in the nextToken field when making another request to return the next batch of results.

* @public */ - sessionMetadata?: Record | undefined; + nextToken?: string | undefined; +} +/** + *

Contains the query made to the knowledge base.

This data type is used in the following API operations:

+ * @public + */ +export interface RetrieveAndGenerateInput { /** - *

The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see Amazon Bedrock session encryption.

+ *

The query made to the knowledge base.

* @public */ - encryptionKeyArn?: string | undefined; + text: string | undefined; } /** + *

The configuration details for the guardrail.

* @public */ -export interface CreateInvocationRequest { - /** - *

A unique identifier for the invocation in UUID format.

- * @public - */ - invocationId?: string | undefined; - +export interface GuardrailConfiguration { /** - *

A description for the interactions in the invocation. For example, "User asking about weather in Seattle".

+ *

The unique identifier for the guardrail.

* @public */ - description?: string | undefined; + guardrailId: string | undefined; /** - *

The unique identifier for the associated session for the invocation. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ *

The version of the guardrail.

* @public */ - sessionIdentifier: string | undefined; + guardrailVersion: string | undefined; } /** + *

Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.

The valid range of maxTokens depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.

* @public */ -export interface CreateInvocationResponse { +export interface TextInferenceConfig { /** - *

The unique identifier for the session associated with the invocation.

+ *

Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.

* @public */ - sessionId: string | undefined; + temperature?: number | undefined; /** - *

The unique identifier for the invocation.

+ *

A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.

* @public */ - invocationId: string | undefined; + topP?: number | undefined; /** - *

The timestamp for when the invocation was created.

+ *

The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.

* @public */ - createdAt: Date | undefined; -} + maxTokens?: number | undefined; -/** - * @public - */ -export interface ListInvocationsRequest { /** - *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

+ *

A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.

* @public */ - nextToken?: string | undefined; + stopSequences?: string[] | undefined; +} +/** + *

The configuration for inference settings when generating responses using RetrieveAndGenerate.

+ * @public + */ +export interface InferenceConfig { /** - *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

+ *

Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.

* @public */ - maxResults?: number | undefined; + textInferenceConfig?: TextInferenceConfig | undefined; +} +/** + *

Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.

This data type is used in the following API operations:

+ * @public + */ +export interface PromptTemplate { /** - *

The unique identifier for the session to list invocations for. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ *

The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.

For more information, see the following resources:

* @public */ - sessionIdentifier: string | undefined; + textPromptTemplate?: string | undefined; } /** - *

Contains details about an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

+ *

Contains the generation configuration of the external source wrapper object.

* @public */ -export interface InvocationSummary { +export interface ExternalSourcesGenerationConfiguration { /** - *

The unique identifier for the session associated with the invocation.

+ *

Contain the textPromptTemplate string for the external source wrapper object.

* @public */ - sessionId: string | undefined; + promptTemplate?: PromptTemplate | undefined; /** - *

A unique identifier for the invocation in UUID format.

+ *

The configuration details for the guardrail.

* @public */ - invocationId: string | undefined; + guardrailConfiguration?: GuardrailConfiguration | undefined; /** - *

The timestamp for when the invocation was created.

+ *

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.

* @public */ - createdAt: Date | undefined; -} + inferenceConfig?: InferenceConfig | undefined; -/** - * @public - */ -export interface ListInvocationsResponse { /** - *

A list of invocation summaries associated with the session.

+ *

Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.

* @public */ - invocationSummaries: InvocationSummary[] | undefined; + additionalModelRequestFields?: Record | undefined; /** - *

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

+ *

The latency configuration for the model.

* @public */ - nextToken?: string | undefined; + performanceConfig?: PerformanceConfiguration | undefined; } /** + *

This property contains the document to chat with, along with its attributes.

* @public */ -export interface GetInvocationStepRequest { +export interface ByteContentDoc { /** - *

The unique identifier for the invocation in UUID format.

+ *

The file name of the document contained in the wrapper object.

* @public */ - invocationIdentifier: string | undefined; + identifier: string | undefined; /** - *

The unique identifier (in UUID format) for the specific invocation step to retrieve.

+ *

The MIME type of the document contained in the wrapper object.

* @public */ - invocationStepId: string | undefined; + contentType: string | undefined; /** - *

The unique identifier for the invocation step's associated session. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ *

The byte value of the file to upload, encoded as a Base-64 string.

* @public */ - sessionIdentifier: string | undefined; + data: Uint8Array | undefined; } /** - * @public - * @enum - */ -export const ImageFormat = { - GIF: "gif", - JPEG: "jpeg", - PNG: "png", - WEBP: "webp", -} as const; - -/** - * @public - */ -export type ImageFormat = (typeof ImageFormat)[keyof typeof ImageFormat]; - -/** - *

Information about the Amazon S3 bucket where the image is stored.

+ *

The unique wrapper object of the document from the S3 location.

* @public */ -export interface S3Location { +export interface S3ObjectDoc { /** - *

The path to the Amazon S3 bucket where the image is stored.

+ *

The file location of the S3 wrapper object.

* @public */ uri: string | undefined; } /** - *

The source for an image.

+ * @public + * @enum + */ +export const ExternalSourceType = { + BYTE_CONTENT: "BYTE_CONTENT", + S3: "S3", +} as const; + +/** * @public */ -export type ImageSource = ImageSource.BytesMember | ImageSource.S3LocationMember | ImageSource.$UnknownMember; +export type ExternalSourceType = (typeof ExternalSourceType)[keyof typeof ExternalSourceType]; /** + *

The unique external source of the content contained in the wrapper object.

* @public */ -export namespace ImageSource { +export interface ExternalSource { /** - *

The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.

+ *

The source type of the external source wrapper object.

* @public */ - export interface BytesMember { - bytes: Uint8Array; - s3Location?: never; - $unknown?: never; - } + sourceType: ExternalSourceType | undefined; /** - *

The path to the Amazon S3 bucket where the image is stored.

+ *

The S3 location of the external source wrapper object.

* @public */ - export interface S3LocationMember { - bytes?: never; - s3Location: S3Location; - $unknown?: never; - } + s3Location?: S3ObjectDoc | undefined; /** + *

The identifier, contentType, and data of the external source wrapper object.

* @public */ - export interface $UnknownMember { - bytes?: never; - s3Location?: never; - $unknown: [string, any]; - } - - export interface Visitor { - bytes: (value: Uint8Array) => T; - s3Location: (value: S3Location) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: ImageSource, visitor: Visitor): T => { - if (value.bytes !== undefined) return visitor.bytes(value.bytes); - if (value.s3Location !== undefined) return visitor.s3Location(value.s3Location); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + byteContent?: ByteContentDoc | undefined; } /** - *

Image content for an invocation step.

+ *

The configurations of the external source wrapper object in the retrieveAndGenerate function.

* @public */ -export interface ImageBlock { +export interface ExternalSourcesRetrieveAndGenerateConfiguration { /** - *

The format of the image.

+ *

The model Amazon Resource Name (ARN) for the external source wrapper object in the retrieveAndGenerate function.

* @public */ - format: ImageFormat | undefined; + modelArn: string | undefined; /** - *

The source for the image.

+ *

The document for the external source wrapper object in the retrieveAndGenerate function.

* @public */ - source: ImageSource | undefined; -} + sources: ExternalSource[] | undefined; -/** - *

A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a session in the payLoad of the PutInvocationStep API operation. You retrieve the content with the GetInvocationStep API operation.

For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

- * @public - */ -export type BedrockSessionContentBlock = - | BedrockSessionContentBlock.ImageMember - | BedrockSessionContentBlock.TextMember - | BedrockSessionContentBlock.$UnknownMember; + /** + *

The prompt used with the external source wrapper object with the retrieveAndGenerate function.

+ * @public + */ + generationConfiguration?: ExternalSourcesGenerationConfiguration | undefined; +} /** + *

Contains configurations for response generation based on the knowledge base query results.

This data type is used in the following API operations:

* @public */ -export namespace BedrockSessionContentBlock { +export interface GenerationConfiguration { /** - *

The text in the invocation step.

+ *

Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$ variable. For more information, see Use placeholder variables in the user guide.

* @public */ - export interface TextMember { - text: string; - image?: never; - $unknown?: never; - } + promptTemplate?: PromptTemplate | undefined; /** - *

The image in the invocation step.

+ *

The configuration details for the guardrail.

* @public */ - export interface ImageMember { - text?: never; - image: ImageBlock; - $unknown?: never; - } + guardrailConfiguration?: GuardrailConfiguration | undefined; /** + *

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

* @public */ - export interface $UnknownMember { - text?: never; - image?: never; - $unknown: [string, any]; - } + inferenceConfig?: InferenceConfig | undefined; - export interface Visitor { - text: (value: string) => T; - image: (value: ImageBlock) => T; - _: (name: string, value: any) => T; - } + /** + *

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

+ * @public + */ + additionalModelRequestFields?: Record | undefined; - export const visit = (value: BedrockSessionContentBlock, visitor: Visitor): T => { - if (value.text !== undefined) return visitor.text(value.text); - if (value.image !== undefined) return visitor.image(value.image); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + /** + *

The latency configuration for the model.

+ * @public + */ + performanceConfig?: PerformanceConfiguration | undefined; } /** - *

Payload content, such as text and images, for the invocation step.

* @public + * @enum */ -export type InvocationStepPayload = InvocationStepPayload.ContentBlocksMember | InvocationStepPayload.$UnknownMember; +export const QueryTransformationType = { + QUERY_DECOMPOSITION: "QUERY_DECOMPOSITION", +} as const; /** * @public */ -export namespace InvocationStepPayload { - /** - *

The content for the invocation step.

- * @public - */ - export interface ContentBlocksMember { - contentBlocks: BedrockSessionContentBlock[]; - $unknown?: never; - } +export type QueryTransformationType = (typeof QueryTransformationType)[keyof typeof QueryTransformationType]; +/** + *

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

+ * @public + */ +export interface QueryTransformationConfiguration { /** + *

The type of transformation to apply to the prompt.

* @public */ - export interface $UnknownMember { - contentBlocks?: never; - $unknown: [string, any]; - } - - export interface Visitor { - contentBlocks: (value: BedrockSessionContentBlock[]) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: InvocationStepPayload, visitor: Visitor): T => { - if (value.contentBlocks !== undefined) return visitor.contentBlocks(value.contentBlocks); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + type: QueryTransformationType | undefined; } /** - *

Stores fine-grained state checkpoints, including text and images, for each interaction in an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

+ *

Settings for how the model processes the prompt prior to retrieval and generation.

* @public */ -export interface InvocationStep { +export interface OrchestrationConfiguration { /** - *

The unique identifier of the session containing the invocation step.

+ *

Contains the template for the prompt that's sent to the model. Orchestration prompts must include the $conversation_history$ and $output_format_instructions$ variables. For more information, see Use placeholder variables in the user guide.

* @public */ - sessionId: string | undefined; + promptTemplate?: PromptTemplate | undefined; /** - *

The unique identifier (in UUID format) for the invocation that includes the invocation step.

+ *

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

* @public */ - invocationId: string | undefined; + inferenceConfig?: InferenceConfig | undefined; /** - *

The unique identifier (in UUID format) for the invocation step.

+ *

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

* @public */ - invocationStepId: string | undefined; + additionalModelRequestFields?: Record | undefined; /** - *

The timestamp for when the invocation step was created.

+ *

To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.

* @public */ - invocationStepTime: Date | undefined; + queryTransformationConfiguration?: QueryTransformationConfiguration | undefined; /** - *

Payload content, such as text and images, for the invocation step.

+ *

The latency configuration for the model.

* @public */ - payload: InvocationStepPayload | undefined; + performanceConfig?: PerformanceConfiguration | undefined; } /** * @public + * @enum */ -export interface GetInvocationStepResponse { - /** - *

The complete details of the requested invocation step.

- * @public - */ - invocationStep: InvocationStep | undefined; -} +export const RetrieveAndGenerateType = { + EXTERNAL_SOURCES: "EXTERNAL_SOURCES", + KNOWLEDGE_BASE: "KNOWLEDGE_BASE", +} as const; /** * @public */ -export interface ListInvocationStepsRequest { - /** - *

The unique identifier (in UUID format) for the invocation to list invocation steps for.

- * @public - */ - invocationIdentifier?: string | undefined; +export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typeof RetrieveAndGenerateType]; +/** + *

Contains configuration about the session with the knowledge base.

This data type is used in the following API operations:

+ * @public + */ +export interface RetrieveAndGenerateSessionConfiguration { /** - *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

+ *

The ARN of the KMS key encrypting the session.

* @public */ - nextToken?: string | undefined; + kmsKeyArn: string | undefined; +} - /** - *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

- * @public - */ - maxResults?: number | undefined; +/** + * @public + * @enum + */ +export const GuadrailAction = { + INTERVENED: "INTERVENED", + NONE: "NONE", +} as const; +/** + * @public + */ +export type GuadrailAction = (typeof GuadrailAction)[keyof typeof GuadrailAction]; + +/** + *

Contains the response generated from querying the knowledge base.

This data type is used in the following API operations:

+ * @public + */ +export interface RetrieveAndGenerateOutput { /** - *

The unique identifier for the session associated with the invocation steps. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ *

The response generated from querying the knowledge base.

* @public */ - sessionIdentifier: string | undefined; + text: string | undefined; } /** - *

Contains details about an 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.

* @public */ -export interface InvocationStepSummary { +export interface RetrieveAndGenerateResponse { /** - *

The unique identifier for the session associated with the invocation step.

+ *

The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

* @public */ sessionId: string | undefined; /** - *

A unique identifier for the invocation in UUID format.

- * @public - */ - invocationId: string | undefined; - - /** - *

The unique identifier (in UUID format) for the invocation step.

- * @public - */ - invocationStepId: string | undefined; - - /** - *

The timestamp for when the invocation step was created.

+ *

Contains the response generated from querying the knowledge base.

* @public */ - invocationStepTime: Date | undefined; -} + output: RetrieveAndGenerateOutput | undefined; -/** - * @public - */ -export interface ListInvocationStepsResponse { /** - *

A list of summaries for each invocation step associated with a session and if you specified it, an invocation within the session.

+ *

A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.

* @public */ - invocationStepSummaries: InvocationStepSummary[] | undefined; + citations?: Citation[] | undefined; /** - *

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

+ *

Specifies if there is a guardrail intervention in the response.

* @public */ - nextToken?: string | undefined; + guardrailAction?: GuadrailAction | undefined; } /** + *

A citation event.

* @public */ -export interface PutInvocationStepRequest { - /** - *

The unique identifier for the session to add the invocation step to. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

- * @public - */ - sessionIdentifier: string | undefined; - - /** - *

The unique identifier (in UUID format) of the invocation to add the invocation step to.

- * @public - */ - invocationIdentifier: string | undefined; - +export interface CitationEvent { /** - *

The timestamp for when the invocation step occurred.

+ *

The citation.

+ * + * @deprecated * @public */ - invocationStepTime: Date | undefined; + citation?: Citation | undefined; /** - *

The payload for the invocation step, including text and images for the interaction.

+ *

The generated response to the citation event.

* @public */ - payload: InvocationStepPayload | undefined; + generatedResponsePart?: GeneratedResponsePart | undefined; /** - *

The unique identifier of the invocation step in UUID format.

+ *

The retrieved references of the citation event.

* @public */ - invocationStepId?: string | undefined; + retrievedReferences?: RetrievedReference[] | undefined; } /** + *

A guardrail event.

* @public */ -export interface PutInvocationStepResponse { +export interface GuardrailEvent { /** - *

The unique identifier of the invocation step in UUID format.

+ *

The guardrail action.

* @public */ - invocationStepId: string | undefined; + action?: GuadrailAction | undefined; } /** + *

A retrieve and generate output event.

* @public */ -export interface ListSessionsRequest { - /** - *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

- * @public - */ - maxResults?: number | undefined; - +export interface RetrieveAndGenerateOutputEvent { /** - *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

+ *

A text response.

* @public */ - nextToken?: string | undefined; + text: string | undefined; } /** @@ -8854,6 +8739,139 @@ export const AgentCollaboratorInvocationOutputFilterSensitiveLog = (obj: AgentCo ...(obj.metadata && { metadata: SENSITIVE_STRING }), }); +/** + * @internal + */ +export const SatisfiedConditionFilterSensitiveLog = (obj: SatisfiedCondition): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ConditionResultEventFilterSensitiveLog = (obj: ConditionResultEvent): any => ({ + ...obj, + ...(obj.satisfiedConditions && { satisfiedConditions: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const FlowFailureEventFilterSensitiveLog = (obj: FlowFailureEvent): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const FlowExecutionContentFilterSensitiveLog = (obj: FlowExecutionContent): any => { + if (obj.document !== undefined) return { document: obj.document }; + if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; +}; + +/** + * @internal + */ +export const FlowInputFieldFilterSensitiveLog = (obj: FlowInputField): any => ({ + ...obj, + ...(obj.content && { content: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const FlowExecutionInputEventFilterSensitiveLog = (obj: FlowExecutionInputEvent): any => ({ + ...obj, + ...(obj.fields && { fields: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const FlowOutputFieldFilterSensitiveLog = (obj: FlowOutputField): any => ({ + ...obj, + ...(obj.content && { content: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const FlowExecutionOutputEventFilterSensitiveLog = (obj: FlowExecutionOutputEvent): any => ({ + ...obj, + ...(obj.fields && { fields: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const NodeFailureEventFilterSensitiveLog = (obj: NodeFailureEvent): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const NodeExecutionContentFilterSensitiveLog = (obj: NodeExecutionContent): any => { + if (obj.document !== undefined) return { document: obj.document }; + if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; +}; + +/** + * @internal + */ +export const NodeInputFieldFilterSensitiveLog = (obj: NodeInputField): any => ({ + ...obj, + ...(obj.content && { content: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const NodeInputEventFilterSensitiveLog = (obj: NodeInputEvent): any => ({ + ...obj, + ...(obj.fields && { fields: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const NodeOutputFieldFilterSensitiveLog = (obj: NodeOutputField): any => ({ + ...obj, + ...(obj.content && { content: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const NodeOutputEventFilterSensitiveLog = (obj: NodeOutputEvent): any => ({ + ...obj, + ...(obj.fields && { fields: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const FlowExecutionEventFilterSensitiveLog = (obj: FlowExecutionEvent): any => { + if (obj.flowInputEvent !== undefined) return { flowInputEvent: SENSITIVE_STRING }; + if (obj.flowOutputEvent !== undefined) return { flowOutputEvent: SENSITIVE_STRING }; + if (obj.nodeInputEvent !== undefined) return { nodeInputEvent: SENSITIVE_STRING }; + if (obj.nodeOutputEvent !== undefined) return { nodeOutputEvent: SENSITIVE_STRING }; + if (obj.conditionResultEvent !== undefined) return { conditionResultEvent: SENSITIVE_STRING }; + if (obj.nodeFailureEvent !== undefined) return { nodeFailureEvent: SENSITIVE_STRING }; + if (obj.flowFailureEvent !== undefined) return { flowFailureEvent: SENSITIVE_STRING }; + if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; +}; + +/** + * @internal + */ +export const ListFlowExecutionEventsResponseFilterSensitiveLog = (obj: ListFlowExecutionEventsResponse): any => ({ + ...obj, + ...(obj.flowExecutionEvents && { + flowExecutionEvents: obj.flowExecutionEvents.map((item) => FlowExecutionEventFilterSensitiveLog(item)), + }), +}); + /** * @internal */ @@ -8870,6 +8888,14 @@ export const FlowInputFilterSensitiveLog = (obj: FlowInput): any => ({ ...(obj.content && { content: SENSITIVE_STRING }), }); +/** + * @internal + */ +export const StartFlowExecutionRequestFilterSensitiveLog = (obj: StartFlowExecutionRequest): any => ({ + ...obj, + ...(obj.inputs && { inputs: obj.inputs.map((item) => FlowInputFilterSensitiveLog(item)) }), +}); + /** * @internal */ @@ -9991,99 +10017,3 @@ export const CitationEventFilterSensitiveLog = (obj: CitationEvent): any => ({ export const RetrieveAndGenerateOutputEventFilterSensitiveLog = (obj: RetrieveAndGenerateOutputEvent): any => ({ ...obj, }); - -/** - * @internal - */ -export const RetrieveAndGenerateStreamResponseOutputFilterSensitiveLog = ( - obj: RetrieveAndGenerateStreamResponseOutput -): any => { - if (obj.output !== undefined) return { output: SENSITIVE_STRING }; - if (obj.citation !== undefined) return { citation: CitationEventFilterSensitiveLog(obj.citation) }; - if (obj.guardrail !== undefined) return { guardrail: obj.guardrail }; - if (obj.internalServerException !== undefined) return { internalServerException: obj.internalServerException }; - if (obj.validationException !== undefined) return { validationException: obj.validationException }; - if (obj.resourceNotFoundException !== undefined) return { resourceNotFoundException: obj.resourceNotFoundException }; - if (obj.serviceQuotaExceededException !== undefined) - return { serviceQuotaExceededException: obj.serviceQuotaExceededException }; - if (obj.throttlingException !== undefined) return { throttlingException: obj.throttlingException }; - if (obj.accessDeniedException !== undefined) return { accessDeniedException: obj.accessDeniedException }; - if (obj.conflictException !== undefined) return { conflictException: obj.conflictException }; - if (obj.dependencyFailedException !== undefined) return { dependencyFailedException: obj.dependencyFailedException }; - if (obj.badGatewayException !== undefined) return { badGatewayException: obj.badGatewayException }; - if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; -}; - -/** - * @internal - */ -export const RetrieveAndGenerateStreamResponseFilterSensitiveLog = (obj: RetrieveAndGenerateStreamResponse): any => ({ - ...obj, - ...(obj.stream && { stream: "STREAMING_CONTENT" }), -}); - -/** - * @internal - */ -export const KnowledgeBaseQueryFilterSensitiveLog = (obj: KnowledgeBaseQuery): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const KnowledgeBaseRetrievalResultFilterSensitiveLog = (obj: KnowledgeBaseRetrievalResult): any => ({ - ...obj, - ...(obj.content && { content: SENSITIVE_STRING }), - ...(obj.location && { location: SENSITIVE_STRING }), - ...(obj.metadata && { metadata: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const RetrieveResponseFilterSensitiveLog = (obj: RetrieveResponse): any => ({ - ...obj, - ...(obj.retrievalResults && { retrievalResults: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const BedrockSessionContentBlockFilterSensitiveLog = (obj: BedrockSessionContentBlock): any => { - if (obj.text !== undefined) return { text: obj.text }; - if (obj.image !== undefined) return { image: obj.image }; - if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; -}; - -/** - * @internal - */ -export const InvocationStepPayloadFilterSensitiveLog = (obj: InvocationStepPayload): any => { - if (obj.contentBlocks !== undefined) return { contentBlocks: SENSITIVE_STRING }; - if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; -}; - -/** - * @internal - */ -export const InvocationStepFilterSensitiveLog = (obj: InvocationStep): any => ({ - ...obj, - ...(obj.payload && { payload: InvocationStepPayloadFilterSensitiveLog(obj.payload) }), -}); - -/** - * @internal - */ -export const GetInvocationStepResponseFilterSensitiveLog = (obj: GetInvocationStepResponse): any => ({ - ...obj, - ...(obj.invocationStep && { invocationStep: InvocationStepFilterSensitiveLog(obj.invocationStep) }), -}); - -/** - * @internal - */ -export const PutInvocationStepRequestFilterSensitiveLog = (obj: PutInvocationStepRequest): any => ({ - ...obj, - ...(obj.payload && { payload: InvocationStepPayloadFilterSensitiveLog(obj.payload) }), -}); diff --git a/clients/client-bedrock-agent-runtime/src/models/models_1.ts b/clients/client-bedrock-agent-runtime/src/models/models_1.ts index 26060ffd41002..f919944d1102b 100644 --- a/clients/client-bedrock-agent-runtime/src/models/models_1.ts +++ b/clients/client-bedrock-agent-runtime/src/models/models_1.ts @@ -1,23 +1,33 @@ // smithy-typescript generated code import { SENSITIVE_STRING } from "@smithy/smithy-client"; +import { DocumentType as __DocumentType } from "@smithy/types"; + import { + AccessDeniedException, AgentActionGroup, AgentActionGroupFilterSensitiveLog, AgentCollaboration, + BadGatewayException, BedrockModelConfigurations, + CitationEvent, + CitationEventFilterSensitiveLog, CollaboratorConfiguration, CollaboratorConfigurationFilterSensitiveLog, + ConflictException, ConversationHistory, ConversationHistoryFilterSensitiveLog, CustomOrchestration, + DependencyFailedException, ExternalSourcesRetrieveAndGenerateConfiguration, ExternalSourcesRetrieveAndGenerateConfigurationFilterSensitiveLog, FilterAttribute, GenerationConfiguration, GenerationConfigurationFilterSensitiveLog, + GuadrailAction, GuardrailConfiguration, GuardrailConfigurationWithArn, + GuardrailEvent, ImplicitFilterConfiguration, ImplicitFilterConfigurationFilterSensitiveLog, InlineBedrockModelConfigurations, @@ -25,23 +35,1115 @@ import { InlineSessionStateFilterSensitiveLog, InputFile, InputFileFilterSensitiveLog, + InternalServerException, InvocationResultMember, InvocationResultMemberFilterSensitiveLog, - KnowledgeBaseQuery, OrchestrationConfiguration, OrchestrationConfigurationFilterSensitiveLog, OrchestrationType, PromptOverrideConfiguration, + ResourceNotFoundException, + RetrievalResultContent, + RetrievalResultLocation, RetrieveAndGenerateInput, + RetrieveAndGenerateOutputEvent, RetrieveAndGenerateSessionConfiguration, RetrieveAndGenerateType, SearchType, - SessionStatus, + ServiceQuotaExceededException, StreamingConfigurations, + ThrottlingException, + ValidationException, VectorSearchRerankingConfiguration, VectorSearchRerankingConfigurationFilterSensitiveLog, } from "./models_0"; +/** + *

A retrieve and generate stream response output.

+ * @public + */ +export type RetrieveAndGenerateStreamResponseOutput = + | RetrieveAndGenerateStreamResponseOutput.AccessDeniedExceptionMember + | RetrieveAndGenerateStreamResponseOutput.BadGatewayExceptionMember + | RetrieveAndGenerateStreamResponseOutput.CitationMember + | RetrieveAndGenerateStreamResponseOutput.ConflictExceptionMember + | RetrieveAndGenerateStreamResponseOutput.DependencyFailedExceptionMember + | RetrieveAndGenerateStreamResponseOutput.GuardrailMember + | RetrieveAndGenerateStreamResponseOutput.InternalServerExceptionMember + | RetrieveAndGenerateStreamResponseOutput.OutputMember + | RetrieveAndGenerateStreamResponseOutput.ResourceNotFoundExceptionMember + | RetrieveAndGenerateStreamResponseOutput.ServiceQuotaExceededExceptionMember + | RetrieveAndGenerateStreamResponseOutput.ThrottlingExceptionMember + | RetrieveAndGenerateStreamResponseOutput.ValidationExceptionMember + | RetrieveAndGenerateStreamResponseOutput.$UnknownMember; + +/** + * @public + */ +export namespace RetrieveAndGenerateStreamResponseOutput { + /** + *

An output event.

+ * @public + */ + export interface OutputMember { + output: RetrieveAndGenerateOutputEvent; + citation?: never; + guardrail?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + $unknown?: never; + } + + /** + *

A citation event.

+ * @public + */ + export interface CitationMember { + output?: never; + citation: CitationEvent; + guardrail?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + $unknown?: never; + } + + /** + *

A guardrail event.

+ * @public + */ + export interface GuardrailMember { + output?: never; + citation?: never; + guardrail: GuardrailEvent; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + $unknown?: never; + } + + /** + *

An internal server error occurred. Retry your request.

+ * @public + */ + export interface InternalServerExceptionMember { + output?: never; + citation?: never; + guardrail?: never; + internalServerException: InternalServerException; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + $unknown?: never; + } + + /** + *

The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide.

+ * @public + */ + export interface ValidationExceptionMember { + output?: never; + citation?: never; + guardrail?: never; + internalServerException?: never; + validationException: ValidationException; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + $unknown?: never; + } + + /** + *

The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide.

+ * @public + */ + export interface ResourceNotFoundExceptionMember { + output?: never; + citation?: never; + guardrail?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException: ResourceNotFoundException; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + $unknown?: never; + } + + /** + *

Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.

+ * @public + */ + export interface ServiceQuotaExceededExceptionMember { + output?: never; + citation?: never; + guardrail?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException: ServiceQuotaExceededException; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + $unknown?: never; + } + + /** + *

Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide.

+ * @public + */ + export interface ThrottlingExceptionMember { + output?: never; + citation?: never; + guardrail?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException: ThrottlingException; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + $unknown?: never; + } + + /** + *

The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide.

+ * @public + */ + export interface AccessDeniedExceptionMember { + output?: never; + citation?: never; + guardrail?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException: AccessDeniedException; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + $unknown?: never; + } + + /** + *

Error occurred because of a conflict while performing an operation.

+ * @public + */ + export interface ConflictExceptionMember { + output?: never; + citation?: never; + guardrail?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException: ConflictException; + dependencyFailedException?: never; + badGatewayException?: never; + $unknown?: never; + } + + /** + *

The request failed due to a dependency error.

+ * @public + */ + export interface DependencyFailedExceptionMember { + output?: never; + citation?: never; + guardrail?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException: DependencyFailedException; + badGatewayException?: never; + $unknown?: never; + } + + /** + *

The request failed due to a bad gateway error.

+ * @public + */ + export interface BadGatewayExceptionMember { + output?: never; + citation?: never; + guardrail?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException: BadGatewayException; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + output?: never; + citation?: never; + guardrail?: never; + internalServerException?: never; + validationException?: never; + resourceNotFoundException?: never; + serviceQuotaExceededException?: never; + throttlingException?: never; + accessDeniedException?: never; + conflictException?: never; + dependencyFailedException?: never; + badGatewayException?: never; + $unknown: [string, any]; + } + + export interface Visitor { + output: (value: RetrieveAndGenerateOutputEvent) => T; + citation: (value: CitationEvent) => T; + guardrail: (value: GuardrailEvent) => T; + internalServerException: (value: InternalServerException) => T; + validationException: (value: ValidationException) => T; + resourceNotFoundException: (value: ResourceNotFoundException) => T; + serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T; + throttlingException: (value: ThrottlingException) => T; + accessDeniedException: (value: AccessDeniedException) => T; + conflictException: (value: ConflictException) => T; + dependencyFailedException: (value: DependencyFailedException) => T; + badGatewayException: (value: BadGatewayException) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: RetrieveAndGenerateStreamResponseOutput, visitor: Visitor): T => { + if (value.output !== undefined) return visitor.output(value.output); + if (value.citation !== undefined) return visitor.citation(value.citation); + if (value.guardrail !== undefined) return visitor.guardrail(value.guardrail); + if (value.internalServerException !== undefined) + return visitor.internalServerException(value.internalServerException); + if (value.validationException !== undefined) return visitor.validationException(value.validationException); + if (value.resourceNotFoundException !== undefined) + return visitor.resourceNotFoundException(value.resourceNotFoundException); + if (value.serviceQuotaExceededException !== undefined) + return visitor.serviceQuotaExceededException(value.serviceQuotaExceededException); + if (value.throttlingException !== undefined) return visitor.throttlingException(value.throttlingException); + if (value.accessDeniedException !== undefined) return visitor.accessDeniedException(value.accessDeniedException); + if (value.conflictException !== undefined) return visitor.conflictException(value.conflictException); + if (value.dependencyFailedException !== undefined) + return visitor.dependencyFailedException(value.dependencyFailedException); + if (value.badGatewayException !== undefined) return visitor.badGatewayException(value.badGatewayException); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + * @public + */ +export interface RetrieveAndGenerateStreamResponse { + /** + *

A stream of events from the model.

+ * @public + */ + stream: AsyncIterable | undefined; + + /** + *

The session ID.

+ * @public + */ + sessionId: string | undefined; +} + +/** + *

Contains the query made to the knowledge base.

This data type is used in the following API operations:

+ * @public + */ +export interface KnowledgeBaseQuery { + /** + *

The text of the query made to the knowledge base.

+ * @public + */ + text: string | undefined; +} + +/** + *

Details about a result from querying the knowledge base.

This data type is used in the following API operations:

+ * @public + */ +export interface KnowledgeBaseRetrievalResult { + /** + *

Contains information about the content of the chunk.

+ * @public + */ + content: RetrievalResultContent | undefined; + + /** + *

Contains information about the location of the data source.

+ * @public + */ + location?: RetrievalResultLocation | undefined; + + /** + *

The level of relevance of the result to the query.

+ * @public + */ + score?: number | undefined; + + /** + *

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

+ * @public + */ + metadata?: Record | undefined; +} + +/** + * @public + */ +export interface RetrieveResponse { + /** + *

A list of results from querying the knowledge base.

+ * @public + */ + retrievalResults: KnowledgeBaseRetrievalResult[] | undefined; + + /** + *

Specifies if there is a guardrail intervention in the response.

+ * @public + */ + guardrailAction?: GuadrailAction | undefined; + + /** + *

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

+ * @public + */ + nextToken?: string | undefined; +} + +/** + * @public + */ +export interface CreateSessionRequest { + /** + *

A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.

+ * @public + */ + sessionMetadata?: Record | undefined; + + /** + *

The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see Amazon Bedrock session encryption.

+ * @public + */ + encryptionKeyArn?: string | undefined; + + /** + *

Specify the key-value pairs for the tags that you want to attach to the session.

+ * @public + */ + tags?: Record | undefined; +} + +/** + * @public + * @enum + */ +export const SessionStatus = { + ACTIVE: "ACTIVE", + ENDED: "ENDED", + EXPIRED: "EXPIRED", +} as const; + +/** + * @public + */ +export type SessionStatus = (typeof SessionStatus)[keyof typeof SessionStatus]; + +/** + * @public + */ +export interface CreateSessionResponse { + /** + *

The unique identifier for the session.

+ * @public + */ + sessionId: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the created session.

+ * @public + */ + sessionArn: string | undefined; + + /** + *

The current status of the session.

+ * @public + */ + sessionStatus: SessionStatus | undefined; + + /** + *

The timestamp for when the session was created.

+ * @public + */ + createdAt: Date | undefined; +} + +/** + * @public + */ +export interface DeleteSessionRequest { + /** + *

The unique identifier for the session to be deleted. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ * @public + */ + sessionIdentifier: string | undefined; +} + +/** + * @public + */ +export interface DeleteSessionResponse {} + +/** + * @public + */ +export interface EndSessionRequest { + /** + *

The unique identifier for the session to end. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ * @public + */ + sessionIdentifier: string | undefined; +} + +/** + * @public + */ +export interface EndSessionResponse { + /** + *

The unique identifier of the session you ended.

+ * @public + */ + sessionId: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the session you ended.

+ * @public + */ + sessionArn: string | undefined; + + /** + *

The current status of the session you ended.

+ * @public + */ + sessionStatus: SessionStatus | undefined; +} + +/** + * @public + */ +export interface GetSessionRequest { + /** + *

A unique identifier for the session to retrieve. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ * @public + */ + sessionIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetSessionResponse { + /** + *

The unique identifier for the session in UUID format.

+ * @public + */ + sessionId: string | undefined; + + /** + *

The Amazon Resource Name (ARN) of the session.

+ * @public + */ + sessionArn: string | undefined; + + /** + *

The current status of the session.

+ * @public + */ + sessionStatus: SessionStatus | undefined; + + /** + *

The timestamp for when the session was created.

+ * @public + */ + createdAt: Date | undefined; + + /** + *

The timestamp for when the session was last modified.

+ * @public + */ + lastUpdatedAt: Date | undefined; + + /** + *

A map of key-value pairs containing attributes persisted across the session.

+ * @public + */ + sessionMetadata?: Record | undefined; + + /** + *

The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see Amazon Bedrock session encryption.

+ * @public + */ + encryptionKeyArn?: string | undefined; +} + +/** + * @public + */ +export interface CreateInvocationRequest { + /** + *

A unique identifier for the invocation in UUID format.

+ * @public + */ + invocationId?: string | undefined; + + /** + *

A description for the interactions in the invocation. For example, "User asking about weather in Seattle".

+ * @public + */ + description?: string | undefined; + + /** + *

The unique identifier for the associated session for the invocation. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ * @public + */ + sessionIdentifier: string | undefined; +} + +/** + * @public + */ +export interface CreateInvocationResponse { + /** + *

The unique identifier for the session associated with the invocation.

+ * @public + */ + sessionId: string | undefined; + + /** + *

The unique identifier for the invocation.

+ * @public + */ + invocationId: string | undefined; + + /** + *

The timestamp for when the invocation was created.

+ * @public + */ + createdAt: Date | undefined; +} + +/** + * @public + */ +export interface ListInvocationsRequest { + /** + *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

+ * @public + */ + nextToken?: string | undefined; + + /** + *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

+ * @public + */ + maxResults?: number | undefined; + + /** + *

The unique identifier for the session to list invocations for. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ * @public + */ + sessionIdentifier: string | undefined; +} + +/** + *

Contains details about an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

+ * @public + */ +export interface InvocationSummary { + /** + *

The unique identifier for the session associated with the invocation.

+ * @public + */ + sessionId: string | undefined; + + /** + *

A unique identifier for the invocation in UUID format.

+ * @public + */ + invocationId: string | undefined; + + /** + *

The timestamp for when the invocation was created.

+ * @public + */ + createdAt: Date | undefined; +} + +/** + * @public + */ +export interface ListInvocationsResponse { + /** + *

A list of invocation summaries associated with the session.

+ * @public + */ + invocationSummaries: InvocationSummary[] | undefined; + + /** + *

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

+ * @public + */ + nextToken?: string | undefined; +} + +/** + * @public + */ +export interface GetInvocationStepRequest { + /** + *

The unique identifier for the invocation in UUID format.

+ * @public + */ + invocationIdentifier: string | undefined; + + /** + *

The unique identifier (in UUID format) for the specific invocation step to retrieve.

+ * @public + */ + invocationStepId: string | undefined; + + /** + *

The unique identifier for the invocation step's associated session. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ * @public + */ + sessionIdentifier: string | undefined; +} + +/** + * @public + * @enum + */ +export const ImageFormat = { + GIF: "gif", + JPEG: "jpeg", + PNG: "png", + WEBP: "webp", +} as const; + +/** + * @public + */ +export type ImageFormat = (typeof ImageFormat)[keyof typeof ImageFormat]; + +/** + *

Information about the Amazon S3 bucket where the image is stored.

+ * @public + */ +export interface S3Location { + /** + *

The path to the Amazon S3 bucket where the image is stored.

+ * @public + */ + uri: string | undefined; +} + +/** + *

The source for an image.

+ * @public + */ +export type ImageSource = ImageSource.BytesMember | ImageSource.S3LocationMember | ImageSource.$UnknownMember; + +/** + * @public + */ +export namespace ImageSource { + /** + *

The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.

+ * @public + */ + export interface BytesMember { + bytes: Uint8Array; + s3Location?: never; + $unknown?: never; + } + + /** + *

The path to the Amazon S3 bucket where the image is stored.

+ * @public + */ + export interface S3LocationMember { + bytes?: never; + s3Location: S3Location; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + bytes?: never; + s3Location?: never; + $unknown: [string, any]; + } + + export interface Visitor { + bytes: (value: Uint8Array) => T; + s3Location: (value: S3Location) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: ImageSource, visitor: Visitor): T => { + if (value.bytes !== undefined) return visitor.bytes(value.bytes); + if (value.s3Location !== undefined) return visitor.s3Location(value.s3Location); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + *

Image content for an invocation step.

+ * @public + */ +export interface ImageBlock { + /** + *

The format of the image.

+ * @public + */ + format: ImageFormat | undefined; + + /** + *

The source for the image.

+ * @public + */ + source: ImageSource | undefined; +} + +/** + *

A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a session in the payLoad of the PutInvocationStep API operation. You retrieve the content with the GetInvocationStep API operation.

For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

+ * @public + */ +export type BedrockSessionContentBlock = + | BedrockSessionContentBlock.ImageMember + | BedrockSessionContentBlock.TextMember + | BedrockSessionContentBlock.$UnknownMember; + +/** + * @public + */ +export namespace BedrockSessionContentBlock { + /** + *

The text in the invocation step.

+ * @public + */ + export interface TextMember { + text: string; + image?: never; + $unknown?: never; + } + + /** + *

The image in the invocation step.

+ * @public + */ + export interface ImageMember { + text?: never; + image: ImageBlock; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + text?: never; + image?: never; + $unknown: [string, any]; + } + + export interface Visitor { + text: (value: string) => T; + image: (value: ImageBlock) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: BedrockSessionContentBlock, visitor: Visitor): T => { + if (value.text !== undefined) return visitor.text(value.text); + if (value.image !== undefined) return visitor.image(value.image); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + *

Payload content, such as text and images, for the invocation step.

+ * @public + */ +export type InvocationStepPayload = InvocationStepPayload.ContentBlocksMember | InvocationStepPayload.$UnknownMember; + +/** + * @public + */ +export namespace InvocationStepPayload { + /** + *

The content for the invocation step.

+ * @public + */ + export interface ContentBlocksMember { + contentBlocks: BedrockSessionContentBlock[]; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + contentBlocks?: never; + $unknown: [string, any]; + } + + export interface Visitor { + contentBlocks: (value: BedrockSessionContentBlock[]) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: InvocationStepPayload, visitor: Visitor): T => { + if (value.contentBlocks !== undefined) return visitor.contentBlocks(value.contentBlocks); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + *

Stores fine-grained state checkpoints, including text and images, for each interaction in an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

+ * @public + */ +export interface InvocationStep { + /** + *

The unique identifier of the session containing the invocation step.

+ * @public + */ + sessionId: string | undefined; + + /** + *

The unique identifier (in UUID format) for the invocation that includes the invocation step.

+ * @public + */ + invocationId: string | undefined; + + /** + *

The unique identifier (in UUID format) for the invocation step.

+ * @public + */ + invocationStepId: string | undefined; + + /** + *

The timestamp for when the invocation step was created.

+ * @public + */ + invocationStepTime: Date | undefined; + + /** + *

Payload content, such as text and images, for the invocation step.

+ * @public + */ + payload: InvocationStepPayload | undefined; +} + +/** + * @public + */ +export interface GetInvocationStepResponse { + /** + *

The complete details of the requested invocation step.

+ * @public + */ + invocationStep: InvocationStep | undefined; +} + +/** + * @public + */ +export interface ListInvocationStepsRequest { + /** + *

The unique identifier (in UUID format) for the invocation to list invocation steps for.

+ * @public + */ + invocationIdentifier?: string | undefined; + + /** + *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

+ * @public + */ + nextToken?: string | undefined; + + /** + *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

+ * @public + */ + maxResults?: number | undefined; + + /** + *

The unique identifier for the session associated with the invocation steps. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ * @public + */ + sessionIdentifier: string | undefined; +} + +/** + *

Contains details about an 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.

+ * @public + */ +export interface InvocationStepSummary { + /** + *

The unique identifier for the session associated with the invocation step.

+ * @public + */ + sessionId: string | undefined; + + /** + *

A unique identifier for the invocation in UUID format.

+ * @public + */ + invocationId: string | undefined; + + /** + *

The unique identifier (in UUID format) for the invocation step.

+ * @public + */ + invocationStepId: string | undefined; + + /** + *

The timestamp for when the invocation step was created.

+ * @public + */ + invocationStepTime: Date | undefined; +} + +/** + * @public + */ +export interface ListInvocationStepsResponse { + /** + *

A list of summaries for each invocation step associated with a session and if you specified it, an invocation within the session.

+ * @public + */ + invocationStepSummaries: InvocationStepSummary[] | undefined; + + /** + *

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

+ * @public + */ + nextToken?: string | undefined; +} + +/** + * @public + */ +export interface PutInvocationStepRequest { + /** + *

The unique identifier for the session to add the invocation step to. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

+ * @public + */ + sessionIdentifier: string | undefined; + + /** + *

The unique identifier (in UUID format) of the invocation to add the invocation step to.

+ * @public + */ + invocationIdentifier: string | undefined; + + /** + *

The timestamp for when the invocation step occurred.

+ * @public + */ + invocationStepTime: Date | undefined; + + /** + *

The payload for the invocation step, including text and images for the interaction.

+ * @public + */ + payload: InvocationStepPayload | undefined; + + /** + *

The unique identifier of the invocation step in UUID format.

+ * @public + */ + invocationStepId?: string | undefined; +} + +/** + * @public + */ +export interface PutInvocationStepResponse { + /** + *

The unique identifier of the invocation step in UUID format.

+ * @public + */ + invocationStepId: string | undefined; +} + +/** + * @public + */ +export interface ListSessionsRequest { + /** + *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

+ * @public + */ + maxResults?: number | undefined; + + /** + *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

+ * @public + */ + nextToken?: string | undefined; +} + /** *

Contains details about a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

* @public @@ -1130,6 +2232,102 @@ export interface InvokeInlineAgentRequest { customOrchestration?: CustomOrchestration | undefined; } +/** + * @internal + */ +export const RetrieveAndGenerateStreamResponseOutputFilterSensitiveLog = ( + obj: RetrieveAndGenerateStreamResponseOutput +): any => { + if (obj.output !== undefined) return { output: SENSITIVE_STRING }; + if (obj.citation !== undefined) return { citation: CitationEventFilterSensitiveLog(obj.citation) }; + if (obj.guardrail !== undefined) return { guardrail: obj.guardrail }; + if (obj.internalServerException !== undefined) return { internalServerException: obj.internalServerException }; + if (obj.validationException !== undefined) return { validationException: obj.validationException }; + if (obj.resourceNotFoundException !== undefined) return { resourceNotFoundException: obj.resourceNotFoundException }; + if (obj.serviceQuotaExceededException !== undefined) + return { serviceQuotaExceededException: obj.serviceQuotaExceededException }; + if (obj.throttlingException !== undefined) return { throttlingException: obj.throttlingException }; + if (obj.accessDeniedException !== undefined) return { accessDeniedException: obj.accessDeniedException }; + if (obj.conflictException !== undefined) return { conflictException: obj.conflictException }; + if (obj.dependencyFailedException !== undefined) return { dependencyFailedException: obj.dependencyFailedException }; + if (obj.badGatewayException !== undefined) return { badGatewayException: obj.badGatewayException }; + if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; +}; + +/** + * @internal + */ +export const RetrieveAndGenerateStreamResponseFilterSensitiveLog = (obj: RetrieveAndGenerateStreamResponse): any => ({ + ...obj, + ...(obj.stream && { stream: "STREAMING_CONTENT" }), +}); + +/** + * @internal + */ +export const KnowledgeBaseQueryFilterSensitiveLog = (obj: KnowledgeBaseQuery): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const KnowledgeBaseRetrievalResultFilterSensitiveLog = (obj: KnowledgeBaseRetrievalResult): any => ({ + ...obj, + ...(obj.content && { content: SENSITIVE_STRING }), + ...(obj.location && { location: SENSITIVE_STRING }), + ...(obj.metadata && { metadata: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const RetrieveResponseFilterSensitiveLog = (obj: RetrieveResponse): any => ({ + ...obj, + ...(obj.retrievalResults && { retrievalResults: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const BedrockSessionContentBlockFilterSensitiveLog = (obj: BedrockSessionContentBlock): any => { + if (obj.text !== undefined) return { text: obj.text }; + if (obj.image !== undefined) return { image: obj.image }; + if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; +}; + +/** + * @internal + */ +export const InvocationStepPayloadFilterSensitiveLog = (obj: InvocationStepPayload): any => { + if (obj.contentBlocks !== undefined) return { contentBlocks: SENSITIVE_STRING }; + if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; +}; + +/** + * @internal + */ +export const InvocationStepFilterSensitiveLog = (obj: InvocationStep): any => ({ + ...obj, + ...(obj.payload && { payload: InvocationStepPayloadFilterSensitiveLog(obj.payload) }), +}); + +/** + * @internal + */ +export const GetInvocationStepResponseFilterSensitiveLog = (obj: GetInvocationStepResponse): any => ({ + ...obj, + ...(obj.invocationStep && { invocationStep: InvocationStepFilterSensitiveLog(obj.invocationStep) }), +}); + +/** + * @internal + */ +export const PutInvocationStepRequestFilterSensitiveLog = (obj: PutInvocationStepRequest): any => ({ + ...obj, + ...(obj.payload && { payload: InvocationStepPayloadFilterSensitiveLog(obj.payload) }), +}); + /** * @internal */ diff --git a/clients/client-bedrock-agent-runtime/src/pagination/ListFlowExecutionEventsPaginator.ts b/clients/client-bedrock-agent-runtime/src/pagination/ListFlowExecutionEventsPaginator.ts new file mode 100644 index 0000000000000..402c30f379f73 --- /dev/null +++ b/clients/client-bedrock-agent-runtime/src/pagination/ListFlowExecutionEventsPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { BedrockAgentRuntimeClient } from "../BedrockAgentRuntimeClient"; +import { + ListFlowExecutionEventsCommand, + ListFlowExecutionEventsCommandInput, + ListFlowExecutionEventsCommandOutput, +} from "../commands/ListFlowExecutionEventsCommand"; +import { BedrockAgentRuntimePaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListFlowExecutionEvents: ( + config: BedrockAgentRuntimePaginationConfiguration, + input: ListFlowExecutionEventsCommandInput, + ...rest: any[] +) => Paginator = createPaginator< + BedrockAgentRuntimePaginationConfiguration, + ListFlowExecutionEventsCommandInput, + ListFlowExecutionEventsCommandOutput +>(BedrockAgentRuntimeClient, ListFlowExecutionEventsCommand, "nextToken", "nextToken", "maxResults"); diff --git a/clients/client-bedrock-agent-runtime/src/pagination/ListFlowExecutionsPaginator.ts b/clients/client-bedrock-agent-runtime/src/pagination/ListFlowExecutionsPaginator.ts new file mode 100644 index 0000000000000..6aeff72ed27d2 --- /dev/null +++ b/clients/client-bedrock-agent-runtime/src/pagination/ListFlowExecutionsPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { BedrockAgentRuntimeClient } from "../BedrockAgentRuntimeClient"; +import { + ListFlowExecutionsCommand, + ListFlowExecutionsCommandInput, + ListFlowExecutionsCommandOutput, +} from "../commands/ListFlowExecutionsCommand"; +import { BedrockAgentRuntimePaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListFlowExecutions: ( + config: BedrockAgentRuntimePaginationConfiguration, + input: ListFlowExecutionsCommandInput, + ...rest: any[] +) => Paginator = createPaginator< + BedrockAgentRuntimePaginationConfiguration, + ListFlowExecutionsCommandInput, + ListFlowExecutionsCommandOutput +>(BedrockAgentRuntimeClient, ListFlowExecutionsCommand, "nextToken", "nextToken", "maxResults"); diff --git a/clients/client-bedrock-agent-runtime/src/pagination/index.ts b/clients/client-bedrock-agent-runtime/src/pagination/index.ts index c8cfdf4f67970..9019e22b8e654 100644 --- a/clients/client-bedrock-agent-runtime/src/pagination/index.ts +++ b/clients/client-bedrock-agent-runtime/src/pagination/index.ts @@ -1,6 +1,8 @@ export * from "./GetAgentMemoryPaginator"; // smithy-typescript generated code export * from "./Interfaces"; +export * from "./ListFlowExecutionEventsPaginator"; +export * from "./ListFlowExecutionsPaginator"; export * from "./ListInvocationStepsPaginator"; export * from "./ListInvocationsPaginator"; export * from "./ListSessionsPaginator"; diff --git a/clients/client-bedrock-agent-runtime/src/protocols/Aws_restJson1.ts b/clients/client-bedrock-agent-runtime/src/protocols/Aws_restJson1.ts index 6c7eb2f2c98dc..932e67511c602 100644 --- a/clients/client-bedrock-agent-runtime/src/protocols/Aws_restJson1.ts +++ b/clients/client-bedrock-agent-runtime/src/protocols/Aws_restJson1.ts @@ -44,11 +44,21 @@ import { DeleteSessionCommandInput, DeleteSessionCommandOutput } from "../comman import { EndSessionCommandInput, EndSessionCommandOutput } from "../commands/EndSessionCommand"; import { GenerateQueryCommandInput, GenerateQueryCommandOutput } from "../commands/GenerateQueryCommand"; import { GetAgentMemoryCommandInput, GetAgentMemoryCommandOutput } from "../commands/GetAgentMemoryCommand"; +import { + GetExecutionFlowSnapshotCommandInput, + GetExecutionFlowSnapshotCommandOutput, +} from "../commands/GetExecutionFlowSnapshotCommand"; +import { GetFlowExecutionCommandInput, GetFlowExecutionCommandOutput } from "../commands/GetFlowExecutionCommand"; import { GetInvocationStepCommandInput, GetInvocationStepCommandOutput } from "../commands/GetInvocationStepCommand"; import { GetSessionCommandInput, GetSessionCommandOutput } from "../commands/GetSessionCommand"; import { InvokeAgentCommandInput, InvokeAgentCommandOutput } from "../commands/InvokeAgentCommand"; import { InvokeFlowCommandInput, InvokeFlowCommandOutput } from "../commands/InvokeFlowCommand"; import { InvokeInlineAgentCommandInput, InvokeInlineAgentCommandOutput } from "../commands/InvokeInlineAgentCommand"; +import { + ListFlowExecutionEventsCommandInput, + ListFlowExecutionEventsCommandOutput, +} from "../commands/ListFlowExecutionEventsCommand"; +import { ListFlowExecutionsCommandInput, ListFlowExecutionsCommandOutput } from "../commands/ListFlowExecutionsCommand"; import { ListInvocationsCommandInput, ListInvocationsCommandOutput } from "../commands/ListInvocationsCommand"; import { ListInvocationStepsCommandInput, @@ -71,6 +81,8 @@ import { RetrieveAndGenerateStreamCommandOutput, } from "../commands/RetrieveAndGenerateStreamCommand"; import { RetrieveCommandInput, RetrieveCommandOutput } from "../commands/RetrieveCommand"; +import { StartFlowExecutionCommandInput, StartFlowExecutionCommandOutput } from "../commands/StartFlowExecutionCommand"; +import { StopFlowExecutionCommandInput, StopFlowExecutionCommandOutput } from "../commands/StopFlowExecutionCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand"; import { UpdateSessionCommandInput, UpdateSessionCommandOutput } from "../commands/UpdateSessionCommand"; @@ -91,13 +103,13 @@ import { BedrockModelConfigurations, BedrockRerankingConfiguration, BedrockRerankingModelConfiguration, - BedrockSessionContentBlock, ByteContentDoc, ByteContentFile, Citation, CitationEvent, CodeInterpreterInvocationOutput, CollaboratorConfiguration, + ConditionResultEvent, ConflictException, ContentBlock, ContentBody, @@ -114,12 +126,20 @@ import { FilterAttribute, FinalResponse, FlowCompletionEvent, + FlowExecutionContent, + FlowExecutionEvent, + FlowExecutionInputEvent, + FlowExecutionOutputEvent, + FlowExecutionSummary, + FlowFailureEvent, FlowInput, FlowInputContent, + FlowInputField, FlowMultiTurnInputContent, FlowMultiTurnInputRequestEvent, FlowOutputContent, FlowOutputEvent, + FlowOutputField, FlowResponseStream, FlowTrace, FlowTraceConditionNodeResultEvent, @@ -139,10 +159,8 @@ import { GuardrailConfigurationWithArn, GuardrailEvent, GuardrailTrace, - ImageBlock, ImageInput, ImageInputSource, - ImageSource, ImplicitFilterConfiguration, InferenceConfig, InferenceConfiguration, @@ -158,13 +176,7 @@ import { InternalServerException, InvocationInput, InvocationResultMember, - InvocationStep, - InvocationStepPayload, - InvocationStepSummary, - InvocationSummary, KnowledgeBaseLookupOutput, - KnowledgeBaseQuery, - KnowledgeBaseRetrievalResult, Memory, MemorySessionSummary, Message, @@ -174,6 +186,12 @@ import { ModelInvocationInput, ModelNotReadyException, ModelPerformanceConfiguration, + NodeExecutionContent, + NodeFailureEvent, + NodeInputEvent, + NodeInputField, + NodeOutputEvent, + NodeOutputField, Observation, OptimizedPromptEvent, OptimizedPromptStream, @@ -207,14 +225,12 @@ import { RetrieveAndGenerateInput, RetrieveAndGenerateOutputEvent, RetrieveAndGenerateSessionConfiguration, - RetrieveAndGenerateStreamResponseOutput, RetrievedReference, ReturnControlPayload, ReturnControlResults, RoutingClassifierModelInvocationOutput, RoutingClassifierTrace, S3Identifier, - S3Location, S3ObjectDoc, S3ObjectFile, ServiceQuotaExceededException, @@ -233,14 +249,25 @@ import { VectorSearchRerankingConfiguration, } from "../models/models_0"; import { + BedrockSessionContentBlock, Collaborator, + ImageBlock, + ImageSource, + InvocationStep, + InvocationStepPayload, + InvocationStepSummary, + InvocationSummary, KnowledgeBase, KnowledgeBaseConfiguration, + KnowledgeBaseQuery, KnowledgeBaseRetrievalConfiguration, + KnowledgeBaseRetrievalResult, KnowledgeBaseRetrieveAndGenerateConfiguration, KnowledgeBaseVectorSearchConfiguration, RetrievalFilter, RetrieveAndGenerateConfiguration, + RetrieveAndGenerateStreamResponseOutput, + S3Location, SessionState, SessionSummary, } from "../models/models_1"; @@ -392,6 +419,42 @@ export const se_GetAgentMemoryCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1GetExecutionFlowSnapshotCommand + */ +export const se_GetExecutionFlowSnapshotCommand = async ( + input: GetExecutionFlowSnapshotCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}/flowsnapshot"); + b.p("flowIdentifier", () => input.flowIdentifier!, "{flowIdentifier}", false); + b.p("flowAliasIdentifier", () => input.flowAliasIdentifier!, "{flowAliasIdentifier}", false); + b.p("executionIdentifier", () => input.executionIdentifier!, "{executionIdentifier}", false); + let body: any; + b.m("GET").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1GetFlowExecutionCommand + */ +export const se_GetFlowExecutionCommand = async ( + input: GetFlowExecutionCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}"); + b.p("flowIdentifier", () => input.flowIdentifier!, "{flowIdentifier}", false); + b.p("flowAliasIdentifier", () => input.flowAliasIdentifier!, "{flowAliasIdentifier}", false); + b.p("executionIdentifier", () => input.executionIdentifier!, "{executionIdentifier}", false); + let body: any; + b.m("GET").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1GetInvocationStepCommand */ @@ -533,6 +596,50 @@ export const se_InvokeInlineAgentCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1ListFlowExecutionEventsCommand + */ +export const se_ListFlowExecutionEventsCommand = async ( + input: ListFlowExecutionEventsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}/events"); + b.p("flowIdentifier", () => input.flowIdentifier!, "{flowIdentifier}", false); + b.p("flowAliasIdentifier", () => input.flowAliasIdentifier!, "{flowAliasIdentifier}", false); + b.p("executionIdentifier", () => input.executionIdentifier!, "{executionIdentifier}", false); + const query: any = map({ + [_mR]: [() => input.maxResults !== void 0, () => input[_mR]!.toString()], + [_nT]: [, input[_nT]!], + [_eT]: [, __expectNonNull(input[_eT]!, `eventType`)], + }); + let body: any; + b.m("GET").h(headers).q(query).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1ListFlowExecutionsCommand + */ +export const se_ListFlowExecutionsCommand = async ( + input: ListFlowExecutionsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/flows/{flowIdentifier}/executions"); + b.p("flowIdentifier", () => input.flowIdentifier!, "{flowIdentifier}", false); + const query: any = map({ + [_fAI]: [, input[_fAI]!], + [_mR]: [() => input.maxResults !== void 0, () => input[_mR]!.toString()], + [_nT]: [, input[_nT]!], + }); + let body: any; + b.m("GET").h(headers).q(query).b(body); + return b.build(); +}; + /** * serializeAws_restJson1ListInvocationsCommand */ @@ -762,6 +869,50 @@ export const se_RetrieveAndGenerateStreamCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1StartFlowExecutionCommand + */ +export const se_StartFlowExecutionCommand = async ( + input: StartFlowExecutionCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions"); + b.p("flowIdentifier", () => input.flowIdentifier!, "{flowIdentifier}", false); + b.p("flowAliasIdentifier", () => input.flowAliasIdentifier!, "{flowAliasIdentifier}", false); + let body: any; + body = JSON.stringify( + take(input, { + flowExecutionName: [], + inputs: (_) => se_FlowInputs(_, context), + modelPerformanceConfiguration: (_) => _json(_), + }) + ); + b.m("POST").h(headers).b(body); + return b.build(); +}; + +/** + * serializeAws_restJson1StopFlowExecutionCommand + */ +export const se_StopFlowExecutionCommand = async ( + input: StopFlowExecutionCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}/stop"); + b.p("flowIdentifier", () => input.flowIdentifier!, "{flowIdentifier}", false); + b.p("flowAliasIdentifier", () => input.flowAliasIdentifier!, "{flowAliasIdentifier}", false); + b.p("executionIdentifier", () => input.executionIdentifier!, "{executionIdentifier}", false); + let body: any; + b.m("POST").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1TagResourceCommand */ @@ -974,6 +1125,60 @@ export const de_GetAgentMemoryCommand = async ( return contents; }; +/** + * deserializeAws_restJson1GetExecutionFlowSnapshotCommand + */ +export const de_GetExecutionFlowSnapshotCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + customerEncryptionKeyArn: __expectString, + definition: __expectString, + executionRoleArn: __expectString, + flowAliasIdentifier: __expectString, + flowIdentifier: __expectString, + flowVersion: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1GetFlowExecutionCommand + */ +export const de_GetFlowExecutionCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + endedAt: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + errors: _json, + executionArn: __expectString, + flowAliasIdentifier: __expectString, + flowIdentifier: __expectString, + flowVersion: __expectString, + startedAt: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + status: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1GetInvocationStepCommand */ @@ -1082,6 +1287,50 @@ export const de_InvokeInlineAgentCommand = async ( return contents; }; +/** + * deserializeAws_restJson1ListFlowExecutionEventsCommand + */ +export const de_ListFlowExecutionEventsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + flowExecutionEvents: (_) => de_FlowExecutionEvents(_, context), + nextToken: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1ListFlowExecutionsCommand + */ +export const de_ListFlowExecutionsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + flowExecutionSummaries: (_) => de_FlowExecutionSummaries(_, context), + nextToken: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1ListInvocationsCommand */ @@ -1296,6 +1545,49 @@ export const de_RetrieveAndGenerateStreamCommand = async ( return contents; }; +/** + * deserializeAws_restJson1StartFlowExecutionCommand + */ +export const de_StartFlowExecutionCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + executionArn: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + +/** + * deserializeAws_restJson1StopFlowExecutionCommand + */ +export const de_StopFlowExecutionCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + executionArn: __expectString, + status: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1TagResourceCommand */ @@ -3211,6 +3503,17 @@ const de_CodeInterpreterInvocationOutput = (output: any, context: __SerdeContext }) as any; }; +/** + * deserializeAws_restJson1ConditionResultEvent + */ +const de_ConditionResultEvent = (output: any, context: __SerdeContext): ConditionResultEvent => { + return take(output, { + nodeName: __expectString, + satisfiedConditions: _json, + timestamp: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + }) as any; +}; + /** * deserializeAws_restJson1ContentBody */ @@ -3262,6 +3565,158 @@ const de_FinalResponse = (output: any, context: __SerdeContext): FinalResponse = // de_FlowCompletionEvent omitted. +/** + * deserializeAws_restJson1FlowExecutionContent + */ +const de_FlowExecutionContent = (output: any, context: __SerdeContext): FlowExecutionContent => { + if (output.document != null) { + return { + document: de_Document(output.document, context), + }; + } + return { $unknown: Object.entries(output)[0] }; +}; + +// de_FlowExecutionError omitted. + +// de_FlowExecutionErrors omitted. + +/** + * deserializeAws_restJson1FlowExecutionEvent + */ +const de_FlowExecutionEvent = (output: any, context: __SerdeContext): FlowExecutionEvent => { + if (output.conditionResultEvent != null) { + return { + conditionResultEvent: de_ConditionResultEvent(output.conditionResultEvent, context), + }; + } + if (output.flowFailureEvent != null) { + return { + flowFailureEvent: de_FlowFailureEvent(output.flowFailureEvent, context), + }; + } + if (output.flowInputEvent != null) { + return { + flowInputEvent: de_FlowExecutionInputEvent(output.flowInputEvent, context), + }; + } + if (output.flowOutputEvent != null) { + return { + flowOutputEvent: de_FlowExecutionOutputEvent(output.flowOutputEvent, context), + }; + } + if (output.nodeFailureEvent != null) { + return { + nodeFailureEvent: de_NodeFailureEvent(output.nodeFailureEvent, context), + }; + } + if (output.nodeInputEvent != null) { + return { + nodeInputEvent: de_NodeInputEvent(output.nodeInputEvent, context), + }; + } + if (output.nodeOutputEvent != null) { + return { + nodeOutputEvent: de_NodeOutputEvent(output.nodeOutputEvent, context), + }; + } + return { $unknown: Object.entries(output)[0] }; +}; + +/** + * deserializeAws_restJson1FlowExecutionEvents + */ +const de_FlowExecutionEvents = (output: any, context: __SerdeContext): FlowExecutionEvent[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_FlowExecutionEvent(__expectUnion(entry), context); + }); + return retVal; +}; + +/** + * deserializeAws_restJson1FlowExecutionInputEvent + */ +const de_FlowExecutionInputEvent = (output: any, context: __SerdeContext): FlowExecutionInputEvent => { + return take(output, { + fields: (_: any) => de_FlowInputFields(_, context), + nodeName: __expectString, + timestamp: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + }) as any; +}; + +/** + * deserializeAws_restJson1FlowExecutionOutputEvent + */ +const de_FlowExecutionOutputEvent = (output: any, context: __SerdeContext): FlowExecutionOutputEvent => { + return take(output, { + fields: (_: any) => de_FlowOutputFields(_, context), + nodeName: __expectString, + timestamp: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + }) as any; +}; + +/** + * deserializeAws_restJson1FlowExecutionSummaries + */ +const de_FlowExecutionSummaries = (output: any, context: __SerdeContext): FlowExecutionSummary[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_FlowExecutionSummary(entry, context); + }); + return retVal; +}; + +/** + * deserializeAws_restJson1FlowExecutionSummary + */ +const de_FlowExecutionSummary = (output: any, context: __SerdeContext): FlowExecutionSummary => { + return take(output, { + createdAt: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + endedAt: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + executionArn: __expectString, + flowAliasIdentifier: __expectString, + flowIdentifier: __expectString, + flowVersion: __expectString, + status: __expectString, + }) as any; +}; + +/** + * deserializeAws_restJson1FlowFailureEvent + */ +const de_FlowFailureEvent = (output: any, context: __SerdeContext): FlowFailureEvent => { + return take(output, { + errorCode: __expectString, + errorMessage: __expectString, + timestamp: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + }) as any; +}; + +/** + * deserializeAws_restJson1FlowInputField + */ +const de_FlowInputField = (output: any, context: __SerdeContext): FlowInputField => { + return take(output, { + content: (_: any) => de_FlowExecutionContent(__expectUnion(_), context), + name: __expectString, + }) as any; +}; + +/** + * deserializeAws_restJson1FlowInputFields + */ +const de_FlowInputFields = (output: any, context: __SerdeContext): FlowInputField[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_FlowInputField(entry, context); + }); + return retVal; +}; + /** * deserializeAws_restJson1FlowMultiTurnInputContent */ @@ -3308,6 +3763,28 @@ const de_FlowOutputEvent = (output: any, context: __SerdeContext): FlowOutputEve }) as any; }; +/** + * deserializeAws_restJson1FlowOutputField + */ +const de_FlowOutputField = (output: any, context: __SerdeContext): FlowOutputField => { + return take(output, { + content: (_: any) => de_FlowExecutionContent(__expectUnion(_), context), + name: __expectString, + }) as any; +}; + +/** + * deserializeAws_restJson1FlowOutputFields + */ +const de_FlowOutputFields = (output: any, context: __SerdeContext): FlowOutputField[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_FlowOutputField(entry, context); + }); + return retVal; +}; + /** * deserializeAws_restJson1FlowTrace */ @@ -3860,6 +4337,96 @@ const de_ModelInvocationInput = (output: any, context: __SerdeContext): ModelInv }) as any; }; +/** + * deserializeAws_restJson1NodeExecutionContent + */ +const de_NodeExecutionContent = (output: any, context: __SerdeContext): NodeExecutionContent => { + if (output.document != null) { + return { + document: de_Document(output.document, context), + }; + } + return { $unknown: Object.entries(output)[0] }; +}; + +/** + * deserializeAws_restJson1NodeFailureEvent + */ +const de_NodeFailureEvent = (output: any, context: __SerdeContext): NodeFailureEvent => { + return take(output, { + errorCode: __expectString, + errorMessage: __expectString, + nodeName: __expectString, + timestamp: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + }) as any; +}; + +/** + * deserializeAws_restJson1NodeInputEvent + */ +const de_NodeInputEvent = (output: any, context: __SerdeContext): NodeInputEvent => { + return take(output, { + fields: (_: any) => de_NodeInputFields(_, context), + nodeName: __expectString, + timestamp: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + }) as any; +}; + +/** + * deserializeAws_restJson1NodeInputField + */ +const de_NodeInputField = (output: any, context: __SerdeContext): NodeInputField => { + return take(output, { + content: (_: any) => de_NodeExecutionContent(__expectUnion(_), context), + name: __expectString, + }) as any; +}; + +/** + * deserializeAws_restJson1NodeInputFields + */ +const de_NodeInputFields = (output: any, context: __SerdeContext): NodeInputField[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_NodeInputField(entry, context); + }); + return retVal; +}; + +/** + * deserializeAws_restJson1NodeOutputEvent + */ +const de_NodeOutputEvent = (output: any, context: __SerdeContext): NodeOutputEvent => { + return take(output, { + fields: (_: any) => de_NodeOutputFields(_, context), + nodeName: __expectString, + timestamp: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + }) as any; +}; + +/** + * deserializeAws_restJson1NodeOutputField + */ +const de_NodeOutputField = (output: any, context: __SerdeContext): NodeOutputField => { + return take(output, { + content: (_: any) => de_NodeExecutionContent(__expectUnion(_), context), + name: __expectString, + }) as any; +}; + +/** + * deserializeAws_restJson1NodeOutputFields + */ +const de_NodeOutputFields = (output: any, context: __SerdeContext): NodeOutputField[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_NodeOutputField(entry, context); + }); + return retVal; +}; + /** * deserializeAws_restJson1Observation */ @@ -4252,6 +4819,10 @@ const de_RoutingClassifierTrace = (output: any, context: __SerdeContext): Routin // de_S3Location omitted. +// de_SatisfiedCondition omitted. + +// de_SatisfiedConditions omitted. + // de_SessionMetadataMap omitted. /** @@ -4370,6 +4941,8 @@ const collectBodyString = (streamBody: any, context: __SerdeContext): PromiseThe name of the condition node that evaluated the conditions.

", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the condition evaluation occurred.

", + "smithy.api#required": {} + } + }, + "satisfiedConditions": { + "target": "com.amazonaws.bedrockagentruntime#SatisfiedConditions", + "traits": { + "smithy.api#documentation": "

A list of conditions that were satisfied during the evaluation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a condition evaluation result during an async execution. This event is generated when a condition node in the flow evaluates its conditions.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagentruntime#ConfirmationState": { "type": "enum", "members": { @@ -2963,217 +2996,688 @@ } } }, - "com.amazonaws.bedrockagentruntime#FlowExecutionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 100 + "com.amazonaws.bedrockagentruntime#FlowErrorCode": { + "type": "enum", + "members": { + "VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION" + } }, - "smithy.api#pattern": "^[0-9a-zA-Z._:-]+$" + "INTERNAL_SERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER" + } + }, + "NODE_EXECUTION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NODE_EXECUTION_FAILED" + } + } } }, - "com.amazonaws.bedrockagentruntime#FlowIdentifier": { - "type": "string", + "com.amazonaws.bedrockagentruntime#FlowExecutionContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The document content of the field, which can contain text or structured data.

" + } + } + }, "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$" + "smithy.api#documentation": "

Contains the content of an async execution input or output field.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagentruntime#FlowInput": { + "com.amazonaws.bedrockagentruntime#FlowExecutionError": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { - "smithy.api#documentation": "

The name of the flow input node that begins the prompt flow.

", - "smithy.api#required": {} - } - }, - "nodeOutputName": { - "target": "com.amazonaws.bedrockagentruntime#NodeOutputName", - "traits": { - "smithy.api#documentation": "

The name of the output from the flow input node that begins the prompt flow.

" + "smithy.api#documentation": "

The name of the node in the flow where the error occurred (if applicable).

" } }, - "content": { - "target": "com.amazonaws.bedrockagentruntime#FlowInputContent", + "error": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionErrorType", "traits": { - "smithy.api#documentation": "

Contains information about an input into the prompt flow.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The error code for the type of error that occurred.

" } }, - "nodeInputName": { - "target": "com.amazonaws.bedrockagentruntime#NodeInputName", + "message": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The name of the input from the flow input node.

" + "smithy.api#documentation": "

A descriptive message that provides details about the error.

" } } }, "traits": { - "smithy.api#documentation": "

Contains information about an input into the prompt flow and where to send it.

" + "smithy.api#documentation": "

Contains information about an error that occurred during an async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

" } }, - "com.amazonaws.bedrockagentruntime#FlowInputContent": { - "type": "union", + "com.amazonaws.bedrockagentruntime#FlowExecutionErrorType": { + "type": "enum", "members": { - "document": { - "target": "smithy.api#Document", + "TIMED_OUT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The input to send to the prompt flow input node.

" + "smithy.api#enumValue": "ExecutionTimedOut" } } - }, - "traits": { - "smithy.api#documentation": "

Contains information about an input into the flow.

", - "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagentruntime#FlowInputs": { + "com.amazonaws.bedrockagentruntime#FlowExecutionErrors": { "type": "list", "member": { - "target": "com.amazonaws.bedrockagentruntime#FlowInput" + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionError" + } + }, + "com.amazonaws.bedrockagentruntime#FlowExecutionEvent": { + "type": "union", + "members": { + "flowInputEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionInputEvent", + "traits": { + "smithy.api#documentation": "

Contains information about the inputs provided to the flow at the start of execution.

" + } + }, + "flowOutputEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionOutputEvent", + "traits": { + "smithy.api#documentation": "

Contains information about the outputs produced by the flow at the end of execution.

" + } + }, + "nodeInputEvent": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputEvent", + "traits": { + "smithy.api#documentation": "

Contains information about the inputs provided to a specific node during execution.

" + } + }, + "nodeOutputEvent": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputEvent", + "traits": { + "smithy.api#documentation": "

Contains information about the outputs produced by a specific node during execution.

" + } + }, + "conditionResultEvent": { + "target": "com.amazonaws.bedrockagentruntime#ConditionResultEvent", + "traits": { + "smithy.api#documentation": "

Contains information about a condition evaluation result during the async execution. This event is generated when a condition node in the flow evaluates its conditions.

" + } + }, + "nodeFailureEvent": { + "target": "com.amazonaws.bedrockagentruntime#NodeFailureEvent", + "traits": { + "smithy.api#documentation": "

Contains information about a failure that occurred at a specific node during execution.

" + } + }, + "flowFailureEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowFailureEvent", + "traits": { + "smithy.api#documentation": "

Contains information about a failure that occurred at the flow level during execution.

" + } + } }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } + "smithy.api#documentation": "

Represents an event that occurred during an async execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

" } }, - "com.amazonaws.bedrockagentruntime#FlowMultiTurnInputContent": { - "type": "union", + "com.amazonaws.bedrockagentruntime#FlowExecutionEventType": { + "type": "enum", "members": { - "document": { - "target": "smithy.api#Document", + "NODE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

The requested additional input to send back to the multi-turn flow node.

" + "smithy.api#enumValue": "Node" + } + }, + "FLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Flow" } } + } + }, + "com.amazonaws.bedrockagentruntime#FlowExecutionEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionEvent" }, "traits": { - "smithy.api#documentation": "

The content structure containing input information for multi-turn flow interactions.

" + "smithy.api#length": { + "max": 10 + } } }, - "com.amazonaws.bedrockagentruntime#FlowMultiTurnInputRequestEvent": { + "com.amazonaws.bedrockagentruntime#FlowExecutionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._:-]+$" + } + }, + "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]{1,36}$|^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}/execution/[a-zA-Z0-9-]{1,36})$" + } + }, + "com.amazonaws.bedrockagentruntime#FlowExecutionInputEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { - "smithy.api#documentation": "

The name of the node in the flow that is requesting the input.

", + "smithy.api#documentation": "

The name of the node that receives the inputs.

", "smithy.api#required": {} } }, - "nodeType": { - "target": "com.amazonaws.bedrockagentruntime#NodeType", + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { - "smithy.api#documentation": "

The type of the node in the flow that is requesting the input.

", + "smithy.api#documentation": "

The timestamp when the inputs are provided.

", "smithy.api#required": {} } }, - "content": { - "target": "com.amazonaws.bedrockagentruntime#FlowMultiTurnInputContent", + "fields": { + "target": "com.amazonaws.bedrockagentruntime#FlowInputFields", "traits": { - "smithy.api#documentation": "

The content payload containing the input request details for the multi-turn interaction.

", + "smithy.api#documentation": "

A list of input fields provided to the flow.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Response object from the flow multi-turn node requesting additional information.

", + "smithy.api#documentation": "

Contains information about the inputs provided to the flow at the start of async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagentruntime#FlowOutputContent": { - "type": "union", - "members": { - "document": { - "target": "smithy.api#Document", - "traits": { - "smithy.api#documentation": "

The content in the output.

" - } - } - }, + "com.amazonaws.bedrockagentruntime#FlowExecutionName": { + "type": "string", "traits": { - "smithy.api#documentation": "

Contains information about the content in an output from prompt flow invocation.

" + "smithy.api#length": { + "max": 36 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]{1,36}$" } }, - "com.amazonaws.bedrockagentruntime#FlowOutputEvent": { + "com.amazonaws.bedrockagentruntime#FlowExecutionOutputEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { - "smithy.api#documentation": "

The name of the flow output node that the output is from.

", + "smithy.api#documentation": "

The name of the node that produces the outputs.

", "smithy.api#required": {} } }, - "nodeType": { - "target": "com.amazonaws.bedrockagentruntime#NodeType", + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { - "smithy.api#documentation": "

The type of the node that the output is from.

", + "smithy.api#documentation": "

The timestamp when the outputs are produced.

", "smithy.api#required": {} } }, - "content": { - "target": "com.amazonaws.bedrockagentruntime#FlowOutputContent", + "fields": { + "target": "com.amazonaws.bedrockagentruntime#FlowOutputFields", "traits": { - "smithy.api#documentation": "

The content in the output.

", + "smithy.api#documentation": "

A list of output fields produced by the flow.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Contains information about an output from prompt flow invoction.

", + "smithy.api#documentation": "

Contains information about the outputs produced by the flow during an async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagentruntime#FlowResource": { + "com.amazonaws.bedrockagentruntime#FlowExecutionResource": { "type": "resource", "operations": [ { - "target": "com.amazonaws.bedrockagentruntime#InvokeFlow" + "target": "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshot" + }, + { + "target": "com.amazonaws.bedrockagentruntime#GetFlowExecution" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ListFlowExecutionEvents" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ListFlowExecutions" + }, + { + "target": "com.amazonaws.bedrockagentruntime#StartFlowExecution" + }, + { + "target": "com.amazonaws.bedrockagentruntime#StopFlowExecution" } ] }, - "com.amazonaws.bedrockagentruntime#FlowResponseStream": { - "type": "union", + "com.amazonaws.bedrockagentruntime#FlowExecutionRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$" + } + }, + "com.amazonaws.bedrockagentruntime#FlowExecutionStatus": { + "type": "enum", "members": { - "flowOutputEvent": { - "target": "com.amazonaws.bedrockagentruntime#FlowOutputEvent", + "RUNNING": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Contains information about an output from flow invocation.

" + "smithy.api#enumValue": "Running" } }, - "flowCompletionEvent": { - "target": "com.amazonaws.bedrockagentruntime#FlowCompletionEvent", + "SUCCEEDED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Contains information about why the flow completed.

" + "smithy.api#enumValue": "Succeeded" } }, - "flowTraceEvent": { - "target": "com.amazonaws.bedrockagentruntime#FlowTraceEvent", + "FAILED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Contains information about a trace, which tracks an input or output for a node in the flow.

" + "smithy.api#enumValue": "Failed" } }, - "internalServerException": { - "target": "com.amazonaws.bedrockagentruntime#InternalServerException", + "TIMED_OUT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

An internal server error occurred. Retry your request.

" + "smithy.api#enumValue": "TimedOut" } }, - "validationException": { - "target": "com.amazonaws.bedrockagentruntime#ValidationException", + "ABORTED": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "

Input validation failed. Check your request parameters and retry the request.

" + "smithy.api#enumValue": "Aborted" } - }, - "resourceNotFoundException": { - "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowExecutionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionSummary" + }, + "traits": { + "smithy.api#length": { + "max": 10 + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowExecutionSummary": { + "type": "structure", + "members": { + "executionArn": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the async execution.

", + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow alias used for the execution.

", + "smithy.api#required": {} + } + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow.

", + "smithy.api#required": {} + } + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagentruntime#Version", + "traits": { + "smithy.api#documentation": "

The version of the flow used for the execution.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionStatus", + "traits": { + "smithy.api#documentation": "

The current status of the async execution.

Async executions time out after 24 hours.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the async execution was created.

", + "smithy.api#required": {} + } + }, + "endedAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the async execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains summary information about a flow's async execution, including its status, timestamps, and identifiers.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

" + } + }, + "com.amazonaws.bedrockagentruntime#FlowFailureEvent": { + "type": "structure", + "members": { + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the failure occurred.

", + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.bedrockagentruntime#FlowErrorCode", + "traits": { + "smithy.api#documentation": "

The error code that identifies the type of failure that occurred.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A descriptive message that provides details about the failure.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a failure that occurred at the flow level during an async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})$" + } + }, + "com.amazonaws.bedrockagentruntime#FlowInput": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the flow input node that begins the prompt flow.

", + "smithy.api#required": {} + } + }, + "nodeOutputName": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputName", + "traits": { + "smithy.api#documentation": "

The name of the output from the flow input node that begins the prompt flow.

" + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowInputContent", + "traits": { + "smithy.api#documentation": "

Contains information about an input into the prompt flow.

", + "smithy.api#required": {} + } + }, + "nodeInputName": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputName", + "traits": { + "smithy.api#documentation": "

The name of the input from the flow input node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an input into the prompt flow and where to send it.

" + } + }, + "com.amazonaws.bedrockagentruntime#FlowInputContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The input to send to the prompt flow input node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an input into the flow.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowInputField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputName", + "traits": { + "smithy.api#documentation": "

The name of the input field as defined in the flow's input schema.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionContent", + "traits": { + "smithy.api#documentation": "

The content of the input field, which can contain text or structured data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an input field provided to a flow during an async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowInputFields": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowInputField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowInputs": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowInput" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowMultiTurnInputContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The requested additional input to send back to the multi-turn flow node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The content structure containing input information for multi-turn flow interactions.

" + } + }, + "com.amazonaws.bedrockagentruntime#FlowMultiTurnInputRequestEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the node in the flow that is requesting the input.

", + "smithy.api#required": {} + } + }, + "nodeType": { + "target": "com.amazonaws.bedrockagentruntime#NodeType", + "traits": { + "smithy.api#documentation": "

The type of the node in the flow that is requesting the input.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowMultiTurnInputContent", + "traits": { + "smithy.api#documentation": "

The content payload containing the input request details for the multi-turn interaction.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Response object from the flow multi-turn node requesting additional information.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowOutputContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The content in the output.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the content in an output from prompt flow invocation.

" + } + }, + "com.amazonaws.bedrockagentruntime#FlowOutputEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the flow output node that the output is from.

", + "smithy.api#required": {} + } + }, + "nodeType": { + "target": "com.amazonaws.bedrockagentruntime#NodeType", + "traits": { + "smithy.api#documentation": "

The type of the node that the output is from.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowOutputContent", + "traits": { + "smithy.api#documentation": "

The content in the output.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about an output from prompt flow invoction.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowOutputField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputName", + "traits": { + "smithy.api#documentation": "

The name of the output field as defined in the flow's output schema.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionContent", + "traits": { + "smithy.api#documentation": "

The content of the output field, which can contain text or structured data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an output field produced by a flow during an async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#FlowOutputFields": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#FlowOutputField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentruntime#FlowResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagentruntime#InvokeFlow" + } + ] + }, + "com.amazonaws.bedrockagentruntime#FlowResponseStream": { + "type": "union", + "members": { + "flowOutputEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowOutputEvent", + "traits": { + "smithy.api#documentation": "

Contains information about an output from flow invocation.

" + } + }, + "flowCompletionEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowCompletionEvent", + "traits": { + "smithy.api#documentation": "

Contains information about why the flow completed.

" + } + }, + "flowTraceEvent": { + "target": "com.amazonaws.bedrockagentruntime#FlowTraceEvent", + "traits": { + "smithy.api#documentation": "

Contains information about a trace, which tracks an input or output for a node in the flow.

" + } + }, + "internalServerException": { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException", + "traits": { + "smithy.api#documentation": "

An internal server error occurred. Retry your request.

" + } + }, + "validationException": { + "target": "com.amazonaws.bedrockagentruntime#ValidationException", + "traits": { + "smithy.api#documentation": "

Input validation failed. Check your request parameters and retry the request.

" + } + }, + "resourceNotFoundException": { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", "traits": { "smithy.api#documentation": "

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

" } @@ -3992,45 +4496,290 @@ "agentAliasId": { "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", "traits": { - "smithy.api#documentation": "

The unique identifier of an alias of an agent.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "

The unique identifier of an alias of an agent.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "memoryType": { + "target": "com.amazonaws.bedrockagentruntime#MemoryType", + "traits": { + "smithy.api#documentation": "

The type of memory.

", + "smithy.api#httpQuery": "memoryType", + "smithy.api#required": {} + } + }, + "memoryId": { + "target": "com.amazonaws.bedrockagentruntime#MemoryId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the memory.

", + "smithy.api#httpQuery": "memoryId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetAgentMemoryResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } + }, + "memoryContents": { + "target": "com.amazonaws.bedrockagentruntime#Memories", + "traits": { + "smithy.api#documentation": "

Contains details of the sessions stored in the memory

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the flow definition snapshot used for an asynchronous execution. The snapshot represents the flow metadata and definition as it existed at the time the asynchronous execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}/flowsnapshot" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshotRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow alias used for the async execution.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the async execution.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshotResponse": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow.

", + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow alias used for the async execution.

", + "smithy.api#required": {} + } + }, + "flowVersion": { + "target": "com.amazonaws.bedrockagentruntime#Version", + "traits": { + "smithy.api#documentation": "

The version of the flow used for the async execution.

", + "smithy.api#required": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionRoleArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM service role that's used by the async execution.

", + "smithy.api#required": {} + } + }, + "definition": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The flow definition used for the async execution, including the nodes, connections, and configuration at the time when the execution started.

The definition returns as a string that follows the structure of a FlowDefinition object.

", + "smithy.api#required": {} + } + }, + "customerEncryptionKeyArn": { + "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetFlowExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#GetFlowExecutionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#GetFlowExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about a specific asynchronous execution of a flow, including its status, start and end times, and any errors that occurred during execution.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetFlowExecutionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow alias used for the execution.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the async execution to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#GetFlowExecutionResponse": { + "type": "structure", + "members": { + "executionArn": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the async execution.

", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionStatus", + "traits": { + "smithy.api#documentation": "

The current status of the async execution.

Async executions time out after 24 hours.

", + "smithy.api#required": {} + } + }, + "startedAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the async execution started.

", + "smithy.api#required": {} + } + }, + "endedAt": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the async execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.

" } }, - "memoryType": { - "target": "com.amazonaws.bedrockagentruntime#MemoryType", + "errors": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionErrors", "traits": { - "smithy.api#documentation": "

The type of memory.

", - "smithy.api#httpQuery": "memoryType", - "smithy.api#required": {} + "smithy.api#documentation": "

A list of errors that occurred during the async execution. Each error includes an error code, message, and the node where the error occurred, if applicable.

" } }, - "memoryId": { - "target": "com.amazonaws.bedrockagentruntime#MemoryId", + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier of the memory.

", - "smithy.api#httpQuery": "memoryId", + "smithy.api#documentation": "

The unique identifier of the flow alias used for the execution.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.bedrockagentruntime#GetAgentMemoryResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.bedrockagentruntime#NextToken", + }, + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", "traits": { - "smithy.api#documentation": "

If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + "smithy.api#documentation": "

The unique identifier of the flow.

", + "smithy.api#required": {} } }, - "memoryContents": { - "target": "com.amazonaws.bedrockagentruntime#Memories", + "flowVersion": { + "target": "com.amazonaws.bedrockagentruntime#Version", "traits": { - "smithy.api#documentation": "

Contains details of the sessions stored in the memory

" + "smithy.api#documentation": "

The version of the flow used for the execution.

", + "smithy.api#required": {} } } }, @@ -6691,80 +7440,295 @@ "generationConfiguration": { "target": "com.amazonaws.bedrockagentruntime#GenerationConfiguration", "traits": { - "smithy.api#documentation": "

Contains configurations for response generation based on the knowledge base query results.

" + "smithy.api#documentation": "

Contains configurations for response generation based on the knowledge base query results.

" + } + }, + "orchestrationConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#OrchestrationConfiguration", + "traits": { + "smithy.api#documentation": "

Settings for how the model processes the prompt prior to retrieval and generation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains details about the resource being queried.

This data type is used in the following API operations:

" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBaseVectorSearchConfiguration": { + "type": "structure", + "members": { + "numberOfResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": 5, + "smithy.api#documentation": "

The number of source chunks to retrieve.

", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "overrideSearchType": { + "target": "com.amazonaws.bedrockagentruntime#SearchType", + "traits": { + "smithy.api#documentation": "

By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.

" + } + }, + "filter": { + "target": "com.amazonaws.bedrockagentruntime#RetrievalFilter", + "traits": { + "smithy.api#documentation": "

Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.

" + } + }, + "rerankingConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#VectorSearchRerankingConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configurations for reranking the retrieved results. For more information, see Improve the relevance of query responses with a reranker model.

" + } + }, + "implicitFilterConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ImplicitFilterConfiguration", + "traits": { + "smithy.api#documentation": "

Settings for implicit filtering.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configurations for how to perform the search query and return results. For more information, see Query configurations.

This data type is used in the following API operations:

" + } + }, + "com.amazonaws.bedrockagentruntime#KnowledgeBases": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#KnowledgeBase" + } + }, + "com.amazonaws.bedrockagentruntime#LambdaArn": { + "type": "string" + }, + "com.amazonaws.bedrockagentruntime#LambdaResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + } + }, + "com.amazonaws.bedrockagentruntime#ListFlowExecutionEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#ListFlowExecutionEventsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#ListFlowExecutionEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists events that occurred during an asynchronous execution of a flow. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}/events" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flowExecutionEvents" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#ListFlowExecutionEventsRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow alias used for the execution.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the async execution.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentruntime#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of events to return in a single response. If more events exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "

A token to retrieve the next set of results. This value is returned in the response if more results are available.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "eventType": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionEventType", + "traits": { + "smithy.api#documentation": "

The type of events to retrieve. Specify Node for node-level events or Flow for flow-level events.

", + "smithy.api#httpQuery": "eventType", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#ListFlowExecutionEventsResponse": { + "type": "structure", + "members": { + "flowExecutionEvents": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionEvents", + "traits": { + "smithy.api#documentation": "

A list of events that occurred during the async execution. Events can include node inputs and outputs, flow inputs and outputs, condition results, and failure events.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", + "traits": { + "smithy.api#documentation": "

A token to retrieve the next set of results. This value is returned if more results are available.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#ListFlowExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#ListFlowExecutionsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#ListFlowExecutionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all asynchronous executions for 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).

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/flows/{flowIdentifier}/executions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "flowExecutionSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bedrockagentruntime#ListFlowExecutionsRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow to list executions for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow alias to list executions for.

", + "smithy.api#httpQuery": "flowAliasIdentifier" + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagentruntime#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of async executions to return in a single response. If more executions exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.

", + "smithy.api#httpQuery": "maxResults" } }, - "orchestrationConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#OrchestrationConfiguration", + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { - "smithy.api#documentation": "

Settings for how the model processes the prompt prior to retrieval and generation.

" + "smithy.api#documentation": "

A token to retrieve the next set of results. This value is returned in the response if more results are available.

", + "smithy.api#httpQuery": "nextToken" } } }, "traits": { - "smithy.api#documentation": "

Contains details about the resource being queried.

This data type is used in the following API operations:

" + "smithy.api#input": {} } }, - "com.amazonaws.bedrockagentruntime#KnowledgeBaseVectorSearchConfiguration": { + "com.amazonaws.bedrockagentruntime#ListFlowExecutionsResponse": { "type": "structure", "members": { - "numberOfResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#addedDefault": {}, - "smithy.api#default": 5, - "smithy.api#documentation": "

The number of source chunks to retrieve.

", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "overrideSearchType": { - "target": "com.amazonaws.bedrockagentruntime#SearchType", - "traits": { - "smithy.api#documentation": "

By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a HYBRID search using both vector embeddings and raw text, or SEMANTIC search using only vector embeddings. For other vector store configurations, only SEMANTIC search is available. For more information, see Test a knowledge base.

" - } - }, - "filter": { - "target": "com.amazonaws.bedrockagentruntime#RetrievalFilter", + "flowExecutionSummaries": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionSummaries", "traits": { - "smithy.api#documentation": "

Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.

" - } - }, - "rerankingConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#VectorSearchRerankingConfiguration", - "traits": { - "smithy.api#documentation": "

Contains configurations for reranking the retrieved results. For more information, see Improve the relevance of query responses with a reranker model.

" + "smithy.api#documentation": "

A list of async execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.

", + "smithy.api#required": {} } }, - "implicitFilterConfiguration": { - "target": "com.amazonaws.bedrockagentruntime#ImplicitFilterConfiguration", + "nextToken": { + "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { - "smithy.api#documentation": "

Settings for implicit filtering.

" + "smithy.api#documentation": "

A token to retrieve the next set of results. This value is returned if more results are available.

" } } }, "traits": { - "smithy.api#documentation": "

Configurations for how to perform the search query and return results. For more information, see Query configurations.

This data type is used in the following API operations:

" - } - }, - "com.amazonaws.bedrockagentruntime#KnowledgeBases": { - "type": "list", - "member": { - "target": "com.amazonaws.bedrockagentruntime#KnowledgeBase" - } - }, - "com.amazonaws.bedrockagentruntime#LambdaArn": { - "type": "string" - }, - "com.amazonaws.bedrockagentruntime#LambdaResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$" + "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#ListInvocationSteps": { @@ -7265,7 +8229,7 @@ "endTime": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { - "smithy.api#documentation": "

In the final response, endTime is the end time time of the agent invocation operation.

", + "smithy.api#documentation": "

In the final response, endTime is the end time of the agent invocation operation.

", "smithy.api#timestampFormat": "date-time" } }, @@ -7433,69 +8397,280 @@ "foundationModel": { "target": "com.amazonaws.bedrockagentruntime#ModelIdentifier", "traits": { - "smithy.api#documentation": "

The identifier of a foundation model.

" + "smithy.api#documentation": "

The identifier of a foundation model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The input for the pre-processing step.

  • The type matches the agent step.

  • The text contains the prompt.

  • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#ModelNotReadyException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.bedrockagentruntime#NonBlankString" + } + }, + "traits": { + "smithy.api#documentation": "

The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 424 + } + }, + "com.amazonaws.bedrockagentruntime#ModelPerformanceConfiguration": { + "type": "structure", + "members": { + "performanceConfig": { + "target": "com.amazonaws.bedrockagentruntime#PerformanceConfiguration", + "traits": { + "smithy.api#documentation": "

The latency configuration for the model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The performance configuration for a model called with InvokeFlow.

" + } + }, + "com.amazonaws.bedrockagentruntime#Name": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^\\S*$" + } + }, + "com.amazonaws.bedrockagentruntime#NodeErrorCode": { + "type": "enum", + "members": { + "VALIDATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALIDATION" + } + }, + "DEPENDENCY_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPENDENCY_FAILED" + } + }, + "BAD_GATEWAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAD_GATEWAY" + } + }, + "INTERNAL_SERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVER" + } + } + } + }, + "com.amazonaws.bedrockagentruntime#NodeExecutionContent": { + "type": "union", + "members": { + "document": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The document content of the field, which can contain text or structured data.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the content of a flow node's input or output field for an async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NodeFailureEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the node where the failure occurred.

", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the node failure occurred.

", + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.bedrockagentruntime#NodeErrorCode", + "traits": { + "smithy.api#documentation": "

The error code that identifies the type of failure that occurred at the node.

", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A descriptive message that provides details about the node failure.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about a failure that occurred at a specific node during a flow's async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NodeInputEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the node that received the inputs.

", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the inputs were provided to the node.

", + "smithy.api#required": {} + } + }, + "fields": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputFields", + "traits": { + "smithy.api#documentation": "

A list of input fields provided to the node.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about the inputs provided to a specific node during a flow's async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NodeInputField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputName", + "traits": { + "smithy.api#documentation": "

The name of the input field as defined in the node's input schema.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#NodeExecutionContent", + "traits": { + "smithy.api#documentation": "

The content of the input field, which can contain text or structured data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents an input field provided to a node during a flow's async execution.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#NodeInputFields": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#NodeInputField" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.bedrockagentruntime#NodeInputName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" + } + }, + "com.amazonaws.bedrockagentruntime#NodeName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" + } + }, + "com.amazonaws.bedrockagentruntime#NodeOutputEvent": { + "type": "structure", + "members": { + "nodeName": { + "target": "com.amazonaws.bedrockagentruntime#NodeName", + "traits": { + "smithy.api#documentation": "

The name of the node that produced the outputs.

", + "smithy.api#required": {} + } + }, + "timestamp": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the outputs were produced by the node.

", + "smithy.api#required": {} + } + }, + "fields": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputFields", + "traits": { + "smithy.api#documentation": "

A list of output fields produced by the node.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The input for the pre-processing step.

  • The type matches the agent step.

  • The text contains the prompt.

  • The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.

", + "smithy.api#documentation": "

Contains information about the outputs produced by a specific node during a flow's async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagentruntime#ModelNotReadyException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.bedrockagentruntime#NonBlankString" - } - }, - "traits": { - "smithy.api#documentation": "

The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.

", - "smithy.api#error": "client", - "smithy.api#httpError": 424 - } - }, - "com.amazonaws.bedrockagentruntime#ModelPerformanceConfiguration": { + "com.amazonaws.bedrockagentruntime#NodeOutputField": { "type": "structure", "members": { - "performanceConfig": { - "target": "com.amazonaws.bedrockagentruntime#PerformanceConfiguration", + "name": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputName", "traits": { - "smithy.api#documentation": "

The latency configuration for the model.

" + "smithy.api#documentation": "

The name of the output field as defined in the node's output schema.

", + "smithy.api#required": {} + } + }, + "content": { + "target": "com.amazonaws.bedrockagentruntime#NodeExecutionContent", + "traits": { + "smithy.api#documentation": "

The content of the output field, which can contain text or structured data.

", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The performance configuration for a model called with InvokeFlow.

" - } - }, - "com.amazonaws.bedrockagentruntime#Name": { - "type": "string", - "traits": { - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$", + "smithy.api#documentation": "

Represents an output field produced by a node during a flow's async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", "smithy.api#sensitive": {} } }, - "com.amazonaws.bedrockagentruntime#NextToken": { - "type": "string", + "com.amazonaws.bedrockagentruntime#NodeOutputFields": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#NodeOutputField" + }, "traits": { "smithy.api#length": { "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^\\S*$" - } - }, - "com.amazonaws.bedrockagentruntime#NodeInputName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" - } - }, - "com.amazonaws.bedrockagentruntime#NodeName": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" + "max": 2 + } } }, "com.amazonaws.bedrockagentruntime#NodeOutputName": { @@ -10669,6 +11844,34 @@ "smithy.api#pattern": "^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$" } }, + "com.amazonaws.bedrockagentruntime#SatisfiedCondition": { + "type": "structure", + "members": { + "conditionName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the condition that was satisfied.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a condition that was satisfied during a condition node evaluation in a flow's async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagentruntime#SatisfiedConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagentruntime#SatisfiedCondition" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.bedrockagentruntime#SearchType": { "type": "enum", "members": { @@ -10982,6 +12185,205 @@ "smithy.api#documentation": "

Contains information about where the text with a citation begins and ends in the generated output.

This data type is used in the following API operations:

" } }, + "com.amazonaws.bedrockagentruntime#StartFlowExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#StartFlowExecutionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#StartFlowExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous execution of an Amazon Bedrock flow. Unlike synchronous flows that run until completion or time out after five minutes, you can run asynchronous flows for longer durations. Asynchronous flows 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's async execution.

Asynchronous flows is in preview release for Amazon Bedrock and is subject to change.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions" + } + } + }, + "com.amazonaws.bedrockagentruntime#StartFlowExecutionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow to execute.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow alias to use for the async execution.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowExecutionName": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionName", + "traits": { + "smithy.api#documentation": "

The unique name for the async execution. If you don't provide one, a system-generated name is used.

" + } + }, + "inputs": { + "target": "com.amazonaws.bedrockagentruntime#FlowInputs", + "traits": { + "smithy.api#documentation": "

The input data required for the async execution. This must match the input schema defined in the flow.

", + "smithy.api#required": {} + } + }, + "modelPerformanceConfiguration": { + "target": "com.amazonaws.bedrockagentruntime#ModelPerformanceConfiguration", + "traits": { + "smithy.api#documentation": "

The performance settings for the foundation model used in the async execution.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#StartFlowExecutionResponse": { + "type": "structure", + "members": { + "executionArn": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the async execution.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bedrockagentruntime#StopFlowExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagentruntime#StopFlowExecutionRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagentruntime#StopFlowExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ConflictException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagentruntime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops an Amazon Bedrock flow's asynchronous execution. This operation prevents further processing of the flow and changes the execution status to Aborted.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}/stop" + } + } + }, + "com.amazonaws.bedrockagentruntime#StopFlowExecutionRequest": { + "type": "structure", + "members": { + "flowIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "flowAliasIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the flow alias used for the execution.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "executionIdentifier": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "

The unique identifier of the async execution to stop.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagentruntime#StopFlowExecutionResponse": { + "type": "structure", + "members": { + "executionArn": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the async execution that was stopped.

" + } + }, + "status": { + "target": "com.amazonaws.bedrockagentruntime#FlowExecutionStatus", + "traits": { + "smithy.api#documentation": "

The updated status of the async execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockagentruntime#StopSequences": { "type": "list", "member": { @@ -11824,6 +13226,16 @@ "traits": { "smithy.api#sensitive": {} } + }, + "com.amazonaws.bedrockagentruntime#Version": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, + "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" + } } } } From 153ceba342777fc1060e2b5bccdb21ee37b7bbe4 Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 21 May 2025 18:10:38 +0000 Subject: [PATCH 7/8] feat(clients): update client endpoints as of 2025-05-21 --- .../amazon/smithy/aws/typescript/codegen/endpoints.json | 7 ------- 1 file changed, 7 deletions(-) diff --git a/codegen/smithy-aws-typescript-codegen/src/main/resources/software/amazon/smithy/aws/typescript/codegen/endpoints.json b/codegen/smithy-aws-typescript-codegen/src/main/resources/software/amazon/smithy/aws/typescript/codegen/endpoints.json index 09ebfed9a37ec..3cba551eb8197 100644 --- a/codegen/smithy-aws-typescript-codegen/src/main/resources/software/amazon/smithy/aws/typescript/codegen/endpoints.json +++ b/codegen/smithy-aws-typescript-codegen/src/main/resources/software/amazon/smithy/aws/typescript/codegen/endpoints.json @@ -21874,13 +21874,6 @@ } } }, - "private-networks": { - "endpoints": { - "us-east-1": {}, - "us-east-2": {}, - "us-west-2": {} - } - }, "profile": { "endpoints": { "af-south-1": {}, From 3bdc582de60b89982293391c8acf066e7b693489 Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 21 May 2025 18:30:54 +0000 Subject: [PATCH 8/8] Publish v3.815.0 --- CHANGELOG.md | 15 +++++++++++++++ benchmark/size/report.md | 2 +- .../client-application-auto-scaling/CHANGELOG.md | 8 ++++++++ .../client-application-auto-scaling/package.json | 2 +- clients/client-bedrock-agent-runtime/CHANGELOG.md | 11 +++++++++++ clients/client-bedrock-agent-runtime/package.json | 2 +- clients/client-cloudwatch/CHANGELOG.md | 11 +++++++++++ clients/client-cloudwatch/package.json | 2 +- clients/client-ec2/CHANGELOG.md | 11 +++++++++++ clients/client-ec2/package.json | 2 +- .../client-partnercentral-selling/CHANGELOG.md | 11 +++++++++++ .../client-partnercentral-selling/package.json | 2 +- clients/client-s3/CHANGELOG.md | 8 ++++++++ clients/client-s3/package.json | 2 +- lerna.json | 2 +- lib/lib-storage/CHANGELOG.md | 8 ++++++++ lib/lib-storage/package.json | 2 +- packages/crc64-nvme-crt/CHANGELOG.md | 8 ++++++++ packages/crc64-nvme-crt/package.json | 2 +- .../middleware-flexible-checksums/CHANGELOG.md | 8 ++++++++ .../middleware-flexible-checksums/package.json | 2 +- packages/s3-presigned-post/CHANGELOG.md | 8 ++++++++ packages/s3-presigned-post/package.json | 2 +- packages/s3-request-presigner/CHANGELOG.md | 8 ++++++++ packages/s3-request-presigner/package.json | 2 +- private/aws-client-api-test/CHANGELOG.md | 8 ++++++++ private/aws-client-api-test/package.json | 2 +- private/aws-client-retry-test/CHANGELOG.md | 8 ++++++++ private/aws-client-retry-test/package.json | 2 +- private/aws-middleware-test/CHANGELOG.md | 8 ++++++++ private/aws-middleware-test/package.json | 2 +- 31 files changed, 155 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 56687a9d03722..718ff79e3563a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,21 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + + +### Features + +* **client-bedrock-agent-runtime:** Amazon Bedrock introduces asynchronous flows (in preview), which let you run flows for longer durations and yield control so that your application can perform other tasks and you don't have to actively monitor the flow's progress. ([9128be8](https://github.com/aws/aws-sdk-js-v3/commit/9128be8e9151dd7c6392c522cb056cb351462bfe)) +* **client-cloudwatch:** Adds support for setting up Contributor Insight rules on logs transformed via Logs Transformation feature. ([0eed872](https://github.com/aws/aws-sdk-js-v3/commit/0eed8726267e154755d45f5545a2e008a7af689b)) +* **client-ec2:** Release of Dualstack and Ipv6-only EC2 Public DNS hostnames ([b9f691a](https://github.com/aws/aws-sdk-js-v3/commit/b9f691a5bacc61a12b266eabd9fb2848aee6708c)) +* **client-partnercentral-selling:** Modified validation to allow expectedCustomerSpend array with zero elements in Partner Opportunity operations. ([ed51782](https://github.com/aws/aws-sdk-js-v3/commit/ed51782d7192b06752c93f15a502006c247179e6)) +* **clients:** update client endpoints as of 2025-05-21 ([153ceba](https://github.com/aws/aws-sdk-js-v3/commit/153ceba342777fc1060e2b5bccdb21ee37b7bbe4)) + + + + + # [3.814.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.813.0...v3.814.0) (2025-05-20) diff --git a/benchmark/size/report.md b/benchmark/size/report.md index a4d57b16a85ea..23978821d4721 100644 --- a/benchmark/size/report.md +++ b/benchmark/size/report.md @@ -50,7 +50,7 @@ |@aws-sdk/node-http-handler|3.370.0|14.4 KB|N/A|N/A|N/A| |@aws-sdk/polly-request-presigner|3.495.0|23.3 KB|✅(5.88.2)|✅(3.26.3)|✅(0.18.15)| |@aws-sdk/s3-presigned-post|3.496.0|27.4 KB|✅(5.88.2)|✅(3.26.3)|✅(0.18.15)| -|@aws-sdk/s3-request-presigner|3.810.0|31.6 KB|✅(5.88.2)|✅(3.26.3)|✅(0.25.1)| +|@aws-sdk/s3-request-presigner|3.812.0|31.6 KB|✅(5.88.2)|✅(3.26.3)|✅(0.25.1)| |@aws-sdk/signature-v4|3.370.0|14.4 KB|✅(5.77.0)|✅(3.20.2)|✅(0.17.15)| |@aws-sdk/signature-v4-crt|3.810.0|54.5 KB|N/A|N/A|N/A| |@aws-sdk/smithy-client|3.370.0|18.8 KB|✅(5.77.0)|✅(3.20.2)|✅(0.17.15)| diff --git a/clients/client-application-auto-scaling/CHANGELOG.md b/clients/client-application-auto-scaling/CHANGELOG.md index 32d7b1b57882a..4d90514123f35 100644 --- a/clients/client-application-auto-scaling/CHANGELOG.md +++ b/clients/client-application-auto-scaling/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + +**Note:** Version bump only for package @aws-sdk/client-application-auto-scaling + + + + + # [3.812.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.811.0...v3.812.0) (2025-05-16) **Note:** Version bump only for package @aws-sdk/client-application-auto-scaling diff --git a/clients/client-application-auto-scaling/package.json b/clients/client-application-auto-scaling/package.json index f0a92210e156a..c358fa678cb59 100644 --- a/clients/client-application-auto-scaling/package.json +++ b/clients/client-application-auto-scaling/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/client-application-auto-scaling", "description": "AWS SDK for JavaScript Application Auto Scaling Client for Node.js, Browser and React Native", - "version": "3.812.0", + "version": "3.815.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline client-application-auto-scaling", diff --git a/clients/client-bedrock-agent-runtime/CHANGELOG.md b/clients/client-bedrock-agent-runtime/CHANGELOG.md index 5fe3cd45836cc..5ea9756a5d3f6 100644 --- a/clients/client-bedrock-agent-runtime/CHANGELOG.md +++ b/clients/client-bedrock-agent-runtime/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + + +### Features + +* **client-bedrock-agent-runtime:** Amazon Bedrock introduces asynchronous flows (in preview), which let you run flows for longer durations and yield control so that your application can perform other tasks and you don't have to actively monitor the flow's progress. ([9128be8](https://github.com/aws/aws-sdk-js-v3/commit/9128be8e9151dd7c6392c522cb056cb351462bfe)) + + + + + # [3.812.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.811.0...v3.812.0) (2025-05-16) **Note:** Version bump only for package @aws-sdk/client-bedrock-agent-runtime diff --git a/clients/client-bedrock-agent-runtime/package.json b/clients/client-bedrock-agent-runtime/package.json index 0fc2df5e0507f..4674cfa37a1d3 100644 --- a/clients/client-bedrock-agent-runtime/package.json +++ b/clients/client-bedrock-agent-runtime/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/client-bedrock-agent-runtime", "description": "AWS SDK for JavaScript Bedrock Agent Runtime Client for Node.js, Browser and React Native", - "version": "3.812.0", + "version": "3.815.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline client-bedrock-agent-runtime", diff --git a/clients/client-cloudwatch/CHANGELOG.md b/clients/client-cloudwatch/CHANGELOG.md index 8ea055cfd6f6f..b55db04256da0 100644 --- a/clients/client-cloudwatch/CHANGELOG.md +++ b/clients/client-cloudwatch/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + + +### Features + +* **client-cloudwatch:** Adds support for setting up Contributor Insight rules on logs transformed via Logs Transformation feature. ([0eed872](https://github.com/aws/aws-sdk-js-v3/commit/0eed8726267e154755d45f5545a2e008a7af689b)) + + + + + # [3.812.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.811.0...v3.812.0) (2025-05-16) **Note:** Version bump only for package @aws-sdk/client-cloudwatch diff --git a/clients/client-cloudwatch/package.json b/clients/client-cloudwatch/package.json index e6dde11684e55..c703b6d3b21fc 100644 --- a/clients/client-cloudwatch/package.json +++ b/clients/client-cloudwatch/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/client-cloudwatch", "description": "AWS SDK for JavaScript Cloudwatch Client for Node.js, Browser and React Native", - "version": "3.812.0", + "version": "3.815.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline client-cloudwatch", diff --git a/clients/client-ec2/CHANGELOG.md b/clients/client-ec2/CHANGELOG.md index 9def3ac49972b..08bc3827c5bca 100644 --- a/clients/client-ec2/CHANGELOG.md +++ b/clients/client-ec2/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + + +### Features + +* **client-ec2:** Release of Dualstack and Ipv6-only EC2 Public DNS hostnames ([b9f691a](https://github.com/aws/aws-sdk-js-v3/commit/b9f691a5bacc61a12b266eabd9fb2848aee6708c)) + + + + + # [3.814.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.813.0...v3.814.0) (2025-05-20) diff --git a/clients/client-ec2/package.json b/clients/client-ec2/package.json index 36316960b93cb..d1f9a3bf7094a 100644 --- a/clients/client-ec2/package.json +++ b/clients/client-ec2/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/client-ec2", "description": "AWS SDK for JavaScript Ec2 Client for Node.js, Browser and React Native", - "version": "3.814.0", + "version": "3.815.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline client-ec2", diff --git a/clients/client-partnercentral-selling/CHANGELOG.md b/clients/client-partnercentral-selling/CHANGELOG.md index 22caf14330794..5afbdb02312f1 100644 --- a/clients/client-partnercentral-selling/CHANGELOG.md +++ b/clients/client-partnercentral-selling/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + + +### Features + +* **client-partnercentral-selling:** Modified validation to allow expectedCustomerSpend array with zero elements in Partner Opportunity operations. ([ed51782](https://github.com/aws/aws-sdk-js-v3/commit/ed51782d7192b06752c93f15a502006c247179e6)) + + + + + # [3.812.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.811.0...v3.812.0) (2025-05-16) **Note:** Version bump only for package @aws-sdk/client-partnercentral-selling diff --git a/clients/client-partnercentral-selling/package.json b/clients/client-partnercentral-selling/package.json index 56c3c69953cc9..0ceff4899d471 100644 --- a/clients/client-partnercentral-selling/package.json +++ b/clients/client-partnercentral-selling/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/client-partnercentral-selling", "description": "AWS SDK for JavaScript Partnercentral Selling Client for Node.js, Browser and React Native", - "version": "3.812.0", + "version": "3.815.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "tsc -p tsconfig.cjs.json", diff --git a/clients/client-s3/CHANGELOG.md b/clients/client-s3/CHANGELOG.md index dfa041f7cbbe2..dbe18a44c5870 100644 --- a/clients/client-s3/CHANGELOG.md +++ b/clients/client-s3/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + +**Note:** Version bump only for package @aws-sdk/client-s3 + + + + + # [3.812.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.811.0...v3.812.0) (2025-05-16) **Note:** Version bump only for package @aws-sdk/client-s3 diff --git a/clients/client-s3/package.json b/clients/client-s3/package.json index e8d9fed9d7ffd..22a4a6ec72a01 100644 --- a/clients/client-s3/package.json +++ b/clients/client-s3/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/client-s3", "description": "AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native", - "version": "3.812.0", + "version": "3.815.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline client-s3", diff --git a/lerna.json b/lerna.json index f2d7e7508fe65..4ea5f3d0579d8 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "3.814.0", + "version": "3.815.0", "npmClient": "yarn", "useWorkspaces": true, "command": { diff --git a/lib/lib-storage/CHANGELOG.md b/lib/lib-storage/CHANGELOG.md index 68e5cbbeb2bc8..405dae6c6e94d 100644 --- a/lib/lib-storage/CHANGELOG.md +++ b/lib/lib-storage/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + +**Note:** Version bump only for package @aws-sdk/lib-storage + + + + + # [3.812.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.811.0...v3.812.0) (2025-05-16) **Note:** Version bump only for package @aws-sdk/lib-storage diff --git a/lib/lib-storage/package.json b/lib/lib-storage/package.json index 4d919373eb36e..17f01e24e7814 100644 --- a/lib/lib-storage/package.json +++ b/lib/lib-storage/package.json @@ -1,6 +1,6 @@ { "name": "@aws-sdk/lib-storage", - "version": "3.812.0", + "version": "3.815.0", "description": "Storage higher order operation", "main": "./dist-cjs/index.js", "module": "./dist-es/index.js", diff --git a/packages/crc64-nvme-crt/CHANGELOG.md b/packages/crc64-nvme-crt/CHANGELOG.md index 668efbe0ead06..6d396b3962a87 100644 --- a/packages/crc64-nvme-crt/CHANGELOG.md +++ b/packages/crc64-nvme-crt/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + +**Note:** Version bump only for package @aws-sdk/crc64-nvme-crt + + + + + # [3.812.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.811.0...v3.812.0) (2025-05-16) **Note:** Version bump only for package @aws-sdk/crc64-nvme-crt diff --git a/packages/crc64-nvme-crt/package.json b/packages/crc64-nvme-crt/package.json index e3cbde2057319..25dde98d49a6b 100644 --- a/packages/crc64-nvme-crt/package.json +++ b/packages/crc64-nvme-crt/package.json @@ -1,6 +1,6 @@ { "name": "@aws-sdk/crc64-nvme-crt", - "version": "3.812.0", + "version": "3.815.0", "description": "An implementation of CRC64-NVME checksum based on AWS Common Runtime https://github.com/awslabs/aws-crt-nodejs", "main": "./dist-cjs/index.js", "module": "./dist-es/index.js", diff --git a/packages/middleware-flexible-checksums/CHANGELOG.md b/packages/middleware-flexible-checksums/CHANGELOG.md index 9b97e6181e8de..63959f4868e6c 100644 --- a/packages/middleware-flexible-checksums/CHANGELOG.md +++ b/packages/middleware-flexible-checksums/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + +**Note:** Version bump only for package @aws-sdk/middleware-flexible-checksums + + + + + # [3.812.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.811.0...v3.812.0) (2025-05-16) **Note:** Version bump only for package @aws-sdk/middleware-flexible-checksums diff --git a/packages/middleware-flexible-checksums/package.json b/packages/middleware-flexible-checksums/package.json index 1f78a983f90cf..48f78e852f4bb 100644 --- a/packages/middleware-flexible-checksums/package.json +++ b/packages/middleware-flexible-checksums/package.json @@ -1,6 +1,6 @@ { "name": "@aws-sdk/middleware-flexible-checksums", - "version": "3.812.0", + "version": "3.815.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline middleware-flexible-checksums", diff --git a/packages/s3-presigned-post/CHANGELOG.md b/packages/s3-presigned-post/CHANGELOG.md index f968a73ab3d96..c1cc4f42cbd3c 100644 --- a/packages/s3-presigned-post/CHANGELOG.md +++ b/packages/s3-presigned-post/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + +**Note:** Version bump only for package @aws-sdk/s3-presigned-post + + + + + # [3.812.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.811.0...v3.812.0) (2025-05-16) **Note:** Version bump only for package @aws-sdk/s3-presigned-post diff --git a/packages/s3-presigned-post/package.json b/packages/s3-presigned-post/package.json index ea1efe3192507..000a762a65bcf 100644 --- a/packages/s3-presigned-post/package.json +++ b/packages/s3-presigned-post/package.json @@ -1,6 +1,6 @@ { "name": "@aws-sdk/s3-presigned-post", - "version": "3.812.0", + "version": "3.815.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline s3-presigned-post", diff --git a/packages/s3-request-presigner/CHANGELOG.md b/packages/s3-request-presigner/CHANGELOG.md index 204cc93a12547..76d029ba04312 100644 --- a/packages/s3-request-presigner/CHANGELOG.md +++ b/packages/s3-request-presigner/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + +**Note:** Version bump only for package @aws-sdk/s3-request-presigner + + + + + # [3.812.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.811.0...v3.812.0) (2025-05-16) **Note:** Version bump only for package @aws-sdk/s3-request-presigner diff --git a/packages/s3-request-presigner/package.json b/packages/s3-request-presigner/package.json index 3ee0eadb21b01..17d82a50a5428 100644 --- a/packages/s3-request-presigner/package.json +++ b/packages/s3-request-presigner/package.json @@ -1,6 +1,6 @@ { "name": "@aws-sdk/s3-request-presigner", - "version": "3.812.0", + "version": "3.815.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "node ../../scripts/compilation/inline s3-request-presigner", diff --git a/private/aws-client-api-test/CHANGELOG.md b/private/aws-client-api-test/CHANGELOG.md index 8c9cf9faeec9a..f911da886ede0 100644 --- a/private/aws-client-api-test/CHANGELOG.md +++ b/private/aws-client-api-test/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + +**Note:** Version bump only for package @aws-sdk/aws-client-api-test + + + + + # [3.814.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.813.0...v3.814.0) (2025-05-20) **Note:** Version bump only for package @aws-sdk/aws-client-api-test diff --git a/private/aws-client-api-test/package.json b/private/aws-client-api-test/package.json index fcfd51eac91d6..5092373516ef3 100644 --- a/private/aws-client-api-test/package.json +++ b/private/aws-client-api-test/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/aws-client-api-test", "description": "Test suite for client interface stability", - "version": "3.814.0", + "version": "3.815.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "tsc -p tsconfig.cjs.json", diff --git a/private/aws-client-retry-test/CHANGELOG.md b/private/aws-client-retry-test/CHANGELOG.md index 90ebabf19a66b..715087d92d8c6 100644 --- a/private/aws-client-retry-test/CHANGELOG.md +++ b/private/aws-client-retry-test/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + +**Note:** Version bump only for package @aws-sdk/aws-client-retry-test + + + + + # [3.812.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.811.0...v3.812.0) (2025-05-16) **Note:** Version bump only for package @aws-sdk/aws-client-retry-test diff --git a/private/aws-client-retry-test/package.json b/private/aws-client-retry-test/package.json index 015617abb0b45..184bd3a17c9f3 100644 --- a/private/aws-client-retry-test/package.json +++ b/private/aws-client-retry-test/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/aws-client-retry-test", "description": "Integration test suite for middleware-retry", - "version": "3.812.0", + "version": "3.815.0", "scripts": { "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", "build:cjs": "tsc -p tsconfig.cjs.json", diff --git a/private/aws-middleware-test/CHANGELOG.md b/private/aws-middleware-test/CHANGELOG.md index 909de1fcdfa6a..d5ee2b8e961b5 100644 --- a/private/aws-middleware-test/CHANGELOG.md +++ b/private/aws-middleware-test/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [3.815.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.814.0...v3.815.0) (2025-05-21) + +**Note:** Version bump only for package @aws-sdk/aws-middleware-test + + + + + # [3.814.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.813.0...v3.814.0) (2025-05-20) **Note:** Version bump only for package @aws-sdk/aws-middleware-test diff --git a/private/aws-middleware-test/package.json b/private/aws-middleware-test/package.json index a0348b2fdb9cd..88b8c2bf5d176 100644 --- a/private/aws-middleware-test/package.json +++ b/private/aws-middleware-test/package.json @@ -1,7 +1,7 @@ { "name": "@aws-sdk/aws-middleware-test", "description": "Integration test suite for AWS middleware", - "version": "3.814.0", + "version": "3.815.0", "scripts": { "build": "exit 0", "build:cjs": "exit 0",