From 57213d98a8e2145c93b34e70370494e078f532a9 Mon Sep 17 00:00:00 2001 From: figbot <82115609+withfig-bot@users.noreply.github.com> Date: Tue, 16 Jul 2024 17:15:56 -0700 Subject: [PATCH] feat: update spec --- src/aws.ts | 2 +- src/aws/acm-pca.ts | 46 +- src/aws/arc-zonal-shift.ts | 77 +- src/aws/bedrock-agent-runtime.ts | 131 +- src/aws/bedrock-agent.ts | 1627 ++++++++++++++--- src/aws/bedrock-runtime.ts | 55 + src/aws/bedrock.ts | 34 +- .../license-manager-linux-subscriptions.ts | 309 +++- src/aws/mediaconnect.ts | 8 + src/aws/qapps.ts | 1 - src/aws/quicksight.ts | 131 ++ 11 files changed, 2140 insertions(+), 281 deletions(-) diff --git a/src/aws.ts b/src/aws.ts index 86bf01dd6665..b86471261fcf 100644 --- a/src/aws.ts +++ b/src/aws.ts @@ -177,7 +177,7 @@ const completionSpec: Fig.Spec = { { name: "arc-zonal-shift", description: - "Welcome to the Zonal Shift API Reference Guide for Amazon Route 53 Application Recovery Controller (Route 53 ARC). You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can also configure zonal autoshift for a load balancer resource. Zonal autoshift is a capability in Route 53 ARC where Amazon Web Services shifts away application resource traffic from an Availability Zone, on your behalf, to help reduce your time to recovery during events. Amazon Web Services shifts away traffic for resources that are enabled for zonal autoshift whenever Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers. To ensure that zonal autoshift is safe for your application, you must also configure practice runs when you enable zonal autoshift for a resource. Practice runs start weekly zonal shifts for a resource, to shift traffic for the resource out of an Availability Zone. Practice runs make sure, on a regular basis, that you have enough capacity in all the Availability Zones in an Amazon Web Services Region for your application to continue to operate normally when traffic for a resource is shifted away from one Availability Zone. You must prescale resource capacity in all Availability Zones in the Region where your application is deployed, before you configure practice runs or enable zonal autoshift for a resource. You should not rely on scaling on demand when an autoshift or practice run starts. For more information about using zonal shift and zonal autoshift, see the Amazon Route 53 Application Recovery Controller Developer Guide", + "Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (Route 53 ARC). You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift is a capability in Route 53 ARC where you authorize Amazon Web Services to shift away application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers. To help make sure that zonal autoshift is safe for your application, you must also configure practice runs when you enable zonal autoshift for a resource. Practice runs start weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone. Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the Availability Zones in an Amazon Web Services Region for your application to continue to operate normally when traffic for a resource is shifted away from one Availability Zone. Before you configure practice runs or enable zonal autoshift, we strongly recommend that you prescale your application resource capacity in all Availability Zones in the Region where your application resources are deployed. You should not rely on scaling on demand when an autoshift or practice run starts. Zonal autoshift, including practice runs, works independently, and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of pre-scaling, can result in loss of availability. If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure the minimum capacity of your auto scaling to continue operating normally with the loss of an Availability Zone. Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could potentially impact customers. In some cases, resources might be shifted away that are not experiencing impact. For more information about using zonal shift and zonal autoshift, see the Amazon Route 53 Application Recovery Controller Developer Guide", loadSpec: "aws/arc-zonal-shift", }, { diff --git a/src/aws/acm-pca.ts b/src/aws/acm-pca.ts index 10a1d68779f8..a94bd57d0f18 100644 --- a/src/aws/acm-pca.ts +++ b/src/aws/acm-pca.ts @@ -488,7 +488,7 @@ const completionSpec: Fig.Spec = { { name: "--resource-arn", description: - "The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action", + "The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.

", args: { name: "string", }, @@ -515,7 +515,7 @@ const completionSpec: Fig.Spec = { { name: "import-certificate-authority-certificate", description: - "Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this action, the following preparations must in place: In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported certificate. Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR). Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory. Amazon Web Services Private CA supports three scenarios for installing a CA certificate: Installing a certificate for a root CA hosted by Amazon Web Services Private CA. Installing a subordinate CA certificate whose parent authority is hosted by Amazon Web Services Private CA. Installing a subordinate CA certificate whose parent authority is externally hosted. The following additional requirements apply when you import a CA certificate. Only a self-signed certificate can be imported as a root CA. A self-signed certificate cannot be imported as a subordinate CA. Your certificate chain must not include the private CA certificate that you are importing. Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built. The chain must be PEM-encoded. The maximum allowed size of a certificate is 32 KB. The maximum allowed size of a certificate chain is 2 MB. Enforcement of Critical Constraints Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA certificate or chain. Authority key identifier Basic constraints (must be marked critical) Certificate policies Extended key usage Inhibit anyPolicy Issuer alternative name Key usage Name constraints Policy mappings Subject alternative name Subject directory attributes Subject key identifier Subject information access Amazon Web Services Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain. Authority information access CRL distribution points Freshest CRL Policy constraints Amazon Web Services Private Certificate Authority will also reject any other extension marked as critical not contained on the preceding list of allowed extensions", + "Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this action, the following preparations must in place: In Amazon Web Services Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported certificate. Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR). Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory. Amazon Web Services Private CA supports three scenarios for installing a CA certificate: Installing a certificate for a root CA hosted by Amazon Web Services Private CA. Installing a subordinate CA certificate whose parent authority is hosted by Amazon Web Services Private CA. Installing a subordinate CA certificate whose parent authority is externally hosted. The following additional requirements apply when you import a CA certificate. Only a self-signed certificate can be imported as a root CA. A self-signed certificate cannot be imported as a subordinate CA. Your certificate chain must not include the private CA certificate that you are importing. Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built. The chain must be PEM-encoded. The maximum allowed size of a certificate is 32 KB. The maximum allowed size of a certificate chain is 2 MB. Enforcement of Critical Constraints Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA certificate or chain. Basic constraints (must be marked critical) Subject alternative names Key usage Extended key usage Authority key identifier Subject key identifier Issuer alternative name Subject directory attributes Subject information access Certificate policies Policy mappings Inhibit anyPolicy Amazon Web Services Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain. Name constraints Policy constraints CRL distribution points Authority information access Freshest CRL Any other extension", options: [ { name: "--certificate-authority-arn", @@ -654,19 +654,19 @@ const completionSpec: Fig.Spec = { "Lists the private certificate authorities that you created by using the CreateCertificateAuthority action", options: [ { - name: "--next-token", + name: "--max-results", description: - "Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received", + "Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items. Although the maximum value is 1000, the action only returns a maximum of 100 items", args: { - name: "string", + name: "integer", }, }, { - name: "--max-results", + name: "--next-token", description: - "Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items. Although the maximum value is 1000, the action only returns a maximum of 100 items", + "Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received", args: { - name: "integer", + name: "string", }, }, { @@ -726,11 +726,11 @@ const completionSpec: Fig.Spec = { "List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action. About Permissions If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals. For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates. If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with Amazon Web Services Private CA", options: [ { - name: "--certificate-authority-arn", + name: "--max-results", description: - "The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action", + "When paginating results, use this parameter to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items", args: { - name: "string", + name: "integer", }, }, { @@ -742,11 +742,11 @@ const completionSpec: Fig.Spec = { }, }, { - name: "--max-results", + name: "--certificate-authority-arn", description: - "When paginating results, use this parameter to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items", + "The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action", args: { - name: "integer", + name: "string", }, }, { @@ -798,11 +798,11 @@ const completionSpec: Fig.Spec = { "Lists the tags, if any, that are associated with your private CA or one that has been shared with you. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags", options: [ { - name: "--certificate-authority-arn", + name: "--max-results", description: - "The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012", + "Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items", args: { - name: "string", + name: "integer", }, }, { @@ -814,11 +814,11 @@ const completionSpec: Fig.Spec = { }, }, { - name: "--max-results", + name: "--certificate-authority-arn", description: - "Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items", + "The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012", args: { - name: "integer", + name: "string", }, }, { @@ -1116,7 +1116,7 @@ const completionSpec: Fig.Spec = { { name: "audit-report-created", description: - "Wait until a Audit Report is created It will poll every 3 seconds until a successful state has been reached. This will exit with a return code of 255 after 60 failed checks", + "Wait until a Audit Report is created It will poll every 3 seconds until a successful state has been reached. This will exit with a return code of 255 after 40 failed checks", options: [ { name: "--certificate-authority-arn", @@ -1156,7 +1156,7 @@ const completionSpec: Fig.Spec = { { name: "certificate-authority-csr-created", description: - "Wait until a Certificate Authority CSR is created It will poll every 3 seconds until a successful state has been reached. This will exit with a return code of 255 after 60 failed checks", + "Wait until a Certificate Authority CSR is created It will poll every 3 seconds until a successful state has been reached. This will exit with a return code of 255 after 40 failed checks", options: [ { name: "--certificate-authority-arn", @@ -1188,7 +1188,7 @@ const completionSpec: Fig.Spec = { { name: "certificate-issued", description: - "Wait until a certificate is issued It will poll every 1 seconds until a successful state has been reached. This will exit with a return code of 255 after 60 failed checks", + "Wait until a certificate is issued It will poll every 1 seconds until a successful state has been reached. This will exit with a return code of 255 after 120 failed checks", options: [ { name: "--certificate-authority-arn", diff --git a/src/aws/arc-zonal-shift.ts b/src/aws/arc-zonal-shift.ts index be8a689c62f5..d07ba1540f5d 100644 --- a/src/aws/arc-zonal-shift.ts +++ b/src/aws/arc-zonal-shift.ts @@ -1,7 +1,7 @@ const completionSpec: Fig.Spec = { name: "arc-zonal-shift", description: - "Welcome to the Zonal Shift API Reference Guide for Amazon Route 53 Application Recovery Controller (Route 53 ARC). You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can also configure zonal autoshift for a load balancer resource. Zonal autoshift is a capability in Route 53 ARC where Amazon Web Services shifts away application resource traffic from an Availability Zone, on your behalf, to help reduce your time to recovery during events. Amazon Web Services shifts away traffic for resources that are enabled for zonal autoshift whenever Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers. To ensure that zonal autoshift is safe for your application, you must also configure practice runs when you enable zonal autoshift for a resource. Practice runs start weekly zonal shifts for a resource, to shift traffic for the resource out of an Availability Zone. Practice runs make sure, on a regular basis, that you have enough capacity in all the Availability Zones in an Amazon Web Services Region for your application to continue to operate normally when traffic for a resource is shifted away from one Availability Zone. You must prescale resource capacity in all Availability Zones in the Region where your application is deployed, before you configure practice runs or enable zonal autoshift for a resource. You should not rely on scaling on demand when an autoshift or practice run starts. For more information about using zonal shift and zonal autoshift, see the Amazon Route 53 Application Recovery Controller Developer Guide", + "Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (Route 53 ARC). You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift is a capability in Route 53 ARC where you authorize Amazon Web Services to shift away application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers. To help make sure that zonal autoshift is safe for your application, you must also configure practice runs when you enable zonal autoshift for a resource. Practice runs start weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone. Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the Availability Zones in an Amazon Web Services Region for your application to continue to operate normally when traffic for a resource is shifted away from one Availability Zone. Before you configure practice runs or enable zonal autoshift, we strongly recommend that you prescale your application resource capacity in all Availability Zones in the Region where your application resources are deployed. You should not rely on scaling on demand when an autoshift or practice run starts. Zonal autoshift, including practice runs, works independently, and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of pre-scaling, can result in loss of availability. If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure the minimum capacity of your auto scaling to continue operating normally with the loss of an Availability Zone. Be aware that Route 53 ARC does not inspect the health of individual resources. Amazon Web Services only starts an autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could potentially impact customers. In some cases, resources might be shifted away that are not experiencing impact. For more information about using zonal shift and zonal autoshift, see the Amazon Route 53 Application Recovery Controller Developer Guide", subcommands: [ { name: "cancel-zonal-shift", @@ -37,7 +37,7 @@ const completionSpec: Fig.Spec = { { name: "create-practice-run-configuration", description: - "A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting. For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide", + "A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting. When a resource has a practice run configuration, Route 53 ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application. For more information, see Considerations when you configure zonal autoshift in the Amazon Route 53 Application Recovery Controller Developer Guide", options: [ { name: "--blocked-dates", @@ -74,7 +74,7 @@ const completionSpec: Fig.Spec = { { name: "--resource-identifier", description: - "The identifier of the resource to shift away traffic for when a practice run starts a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off", + "The identifier of the resource that Amazon Web Services shifts traffic for with a practice run zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off", args: { name: "string", }, @@ -130,6 +130,30 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "get-autoshift-observer-notification-status", + description: + "Returns the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift. For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide", + options: [ + { + 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-managed-resource", description: @@ -138,7 +162,7 @@ const completionSpec: Fig.Spec = { { name: "--resource-identifier", description: - "The identifier for the resource to shift away traffic for. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off", + "The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off", args: { name: "string", }, @@ -164,7 +188,8 @@ const completionSpec: Fig.Spec = { }, { name: "list-autoshifts", - description: "Returns the active autoshifts for a specified resource", + description: + "Returns a list of autoshifts for an Amazon Web Services Region. By default, the call returns only ACTIVE autoshifts. Optionally, you can specify the status parameter to return COMPLETED autoshifts", options: [ { name: "--max-results", @@ -299,7 +324,7 @@ const completionSpec: Fig.Spec = { { name: "list-zonal-shifts", description: - 'Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-started zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift. The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see ">ListAutoshifts', + 'Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. ListZonalShifts returns customer-initiated zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on your behalf for zonal autoshift. The ListZonalShifts operation does not list autoshifts. For more information about listing autoshifts, see ">ListAutoshifts', options: [ { name: "--max-results", @@ -384,7 +409,7 @@ const completionSpec: Fig.Spec = { { name: "--away-from", description: - "The Availability Zone that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region", + "The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region", args: { name: "string", }, @@ -408,7 +433,39 @@ const completionSpec: Fig.Spec = { { name: "--resource-identifier", description: - "The identifier for the resource to shift away traffic for. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off", + "The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource. At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off", + 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-autoshift-observer-notification-status", + description: + "Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift. For more information, see Notifications for practice runs and autoshifts in the Amazon Route 53 Application Recovery Controller Developer Guide", + options: [ + { + name: "--status", + description: + "The status to set for autoshift observer notification. If the status is ENABLED, Route 53 ARC includes all autoshift events when you use the Amazon EventBridge pattern Autoshift In Progress. When the status is DISABLED, Route 53 ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift", args: { name: "string", }, @@ -499,7 +556,7 @@ const completionSpec: Fig.Spec = { { name: "update-zonal-autoshift-configuration", description: - "You can update the zonal autoshift status for a resource, to enable or disable zonal autoshift. When zonal autoshift is ENABLED, Amazon Web Services shifts away resource traffic from an Availability Zone, on your behalf, when Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers", + "The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone. You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs", options: [ { name: "--resource-identifier", @@ -512,7 +569,7 @@ const completionSpec: Fig.Spec = { { name: "--zonal-autoshift-status", description: - "The zonal autoshift status for the resource that you want to update the zonal autoshift configuration for", + "The zonal autoshift status for the resource that you want to update the zonal autoshift configuration for. Choose ENABLED to authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery", args: { name: "string", }, diff --git a/src/aws/bedrock-agent-runtime.ts b/src/aws/bedrock-agent-runtime.ts index dfe19a0ace24..a727a62be86c 100644 --- a/src/aws/bedrock-agent-runtime.ts +++ b/src/aws/bedrock-agent-runtime.ts @@ -3,6 +3,135 @@ const completionSpec: Fig.Spec = { description: "Contains APIs related to model invocation and querying of knowledge bases", subcommands: [ + { + name: "delete-agent-memory", + description: "Deletes memory from the specified memory identifier", + options: [ + { + name: "--agent-alias-id", + description: "The unique identifier of an alias of an agent", + args: { + name: "string", + }, + }, + { + name: "--agent-id", + description: + "The unique identifier of the agent to which the alias belongs", + args: { + name: "string", + }, + }, + { + name: "--memory-id", + description: "The unique identifier of the memory", + 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-agent-memory", + description: "Gets the sessions stored in the memory of the agent", + options: [ + { + name: "--agent-alias-id", + description: "The unique identifier of an alias of an agent", + args: { + name: "string", + }, + }, + { + name: "--agent-id", + description: + "The unique identifier of the agent to which the alias belongs", + args: { + name: "string", + }, + }, + { + 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: "--memory-id", + description: "The unique identifier of the memory", + args: { + name: "string", + }, + }, + { + name: "--memory-type", + description: "The type of memory", + args: { + name: "string", + }, + }, + { + name: "--next-token", + description: + "If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results", + 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: "--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: "retrieve", description: "Queries a knowledge base and retrieves information from it", @@ -103,7 +232,7 @@ const completionSpec: Fig.Spec = { { name: "--session-id", description: - "The unique identifier of the session. Reuse the same value to continue the same session with the knowledge base", + "The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself", args: { name: "string", }, diff --git a/src/aws/bedrock-agent.ts b/src/aws/bedrock-agent.ts index 21cdc9eda683..706959618d8d 100644 --- a/src/aws/bedrock-agent.ts +++ b/src/aws/bedrock-agent.ts @@ -70,7 +70,7 @@ const completionSpec: Fig.Spec = { { name: "create-agent", description: - "Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers. Specify the following fields for security purposes. agentResourceRoleArn \u2013 The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent. (Optional) customerEncryptionKeyArn \u2013 The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. (Optional) idleSessionTTLinSeconds \u2013 Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session. To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts. If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot", + "Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers. Specify the following fields for security purposes. agentResourceRoleArn \u2013 The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent. (Optional) customerEncryptionKeyArn \u2013 The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent. (Optional) idleSessionTTLinSeconds \u2013 Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session. To enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration object. For more information, see Configure memory. To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts. If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot", options: [ { name: "--agent-name", @@ -142,6 +142,14 @@ const completionSpec: Fig.Spec = { name: "string", }, }, + { + name: "--memory-configuration", + description: + "Contains the details of the memory configured for the agent", + args: { + name: "structure", + }, + }, { name: "--prompt-override-configuration", description: @@ -179,7 +187,7 @@ const completionSpec: Fig.Spec = { { name: "create-agent-action-group", description: - "Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them. To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information", + "Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them. To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information", options: [ { name: "--action-group-executor", @@ -254,7 +262,7 @@ const completionSpec: Fig.Spec = { { name: "--parent-action-group-signature", description: - "To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information", + "To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information", args: { name: "string", }, @@ -350,7 +358,7 @@ const completionSpec: Fig.Spec = { { name: "create-data-source", description: - "Sets up a data source to be added to a knowledge base. You can't change the chunkingConfiguration after you create the data source", + "Creates a data source connector for a knowledge base. You can't change the chunkingConfiguration after you create the data source connector", options: [ { name: "--client-token", @@ -362,15 +370,15 @@ const completionSpec: Fig.Spec = { }, { name: "--data-deletion-policy", - description: "The data deletion policy assigned to the data source", + description: + "The data deletion policy for the data source. You can set the data deletion policy to: DELETE: Deletes all underlying data belonging to the data source from the vector store upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted, only the underlying data. This flag is ignored if an Amazon Web Services account is deleted. RETAIN: Retains all underlying data in your vector store upon deletion of a knowledge base or data source resource", args: { name: "string", }, }, { name: "--data-source-configuration", - description: - "Contains metadata about where the data source is stored", + description: "The connection configuration for the data source", args: { name: "structure", }, @@ -433,9 +441,9 @@ const completionSpec: Fig.Spec = { ], }, { - name: "create-knowledge-base", + name: "create-flow", description: - "Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion. If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base. Provide the name and an optional description. Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field. Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object. Provide the configuration for your vector store in the storageConfiguration object. For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service. For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora. For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone. For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud", + "Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide", options: [ { name: "--client-token", @@ -446,47 +454,47 @@ const completionSpec: Fig.Spec = { }, }, { - name: "--description", - description: "A description of the knowledge base", + name: "--customer-encryption-key-arn", + description: + "The Amazon Resource Name (ARN) of the KMS key to encrypt the flow", args: { name: "string", }, }, { - name: "--knowledge-base-configuration", + name: "--definition", description: - "Contains details about the embeddings model used for the knowledge base", + "A definition of the nodes and connections between nodes in the flow", args: { name: "structure", }, }, { - name: "--name", - description: "A name for the knowledge base", + name: "--description", + description: "A description for the flow", args: { name: "string", }, }, { - name: "--role-arn", + name: "--execution-role-arn", description: - "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base", + "The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide", args: { name: "string", }, }, { - name: "--storage-configuration", - description: - "Contains details about the configuration of the vector database used for the knowledge base", + name: "--name", + description: "A name for the flow", args: { - name: "structure", + name: "string", }, }, { name: "--tags", description: - "Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object", + "Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock", args: { name: "map", }, @@ -511,25 +519,55 @@ const completionSpec: Fig.Spec = { ], }, { - name: "delete-agent", - description: "Deletes an agent", + name: "create-flow-alias", + description: + "Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide", options: [ { - name: "--agent-id", - description: "The unique identifier of the agent to delete", + name: "--client-token", + description: + "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency", args: { name: "string", }, }, { - name: "--skip-resource-in-use-check", + name: "--description", + description: "A description for the alias", + args: { + name: "string", + }, + }, + { + name: "--flow-identifier", description: - "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + "The unique identifier of the flow for which to create an alias", + args: { + name: "string", + }, }, { - name: "--no-skip-resource-in-use-check", + name: "--name", + description: "A name for the alias", + args: { + name: "string", + }, + }, + { + name: "--routing-configuration", description: - "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + "Contains information about the version to which to map the alias", + args: { + name: "list", + }, + }, + { + name: "--tags", + description: + "Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock", + args: { + name: "map", + }, }, { name: "--cli-input-json", @@ -551,42 +589,33 @@ const completionSpec: Fig.Spec = { ], }, { - name: "delete-agent-action-group", - description: "Deletes an action group in an agent", + name: "create-flow-version", + description: + "Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide", options: [ { - name: "--action-group-id", - description: "The unique identifier of the action group to delete", + name: "--client-token", + description: + "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency", args: { name: "string", }, }, { - name: "--agent-id", - description: - "The unique identifier of the agent that the action group belongs to", + name: "--description", + description: "A description of the version of the flow", args: { name: "string", }, }, { - name: "--agent-version", + name: "--flow-identifier", description: - "The version of the agent that the action group belongs to", + "The unique identifier of the flow that you want to create a version of", args: { name: "string", }, }, - { - name: "--skip-resource-in-use-check", - description: - "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", - }, - { - name: "--no-skip-resource-in-use-check", - description: - "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", - }, { name: "--cli-input-json", description: @@ -607,71 +636,63 @@ const completionSpec: Fig.Spec = { ], }, { - name: "delete-agent-alias", - description: "Deletes an alias of an agent", + name: "create-knowledge-base", + description: + "Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion. If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base. Provide the name and an optional description. Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field. Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object. Provide the configuration for your vector store in the storageConfiguration object. For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service. For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora. For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone. For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud", options: [ { - name: "--agent-alias-id", - description: "The unique identifier of the alias to delete", + name: "--client-token", + description: + "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency", args: { name: "string", }, }, { - name: "--agent-id", - description: - "The unique identifier of the agent that the alias belongs to", + name: "--description", + description: "A description of the knowledge base", args: { name: "string", }, }, { - name: "--cli-input-json", + name: "--knowledge-base-configuration", 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", + "Contains details about the embeddings model used for the knowledge base", args: { - name: "string", + name: "structure", }, }, { - 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", + name: "--name", + description: "A name for the knowledge base", args: { name: "string", - suggestions: ["input", "output"], }, }, - ], - }, - { - name: "delete-agent-version", - description: "Deletes a version of an agent", - options: [ { - name: "--agent-id", + name: "--role-arn", description: - "The unique identifier of the agent that the version belongs to", + "The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base", args: { name: "string", }, }, { - name: "--agent-version", - description: "The version of the agent to delete", + name: "--storage-configuration", + description: + "Contains details about the configuration of the vector database used for the knowledge base", args: { - name: "string", + name: "structure", }, }, { - name: "--skip-resource-in-use-check", - description: - "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", - }, - { - name: "--no-skip-resource-in-use-check", + name: "--tags", description: - "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + "Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object", + args: { + name: "map", + }, }, { name: "--cli-input-json", @@ -693,55 +714,64 @@ const completionSpec: Fig.Spec = { ], }, { - name: "delete-data-source", - description: "Deletes a data source from a knowledge base", + name: "create-prompt", + description: + "Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide", options: [ { - name: "--data-source-id", - description: "The unique identifier of the data source to delete", + name: "--client-token", + description: + "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency", args: { name: "string", }, }, { - name: "--knowledge-base-id", + name: "--customer-encryption-key-arn", description: - "The unique identifier of the knowledge base from which to delete the data source", + "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt", args: { name: "string", }, }, { - name: "--cli-input-json", + name: "--default-variant", 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", + "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object", 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", + name: "--description", + description: "A description for the prompt", args: { name: "string", - suggestions: ["input", "output"], }, }, - ], - }, - { - name: "delete-knowledge-base", - description: - "Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request", - options: [ { - name: "--knowledge-base-id", - description: "The unique identifier of the knowledge base to delete", + name: "--name", + description: "A name for the prompt", args: { name: "string", }, }, + { + name: "--tags", + description: + "Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock", + args: { + name: "map", + }, + }, + { + name: "--variants", + description: + "A list of objects, each containing details about a variant of the prompt", + args: { + name: "list", + }, + }, { name: "--cli-input-json", description: @@ -762,33 +792,41 @@ const completionSpec: Fig.Spec = { ], }, { - name: "disassociate-agent-knowledge-base", - description: "Disassociates a knowledge base from an agent", + name: "create-prompt-version", + description: + "Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide", options: [ { - name: "--agent-id", + name: "--client-token", description: - "The unique identifier of the agent from which to disassociate the knowledge base", + "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency", args: { name: "string", }, }, { - name: "--agent-version", - description: - "The version of the agent from which to disassociate the knowledge base", + name: "--description", + description: "A description for the version of the prompt", args: { name: "string", }, }, { - name: "--knowledge-base-id", + name: "--prompt-identifier", description: - "The unique identifier of the knowledge base to disassociate", + "The unique identifier of the prompt that you want to create a version of", args: { name: "string", }, }, + { + name: "--tags", + description: + "Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock", + args: { + name: "map", + }, + }, { name: "--cli-input-json", description: @@ -809,16 +847,26 @@ const completionSpec: Fig.Spec = { ], }, { - name: "get-agent", - description: "Gets information about an agent", + name: "delete-agent", + description: "Deletes an agent", options: [ { name: "--agent-id", - description: "The unique identifier of the agent", + description: "The unique identifier of the agent to delete", args: { name: "string", }, }, + { + name: "--skip-resource-in-use-check", + description: + "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + }, + { + name: "--no-skip-resource-in-use-check", + description: + "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + }, { name: "--cli-input-json", description: @@ -839,13 +887,12 @@ const completionSpec: Fig.Spec = { ], }, { - name: "get-agent-action-group", - description: "Gets information about an action group for an agent", + name: "delete-agent-action-group", + description: "Deletes an action group in an agent", options: [ { name: "--action-group-id", - description: - "The unique identifier of the action group for which to get information", + description: "The unique identifier of the action group to delete", args: { name: "string", }, @@ -866,6 +913,16 @@ const completionSpec: Fig.Spec = { name: "string", }, }, + { + name: "--skip-resource-in-use-check", + description: + "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + }, + { + name: "--no-skip-resource-in-use-check", + description: + "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + }, { name: "--cli-input-json", description: @@ -886,13 +943,12 @@ const completionSpec: Fig.Spec = { ], }, { - name: "get-agent-alias", - description: "Gets information about an alias of an agent", + name: "delete-agent-alias", + description: "Deletes an alias of an agent", options: [ { name: "--agent-alias-id", - description: - "The unique identifier of the alias for which to get information", + description: "The unique identifier of the alias to delete", args: { name: "string", }, @@ -900,7 +956,7 @@ const completionSpec: Fig.Spec = { { name: "--agent-id", description: - "The unique identifier of the agent to which the alias to get information belongs", + "The unique identifier of the agent that the alias belongs to", args: { name: "string", }, @@ -925,30 +981,776 @@ const completionSpec: Fig.Spec = { ], }, { - name: "get-agent-knowledge-base", - description: - "Gets information about a knowledge base associated with an agent", + name: "delete-agent-version", + description: "Deletes a version of an agent", options: [ { name: "--agent-id", description: - "The unique identifier of the agent with which the knowledge base is associated", + "The unique identifier of the agent that the version belongs to", + args: { + name: "string", + }, + }, + { + name: "--agent-version", + description: "The version of the agent to delete", + args: { + name: "string", + }, + }, + { + name: "--skip-resource-in-use-check", + description: + "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + }, + { + name: "--no-skip-resource-in-use-check", + description: + "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + }, + { + 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-source", + description: "Deletes a data source from a knowledge base", + options: [ + { + name: "--data-source-id", + description: "The unique identifier of the data source to delete", + args: { + name: "string", + }, + }, + { + name: "--knowledge-base-id", + description: + "The unique identifier of the knowledge base from which to delete the data source", + 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-flow", + description: "Deletes a flow", + options: [ + { + name: "--flow-identifier", + description: "The unique identifier of the flow", + args: { + name: "string", + }, + }, + { + name: "--skip-resource-in-use-check", + description: + "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + }, + { + name: "--no-skip-resource-in-use-check", + description: + "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + }, + { + 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-flow-alias", + description: "Deletes an alias of a flow", + options: [ + { + name: "--alias-identifier", + description: "The unique identifier of the alias to be deleted", + args: { + name: "string", + }, + }, + { + name: "--flow-identifier", + description: + "The unique identifier of the flow that the alias belongs to", + 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-flow-version", + description: "Deletes a version of a flow", + options: [ + { + name: "--flow-identifier", + description: + "The unique identifier of the flow whose version that you want to delete", + args: { + name: "string", + }, + }, + { + name: "--flow-version", + description: "The version of the flow that you want to delete", + args: { + name: "string", + }, + }, + { + name: "--skip-resource-in-use-check", + description: + "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + }, + { + name: "--no-skip-resource-in-use-check", + description: + "By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use", + }, + { + 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-knowledge-base", + description: + "Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request", + options: [ + { + name: "--knowledge-base-id", + description: "The unique identifier of the knowledge base 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-prompt", + description: + "Deletes a prompt or a prompt version from the Prompt management tool. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide", + options: [ + { + name: "--prompt-identifier", + description: "The unique identifier of the prompt", + args: { + name: "string", + }, + }, + { + name: "--prompt-version", + description: "The version of the prompt 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: "disassociate-agent-knowledge-base", + description: "Disassociates a knowledge base from an agent", + options: [ + { + name: "--agent-id", + description: + "The unique identifier of the agent from which to disassociate the knowledge base", + args: { + name: "string", + }, + }, + { + name: "--agent-version", + description: + "The version of the agent from which to disassociate the knowledge base", + args: { + name: "string", + }, + }, + { + name: "--knowledge-base-id", + description: + "The unique identifier of the knowledge base to disassociate", + 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-agent", + description: "Gets information about an agent", + options: [ + { + name: "--agent-id", + description: "The unique identifier of the agent", + 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-agent-action-group", + description: "Gets information about an action group for an agent", + options: [ + { + name: "--action-group-id", + description: + "The unique identifier of the action group for which to get information", + args: { + name: "string", + }, + }, + { + name: "--agent-id", + description: + "The unique identifier of the agent that the action group belongs to", + args: { + name: "string", + }, + }, + { + name: "--agent-version", + description: + "The version of the agent that the action group belongs to", + 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-agent-alias", + description: "Gets information about an alias of an agent", + options: [ + { + name: "--agent-alias-id", + description: + "The unique identifier of the alias for which to get information", + args: { + name: "string", + }, + }, + { + name: "--agent-id", + description: + "The unique identifier of the agent to which the alias to get information belongs", + 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-agent-knowledge-base", + description: + "Gets information about a knowledge base associated with an agent", + options: [ + { + name: "--agent-id", + description: + "The unique identifier of the agent with which the knowledge base is associated", + args: { + name: "string", + }, + }, + { + name: "--agent-version", + description: + "The version of the agent with which the knowledge base is associated", + args: { + name: "string", + }, + }, + { + name: "--knowledge-base-id", + description: + "The unique identifier of the knowledge base associated with the agent", + 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-agent-version", + description: "Gets details about a version of an agent", + options: [ + { + name: "--agent-id", + description: "The unique identifier of the agent", + args: { + name: "string", + }, + }, + { + name: "--agent-version", + description: "The version of the agent", + 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-source", + description: "Gets information about a data source", + options: [ + { + name: "--data-source-id", + description: "The unique identifier of the data source", + args: { + name: "string", + }, + }, + { + name: "--knowledge-base-id", + description: + "The unique identifier of the knowledge base that the data source was added to", + 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-flow", + description: + "Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide", + options: [ + { + name: "--flow-identifier", + description: "The unique identifier of the flow", + 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-flow-alias", + description: + "Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide", + options: [ + { + name: "--alias-identifier", + description: + "The unique identifier of the alias for which to retrieve information", + args: { + name: "string", + }, + }, + { + name: "--flow-identifier", + description: + "The unique identifier of the flow that the alias belongs to", + 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-flow-version", + description: + "Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide", + options: [ + { + name: "--flow-identifier", + description: + "The unique identifier of the flow for which to get information", + args: { + name: "string", + }, + }, + { + name: "--flow-version", + description: "The version of the flow for which to get information", + 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-ingestion-job", + description: + "Gets information about a ingestion job, in which a data source is added to a knowledge base", + options: [ + { + name: "--data-source-id", + description: + "The unique identifier of the data source in the ingestion job", args: { name: "string", }, }, { - name: "--agent-version", - description: - "The version of the agent with which the knowledge base is associated", + name: "--ingestion-job-id", + description: "The unique identifier of the ingestion job", + args: { + name: "string", + }, + }, + { + name: "--knowledge-base-id", + description: + "The unique identifier of the knowledge base for which the ingestion job applies", + 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-knowledge-base", + description: "Gets information about a knoweldge base", + options: [ + { + name: "--knowledge-base-id", + description: + "The unique identifier of the knowledge base for which to get information", + 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-prompt", + description: + "Retrieves information about a prompt or a version of it. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide", + options: [ + { + name: "--prompt-identifier", + description: "The unique identifier of the prompt", args: { name: "string", }, }, { - name: "--knowledge-base-id", + name: "--prompt-version", description: - "The unique identifier of the knowledge base associated with the agent", + "The version of the prompt about which you want to retrieve information", args: { name: "string", }, @@ -973,8 +1775,9 @@ const completionSpec: Fig.Spec = { ], }, { - name: "get-agent-version", - description: "Gets details about a version of an agent", + name: "list-agent-action-groups", + description: + "Lists the action groups for an agent and information about each one", options: [ { name: "--agent-id", @@ -990,6 +1793,22 @@ const completionSpec: Fig.Spec = { name: "string", }, }, + { + name: "--max-results", + description: + "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results", + args: { + name: "string", + }, + }, { name: "--cli-input-json", description: @@ -998,6 +1817,30 @@ const completionSpec: Fig.Spec = { 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: @@ -1010,20 +1853,29 @@ const completionSpec: Fig.Spec = { ], }, { - name: "get-data-source", - description: "Gets information about a data source", + name: "list-agent-aliases", + description: + "Lists the aliases of an agent and information about each one", options: [ { - name: "--data-source-id", - description: "The unique identifier of the data source", + name: "--agent-id", + description: "The unique identifier of the agent", args: { name: "string", }, }, { - name: "--knowledge-base-id", + name: "--max-results", description: - "The unique identifier of the knowledge base that the data source was added to", + "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results", args: { name: "string", }, @@ -1036,6 +1888,30 @@ const completionSpec: Fig.Spec = { 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: @@ -1048,29 +1924,38 @@ const completionSpec: Fig.Spec = { ], }, { - name: "get-ingestion-job", + name: "list-agent-knowledge-bases", description: - "Gets information about a ingestion job, in which a data source is added to a knowledge base", + "Lists knowledge bases associated with an agent and information about each one", options: [ { - name: "--data-source-id", + name: "--agent-id", description: - "The unique identifier of the data source in the ingestion job", + "The unique identifier of the agent for which to return information about knowledge bases associated with it", args: { name: "string", }, }, { - name: "--ingestion-job-id", - description: "The unique identifier of the ingestion job", + name: "--agent-version", + description: + "The version of the agent for which to return information about knowledge bases associated with it", args: { name: "string", }, }, { - name: "--knowledge-base-id", + name: "--max-results", description: - "The unique identifier of the knowledge base for which the ingestion job applies", + "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results", args: { name: "string", }, @@ -1084,34 +1969,27 @@ const completionSpec: Fig.Spec = { }, }, { - name: "--generate-cli-skeleton", + name: "--starting-token", 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", + "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", - suggestions: ["input", "output"], }, }, - ], - }, - { - name: "get-knowledge-base", - description: "Gets information about a knoweldge base", - options: [ { - name: "--knowledge-base-id", + name: "--page-size", description: - "The unique identifier of the knowledge base for which to get information", + "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: "string", + name: "integer", }, }, { - name: "--cli-input-json", + name: "--max-items", 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", + "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: "string", + name: "integer", }, }, { @@ -1126,9 +2004,9 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-agent-action-groups", + name: "list-agent-versions", description: - "Lists the action groups for an agent and information about each one", + "Lists the versions of an agent and information about each version", options: [ { name: "--agent-id", @@ -1138,12 +2016,69 @@ const completionSpec: Fig.Spec = { }, }, { - name: "--agent-version", - description: "The version of the agent", + name: "--max-results", + description: + "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results", + 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-agents", + description: + "Lists the agents belonging to an account and information about each agent", + options: [ { name: "--max-results", description: @@ -1204,13 +2139,14 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-agent-aliases", + name: "list-data-sources", description: - "Lists the aliases of an agent and information about each one", + "Lists the data sources in a knowledge base and information about each one", options: [ { - name: "--agent-id", - description: "The unique identifier of the agent", + name: "--knowledge-base-id", + description: + "The unique identifier of the knowledge base for which to return a list of information", args: { name: "string", }, @@ -1275,22 +2211,13 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-agent-knowledge-bases", - description: - "Lists knowledge bases associated with an agent and information about each one", + name: "list-flow-aliases", + description: "Returns a list of aliases for a flow", options: [ { - name: "--agent-id", - description: - "The unique identifier of the agent for which to return information about knowledge bases associated with it", - args: { - name: "string", - }, - }, - { - name: "--agent-version", + name: "--flow-identifier", description: - "The version of the agent for which to return information about knowledge bases associated with it", + "The unique identifier of the flow for which aliases are being returned", args: { name: "string", }, @@ -1355,13 +2282,13 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-agent-versions", + name: "list-flow-versions", description: - "Lists the versions of an agent and information about each version", + "Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide", options: [ { - name: "--agent-id", - description: "The unique identifier of the agent", + name: "--flow-identifier", + description: "The unique identifier of the flow", args: { name: "string", }, @@ -1426,9 +2353,9 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-agents", + name: "list-flows", description: - "Lists the agents belonging to an account and information about each agent", + "Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide", options: [ { name: "--max-results", @@ -1490,14 +2417,30 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-data-sources", + name: "list-ingestion-jobs", description: - "Lists the data sources in a knowledge base and information about each one", + "Lists the ingestion jobs for a data source and information about each of them", options: [ + { + name: "--data-source-id", + description: + "The unique identifier of the data source for which to return ingestion jobs", + args: { + name: "string", + }, + }, + { + name: "--filters", + description: + "Contains a definition of a filter for which to filter the results", + args: { + name: "list", + }, + }, { name: "--knowledge-base-id", description: - "The unique identifier of the knowledge base for which to return a list of information", + "The unique identifier of the knowledge base for which to return ingestion jobs", args: { name: "string", }, @@ -1518,6 +2461,13 @@ const completionSpec: Fig.Spec = { name: "string", }, }, + { + name: "--sort-by", + description: "Contains details about how to sort the results", + args: { + name: "structure", + }, + }, { name: "--cli-input-json", description: @@ -1562,34 +2512,10 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-ingestion-jobs", + name: "list-knowledge-bases", description: - "Lists the ingestion jobs for a data source and information about each of them", + "Lists the knowledge bases in an account and information about each of them", options: [ - { - name: "--data-source-id", - description: - "The unique identifier of the data source for which to return ingestion jobs", - args: { - name: "string", - }, - }, - { - name: "--filters", - description: - "Contains a definition of a filter for which to filter the results", - args: { - name: "list", - }, - }, - { - name: "--knowledge-base-id", - description: - "The unique identifier of the knowledge base for which to return ingestion jobs", - args: { - name: "string", - }, - }, { name: "--max-results", description: @@ -1606,13 +2532,6 @@ const completionSpec: Fig.Spec = { name: "string", }, }, - { - name: "--sort-by", - description: "Contains details about how to sort the results", - args: { - name: "structure", - }, - }, { name: "--cli-input-json", description: @@ -1657,9 +2576,9 @@ const completionSpec: Fig.Spec = { ], }, { - name: "list-knowledge-bases", + name: "list-prompts", description: - "Lists the knowledge bases in an account and information about each of them", + "Returns a list of prompts from the Prompt management tool and information about each prompt. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide", options: [ { name: "--max-results", @@ -1677,6 +2596,13 @@ const completionSpec: Fig.Spec = { name: "string", }, }, + { + name: "--prompt-identifier", + description: "The unique identifier of the prompt", + args: { + name: "string", + }, + }, { name: "--cli-input-json", description: @@ -1783,6 +2709,37 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "prepare-flow", + description: + "Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide", + options: [ + { + name: "--flow-identifier", + description: "The unique identifier of the flow", + 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: "start-ingestion-job", description: @@ -1987,6 +2944,13 @@ const completionSpec: Fig.Spec = { name: "string", }, }, + { + name: "--memory-configuration", + description: "Specifies the new memory configuration for the agent", + args: { + name: "structure", + }, + }, { name: "--prompt-override-configuration", description: @@ -2240,11 +3204,12 @@ const completionSpec: Fig.Spec = { { name: "update-data-source", description: - "Updates configurations for a data source. You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration", + "Updates the configurations for a data source connector. You can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration", options: [ { name: "--data-deletion-policy", - description: "The data deletion policy of the updated data source", + description: + "The data deletion policy for the data source that you want to update", args: { name: "string", }, @@ -2252,7 +3217,7 @@ const completionSpec: Fig.Spec = { { name: "--data-source-configuration", description: - "Contains details about the storage configuration of the data source", + "The connection configuration for the data source that you want to update", args: { name: "structure", }, @@ -2274,7 +3239,7 @@ const completionSpec: Fig.Spec = { { name: "--knowledge-base-id", description: - "The unique identifier of the knowledge base to which the data source belongs", + "The unique identifier of the knowledge base for the data source", args: { name: "string", }, @@ -2321,6 +3286,135 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "update-flow", + description: + "Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide", + options: [ + { + name: "--customer-encryption-key-arn", + description: + "The Amazon Resource Name (ARN) of the KMS key to encrypt the flow", + args: { + name: "string", + }, + }, + { + name: "--definition", + description: + "A definition of the nodes and the connections between the nodes in the flow", + args: { + name: "structure", + }, + }, + { + name: "--description", + description: "A description for the flow", + args: { + name: "string", + }, + }, + { + name: "--execution-role-arn", + description: + "The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide", + args: { + name: "string", + }, + }, + { + name: "--flow-identifier", + description: "The unique identifier of the flow", + args: { + name: "string", + }, + }, + { + name: "--name", + description: "A name for the flow", + 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-flow-alias", + description: + "Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide", + options: [ + { + name: "--alias-identifier", + description: "The unique identifier of the alias", + args: { + name: "string", + }, + }, + { + name: "--description", + description: "A description for the flow alias", + args: { + name: "string", + }, + }, + { + name: "--flow-identifier", + description: "The unique identifier of the flow", + args: { + name: "string", + }, + }, + { + name: "--name", + description: "The name of the flow alias", + args: { + name: "string", + }, + }, + { + name: "--routing-configuration", + description: + "Contains information about the version to which to map the alias", + 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-knowledge-base", description: @@ -2390,6 +3484,75 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "update-prompt", + description: + "Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide", + options: [ + { + name: "--customer-encryption-key-arn", + description: + "The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt", + args: { + name: "string", + }, + }, + { + name: "--default-variant", + description: + "The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object", + args: { + name: "string", + }, + }, + { + name: "--description", + description: "A description for the prompt", + args: { + name: "string", + }, + }, + { + name: "--name", + description: "A name for the prompt", + args: { + name: "string", + }, + }, + { + name: "--prompt-identifier", + description: "The unique identifier of the prompt", + args: { + name: "string", + }, + }, + { + name: "--variants", + description: + "A list of objects, each containing details about a variant of the prompt", + 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-runtime.ts b/src/aws/bedrock-runtime.ts index 1a82685972d5..bb9a7ffa75d1 100644 --- a/src/aws/bedrock-runtime.ts +++ b/src/aws/bedrock-runtime.ts @@ -3,6 +3,61 @@ const completionSpec: Fig.Spec = { description: "Describes the API operations for running inference using Amazon Bedrock models", subcommands: [ + { + name: "apply-guardrail", + description: "The action to apply a guardrail", + options: [ + { + name: "--guardrail-identifier", + description: + "The guardrail identifier used in the request to apply the guardrail", + args: { + name: "string", + }, + }, + { + name: "--guardrail-version", + description: + "The guardrail version used in the request to apply the guardrail", + args: { + name: "string", + }, + }, + { + name: "--source", + description: + "The source of data used in the request to apply the guardrail", + args: { + name: "string", + }, + }, + { + name: "--content", + description: + "The content details used in the request to apply the guardrail", + 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: "converse", description: diff --git a/src/aws/bedrock.ts b/src/aws/bedrock.ts index 6356ae76af25..9521a2f021ee 100644 --- a/src/aws/bedrock.ts +++ b/src/aws/bedrock.ts @@ -100,7 +100,7 @@ const completionSpec: Fig.Spec = { { name: "create-guardrail", description: - "Creates a guardrail to block topics and to filter out harmful content. Specify a name and optional description. Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields. Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic. Give a name and description so that the guardrail can properly identify the topic. Specify DENY in the type field. (Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list. Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig. Specify the category in the type field. Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig. (Optional) For security, include the ARN of a KMS key in the kmsKeyId field. (Optional) Attach any tags to the guardrail in the tags object. For more information, see Tag resources", + "Creates a guardrail to block topics and to implement safeguards for your generative AI applications. You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection. Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content. Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses. Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc. Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses. In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail. For more information, see Guardrails for Amazon Bedrock in the Amazon Bedrock User Guide", options: [ { name: "--name", @@ -146,6 +146,14 @@ const completionSpec: Fig.Spec = { name: "structure", }, }, + { + name: "--contextual-grounding-policy-config", + description: + "The contextual grounding policy configuration used to create a guardrail", + args: { + name: "structure", + }, + }, { name: "--blocked-input-messaging", description: @@ -211,7 +219,8 @@ const completionSpec: Fig.Spec = { options: [ { name: "--guardrail-identifier", - description: "The unique identifier of the guardrail", + description: + "The unique identifier of the guardrail. This can be an ID or the ARN", args: { name: "string", }, @@ -484,7 +493,8 @@ const completionSpec: Fig.Spec = { options: [ { name: "--guardrail-identifier", - description: "The unique identifier of the guardrail", + description: + "The unique identifier of the guardrail. This can be an ID or the ARN", args: { name: "string", }, @@ -671,7 +681,7 @@ const completionSpec: Fig.Spec = { { name: "--guardrail-identifier", description: - "The unique identifier of the guardrail for which to get details", + "The unique identifier of the guardrail for which to get details. This can be an ID or the ARN", args: { name: "string", }, @@ -1075,7 +1085,8 @@ const completionSpec: Fig.Spec = { options: [ { name: "--guardrail-identifier", - description: "The unique identifier of the guardrail", + description: + "The unique identifier of the guardrail. This can be an ID or the ARN", args: { name: "string", }, @@ -1568,11 +1579,12 @@ const completionSpec: Fig.Spec = { { name: "update-guardrail", description: - "Updates a guardrail with the values you specify. Specify a name and optional description. Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields. Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic. Give a name and description so that the guardrail can properly identify the topic. Specify DENY in the type field. (Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list. Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig. Specify the category in the type field. Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig. (Optional) For security, include the ARN of a KMS key in the kmsKeyId field. (Optional) Attach any tags to the guardrail in the tags object. For more information, see Tag resources", + "Updates a guardrail with the values you specify. Specify a name and optional description. Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields. Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic. Give a name and description so that the guardrail can properly identify the topic. Specify DENY in the type field. (Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples list. Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig object. Each GuardrailContentFilterConfig object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig. Specify the category in the type field. Specify the strength of the filter for prompts in the inputStrength field and for model responses in the strength field of the GuardrailContentFilterConfig. (Optional) For security, include the ARN of a KMS key in the kmsKeyId field", options: [ { name: "--guardrail-identifier", - description: "The unique identifier of the guardrail", + description: + "The unique identifier of the guardrail. This can be an ID or the ARN", args: { name: "string", }, @@ -1620,6 +1632,14 @@ const completionSpec: Fig.Spec = { name: "structure", }, }, + { + name: "--contextual-grounding-policy-config", + description: + "The contextual grounding policy configuration used to update a guardrail", + args: { + name: "structure", + }, + }, { name: "--blocked-input-messaging", description: diff --git a/src/aws/license-manager-linux-subscriptions.ts b/src/aws/license-manager-linux-subscriptions.ts index c2294f59a7e2..345288b3a4dc 100644 --- a/src/aws/license-manager-linux-subscriptions.ts +++ b/src/aws/license-manager-linux-subscriptions.ts @@ -3,9 +3,74 @@ const completionSpec: Fig.Spec = { description: "With License Manager, you can discover and track your commercial Linux subscriptions on running Amazon EC2 instances", subcommands: [ + { + name: "deregister-subscription-provider", + description: + "Remove a third-party subscription provider from the Bring Your Own License (BYOL) subscriptions registered to your account", + options: [ + { + name: "--subscription-provider-arn", + description: + "The Amazon Resource Name (ARN) of the subscription provider resource 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-registered-subscription-provider", + description: + "Get details for a Bring Your Own License (BYOL) subscription that's registered to your account", + options: [ + { + name: "--subscription-provider-arn", + description: + "The Amazon Resource Name (ARN) of the BYOL registration resource to get details for", + 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-service-settings", - description: "Lists the Linux subscriptions service settings", + description: + "Lists the Linux subscriptions service settings for your account", options: [ { name: "--cli-input-json", @@ -34,21 +99,22 @@ const completionSpec: Fig.Spec = { { name: "--filters", description: - "An array of structures that you can use to filter the results to those that match one or more sets of key-value pairs that you specify. For example, you can filter by the name of AmiID with an optional operator to see subscriptions that match, partially match, or don't match a certain Amazon Machine Image (AMI) ID. The valid names for this filter are: AmiID InstanceID AccountID Status Region UsageOperation ProductCode InstanceType The valid Operators for this filter are: contains equals Notequal", + "An array of structures that you can use to filter the results by your specified criteria. For example, you can specify Region in the Name, with the contains operator to list all subscriptions that match a partial string in the Value, such as us-west. For each filter, you can specify one of the following values for the Name key to streamline results: AccountID AmiID DualSubscription InstanceID InstanceType ProductCode Region Status UsageOperation For each filter, you can use one of the following Operator values to define the behavior of the filter: contains equals Notequal", args: { name: "list", }, }, { name: "--max-results", - description: "Maximum number of results to return in a single call", + description: "The maximum items to return in a request", args: { name: "integer", }, }, { name: "--next-token", - description: "Token for the next set of results", + description: + "A token to specify where to start paginating. This is the nextToken from a previously truncated response", args: { name: "string", }, @@ -111,14 +177,15 @@ const completionSpec: Fig.Spec = { }, { name: "--max-results", - description: "Maximum number of results to return in a single call", + description: "The maximum items to return in a request", args: { name: "integer", }, }, { name: "--next-token", - description: "Token for the next set of results", + description: + "A token to specify where to start paginating. This is the nextToken from a previously truncated response", args: { name: "string", }, @@ -166,6 +233,236 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "list-registered-subscription-providers", + description: + "List Bring Your Own License (BYOL) subscription registration resources for your account", + options: [ + { + name: "--max-results", + description: "The maximum items to return in a request", + args: { + name: "integer", + }, + }, + { + name: "--next-token", + description: + "A token to specify where to start paginating. This is the nextToken from a previously truncated response", + args: { + name: "string", + }, + }, + { + name: "--subscription-provider-sources", + description: + "To filter your results, specify which subscription providers to return in the 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: "--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-tags-for-resource", + description: + "List the metadata tags that are assigned to the specified Amazon Web Services resource", + options: [ + { + name: "--resource-arn", + description: + "The Amazon Resource Name (ARN) of the resource for which to list metadata tags", + 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: "register-subscription-provider", + description: + "Register the supported third-party subscription provider for your Bring Your Own License (BYOL) subscription", + options: [ + { + name: "--secret-arn", + description: + "The Amazon Resource Name (ARN) of the secret where you've stored your subscription provider's access token. For RHEL subscriptions managed through the Red Hat Subscription Manager (RHSM), the secret contains your Red Hat Offline token", + args: { + name: "string", + }, + }, + { + name: "--subscription-provider-source", + description: "The supported Linux subscription provider to register", + args: { + name: "string", + }, + }, + { + name: "--tags", + description: + "The metadata tags to assign to your registered Linux subscription provider resource", + args: { + name: "map", + }, + }, + { + 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: "tag-resource", + description: + "Add metadata tags to the specified Amazon Web Services resource", + options: [ + { + name: "--resource-arn", + description: + "The Amazon Resource Name (ARN) of the Amazon Web Services resource to which to add the specified metadata tags", + args: { + name: "string", + }, + }, + { + name: "--tags", + description: + "The metadata tags to assign to the Amazon Web Services resource. Tags are formatted as key value pairs", + args: { + name: "map", + }, + }, + { + 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: "untag-resource", + description: + "Remove one or more metadata tag from the specified Amazon Web Services resource", + options: [ + { + name: "--resource-arn", + description: + "The Amazon Resource Name (ARN) of the Amazon Web Services resource to remove the metadata tags from", + args: { + name: "string", + }, + }, + { + name: "--tag-keys", + description: + "A list of metadata tag keys to remove from the requested 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-service-settings", description: "Updates the service settings for Linux subscriptions", diff --git a/src/aws/mediaconnect.ts b/src/aws/mediaconnect.ts index 659f367ec659..7bcd08dab89c 100644 --- a/src/aws/mediaconnect.ts +++ b/src/aws/mediaconnect.ts @@ -2281,6 +2281,14 @@ const completionSpec: Fig.Spec = { name: "structure", }, }, + { + name: "--output-status", + description: + "An indication of whether the output should transmit data or not. If you don't specify the outputStatus field in your request, MediaConnect leaves the value unchanged", + args: { + name: "string", + }, + }, { name: "--cli-input-json", description: diff --git a/src/aws/qapps.ts b/src/aws/qapps.ts index 80802dcaf035..309726992442 100644 --- a/src/aws/qapps.ts +++ b/src/aws/qapps.ts @@ -1120,5 +1120,4 @@ const completionSpec: Fig.Spec = { }, ], }; - export default completionSpec; diff --git a/src/aws/quicksight.ts b/src/aws/quicksight.ts index fd60d3ffa78f..3bf66ecd7a54 100644 --- a/src/aws/quicksight.ts +++ b/src/aws/quicksight.ts @@ -3,6 +3,98 @@ const completionSpec: Fig.Spec = { description: "Amazon QuickSight API Reference Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight", subcommands: [ + { + name: "batch-create-topic-reviewed-answer", + description: "Creates new reviewed answers for a Q Topic", + options: [ + { + name: "--aws-account-id", + description: + "The ID of the Amazon Web Services account that you want to create a reviewed answer in", + args: { + name: "string", + }, + }, + { + name: "--topic-id", + description: + "The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account", + args: { + name: "string", + }, + }, + { + name: "--answers", + description: "The definition of the Answers to be created", + 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: "batch-delete-topic-reviewed-answer", + description: "Deletes reviewed answers for Q Topic", + options: [ + { + name: "--aws-account-id", + description: + "The ID of the Amazon Web Services account that you want to delete a reviewed answers in", + args: { + name: "string", + }, + }, + { + name: "--topic-id", + description: + "The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account", + args: { + name: "string", + }, + }, + { + name: "--answer-ids", + description: "The Answer IDs of the Answers to be deleted", + 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: "cancel-ingestion", description: "Cancels an ongoing ingestion of data into SPICE", @@ -7003,6 +7095,45 @@ const completionSpec: Fig.Spec = { }, ], }, + { + name: "list-topic-reviewed-answers", + description: "Lists all reviewed answers for a Q Topic", + options: [ + { + name: "--aws-account-id", + description: + "The ID of the Amazon Web Services account that containd the reviewed answers that you want listed", + args: { + name: "string", + }, + }, + { + name: "--topic-id", + description: + "The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account", + 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-topics", description: "Lists all of the topics within an account",