From b389f5950681c47305f12538c415a25107599f74 Mon Sep 17 00:00:00 2001 From: figbot <82115609+withfig-bot@users.noreply.github.com> Date: Tue, 10 Dec 2024 16:41:51 -0800 Subject: [PATCH] feat: update spec --- src/aws.ts | 10 + src/aws/bedrock-agent-runtime.ts | 40 + src/aws/bedrock-data-automation-runtime.ts | 110 ++ src/aws/bedrock-data-automation.ts | 629 ++++++++ src/aws/bedrock.ts | 423 +++++ src/aws/connect.ts | 117 ++ src/aws/dsql.ts | 1 - src/aws/ecs.ts | 6 +- src/aws/kendra.ts | 68 +- src/aws/keyspaces.ts | 2 +- src/aws/partnercentral-selling.ts | 1630 ++++++++++++++++++-- src/aws/qbusiness.ts | 18 +- src/aws/s3tables.ts | 1 - src/aws/sagemaker.ts | 1338 +++++++++++++++- 14 files changed, 4194 insertions(+), 199 deletions(-) create mode 100644 src/aws/bedrock-data-automation-runtime.ts create mode 100644 src/aws/bedrock-data-automation.ts diff --git a/src/aws.ts b/src/aws.ts index 77312c6ed1a9..ea9f131db67e 100644 --- a/src/aws.ts +++ b/src/aws.ts @@ -264,6 +264,16 @@ const completionSpec: Fig.Spec = { "Contains APIs related to model invocation and querying of knowledge bases", loadSpec: "aws/bedrock-agent-runtime", }, + { + name: "bedrock-data-automation", + description: "Amazon Bedrock Keystone Build", + loadSpec: "aws/bedrock-data-automation", + }, + { + name: "bedrock-data-automation-runtime", + description: "Amazon Bedrock Keystone Runtime", + loadSpec: "aws/bedrock-data-automation-runtime", + }, { name: "bedrock-runtime", description: diff --git a/src/aws/bedrock-agent-runtime.ts b/src/aws/bedrock-agent-runtime.ts index 833330f184ca..8a7d7277fc4c 100644 --- a/src/aws/bedrock-agent-runtime.ts +++ b/src/aws/bedrock-agent-runtime.ts @@ -48,6 +48,46 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "generate-query", + description: + "Generates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide", + options: [ + { + name: "--query-generation-input", + description: + "Specifies information about a natural language query to transform into SQL", + args: { + name: "structure", + }, + }, + { + name: "--transformation-configuration", + description: + "Specifies configurations for transforming the natural language query into SQL", + args: { + name: "structure", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "get-agent-memory", description: "Gets the sessions stored in the memory of the agent", diff --git a/src/aws/bedrock-data-automation-runtime.ts b/src/aws/bedrock-data-automation-runtime.ts new file mode 100644 index 000000000000..39f5b75d5d16 --- /dev/null +++ b/src/aws/bedrock-data-automation-runtime.ts @@ -0,0 +1,110 @@ +const completionSpec: Fig.Spec = { + name: "bedrock-data-automation-runtime", + description: "Amazon Bedrock Keystone Runtime", + subcommands: [ + { + name: "get-data-automation-status", + description: "API used to get data automation status", + options: [ + { + name: "--invocation-arn", + description: "Invocation arn", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "invoke-data-automation-async", + description: "Async API: Invoke data automation", + options: [ + { + name: "--client-token", + description: "Idempotency token", + args: { + name: "string", + }, + }, + { + name: "--input-configuration", + description: "Input configuration", + args: { + name: "structure", + }, + }, + { + name: "--output-configuration", + description: "Output configuration", + args: { + name: "structure", + }, + }, + { + name: "--data-automation-configuration", + description: "Data automation configuration", + args: { + name: "structure", + }, + }, + { + name: "--encryption-configuration", + description: "Encryption configuration", + args: { + name: "structure", + }, + }, + { + name: "--notification-configuration", + description: "Notification configuration", + args: { + name: "structure", + }, + }, + { + name: "--blueprints", + description: "Blueprint list", + args: { + name: "list", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + ], +}; + +export default completionSpec; diff --git a/src/aws/bedrock-data-automation.ts b/src/aws/bedrock-data-automation.ts new file mode 100644 index 000000000000..54069f37d79f --- /dev/null +++ b/src/aws/bedrock-data-automation.ts @@ -0,0 +1,629 @@ +const completionSpec: Fig.Spec = { + name: "bedrock-data-automation", + description: "Amazon Bedrock Keystone Build", + subcommands: [ + { + name: "create-blueprint", + description: "Creates an Amazon Bedrock Keystone Blueprint", + options: [ + { + name: "--blueprint-name", + description: "Name of the Blueprint", + args: { + name: "string", + }, + }, + { + name: "--type", + description: "Type", + args: { + name: "string", + }, + }, + { + name: "--blueprint-stage", + description: "Stage of the Blueprint", + args: { + name: "string", + }, + }, + { + name: "--schema", + description: "Schema of the blueprint", + args: { + name: "string", + }, + }, + { + name: "--client-token", + description: "Client specified token used for idempotency checks", + args: { + name: "string", + }, + }, + { + name: "--encryption-configuration", + description: "KMS Encryption Configuration", + args: { + name: "structure", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "create-blueprint-version", + description: + "Creates a new version of an existing Amazon Bedrock Keystone Blueprint", + options: [ + { + name: "--blueprint-arn", + description: + "ARN generated at the server side when a Blueprint is created", + args: { + name: "string", + }, + }, + { + name: "--client-token", + description: "Client specified token used for idempotency checks", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "create-data-automation-project", + description: "Creates an Amazon Bedrock Keystone DataAutomationProject", + options: [ + { + name: "--project-name", + description: "Name of the DataAutomationProject", + args: { + name: "string", + }, + }, + { + name: "--project-description", + description: "Description of the DataAutomationProject", + args: { + name: "string", + }, + }, + { + name: "--project-stage", + description: "Stage of the Project", + args: { + name: "string", + }, + }, + { + name: "--standard-output-configuration", + description: "Standard output configuration", + args: { + name: "structure", + }, + }, + { + name: "--custom-output-configuration", + description: "Custom output configuration", + args: { + name: "structure", + }, + }, + { + name: "--override-configuration", + description: "Override configuration", + args: { + name: "structure", + }, + }, + { + name: "--client-token", + description: "Client specified token used for idempotency checks", + args: { + name: "string", + }, + }, + { + name: "--encryption-configuration", + description: "KMS Encryption Configuration", + args: { + name: "structure", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "delete-blueprint", + description: "Deletes an existing Amazon Bedrock Keystone Blueprint", + options: [ + { + name: "--blueprint-arn", + description: + "ARN generated at the server side when a Blueprint is created", + args: { + name: "string", + }, + }, + { + name: "--blueprint-version", + description: "Optional field to delete a specific Blueprint version", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "delete-data-automation-project", + description: + "Deletes an existing Amazon Bedrock Keystone DataAutomationProject", + options: [ + { + name: "--project-arn", + description: + "ARN generated at the server side when a DataAutomationProject is created", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "get-blueprint", + description: "Gets an existing Amazon Bedrock Keystone Blueprint", + options: [ + { + name: "--blueprint-arn", + description: + "ARN generated at the server side when a Blueprint is created", + args: { + name: "string", + }, + }, + { + name: "--blueprint-version", + description: "Optional field to get a specific Blueprint version", + args: { + name: "string", + }, + }, + { + name: "--blueprint-stage", + description: "Optional field to get a specific Blueprint stage", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "get-data-automation-project", + description: + "Gets an existing Amazon Bedrock Keystone DataAutomationProject", + options: [ + { + name: "--project-arn", + description: + "ARN generated at the server side when a DataAutomationProject is created", + args: { + name: "string", + }, + }, + { + name: "--project-stage", + description: + "Optional field to delete a specific DataAutomationProject stage", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-blueprints", + description: "Lists all existing Amazon Bedrock Keystone Blueprints", + options: [ + { + name: "--blueprint-arn", + description: "ARN of a Blueprint", + args: { + name: "string", + }, + }, + { + name: "--resource-owner", + description: "Resource Owner", + args: { + name: "string", + }, + }, + { + name: "--blueprint-stage-filter", + description: "Blueprint Stage filter", + args: { + name: "string", + }, + }, + { + name: "--max-results", + description: "Max Results", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: "Pagination token", + args: { + name: "string", + }, + }, + { + name: "--project-filter", + description: "Data Automation Project Filter", + args: { + name: "structure", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-data-automation-projects", + description: + "Lists all existing Amazon Bedrock Keystone DataAutomationProjects", + options: [ + { + name: "--max-results", + description: "Max Results", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: "Pagination token", + args: { + name: "string", + }, + }, + { + name: "--project-stage-filter", + description: "Project Stage filter", + args: { + name: "string", + }, + }, + { + name: "--blueprint-filter", + description: "Blueprint Filter", + args: { + name: "structure", + }, + }, + { + name: "--resource-owner", + description: "Resource Owner", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "update-blueprint", + description: "Updates an existing Amazon Bedrock Blueprint", + options: [ + { + name: "--blueprint-arn", + description: + "ARN generated at the server side when a Blueprint is created", + args: { + name: "string", + }, + }, + { + name: "--schema", + description: "Schema of the blueprint", + args: { + name: "string", + }, + }, + { + name: "--blueprint-stage", + description: "Stage of the Blueprint", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "update-data-automation-project", + description: "Updates an existing Amazon Bedrock DataAutomationProject", + options: [ + { + name: "--project-arn", + description: + "ARN generated at the server side when a DataAutomationProject is created", + args: { + name: "string", + }, + }, + { + name: "--project-stage", + description: "Stage of the Project", + args: { + name: "string", + }, + }, + { + name: "--project-description", + description: "Description of the DataAutomationProject", + args: { + name: "string", + }, + }, + { + name: "--standard-output-configuration", + description: "Standard output configuration", + args: { + name: "structure", + }, + }, + { + name: "--custom-output-configuration", + description: "Custom output configuration", + args: { + name: "structure", + }, + }, + { + name: "--override-configuration", + description: "Override configuration", + args: { + name: "structure", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + ], +}; + +export default completionSpec; diff --git a/src/aws/bedrock.ts b/src/aws/bedrock.ts index 06415a999c77..d39e0c89f6c8 100644 --- a/src/aws/bedrock.ts +++ b/src/aws/bedrock.ts @@ -360,6 +360,80 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "create-marketplace-model-endpoint", + description: + "Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker", + options: [ + { + name: "--model-source-identifier", + description: + "The ARN of the model from Amazon Bedrock Marketplace that you want to deploy to the endpoint", + args: { + name: "string", + }, + }, + { + name: "--endpoint-config", + description: + "The configuration for the endpoint, including the number and type of instances to use", + args: { + name: "structure", + }, + }, + { + name: "--accept-eula", + description: + "Indicates whether you accept the end-user license agreement (EULA) for the model. Set to true to accept the EULA", + }, + { + name: "--no-accept-eula", + description: + "Indicates whether you accept the end-user license agreement (EULA) for the model. Set to true to accept the EULA", + }, + { + name: "--endpoint-name", + description: + "The name of the endpoint. This name must be unique within your Amazon Web Services account and region", + args: { + name: "string", + }, + }, + { + name: "--client-request-token", + description: + "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because Amazon Web Services SDKs automatically generate it for you and set this parameter. If you're not using the Amazon Web Services SDK or the CLI, you must provide this token or the action will fail", + args: { + name: "string", + }, + }, + { + name: "--tags", + description: + "An array of key-value pairs to apply to the underlying Amazon SageMaker endpoint. You can use these tags to organize and identify your Amazon Web Services resources", + args: { + name: "list", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "create-model-copy-job", description: @@ -944,6 +1018,38 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "delete-marketplace-model-endpoint", + description: + "Deletes an endpoint for a model from Amazon Bedrock Marketplace", + options: [ + { + name: "--endpoint-arn", + description: + "The Amazon Resource Name (ARN) of the endpoint you want to delete", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "delete-model-invocation-logging-configuration", description: "Delete the invocation logging", @@ -999,6 +1105,38 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "deregister-marketplace-model-endpoint", + description: + "Deregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint", + options: [ + { + name: "--endpoint-arn", + description: + "The Amazon Resource Name (ARN) of the endpoint you want to deregister", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "get-custom-model", description: @@ -1196,6 +1334,38 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "get-marketplace-model-endpoint", + description: + "Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace", + options: [ + { + name: "--endpoint-arn", + description: + "The Amazon Resource Name (ARN) of the endpoint you want to get information about", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "get-model-copy-job", description: @@ -1345,6 +1515,36 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "get-prompt-router", + description: "Retrieves details about a prompt router", + options: [ + { + name: "--prompt-router-arn", + description: "The prompt router's ARN", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "get-provisioned-model-throughput", description: @@ -1925,6 +2125,78 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "list-marketplace-model-endpoints", + description: + "Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account", + options: [ + { + name: "--max-results", + description: + "The maximum number of results to return in a single call. If more results are available, the operation returns a NextToken value", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "The token for the next set of results. You receive this token from a previous ListMarketplaceModelEndpoints call", + args: { + name: "string", + }, + }, + { + name: "--model-source-equals", + description: + "If specified, only endpoints for the given model source identifier are returned", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "list-model-copy-jobs", description: @@ -2384,6 +2656,69 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "list-prompt-routers", + description: "Retrieves a list of prompt routers", + options: [ + { + name: "--max-results", + description: + "The maximum number of prompt routers to return in one page of results", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "Specify the pagination token from a previous request to retrieve the next page of results", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "list-provisioned-model-throughputs", description: @@ -2564,6 +2899,46 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "register-marketplace-model-endpoint", + description: + "Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs", + options: [ + { + name: "--endpoint-identifier", + description: + "The ARN of the Amazon SageMaker endpoint you want to register with Amazon Bedrock Marketplace", + args: { + name: "string", + }, + }, + { + name: "--model-source-identifier", + description: + "The ARN of the model from Amazon Bedrock Marketplace that is deployed on the endpoint", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "stop-evaluation-job", description: @@ -2843,6 +3218,54 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "update-marketplace-model-endpoint", + description: + "Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace", + options: [ + { + name: "--endpoint-arn", + description: + "The Amazon Resource Name (ARN) of the endpoint you want to update", + args: { + name: "string", + }, + }, + { + name: "--endpoint-config", + description: + "The new configuration for the endpoint, including the number and type of instances to use", + args: { + name: "structure", + }, + }, + { + name: "--client-request-token", + description: + "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because Amazon Web Services SDKs automatically generate it for you and set this parameter. If you're not using the Amazon Web Services SDK or the CLI, you must provide this token or the action will fail", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "update-provisioned-model-throughput", description: diff --git a/src/aws/connect.ts b/src/aws/connect.ts index ab033628e420..e51ac3d14418 100644 --- a/src/aws/connect.ts +++ b/src/aws/connect.ts @@ -2025,6 +2025,77 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "create-push-notification-registration", + description: + "Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see Set up push notifications in Amazon Connect for mobile chat in the Amazon Connect Administrator Guide", + options: [ + { + name: "--instance-id", + description: + "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance", + args: { + name: "string", + }, + }, + { + name: "--client-token", + description: + "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs", + args: { + name: "string", + }, + }, + { + name: "--pinpoint-app-arn", + description: + "The Amazon Resource Name (ARN) of the Pinpoint application", + args: { + name: "string", + }, + }, + { + name: "--device-token", + description: + "The push notification token issued by the Apple or Google gateways", + args: { + name: "string", + }, + }, + { + name: "--device-type", + description: "The device type to use when sending the message", + args: { + name: "string", + }, + }, + { + name: "--contact-configuration", + description: + "The contact configuration for push notification registration", + args: { + name: "structure", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "create-queue", description: @@ -3495,6 +3566,52 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "delete-push-notification-registration", + description: "Deletes registration for a device token and a chat contact", + options: [ + { + name: "--instance-id", + description: + "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance", + args: { + name: "string", + }, + }, + { + name: "--registration-id", + description: "The identifier for the registration", + args: { + name: "string", + }, + }, + { + name: "--contact-id", + description: + "The identifier of the contact within the Amazon Connect instance", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "delete-queue", description: diff --git a/src/aws/dsql.ts b/src/aws/dsql.ts index fc65cd979545..b950fdff2f23 100644 --- a/src/aws/dsql.ts +++ b/src/aws/dsql.ts @@ -502,5 +502,4 @@ const completionSpec: Fig.Spec = { }, ], }; - export default completionSpec; diff --git a/src/aws/ecs.ts b/src/aws/ecs.ts index 6c8cf3dcd813..f127276a06a4 100644 --- a/src/aws/ecs.ts +++ b/src/aws/ecs.ts @@ -595,7 +595,7 @@ const completionSpec: Fig.Spec = { { name: "--capacity-provider-strategy", description: - "The capacity provider strategy to use for the service. If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used. A capacity provider strategy may contain a maximum of 6 capacity providers", + "The capacity provider strategy to use for the service. If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used. A capacity provider strategy can contain a maximum of 20 capacity providers", args: { name: "list", isVariadic: true, @@ -2805,7 +2805,7 @@ const completionSpec: Fig.Spec = { { name: "--name", description: - "The Amazon ECS account setting name to modify. The following are the valid values for the account setting name. serviceLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging. taskLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging. containerInstanceLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging. awsvpcTrunking - When modified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide. containerInsights - Container Insights with enhanced observability provides all the Container Insights metrics, plus additional task and container metrics. This version supports enhanced observability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you configure Container Insights with enhanced observability on Amazon ECS, Container Insights auto-collects detailed infrastructure telemetry from the cluster level down to the container level in your environment and displays these critical performance data in curated dashboards removing the heavy lifting in observability set-up. To use Container Insights with enhanced observability, set the containerInsights account setting to enhanced. To use Container Insights, set the containerInsights account setting to enabled. For more information, see Monitor Amazon ECS containers using Container Insights with enhanced observability in the Amazon Elastic Container Service Developer Guide. dualStackIPv6 - When turned on, when using a VPC in dual stack mode, your tasks using the awsvpc network mode can have an IPv6 address assigned. For more information on using IPv6 with tasks launched on Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6 with tasks launched on Fargate, see Using a VPC in dual-stack mode. fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide. tagResourceAuthorization - Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide. guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring", + "The Amazon ECS account setting name to modify. The following are the valid values for the account setting name. serviceLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging. taskLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging. fargateFIPSMode - When turned on, you can run Fargate workloads in a manner that is compliant with Federal Information Processing Standard (FIPS-140). For more information, see Fargate Federal Information Processing Standard (FIPS-140). containerInstanceLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging. awsvpcTrunking - When modified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide. containerInsights - Container Insights with enhanced observability provides all the Container Insights metrics, plus additional task and container metrics. This version supports enhanced observability for Amazon ECS clusters using the Amazon EC2 and Fargate launch types. After you configure Container Insights with enhanced observability on Amazon ECS, Container Insights auto-collects detailed infrastructure telemetry from the cluster level down to the container level in your environment and displays these critical performance data in curated dashboards removing the heavy lifting in observability set-up. To use Container Insights with enhanced observability, set the containerInsights account setting to enhanced. To use Container Insights, set the containerInsights account setting to enabled. For more information, see Monitor Amazon ECS containers using Container Insights with enhanced observability in the Amazon Elastic Container Service Developer Guide. dualStackIPv6 - When turned on, when using a VPC in dual stack mode, your tasks using the awsvpc network mode can have an IPv6 address assigned. For more information on using IPv6 with tasks launched on Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6 with tasks launched on Fargate, see Using a VPC in dual-stack mode. fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide. tagResourceAuthorization - Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide. guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring", args: { name: "string", suggestions: accountSettingsResourceNames, @@ -3273,7 +3273,7 @@ const completionSpec: Fig.Spec = { { name: "--capacity-provider-strategy", description: - "The capacity provider strategy to use for the task. If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used. When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType. A capacity provider strategy may contain a maximum of 6 capacity providers", + "The capacity provider strategy to use for the task. If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used. When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType. A capacity provider strategy can contain a maximum of 20 capacity providers", args: { name: "list", isVariadic: true, diff --git a/src/aws/kendra.ts b/src/aws/kendra.ts index 619afa361918..e48b4ee9ba14 100644 --- a/src/aws/kendra.ts +++ b/src/aws/kendra.ts @@ -314,7 +314,7 @@ const completionSpec: Fig.Spec = { { name: "create-access-control-configuration", description: - "Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change. To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API", + "Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change. To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API. You can't configure access control using CreateAccessControlConfiguration for an Amazon Kendra Gen AI Enterprise Edition index. Amazon Kendra will return a ValidationException error for a Gen_AI_ENTERPRISE_EDITION index", options: [ { name: "--index-id", @@ -605,7 +605,7 @@ const completionSpec: Fig.Spec = { { name: "--role-arn", description: - "The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM access roles for Amazon Kendra", + "The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQ file. For more information, see IAM access roles for Amazon Kendra", args: { name: "string", }, @@ -762,7 +762,7 @@ const completionSpec: Fig.Spec = { { name: "--edition", description: - "The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed. The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION. For more information on quota limits for Enterprise and Developer editions, see Quotas", + "The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Use GEN_AI_ENTERPRISE_EDITION for creating generative AI applications. Once you set the edition for an index, it can't be changed. The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION. For more information on quota limits for Gen AI Enterprise Edition, Enterprise Edition, and Developer Edition indices, see Quotas", args: { name: "string", }, @@ -808,7 +808,8 @@ const completionSpec: Fig.Spec = { }, { name: "--user-token-configurations", - description: "The user token configuration", + description: + "The user token configuration. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error", args: { name: "list", }, @@ -816,7 +817,7 @@ const completionSpec: Fig.Spec = { { name: "--user-context-policy", description: - "The user context policy. ATTRIBUTE_FILTER All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext. USER_TOKEN Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable", + "The user context policy. If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error. ATTRIBUTE_FILTER All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext. USER_TOKEN Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable", args: { name: "string", }, @@ -824,7 +825,7 @@ const completionSpec: Fig.Spec = { { name: "--user-group-resolution-configuration", description: - "Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents", + "Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. If you're using an Amazon Kendra Gen AI Enterprise Edition index, UserGroupResolutionConfiguration isn't supported", args: { name: "structure", }, @@ -1126,7 +1127,7 @@ const completionSpec: Fig.Spec = { }, { name: "delete-faq", - description: "Removes an FAQ from an index", + description: "Removes a FAQ from an index", options: [ { name: "--id", @@ -1195,7 +1196,7 @@ const completionSpec: Fig.Spec = { { name: "delete-principal-mapping", description: - 'Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results. If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping. DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region', + 'Deletes a group so that all users that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results. If you want to delete or replace users or sub groups of a group, you need to use the PutPrincipalMapping operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutPrincipalMapping. You can update your internal list of users or sub groups and input this list when calling PutPrincipalMapping. DeletePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region', options: [ { name: "--index-id", @@ -1443,7 +1444,7 @@ const completionSpec: Fig.Spec = { }, { name: "describe-faq", - description: "Gets information about an FAQ list", + description: "Gets information about a FAQ", options: [ { name: "--id", @@ -2242,11 +2243,11 @@ const completionSpec: Fig.Spec = { }, { name: "list-faqs", - description: "Gets a list of FAQ lists associated with an index", + description: "Gets a list of FAQs associated with an index", options: [ { name: "--index-id", - description: "The index that contains the FAQ lists", + description: "The index for the FAQs", args: { name: "string", }, @@ -2484,12 +2485,12 @@ const completionSpec: Fig.Spec = { { name: "list-tags-for-resource", description: - "Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them", + "Gets a list of tags associated with a resource. Indexes, FAQs, data sources, and other resources can have tags associated with them", options: [ { name: "--resource-arn", description: - "The Amazon Resource Name (ARN) of the index, FAQ, or data source to get a list of tags for", + "The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to get a list of tags for. For example, the ARN of an index is constructed as follows: arn:aws:kendra:your-region:your-account-id:index/index-id For information on how to construct an ARN for all types of Amazon Kendra resources, see Resource types", args: { name: "string", }, @@ -2590,7 +2591,7 @@ const completionSpec: Fig.Spec = { { name: "--group-members", description: - 'The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing". If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000', + 'The list that contains your users that belong the same group. This can include sub groups that belong to a group. For example, the group "Company A" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing". If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000', args: { name: "structure", }, @@ -2598,7 +2599,7 @@ const completionSpec: Fig.Spec = { { name: "--ordering-id", description: - "The timestamp identifier you specify to ensure Amazon Kendra does not override the latest PUT action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action. The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your PUT action for that updated group with the latest members list doesn't get overwritten by earlier PUT actions for the same group which are yet to be processed. The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra", + "The timestamp identifier you specify to ensure Amazon Kendra doesn't override the latest PUT action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action. The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your PUT action for that updated group with the latest members list doesn't get overwritten by earlier PUT actions for the same group which are yet to be processed. The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra", args: { name: "long", }, @@ -2606,7 +2607,7 @@ const completionSpec: Fig.Spec = { { name: "--role-arn", description: - "The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group. For more information, see IAM roles for Amazon Kendra", + "The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group. For more information, see IAM roles for Amazon Kendra", args: { name: "string", }, @@ -2633,7 +2634,7 @@ const completionSpec: Fig.Spec = { { name: "query", description: - "Searches an index given an input query. If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG) systems, you can use Amazon Kendra's Retrieve API, which can return longer semantically relevant passages. We recommend using the Retrieve API instead of filing a service limit increase to increase the Query API document excerpt length. You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information. A query response contains three types of results. Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt. Matching FAQs or questions-answer from your FAQ file. Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt. You can specify that the query return only one type of result using the QueryResultTypeFilter parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers, a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are returned", + "Searches an index given an input query. If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG) systems, you can use Amazon Kendra's Retrieve API, which can return longer semantically relevant passages. We recommend using the Retrieve API instead of filing a service limit increase to increase the Query API document excerpt length. You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information. A query response contains three types of results. Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt. Matching FAQs or questions-answer from your FAQ file. Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt. You can specify that the query return only one type of result using the QueryResultTypeFilter parameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers, a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are returned. If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error", options: [ { name: "--index-id", @@ -2653,7 +2654,7 @@ const completionSpec: Fig.Spec = { { name: "--attribute-filter", description: - "Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters. The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results", + "Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters. The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results. For Amazon Kendra Gen AI Enterprise Edition indices use AttributeFilter to enable document filtering for end users using _email_id or include public documents (_email_id=null)", args: { name: "structure", }, @@ -2774,7 +2775,7 @@ const completionSpec: Fig.Spec = { { name: "retrieve", description: - "Retrieves relevant passages or text excerpts given an input query. This API is similar to the Query API. However, by default, the Query API only returns excerpt passages of up to 100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce zero passages using the Retrieve API, you can alternatively use the Query API and its types of responses. You can also do the following: Override boosting at the index level Filter based on document fields or attributes Filter based on the user or their group access to documents View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query. Confidence score buckets are currently available only for English. You can also include certain fields in the response that might provide useful additional information. The Retrieve API shares the number of query capacity units that you set for your index. For more information on what's included in a single capacity unit and the default base capacity for an index, see Adjusting capacity", + "Retrieves relevant passages or text excerpts given an input query. This API is similar to the Query API. However, by default, the Query API only returns excerpt passages of up to 100 token words. With the Retrieve API, you can retrieve longer passages of up to 200 token words and up to 100 semantically relevant passages. This doesn't include question-answer or FAQ type responses from your index. The passages are text excerpts that can be semantically extracted from multiple documents and multiple parts of the same document. If in extreme cases your documents produce zero passages using the Retrieve API, you can alternatively use the Query API and its types of responses. You can also do the following: Override boosting at the index level Filter based on document fields or attributes Filter based on the user or their group access to documents View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query. Confidence score buckets are currently available only for English. You can also include certain fields in the response that might provide useful additional information. The Retrieve API shares the number of query capacity units that you set for your index. For more information on what's included in a single capacity unit and the default base capacity for an index, see Adjusting capacity. If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error", options: [ { name: "--index-id", @@ -2795,7 +2796,7 @@ const completionSpec: Fig.Spec = { { name: "--attribute-filter", description: - "Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters. The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results", + "Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters. The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results. For Amazon Kendra Gen AI Enterprise Edition indices use AttributeFilter to enable document filtering for end users using _email_id or include public documents (_email_id=null)", args: { name: "structure", }, @@ -2996,12 +2997,12 @@ const completionSpec: Fig.Spec = { { name: "tag-resource", description: - "Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value", + "Adds the specified tag to the specified index, FAQ, data source, or other resource. If the tag already exists, the existing value is replaced with the new value", options: [ { name: "--resource-arn", description: - "The Amazon Resource Name (ARN) of the index, FAQ, or data source to tag", + "The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to add a tag. For example, the ARN of an index is constructed as follows: arn:aws:kendra:your-region:your-account-id:index/index-id For information on how to construct an ARN for all types of Amazon Kendra resources, see Resource types", args: { name: "string", }, @@ -3009,7 +3010,7 @@ const completionSpec: Fig.Spec = { { name: "--tags", description: - "A list of tag keys to add to the index, FAQ, or data source. If a tag already exists, the existing value is replaced with the new value", + "A list of tag keys to add to the index, FAQ, data source, or other resource. If a tag already exists, the existing value is replaced with the new value", args: { name: "list", }, @@ -3035,12 +3036,13 @@ const completionSpec: Fig.Spec = { }, { name: "untag-resource", - description: "Removes a tag from an index, FAQ, or a data source", + description: + "Removes a tag from an index, FAQ, data source, or other resource", options: [ { name: "--resource-arn", description: - "The Amazon Resource Name (ARN) of the index, FAQ, or data source to remove the tag from", + "The Amazon Resource Name (ARN) of the index, FAQ, data source, or other resource to remove a tag. For example, the ARN of an index is constructed as follows: arn:aws:kendra:your-region:your-account-id:index/index-id For information on how to construct an ARN for all types of Amazon Kendra resources, see Resource types", args: { name: "string", }, @@ -3048,7 +3050,7 @@ const completionSpec: Fig.Spec = { { name: "--tag-keys", description: - "A list of tag keys to remove from the index, FAQ, or data source. If a tag key does not exist on the resource, it is ignored", + "A list of tag keys to remove from the index, FAQ, data source, or other resource. If a tag key doesn't exist for the resource, it is ignored", args: { name: "list", }, @@ -3075,7 +3077,7 @@ const completionSpec: Fig.Spec = { { name: "update-access-control-configuration", description: - "Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change. You call the BatchPutDocument API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId in the .metadata.json file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API", + "Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change. You call the BatchPutDocument API to apply the updated access control configuration, with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you synchronize your data source to apply the AccessControlConfigurationId in the .metadata.json file. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API. You can't configure access control using CreateAccessControlConfiguration for an Amazon Kendra Gen AI Enterprise Edition index. Amazon Kendra will return a ValidationException error for a Gen_AI_ENTERPRISE_EDITION index", options: [ { name: "--index-id", @@ -3203,7 +3205,7 @@ const completionSpec: Fig.Spec = { { name: "--role-arn", description: - "The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see IAM roles for Amazon Kendra", + "The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM roles for Amazon Kendra", args: { name: "string", }, @@ -3274,7 +3276,7 @@ const completionSpec: Fig.Spec = { { name: "--role-arn", description: - "The Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information. For more information, see IAM roles for Amazon Kendra", + "The Amazon Resource Name (ARN) of an IAM role with permission to access the Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your users and groups information. For more information, see IAM roles for Amazon Kendra", args: { name: "string", }, @@ -3441,14 +3443,16 @@ const completionSpec: Fig.Spec = { }, { name: "--user-token-configurations", - description: "The user token configuration", + description: + "The user token configuration. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error", args: { name: "list", }, }, { name: "--user-context-policy", - description: "The user context policy", + description: + "The user context policy. If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error", args: { name: "string", }, @@ -3456,7 +3460,7 @@ const completionSpec: Fig.Spec = { { name: "--user-group-resolution-configuration", description: - "Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents", + "Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. If you're using an Amazon Kendra Gen AI Enterprise Edition index, UserGroupResolutionConfiguration isn't supported", args: { name: "structure", }, diff --git a/src/aws/keyspaces.ts b/src/aws/keyspaces.ts index b4a422da4d79..8bb64217cc81 100644 --- a/src/aws/keyspaces.ts +++ b/src/aws/keyspaces.ts @@ -945,7 +945,7 @@ const completionSpec: Fig.Spec = { { name: "update-keyspace", description: - "Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. The new replica Region is applied to all tables in the keyspace. For more information, see Add an Amazon Web Services Region to a keyspace in Amazon Keyspaces in the Amazon Keyspaces Developer Guide. To change a single-Region to a multi-Region keyspace, you have to enable client-side timestamps for all tables in the keyspace. For more information, see Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer Guide", + "Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. Amazon Keyspaces is going to replicate all tables in the keyspace to the new Region. To successfully replicate all tables to the new Region, they must use client-side timestamps for conflict resolution. To enable client-side timestamps, specify clientSideTimestamps.status = enabled when invoking the API. For more information about client-side timestamps, see Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer Guide. To add a Region to a keyspace using the UpdateKeyspace API, the IAM principal needs permissions for the following IAM actions: cassandra:Alter cassandra:AlterMultiRegionResource cassandra:Create cassandra:CreateMultiRegionResource cassandra:Select cassandra:SelectMultiRegionResource cassandra:Modify cassandra:ModifyMultiRegionResource If the keyspace contains a table that is configured in provisioned mode with auto scaling enabled, the following additional IAM actions need to be allowed. application-autoscaling:RegisterScalableTarget application-autoscaling:DeregisterScalableTarget application-autoscaling:DescribeScalableTargets application-autoscaling:PutScalingPolicy application-autoscaling:DescribeScalingPolicies To use the UpdateKeyspace API, the IAM principal also needs permissions to create a service-linked role with the following elements: iam:CreateServiceLinkedRole - The action the principal can perform. arn:aws:iam::*:role/aws-service-role/replication.cassandra.amazonaws.com/AWSServiceRoleForKeyspacesReplication - The resource that the action can be performed on. iam:AWSServiceName: replication.cassandra.amazonaws.com - The only Amazon Web Services service that this role can be attached to is Amazon Keyspaces. For more information, see Configure the IAM permissions required to add an Amazon Web Services Region to a keyspace in the Amazon Keyspaces Developer Guide", options: [ { name: "--keyspace-name", diff --git a/src/aws/partnercentral-selling.ts b/src/aws/partnercentral-selling.ts index c2706ce84d0e..b04d96d4ae14 100644 --- a/src/aws/partnercentral-selling.ts +++ b/src/aws/partnercentral-selling.ts @@ -3,10 +3,50 @@ const completionSpec: Fig.Spec = { description: "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 Opportunity management: Manages coselling opportunities through API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity. AWS referral management: Manages referrals shared by AWS using actions such as ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation. Entity association: Associates related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity, and DisassociateOpportunity. View AWS opportunity details: Retrieves real-time summaries of AWS opportunities using the GetAWSOpportunitySummary action. List solutions: Provides list APIs for listing partner offers using ListSolutions. 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", subcommands: [ + { + name: "accept-engagement-invitation", + description: + "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", + options: [ + { + name: "--catalog", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--identifier", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "assign-opportunity", description: - "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", options: [ { name: "--assignee", @@ -54,7 +94,7 @@ const completionSpec: Fig.Spec = { { name: "associate-opportunity", description: - "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: Partner Solution: A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address business challenges using Amazon Web Services services. Amazon Web Services Products: Amazon Web Services offers many products and services that provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of Amazon Web Services products, see Amazon Web Services products. Amazon Web Services Marketplace private offer: Allows Amazon Web Services Marketplace sellers to extend custom pricing and terms to individual Amazon Web Services customers. Sellers can negotiate custom prices, payment schedules, and end user license terms through private offers, enabling Amazon Web Services customers to acquire software solutions tailored to their specific needs. For more information, see Private offers in Amazon Web Services Marketplace. To obtain identifiers for these entities, use the following methods: Solution: Use the ListSolutions operation. AWS Products: For the latest list of Amazon Web Services products, see Amazon Web Services products. Amazon Web Services Marketplace private offer: Use the Using the Amazon Web Services Marketplace Catalog API to list entities. Specifically, use the ListEntities operation to retrieve a list of private offers. The request returns the details of available private offers. For more information, see ListEntities", + "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: Partner Solution: A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address business challenges using Amazon Web Services services. Amazon Web Services Products: Amazon Web Services offers many products and services that provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of Amazon Web Services products, see Amazon Web Services products. Amazon Web Services Marketplace private offer: Allows Amazon Web Services Marketplace sellers to extend custom pricing and terms to individual Amazon Web Services customers. Sellers can negotiate custom prices, payment schedules, and end user license terms through private offers, enabling Amazon Web Services customers to acquire software solutions tailored to their specific needs. For more information, see Private offers in Amazon Web Services Marketplace. To obtain identifiers for these entities, use the following methods: Solution: Use the ListSolutions operation. AWS Products: For the latest list of Amazon Web Services products, see Amazon Web Services products. Amazon Web Services Marketplace private offer: Use the Using the Amazon Web Services Marketplace Catalog API to list entities. Specifically, use the ListEntities operation to retrieve a list of private offers. The request returns the details of available private offers. For more information, see ListEntities", options: [ { name: "--catalog", @@ -107,10 +147,128 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "create-engagement", + description: + "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", + options: [ + { + name: "--catalog", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--client-token", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--contexts", + description: + "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", + args: { + name: "list", + }, + }, + { + name: "--description", + description: "Provides a description of the Engagement", + args: { + name: "string", + }, + }, + { + name: "--title", + description: "Specifies the title of the Engagement", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "create-engagement-invitation", + description: + "This action creates an invitation from a sender to a single receiver to join an engagement", + options: [ + { + name: "--catalog", + description: + "Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed", + args: { + name: "string", + }, + }, + { + name: "--client-token", + description: + "Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations", + args: { + name: "string", + }, + }, + { + name: "--engagement-identifier", + description: + "The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context", + args: { + name: "string", + }, + }, + { + name: "--invitation", + description: + "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", + args: { + name: "structure", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "create-opportunity", description: - "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: To create the opportunity, use CreateOpportunity. To associate a solution with the opportunity, use AssociateOpportunity. To submit the opportunity, use StartEngagementFromOpportunityTask. 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: To create the opportunity, use CreateOpportunity. To associate a solution with the opportunity, use AssociateOpportunity. To submit the opportunity, use StartEngagementFromOpportunityTask. 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", options: [ { name: "--catalog", @@ -123,7 +281,7 @@ const completionSpec: Fig.Spec = { { name: "--client-token", description: - '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."', args: { name: "string", }, @@ -171,7 +329,7 @@ const completionSpec: Fig.Spec = { { name: "--opportunity-type", description: - "Specifies the opportunity type as a renewal, new, or expansion. Opportunity types: New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services. Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service. Expansion opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer", + "Specifies the opportunity type as a renewal, new, or expansion. Opportunity types: New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services. Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service. Expansion opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer", args: { name: "string", }, @@ -187,7 +345,7 @@ const completionSpec: Fig.Spec = { { name: "--partner-opportunity-identifier", description: - "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", args: { name: "string", }, @@ -195,7 +353,7 @@ const completionSpec: Fig.Spec = { { name: "--primary-needs-from-aws", description: - "Identifies the type of support the partner needs from Amazon Web Services. Valid values: Cosell\u2014Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks. Cosell\u2014Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation. Cosell\u2014Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution. Cosell\u2014Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals). Cosell\u2014Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution. Cosell\u2014Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment. Cosell\u2014Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning). Cosell\u2014Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support. Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request coselling support on these opportunities at any stage during their lifecycles. This is also known as a for-visibility-only (FVO) opportunity", + "Identifies the type of support the partner needs from Amazon Web Services. Valid values: Cosell\u2014Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks. Cosell\u2014Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation. Cosell\u2014Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution. Cosell\u2014Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals). Cosell\u2014Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution. Cosell\u2014Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment. Cosell\u2014Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning). Cosell\u2014Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support. Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request coselling support on these opportunities at any stage during their lifecycles. This is also known as a for-visibility-only (FVO) opportunity", args: { name: "list", }, @@ -236,38 +394,54 @@ const completionSpec: Fig.Spec = { ], }, { - name: "disassociate-opportunity", + name: "create-resource-snapshot", description: - "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", + "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", options: [ { name: "--catalog", description: - "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 where the snapshot is created. Valid values are AWS and Sandbox", args: { name: "string", }, }, { - name: "--opportunity-identifier", + name: "--client-token", description: - "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", + "Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations", args: { name: "string", }, }, { - name: "--related-entity-identifier", + name: "--engagement-identifier", description: - "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 unique identifier of the engagement associated with this snapshot. This field links the snapshot to a specific engagement context", args: { name: "string", }, }, { - name: "--related-entity-type", + name: "--resource-identifier", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--resource-snapshot-template-identifier", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--resource-type", description: - "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", + "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", args: { name: "string", }, @@ -292,62 +466,54 @@ const completionSpec: Fig.Spec = { ], }, { - name: "get-aws-opportunity-summary", + name: "create-resource-snapshot-job", description: - "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", + "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", options: [ { name: "--catalog", description: - "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 to create the snapshot job. Valid values are AWS and Sandbox", args: { name: "string", }, }, { - name: "--related-opportunity-identifier", + name: "--client-token", description: - "The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity", + "Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot job creations", args: { name: "string", }, }, { - name: "--cli-input-json", + name: "--engagement-identifier", description: - "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + "Specifies the identifier of the engagement associated with the resource to be snapshotted", args: { name: "string", }, }, { - name: "--generate-cli-skeleton", + name: "--resource-identifier", description: - "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + "Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType", args: { name: "string", - suggestions: ["input", "output"], }, }, - ], - }, - { - name: "get-engagement-invitation", - description: - "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\u2019s Payload.Project.Title with opportunity Project.Title", - options: [ { - name: "--catalog", + name: "--resource-snapshot-template-identifier", description: - "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 name of the template that defines the schema for the snapshot", args: { name: "string", }, }, { - name: "--identifier", + name: "--resource-type", description: - "Specifies the unique identifier for the retrieved engagement invitation", + "The type of resource for which the snapshot job is being created. Must be one of the supported resource types Opportunity", args: { name: "string", }, @@ -372,22 +538,22 @@ const completionSpec: Fig.Spec = { ], }, { - name: "get-opportunity", + name: "delete-resource-snapshot-job", description: - "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", + "Use this action to deletes a previously created resource snapshot job. The job must be in a stopped state before it can be deleted", options: [ { name: "--catalog", description: - "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 from which to delete the snapshot job. Valid values are AWS and Sandbox", args: { name: "string", }, }, { - name: "--identifier", + name: "--resource-snapshot-job-identifier", description: - "Read-only, system generated Opportunity unique identifier", + "The unique identifier of the resource snapshot job to be deleted", args: { name: "string", }, @@ -412,88 +578,88 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-engagement-invitations", + name: "disassociate-opportunity", description: - "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", + "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", options: [ { name: "--catalog", description: - "Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing 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", args: { name: "string", }, }, { - name: "--max-results", - description: - "Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided", - args: { - name: "integer", - }, - }, - { - name: "--next-token", + name: "--opportunity-identifier", description: - "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", + "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", args: { name: "string", }, }, { - name: "--participant-type", + name: "--related-entity-identifier", description: - "Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant", + "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", args: { name: "string", }, }, { - name: "--payload-type", + name: "--related-entity-type", description: - "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", + "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", args: { - name: "list", + name: "string", }, }, { - name: "--sort", + name: "--cli-input-json", description: - "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", + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", args: { - name: "structure", + name: "string", }, }, { - name: "--cli-input-json", + name: "--generate-cli-skeleton", description: - "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", args: { name: "string", + suggestions: ["input", "output"], }, }, + ], + }, + { + name: "get-aws-opportunity-summary", + description: + "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", + options: [ { - name: "--starting-token", + name: "--catalog", description: - "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + "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", args: { name: "string", }, }, { - name: "--page-size", + name: "--related-opportunity-identifier", description: - "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + "The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity", args: { - name: "integer", + name: "string", }, }, { - name: "--max-items", + name: "--cli-input-json", description: - "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", args: { - name: "integer", + name: "string", }, }, { @@ -508,80 +674,1173 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-opportunities", + name: "get-engagement", description: - "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\u2019s Amazon EventBridge default event bus, you can also use the ListOpportunities action. We recommend the following approach: Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don\u2019t use values generated by your system. When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter. Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages", + "Use this action to retrieve the engagement record for a given EngagementIdentifier", options: [ { name: "--catalog", description: - "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 related to the engagement request. Valid values are AWS and Sandbox", args: { name: "string", }, }, { - name: "--customer-company-name", + name: "--identifier", description: - "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", + "Specifies the identifier of the Engagement record to retrieve", args: { - name: "list", + name: "string", }, }, { - name: "--identifier", + name: "--cli-input-json", description: - "Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results", + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", args: { - name: "list", + name: "string", }, }, { - name: "--last-modified-date", + name: "--generate-cli-skeleton", description: - "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", + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", args: { - name: "structure", + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "get-engagement-invitation", + description: + "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\u2019s Payload.Project.Title with opportunity Project.Title", + options: [ + { + name: "--catalog", + description: + "Specifies the catalog associated with the request. The field accepts values from the predefined set: AWS for live operations or Sandbox for testing environments", + args: { + name: "string", + }, + }, + { + name: "--identifier", + description: + "Specifies the unique identifier for the retrieved engagement invitation", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "get-opportunity", + description: + "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", + options: [ + { + name: "--catalog", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--identifier", + description: + "Read-only, system generated Opportunity unique identifier", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "get-resource-snapshot", + description: "Use this action to retrieve a specific snapshot record", + options: [ + { + name: "--catalog", + description: + "Specifies the catalog related to the request. Valid values are: AWS: Retrieves the snapshot from the production AWS environment. Sandbox: Retrieves the snapshot from a sandbox environment used for testing or development purposes", + args: { + name: "string", + }, + }, + { + name: "--engagement-identifier", + description: + "The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context", + args: { + name: "string", + }, + }, + { + name: "--resource-identifier", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--resource-snapshot-template-identifier", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--resource-type", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--revision", + description: + "Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision", + args: { + name: "integer", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "get-resource-snapshot-job", + description: + "Use this action to retrieves information about a specific resource snapshot job", + options: [ + { + name: "--catalog", + description: + "Specifies the catalog related to the request. Valid values are: AWS: Retrieves the snapshot job from the production AWS environment. Sandbox: Retrieves the snapshot job from a sandbox environment used for testing or development purposes", + args: { + name: "string", + }, + }, + { + name: "--resource-snapshot-job-identifier", + description: + "The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "get-selling-system-settings", + description: + "Retrieves the currently set system settings, which include the IAM Role used for resource snapshot jobs", + options: [ + { + name: "--catalog", + description: + "Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-engagement-by-accepting-invitation-tasks", + description: + "Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account", + options: [ + { + name: "--catalog", + description: + "Specifies the catalog related to the request. Valid values are: AWS: Retrieves the request from the production AWS environment. Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes", + args: { + name: "string", + }, + }, + { + name: "--engagement-invitation-identifier", + description: + "Filters tasks by the identifiers of the engagement invitations they are processing", + args: { + name: "list", + }, + }, + { + name: "--max-results", + description: + "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", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--opportunity-identifier", + description: + "Filters tasks by the identifiers of the opportunities they created or are associated with", + args: { + name: "list", + }, + }, + { + name: "--sort", + description: + "Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes", + args: { + name: "structure", + }, + }, + { + name: "--task-identifier", + description: + "Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks", + args: { + name: "list", + }, + }, + { + name: "--task-status", + description: + "Filters the tasks based on their current status. This allows you to focus on tasks in specific states", + args: { + name: "list", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-engagement-from-opportunity-tasks", + description: + "Lists all in-progress, completed, or failed EngagementFromOpportunity tasks that were initiated by the caller's account", + options: [ + { + name: "--catalog", + description: + "Specifies the catalog related to the request. Valid values are: AWS: Retrieves the request from the production AWS environment. Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes", + args: { + name: "string", + }, + }, + { + name: "--engagement-identifier", + description: + "Filters tasks by the identifiers of the engagements they created or are associated with", + args: { + name: "list", + }, + }, + { + name: "--max-results", + description: + "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", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--opportunity-identifier", + description: + "The identifier of the original opportunity associated with this task", + args: { + name: "list", + }, + }, + { + name: "--sort", + description: + "Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes", + args: { + name: "structure", + }, + }, + { + name: "--task-identifier", + description: + "Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks", + args: { + name: "list", + }, + }, + { + name: "--task-status", + description: + "Filters the tasks based on their current status. This allows you to focus on tasks in specific states", + args: { + name: "list", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-engagement-invitations", + description: + "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", + options: [ + { + name: "--catalog", + description: + "Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments", + args: { + name: "string", + }, + }, + { + name: "--engagement-identifier", + description: + "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", + args: { + name: "list", + }, + }, + { + name: "--max-results", + description: + "Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--participant-type", + description: + "Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant", + args: { + name: "string", + }, + }, + { + name: "--payload-type", + description: + "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", + args: { + name: "list", + }, + }, + { + name: "--sender-aws-account-id", + description: + "List of sender AWS account IDs to filter the invitations", + args: { + name: "list", + }, + }, + { + name: "--sort", + description: + "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", + args: { + name: "structure", + }, + }, + { + name: "--status", + description: "Status values to filter the invitations", + args: { + name: "list", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-engagement-members", + description: + "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", + options: [ + { + name: "--catalog", + description: "The catalog related to the request", + args: { + name: "string", + }, + }, + { + name: "--identifier", + description: + "Identifier of the engagement record to retrieve members from", + args: { + name: "string", + }, + }, + { + name: "--max-results", + description: + "The maximum number of results to return in a single call", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: "The token for the next set of results", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-engagement-resource-associations", + description: + "Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement", + options: [ + { + name: "--catalog", + description: + "Specifies the catalog in which to search for engagement-resource associations", + args: { + name: "string", + }, + }, + { + name: "--created-by", + description: + "Filters the results to include only associations with resources owned by the specified AWS account. Use this when you want to find associations related to resources owned by a particular account", + args: { + name: "string", + }, + }, + { + name: "--engagement-identifier", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--max-results", + description: + "Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results", + args: { + name: "string", + }, + }, + { + name: "--resource-identifier", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--resource-type", + description: + "Filters the results to include only associations with resources of the specified type", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-engagements", + description: + "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", + options: [ + { + name: "--catalog", + description: "Specifies the catalog related to the request", + args: { + name: "string", + }, + }, + { + name: "--created-by", + description: + "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", + args: { + name: "list", + }, + }, + { + name: "--engagement-identifier", + description: + "An array of strings representing engagement identifiers to retrieve", + args: { + name: "list", + }, + }, + { + name: "--exclude-created-by", + description: + "An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users", + args: { + name: "list", + }, + }, + { + name: "--max-results", + description: + "The maximum number of results to return in a single call", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "The token for the next set of results. This value is returned from a previous call", + args: { + name: "string", + }, + }, + { + name: "--sort", + description: "An object that specifies the sort order of the results", + args: { + name: "structure", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-opportunities", + description: + "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\u2019s Amazon EventBridge default event bus, you can also use the ListOpportunities action. We recommend the following approach: Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don\u2019t use values generated by your system. When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter. Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages", + options: [ + { + name: "--catalog", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--customer-company-name", + description: + "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", + args: { + name: "list", + }, + }, + { + name: "--identifier", + description: + "Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results", + args: { + name: "list", + }, + }, + { + name: "--last-modified-date", + description: + "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", + args: { + name: "structure", + }, + }, + { + name: "--life-cycle-review-status", + description: + "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", + args: { + name: "list", + }, + }, + { + name: "--life-cycle-stage", + description: + "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", + args: { + name: "list", + }, + }, + { + name: "--max-results", + description: + "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", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "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", + args: { + name: "string", + }, + }, + { + name: "--sort", + description: + "An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate", + args: { + name: "structure", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-resource-snapshot-jobs", + description: + "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", + options: [ + { + name: "--catalog", + description: "Specifies the catalog related to the request", + args: { + name: "string", }, }, { - name: "--life-cycle-review-status", + name: "--engagement-identifier", description: - "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", + "The identifier of the engagement to filter the response", args: { - name: "list", + name: "string", }, }, { - name: "--life-cycle-stage", + name: "--max-results", description: - "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", + "The maximum number of results to return in a single call. If omitted, defaults to 50", args: { - name: "list", + name: "integer", + }, + }, + { + name: "--next-token", + description: "The token for the next set of results", + args: { + name: "string", + }, + }, + { + name: "--sort", + description: + "Configures the sorting of the response. If omitted, results are sorted by CreatedDate in descending order", + args: { + name: "structure", + }, + }, + { + name: "--status", + description: "The status of the jobs to filter the response", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-resource-snapshots", + description: + "Retrieves a list of resource view snapshots based on specified criteria", + options: [ + { + name: "--catalog", + description: "Specifies the catalog related to the request", + args: { + name: "string", + }, + }, + { + name: "--created-by", + description: + "Filters the response to include only snapshots of resources created by the specified AWS account", + args: { + name: "string", + }, + }, + { + name: "--engagement-identifier", + description: + "The unique identifier of the engagement associated with the snapshots", + args: { + name: "string", }, }, { name: "--max-results", description: - "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", + "The maximum number of results to return in a single call", args: { name: "integer", }, }, { name: "--next-token", + description: "The token for the next set of results", + args: { + name: "string", + }, + }, + { + name: "--resource-identifier", description: - "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", + "Filters the response to include only snapshots of the specified resource", args: { name: "string", }, }, { - name: "--sort", + name: "--resource-snapshot-template-identifier", description: - "An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate", + "Filters the response to include only snapshots created using the specified template", args: { - name: "structure", + name: "string", + }, + }, + { + name: "--resource-type", + description: + "Filters the response to include only snapshots of the specified resource type", + args: { + name: "string", }, }, { @@ -659,7 +1918,7 @@ const completionSpec: Fig.Spec = { { name: "--max-results", description: - "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", args: { name: "integer", }, @@ -731,6 +1990,46 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "put-selling-system-settings", + description: + "Updates the currently set system settings, which include the IAM Role used for resource snapshot jobs", + options: [ + { + name: "--catalog", + description: + "Specifies the catalog in which the settings will be updated. Acceptable values include AWS for production and Sandbox for testing environments", + args: { + name: "string", + }, + }, + { + name: "--resource-snapshot-job-role-identifier", + description: + "Specifies the ARN of the IAM Role used for resource snapshot job executions", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "reject-engagement-invitation", description: @@ -883,10 +2182,141 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "start-resource-snapshot-job", + description: + "Starts a resource snapshot job that has been previously created", + options: [ + { + name: "--catalog", + description: "Specifies the catalog related to the request", + args: { + name: "string", + }, + }, + { + name: "--resource-snapshot-job-identifier", + description: "The identifier of the resource snapshot job to start", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "stop-resource-snapshot-job", + description: + "Stops a resource snapshot job. The job must be started prior to being stopped", + options: [ + { + name: "--catalog", + description: "Specifies the catalog related to the request", + args: { + name: "string", + }, + }, + { + name: "--resource-snapshot-job-identifier", + description: "The identifier of the job to stop", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "submit-opportunity", + description: + "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", + options: [ + { + name: "--catalog", + description: "Specifies the catalog related to the request", + args: { + name: "string", + }, + }, + { + name: "--identifier", + description: + "The identifier of the opportunity previously created by partner and needs to be submitted", + args: { + name: "string", + }, + }, + { + name: "--involvement-type", + description: + "Specifies the level of AWS sellers' involvement on the opportunity", + args: { + name: "string", + }, + }, + { + name: "--visibility", + description: + "Determines whether to restrict visibility of the opportunity from AWS sales. Default value is Full", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "update-opportunity", description: - "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", options: [ { name: "--catalog", @@ -946,7 +2376,7 @@ const completionSpec: Fig.Spec = { { name: "--opportunity-type", description: - "Specifies the opportunity type as a renewal, new, or expansion. Opportunity types: New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services. Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service. Expansion opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer", + "Specifies the opportunity type as a renewal, new, or expansion. Opportunity types: New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services. Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service. Expansion opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer", args: { name: "string", }, @@ -962,7 +2392,7 @@ const completionSpec: Fig.Spec = { { name: "--primary-needs-from-aws", description: - "Identifies the type of support the partner needs from Amazon Web Services. Valid values: Cosell\u2014Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks. Cosell\u2014Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation. Cosell\u2014Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution. Cosell\u2014Pricing Assistance: Connect with an AWS seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals). Cosell\u2014Technical Consultation: Connection with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution. Cosell\u2014Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment. Cosell\u2014Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning). Cosell\u2014Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs RFx support from Amazon Web Services. Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services Sales representative. The opportunity is managed solely by the partner. It's possible to request coselling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity", + "Identifies the type of support the partner needs from Amazon Web Services. Valid values: Cosell\u2014Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks. Cosell\u2014Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation. Cosell\u2014Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution. Cosell\u2014Pricing Assistance: Connect with an AWS seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals). Cosell\u2014Technical Consultation: Connection with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution. Cosell\u2014Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment. Cosell\u2014Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning). Cosell\u2014Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs RFx support from Amazon Web Services. Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services Sales representative. The opportunity is managed solely by the partner. It's possible to request coselling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity", args: { name: "list", }, diff --git a/src/aws/qbusiness.ts b/src/aws/qbusiness.ts index f74cbee4cafa..f7654a285b14 100644 --- a/src/aws/qbusiness.ts +++ b/src/aws/qbusiness.ts @@ -3456,7 +3456,7 @@ const completionSpec: Fig.Spec = { { name: "search-relevant-content", description: - "Searches for relevant content in a Q Business application based on a query. This operation takes a search query text, the Q Business application identifier, and optional filters (such as user ID, user groups, content source, and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance", + "Searches for relevant content in a Q Business application based on a query. This operation takes a search query text, the Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance", options: [ { name: "--application-id", @@ -3466,22 +3466,6 @@ const completionSpec: Fig.Spec = { name: "string", }, }, - { - name: "--user-id", - description: - "The ID of the user performing the search. Used for access control", - args: { - name: "string", - }, - }, - { - name: "--user-groups", - description: - "The groups the user belongs to. Used for access control", - args: { - name: "list", - }, - }, { name: "--query-text", description: "The text to search for", diff --git a/src/aws/s3tables.ts b/src/aws/s3tables.ts index ceca9592fc2e..53f4a75a1c8a 100644 --- a/src/aws/s3tables.ts +++ b/src/aws/s3tables.ts @@ -1226,5 +1226,4 @@ const completionSpec: Fig.Spec = { }, ], }; - export default completionSpec; diff --git a/src/aws/sagemaker.ts b/src/aws/sagemaker.ts index cbbc99086367..d0d6784926f6 100644 --- a/src/aws/sagemaker.ts +++ b/src/aws/sagemaker.ts @@ -856,6 +856,65 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "create-cluster-scheduler-config", + description: + "Create cluster policy configuration. This policy is used for task prioritization and fair-share allocation of idle compute. This helps prioritize critical workloads and distributes idle compute across entities", + options: [ + { + name: "--name", + description: "Name for the cluster policy", + args: { + name: "string", + }, + }, + { + name: "--cluster-arn", + description: "ARN of the cluster", + args: { + name: "string", + }, + }, + { + name: "--scheduler-config", + description: "Configuration about the monitoring schedule", + args: { + name: "structure", + }, + }, + { + name: "--description", + description: "Description of the cluster policy", + args: { + name: "string", + }, + }, + { + name: "--tags", + description: "Tags of the cluster policy", + args: { + name: "list", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "create-code-repository", description: @@ -992,6 +1051,81 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "create-compute-quota", + description: + "Create compute allocation definition. This defines how compute is allocated, shared, and borrowed for specified entities. Specifically, how to lend and borrow idle compute and assign a fair-share weight to the specified entities", + options: [ + { + name: "--name", + description: "Name to the compute allocation definition", + args: { + name: "string", + }, + }, + { + name: "--description", + description: "Description of the compute allocation definition", + args: { + name: "string", + }, + }, + { + name: "--cluster-arn", + description: "ARN of the cluster", + args: { + name: "string", + }, + }, + { + name: "--compute-quota-config", + description: + "Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks", + args: { + name: "structure", + }, + }, + { + name: "--compute-quota-target", + description: "The target entity to allocate compute resources to", + args: { + name: "structure", + }, + }, + { + name: "--activation-state", + description: + "The state of the compute allocation being described. Use to enable or disable compute allocation. Default is Enabled", + args: { + name: "string", + }, + }, + { + name: "--tags", + description: "Tags of the compute allocation definition", + args: { + name: "list", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "create-context", description: @@ -3931,6 +4065,158 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "create-partner-app", + description: "Creates an Amazon SageMaker Partner AI App", + options: [ + { + name: "--name", + description: "The name to give the SageMaker Partner AI App", + args: { + name: "string", + }, + }, + { + name: "--type", + description: + "The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler", + args: { + name: "string", + }, + }, + { + name: "--execution-role-arn", + description: + "The ARN of the IAM role that the partner application uses", + args: { + name: "string", + }, + }, + { + name: "--maintenance-config", + description: + "Maintenance configuration settings for the SageMaker Partner AI App", + args: { + name: "structure", + }, + }, + { + name: "--tier", + description: + "Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App", + args: { + name: "string", + }, + }, + { + name: "--application-config", + description: + "Configuration settings for the SageMaker Partner AI App", + args: { + name: "structure", + }, + }, + { + name: "--auth-type", + description: + "The authorization type that users use to access the SageMaker Partner AI App", + args: { + name: "string", + }, + }, + { + name: "--enable-iam-session-based-identity", + description: + "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user", + }, + { + name: "--no-enable-iam-session-based-identity", + description: + "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user", + }, + { + name: "--client-token", + description: + "A unique token that guarantees that the call to this API is idempotent", + args: { + name: "string", + }, + }, + { + name: "--tags", + description: + "Each tag consists of a key and an optional value. Tag keys must be unique per resource", + args: { + name: "list", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "create-partner-app-presigned-url", + description: + "Creates a presigned URL to access an Amazon SageMaker Partner AI App", + options: [ + { + name: "--arn", + description: + "The ARN of the SageMaker Partner AI App to create the presigned URL for", + args: { + name: "string", + }, + }, + { + name: "--expires-in-seconds", + description: + "The time that will pass before the presigned URL expires", + args: { + name: "integer", + }, + }, + { + name: "--session-expiration-duration-in-seconds", + description: + "Indicates how long the Amazon SageMaker Partner AI App session can be accessed for after logging in", + args: { + name: "integer", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "create-pipeline", description: "Creates a pipeline using a JSON pipeline definition", @@ -4703,38 +4989,85 @@ const completionSpec: Fig.Spec = { ], }, { - name: "create-transform-job", + name: "create-training-plan", description: - "Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify. To perform batch transformations, you create a transform job and use the data that you have readily available. In the request body, you provide the following: TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel. TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored. TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. TransformResources - Identifies the ML compute instances for the transform job. For more information about how batch transformation works, see Batch Transform", + "Creates a new training plan in SageMaker to reserve compute capacity. Amazon SageMaker Training Plan is a capability within SageMaker that allows customers to reserve and manage GPU capacity for large-scale AI model training. It provides a way to secure predictable access to computational resources within specific timelines and budgets, without the need to manage underlying infrastructure. How it works Plans can be created for specific resources such as SageMaker Training Jobs or SageMaker HyperPod clusters, automatically provisioning resources, setting up infrastructure, executing workloads, and handling infrastructure failures. Plan creation workflow Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration) using the SearchTrainingPlanOfferings API operation. They create a plan that best matches their needs using the ID of the plan offering they want to use. After successful upfront payment, the plan's status becomes Scheduled. The plan can be used to: Queue training jobs. Allocate to an instance group of a SageMaker HyperPod cluster. When the plan start date arrives, it becomes Active. Based on available reserved capacity: Training jobs are launched. Instance groups are provisioned. Plan composition A plan can consist of one or more Reserved Capacities, each defined by a specific instance type, quantity, Availability Zone, duration, and start and end times. For more information about Reserved Capacity, see ReservedCapacitySummary", options: [ { - name: "--transform-job-name", - description: - "The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account", + name: "--training-plan-name", + description: "The name of the training plan to create", args: { name: "string", }, }, { - name: "--model-name", + name: "--training-plan-offering-id", description: - "The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account", + "The unique identifier of the training plan offering to use for creating this plan", args: { name: "string", }, }, { - name: "--max-concurrent-transforms", + name: "--tags", description: - "The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms", + "An array of key-value pairs to apply to this training plan", args: { - name: "integer", + name: "list", }, }, { - name: "--model-client-config", + name: "--cli-input-json", description: - "Configures the timeout and maximum number of retries for processing a transform job invocation", + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "create-transform-job", + description: + "Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify. To perform batch transformations, you create a transform job and use the data that you have readily available. In the request body, you provide the following: TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel. TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored. TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job. TransformResources - Identifies the ML compute instances for the transform job. For more information about how batch transformation works, see Batch Transform", + options: [ + { + name: "--transform-job-name", + description: + "The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account", + args: { + name: "string", + }, + }, + { + name: "--model-name", + description: + "The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account", + args: { + name: "string", + }, + }, + { + name: "--max-concurrent-transforms", + description: + "The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms", + args: { + name: "integer", + }, + }, + { + name: "--model-client-config", + description: + "Configures the timeout and maximum number of retries for processing a transform job invocation", args: { name: "structure", }, @@ -5476,6 +5809,36 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "delete-cluster-scheduler-config", + description: "Deletes the cluster policy of the cluster", + options: [ + { + name: "--cluster-scheduler-config-id", + description: "ID of the cluster policy", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "delete-code-repository", description: "Deletes the specified Git repository from your account", @@ -5537,6 +5900,36 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "delete-compute-quota", + description: "Deletes the compute allocation from the cluster", + options: [ + { + name: "--compute-quota-id", + description: "ID of the compute allocation definition", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "delete-context", description: "Deletes an context", @@ -6626,6 +7019,44 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "delete-partner-app", + description: "Deletes a SageMaker Partner AI App", + options: [ + { + name: "--arn", + description: "The ARN of the SageMaker Partner AI App to delete", + args: { + name: "string", + }, + }, + { + name: "--client-token", + description: + "A unique token that guarantees that the call to this API is idempotent", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "delete-pipeline", description: @@ -7318,6 +7749,44 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "describe-cluster-scheduler-config", + description: + "Description of the cluster policy. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities", + options: [ + { + name: "--cluster-scheduler-config-id", + description: "ID of the cluster policy", + args: { + name: "string", + }, + }, + { + name: "--cluster-scheduler-config-version", + description: "Version of the cluster policy", + args: { + name: "integer", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "describe-code-repository", description: "Gets details about the specified Git repository", @@ -7380,6 +7849,43 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "describe-compute-quota", + description: "Description of the compute allocation definition", + options: [ + { + name: "--compute-quota-id", + description: "ID of the compute allocation definition", + args: { + name: "string", + }, + }, + { + name: "--compute-quota-version", + description: "Version of the compute allocation definition", + args: { + name: "integer", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "describe-context", description: "Describes a context", @@ -8605,6 +9111,36 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "describe-partner-app", + description: "Gets information about a SageMaker Partner AI App", + options: [ + { + name: "--arn", + description: "The ARN of the SageMaker Partner AI App to describe", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "describe-pipeline", description: "Describes the details of a pipeline", @@ -8892,6 +9428,37 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "describe-training-plan", + description: + "Retrieves detailed information about a specific training plan", + options: [ + { + name: "--training-plan-name", + description: "The name of the training plan to describe", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "describe-transform-job", description: "Returns information about a transform job", @@ -10591,13 +11158,128 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-clusters", - description: "Retrieves the list of SageMaker HyperPod clusters", + name: "list-cluster-scheduler-configs", + description: "List the cluster policy configurations", options: [ { - name: "--creation-time-after", + name: "--created-after", description: - "Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard. Acceptable formats include: YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00 YYYY-MM-DD, for example, 2014-10-01 Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide", + "Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter", + args: { + name: "timestamp", + }, + }, + { + name: "--created-before", + description: + "Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter", + args: { + name: "timestamp", + }, + }, + { + name: "--name-contains", + description: "Filter for name containing this string", + args: { + name: "string", + }, + }, + { + name: "--cluster-arn", + description: "Filter for ARN of the cluster", + args: { + name: "string", + }, + }, + { + name: "--status", + description: "Filter for status", + args: { + name: "string", + }, + }, + { + name: "--sort-by", + description: + "Filter for sorting the list by a given value. For example, sort by name, creation time, or status", + args: { + name: "string", + }, + }, + { + name: "--sort-order", + description: + "The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending", + args: { + name: "string", + }, + }, + { + name: "--next-token", + description: + "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results", + args: { + name: "string", + }, + }, + { + name: "--max-results", + description: "The maximum number of cluster policies to list", + args: { + name: "integer", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-clusters", + description: "Retrieves the list of SageMaker HyperPod clusters", + options: [ + { + name: "--creation-time-after", + description: + "Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard. Acceptable formats include: YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00 YYYY-MM-DD, for example, 2014-10-01 Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide", args: { name: "timestamp", }, @@ -10650,6 +11332,14 @@ const completionSpec: Fig.Spec = { name: "string", }, }, + { + name: "--training-plan-arn", + description: + "The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan", + args: { + name: "string", + }, + }, { name: "--cli-input-json", description: @@ -10937,6 +11627,122 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "list-compute-quotas", + description: "List the resource allocation definitions", + options: [ + { + name: "--created-after", + description: + "Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter", + args: { + name: "timestamp", + }, + }, + { + name: "--created-before", + description: + "Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter", + args: { + name: "timestamp", + }, + }, + { + name: "--name-contains", + description: "Filter for name containing this string", + args: { + name: "string", + }, + }, + { + name: "--status", + description: "Filter for status", + args: { + name: "string", + }, + }, + { + name: "--cluster-arn", + description: "Filter for ARN of the cluster", + args: { + name: "string", + }, + }, + { + name: "--sort-by", + description: + "Filter for sorting the list by a given value. For example, sort by name, creation time, or status", + args: { + name: "string", + }, + }, + { + name: "--sort-order", + description: + "The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending", + args: { + name: "string", + }, + }, + { + name: "--next-token", + description: + "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results", + args: { + name: "string", + }, + }, + { + name: "--max-results", + description: + "The maximum number of compute allocation definitions to list", + args: { + name: "integer", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "list-contexts", description: "Lists the contexts in your account and their properties", @@ -15882,37 +16688,21 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-pipeline-execution-steps", - description: "Gets a list of PipeLineExecutionStep objects", + name: "list-partner-apps", + description: "Lists all of the SageMaker Partner AI Apps in an account", options: [ - { - name: "--pipeline-execution-arn", - description: - "The Amazon Resource Name (ARN) of the pipeline execution", - args: { - name: "string", - }, - }, - { - name: "--next-token", - description: - "If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request", - args: { - name: "string", - }, - }, { name: "--max-results", description: - "The maximum number of pipeline execution steps to return in the response", + "This parameter defines the maximum number of results that can be returned in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10", args: { name: "integer", }, }, { - name: "--sort-order", + name: "--next-token", description: - "The field by which to sort results. The default is CreatedTime", + "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results", args: { name: "string", }, @@ -15961,22 +16751,101 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-pipeline-executions", - description: "Gets a list of the pipeline executions", + name: "list-pipeline-execution-steps", + description: "Gets a list of PipeLineExecutionStep objects", options: [ { - name: "--pipeline-name", - description: "The name or Amazon Resource Name (ARN) of the pipeline", + name: "--pipeline-execution-arn", + description: + "The Amazon Resource Name (ARN) of the pipeline execution", args: { name: "string", }, }, { - name: "--created-after", + name: "--next-token", description: - "A filter that returns the pipeline executions that were created after a specified time", + "If the result of the previous ListPipelineExecutionSteps request was truncated, the response includes a NextToken. To retrieve the next set of pipeline execution steps, use the token in the next request", args: { - name: "timestamp", + name: "string", + }, + }, + { + name: "--max-results", + description: + "The maximum number of pipeline execution steps to return in the response", + args: { + name: "integer", + }, + }, + { + name: "--sort-order", + description: + "The field by which to sort results. The default is CreatedTime", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, + { + name: "list-pipeline-executions", + description: "Gets a list of the pipeline executions", + options: [ + { + name: "--pipeline-name", + description: "The name or Amazon Resource Name (ARN) of the pipeline", + args: { + name: "string", + }, + }, + { + name: "--created-after", + description: + "A filter that returns the pipeline executions that were created after a specified time", + args: { + name: "timestamp", }, }, { @@ -17079,6 +17948,14 @@ const completionSpec: Fig.Spec = { name: "string", }, }, + { + name: "--training-plan-arn-equals", + description: + "The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see CreateTrainingPlan", + args: { + name: "string", + }, + }, { name: "--cli-input-json", description: @@ -17217,6 +18094,109 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "list-training-plans", + description: "Retrieves a list of training plans for the current account", + options: [ + { + name: "--next-token", + description: + "A token to continue pagination if more results are available", + args: { + name: "string", + }, + }, + { + name: "--max-results", + description: + "The maximum number of results to return in the response", + args: { + name: "integer", + }, + }, + { + name: "--start-time-after", + description: + "Filter to list only training plans with an actual start time after this date", + args: { + name: "timestamp", + }, + }, + { + name: "--start-time-before", + description: + "Filter to list only training plans with an actual start time before this date", + args: { + name: "timestamp", + }, + }, + { + name: "--sort-by", + description: + "The training plan field to sort the results by (e.g., StartTime, Status)", + args: { + name: "string", + }, + }, + { + name: "--sort-order", + description: + "The order to sort the results (Ascending or Descending)", + args: { + name: "string", + }, + }, + { + name: "--filters", + description: + "Additional filters to apply to the list of training plans", + args: { + name: "list", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--starting-token", + description: + "A token to specify where to start paginating. This is the\nNextToken from a previously truncated response.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "string", + }, + }, + { + name: "--page-size", + description: + "The size of each page to get in the AWS service call. This\ndoes not affect the number of items returned in the command's\noutput. Setting a smaller page size results in more calls to\nthe AWS service, retrieving fewer items in each call. This can\nhelp prevent the AWS service calls from timing out.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--max-items", + description: + "The total number of items to return in the command's output.\nIf the total number of items available is more than the value\nspecified, a NextToken is provided in the command's\noutput. To resume pagination, provide the\nNextToken value in the starting-token\nargument of a subsequent command. Do not use the\nNextToken response element directly outside of the\nAWS CLI.\nFor usage examples, see Pagination in the AWS Command Line Interface User\nGuide", + args: { + name: "integer", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "list-transform-jobs", description: "Lists transform jobs", @@ -18218,6 +19198,78 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "search-training-plan-offerings", + description: + "Searches for available training plan offerings based on specified criteria. Users search for available plan offerings based on their requirements (e.g., instance type, count, start time, duration). And then, they create a plan that best matches their needs using the ID of the plan offering they want to use. For more information about how to reserve GPU capacity for your SageMaker training jobs or SageMaker HyperPod clusters using Amazon SageMaker Training Plan , see CreateTrainingPlan", + options: [ + { + name: "--instance-type", + description: + "The type of instance you want to search for in the available training plan offerings. This field allows you to filter the search results based on the specific compute resources you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training plan offerings, specifying the instance type helps you find Reserved Instances that match your computational needs", + args: { + name: "string", + }, + }, + { + name: "--instance-count", + description: + "The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements", + args: { + name: "integer", + }, + }, + { + name: "--start-time-after", + description: + "A filter to search for training plan offerings with a start time after a specified date", + args: { + name: "timestamp", + }, + }, + { + name: "--end-time-before", + description: + "A filter to search for reserved capacity offerings with an end time before a specified date", + args: { + name: "timestamp", + }, + }, + { + name: "--duration-hours", + description: + "The desired duration in hours for the training plan offerings", + args: { + name: "long", + }, + }, + { + name: "--target-resources", + description: + "The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the offerings. Training plans are specific to their target resource. A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs. A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group", + args: { + name: "list", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "send-pipeline-execution-step-failure", description: @@ -19288,6 +20340,57 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "update-cluster-scheduler-config", + description: "Update the cluster policy configuration", + options: [ + { + name: "--cluster-scheduler-config-id", + description: "ID of the cluster policy", + args: { + name: "string", + }, + }, + { + name: "--target-version", + description: "Target version", + args: { + name: "integer", + }, + }, + { + name: "--scheduler-config", + description: "Cluster policy configuration", + args: { + name: "structure", + }, + }, + { + name: "--description", + description: "Description of the cluster policy", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "update-cluster-software", description: @@ -19359,6 +20462,73 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "update-compute-quota", + description: "Update the compute allocation definition", + options: [ + { + name: "--compute-quota-id", + description: "ID of the compute allocation definition", + args: { + name: "string", + }, + }, + { + name: "--target-version", + description: "Target version", + args: { + name: "integer", + }, + }, + { + name: "--compute-quota-config", + description: + "Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks", + args: { + name: "structure", + }, + }, + { + name: "--compute-quota-target", + description: "The target entity to allocate compute resources to", + args: { + name: "structure", + }, + }, + { + name: "--activation-state", + description: + "The state of the compute allocation being described. Use to enable or disable compute allocation. Default is Enabled", + args: { + name: "string", + }, + }, + { + name: "--description", + description: "Description of the compute allocation definition", + args: { + name: "string", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "update-context", description: "Updates a context", @@ -20752,6 +21922,86 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "update-partner-app", + description: "Updates all of the SageMaker Partner AI Apps in an account", + options: [ + { + name: "--arn", + description: "The ARN of the SageMaker Partner AI App to update", + args: { + name: "string", + }, + }, + { + name: "--maintenance-config", + description: + "Maintenance configuration settings for the SageMaker Partner AI App", + args: { + name: "structure", + }, + }, + { + name: "--tier", + description: + "Indicates the instance type and size of the cluster attached to the SageMaker Partner AI App", + args: { + name: "string", + }, + }, + { + name: "--application-config", + description: + "Configuration settings for the SageMaker Partner AI App", + args: { + name: "structure", + }, + }, + { + name: "--enable-iam-session-based-identity", + description: + "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user", + }, + { + name: "--no-enable-iam-session-based-identity", + description: + "When set to TRUE, the SageMaker Partner AI App sets the Amazon Web Services IAM session name or the authenticated IAM user as the identity of the SageMaker Partner AI App user", + }, + { + name: "--client-token", + description: + "A unique token that guarantees that the call to this API is idempotent", + args: { + name: "string", + }, + }, + { + name: "--tags", + description: + "Each tag consists of a key and an optional value. Tag keys must be unique per resource", + args: { + name: "list", + }, + }, + { + name: "--cli-input-json", + description: + "Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally", + args: { + name: "string", + }, + }, + { + name: "--generate-cli-skeleton", + description: + "Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command", + args: { + name: "string", + suggestions: ["input", "output"], + }, + }, + ], + }, { name: "update-pipeline", description: "Updates a pipeline",